Resolve and contain the user-supplied filename before serving it from the runner's /files endpoint. Also raise a 404 (instead of returning None) when the downloads folder is unset, and use the resolved basename for Content-Disposition.
96 lines
3.4 KiB
Python
96 lines
3.4 KiB
Python
#
|
|
# Copyright (c) 2024-2026, Daily
|
|
#
|
|
# SPDX-License-Identifier: BSD 2-Clause License
|
|
#
|
|
|
|
import os
|
|
import tempfile
|
|
import unittest
|
|
from pathlib import Path
|
|
from types import SimpleNamespace
|
|
|
|
from fastapi import FastAPI, HTTPException
|
|
from fastapi.testclient import TestClient
|
|
|
|
from pipecat.runner.run import _resolve_download_path, _setup_webrtc_routes
|
|
|
|
|
|
class TestRunnerDownloads(unittest.TestCase):
|
|
def test_resolve_download_path_allows_files_inside_folder(self):
|
|
with tempfile.TemporaryDirectory() as tmpdir:
|
|
downloads = Path(tmpdir) / "downloads"
|
|
nested = downloads / "nested"
|
|
nested.mkdir(parents=True)
|
|
file_path = nested / "recording.txt"
|
|
file_path.write_text("session transcript")
|
|
|
|
resolved = _resolve_download_path(str(downloads), "nested/recording.txt")
|
|
|
|
self.assertEqual(resolved, file_path.resolve())
|
|
|
|
def test_resolve_download_path_blocks_parent_traversal(self):
|
|
with tempfile.TemporaryDirectory() as tmpdir:
|
|
root = Path(tmpdir)
|
|
downloads = root / "downloads"
|
|
downloads.mkdir()
|
|
(root / "secret.txt").write_text("secret")
|
|
|
|
with self.assertRaises(HTTPException) as context:
|
|
_resolve_download_path(str(downloads), "../secret.txt")
|
|
|
|
self.assertEqual(context.exception.status_code, 403)
|
|
|
|
def test_download_file_returns_404_when_folder_not_configured(self):
|
|
app = FastAPI()
|
|
args = SimpleNamespace(folder=None, esp32=False, host="127.0.0.1")
|
|
_setup_webrtc_routes(app, args)
|
|
|
|
response = TestClient(app).get("/files/recording.txt")
|
|
|
|
self.assertEqual(response.status_code, 404)
|
|
|
|
def test_resolve_download_path_blocks_decoded_encoded_slashes(self):
|
|
with tempfile.TemporaryDirectory() as tmpdir:
|
|
root = Path(tmpdir)
|
|
downloads = root / "media"
|
|
downloads.mkdir()
|
|
outside = root / "outside"
|
|
outside.mkdir()
|
|
(outside / "secret.txt").write_text("secret")
|
|
|
|
with self.assertRaises(HTTPException) as context:
|
|
_resolve_download_path(str(downloads), "../outside/secret.txt")
|
|
|
|
self.assertEqual(context.exception.status_code, 403)
|
|
|
|
def test_resolve_download_path_blocks_absolute_paths(self):
|
|
with tempfile.TemporaryDirectory() as tmpdir:
|
|
downloads = Path(tmpdir) / "downloads"
|
|
downloads.mkdir()
|
|
|
|
with self.assertRaises(HTTPException) as context:
|
|
_resolve_download_path(str(downloads), "/etc/passwd")
|
|
|
|
self.assertEqual(context.exception.status_code, 403)
|
|
|
|
@unittest.skipUnless(hasattr(os, "symlink"), "os.symlink is not available")
|
|
def test_resolve_download_path_blocks_symlink_escape(self):
|
|
with tempfile.TemporaryDirectory() as tmpdir:
|
|
root = Path(tmpdir)
|
|
downloads = root / "downloads"
|
|
outside = root / "outside"
|
|
downloads.mkdir()
|
|
outside.mkdir()
|
|
(outside / "secret.txt").write_text("secret")
|
|
|
|
try:
|
|
os.symlink(outside, downloads / "linked")
|
|
except OSError as e:
|
|
self.skipTest(f"Unable to create symlink: {e}")
|
|
|
|
with self.assertRaises(HTTPException) as context:
|
|
_resolve_download_path(str(downloads), "linked/secret.txt")
|
|
|
|
self.assertEqual(context.exception.status_code, 403)
|