Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
# SPDX-FileCopyrightText: Copyright (c) 2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0

import os

import pytest
from fastapi import HTTPException

from cuopt_server import webserver
from cuopt_server.utils import settings


@pytest.fixture(autouse=True)
def restore_data_dir():
original_data_dir = settings.get_data_dir()
try:
yield
finally:
settings.set_data_dir(original_data_dir)


def test_validate_file_path_returns_file_if_relative_path_stays_in_data_dir(
tmp_path,
):
data_dir = tmp_path / "data"
data_dir.mkdir()
data_file = data_dir / "input.json"
data_file.write_text("{}", encoding="utf-8")
settings.set_data_dir(str(data_dir))

assert webserver.validate_file_path("input.json") == str(data_file)


def test_validate_file_path_rejects_unset_data_dir():
settings.set_data_dir("")

with pytest.raises(HTTPException) as exc_info:
webserver.validate_file_path("input.json")

assert exc_info.value.status_code == 400
assert "cuopt data directory not set" in exc_info.value.detail


def test_validate_file_path_rejects_absolute_path(tmp_path):
data_dir = tmp_path / "data"
data_dir.mkdir()
outside_file = tmp_path / "input.json"
outside_file.write_text("{}", encoding="utf-8")
settings.set_data_dir(str(data_dir))

with pytest.raises(HTTPException) as exc_info:
webserver.validate_file_path(str(outside_file))

assert exc_info.value.status_code == 400
assert "relative to CUOPT_DATA_DIR" in exc_info.value.detail


def test_validate_file_path_rejects_parent_directory_escape(tmp_path):
data_dir = tmp_path / "data"
data_dir.mkdir()
outside_file = tmp_path / "input.json"
outside_file.write_text("{}", encoding="utf-8")
settings.set_data_dir(str(data_dir))

with pytest.raises(HTTPException) as exc_info:
webserver.validate_file_path("../input.json")

assert exc_info.value.status_code == 400
assert "stay inside CUOPT_DATA_DIR" in exc_info.value.detail


def test_validate_file_path_rejects_non_regular_file(tmp_path):
data_dir = tmp_path / "data"
data_dir.mkdir()
(data_dir / "input").mkdir()
settings.set_data_dir(str(data_dir))

with pytest.raises(HTTPException) as exc_info:
webserver.validate_file_path("input")

assert exc_info.value.status_code == 400
assert "not a regular file" in exc_info.value.detail


def test_validate_file_path_rejects_symlink_escape(tmp_path):
data_dir = tmp_path / "data"
data_dir.mkdir()
outside_file = tmp_path / "input.json"
outside_file.write_text("{}", encoding="utf-8")
os.symlink(outside_file, data_dir / "linked-input.json")
settings.set_data_dir(str(data_dir))

with pytest.raises(HTTPException) as exc_info:
webserver.validate_file_path("linked-input.json")

assert exc_info.value.status_code == 400
assert "stay inside CUOPT_DATA_DIR" in exc_info.value.detail
Comment thread
coderabbitai[bot] marked this conversation as resolved.
62 changes: 36 additions & 26 deletions python/cuopt_server/cuopt_server/webserver.py
Original file line number Diff line number Diff line change
Expand Up @@ -190,36 +190,46 @@ def get_output_name(resultdir, CUOPT_DATA_FILE, CUOPT_RESULT_FILE):


# Validate if given data file and file path exists
def validate_file_path(CUOPT_DATA_FILE):
def validate_file_path(cuopt_data_file):
ddir = settings.get_data_dir()
try:
file_path = os.path.join(ddir, CUOPT_DATA_FILE)
if not ddir:
logging.error("cuopt data directory not set!")
# If no datadir was set but the path is relative,
# this can't work
if not CUOPT_DATA_FILE.startswith("/"):
raise ValueError(
f"cuopt server was started without data directory "
f"defined but local path {CUOPT_DATA_FILE} "
"was specified"
)
if not os.path.exists(file_path):
logging.error(f"File path '{file_path}' doesn't exist")
msg = f"Specified path '{file_path}' does not exist"
if CUOPT_DATA_FILE.startswith("/"):
dir = os.path.dirname(CUOPT_DATA_FILE)
if not os.path.isdir(dir):
msg += f". Absolute path '{dir}' does not exist"
msg += ". Perhaps you did not intend to "
"specify an absolute path?"
raise ValueError(msg)
except Exception as e:
if not ddir:
logging.error("cuopt data directory not set!")
raise HTTPException(
status_code=400,
detail="cuopt data directory not set",
)

if os.path.isabs(cuopt_data_file):
raise HTTPException(
status_code=400,
detail="cuopt-data-file must be relative to CUOPT_DATA_DIR",
)

root = os.path.realpath(ddir)
file_path = os.path.realpath(os.path.join(root, cuopt_data_file))
if os.path.commonpath([root, file_path]) != root:
raise HTTPException(
status_code=400,
detail="cuopt-data-file must stay inside CUOPT_DATA_DIR",
)

if not os.path.exists(file_path):
logging.error("cuopt-data-file does not exist")
raise HTTPException(
status_code=400,
detail="unable to read "
"optimization data from file %s, %s" % (file_path, str(e)),
detail=f"specified data file does not exist: {cuopt_data_file}",
)

if not os.path.isfile(file_path):
logging.error("cuopt-data-file is not a regular file")
raise HTTPException(
status_code=400,
detail=(
"specified data file is not a regular file: "
f"{cuopt_data_file}"
),
)

return file_path


Expand Down
Loading