Skip to content

chore: Validate run_name in Vertex Tensorboard profile uploader. #6233

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
copybara-service wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: Validate run_name in Vertex Tensorboard profile uploader. #6233

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 17 additions & 3 deletions google/cloud/aiplatform/tensorboard/plugins/tf_profiler/profile_uploader.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ def _is_valid_event(self, run_name: str) -> bool:
return tf.io.gfile.isdir(self._profile_dir(run_name))

def _profile_dir(self, run_name: str) -> str:
"""Converts run name to full profile path.
"""Converts run name to a full, validated profile path under `logdir`.

Args:
run_name (str):
Expand All @@ -155,9 +155,23 @@ def _profile_dir(self, run_name: str) -> str:
Returns:
Full path for run name.
"""
logger.debug("_profile_dir run_name: %s", run_name)
base = os.path.realpath(self._logdir)
if run_name is None or run_name == uploader_utils.DEFAULT_PROFILE_RUN_NAME:
return os.path.join(self._logdir, self.PROFILE_PATH)
return os.path.join(self._logdir, run_name, self.PROFILE_PATH)
candidate = os.path.join(base, self.PROFILE_PATH)
else:
# Normalize and forbid absolute/traversal components in `run_name`.
if os.path.isabs(run_name):
raise ValueError("run_name must be a relative name")
# Collapse dot segments then strip leading separators
safe_name = os.path.normpath(run_name).lstrip("/\\")
if safe_name.startswith("..") or (".." + os.sep) in safe_name:
raise ValueError("run_name must not contain path traversal")
candidate = os.path.join(base, safe_name, self.PROFILE_PATH)
resolved = os.path.realpath(candidate)
if os.path.commonpath([base, resolved]) != base:
raise ValueError("profile path escapes logdir")
return resolved

def send_request(self, run_name: str):
"""Accepts run_name and sends an RPC request if an event is detected.
Expand Down
Loading