Skip to content
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.

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

Already on GitHub? Sign in to your account

Further fix validate path on Windows #10330

Merged
merged 1 commit into from
Nov 14, 2023

Conversation

Haxatron
Copy link
Contributor

@Haxatron Haxatron commented Nov 8, 2023

馃洜 DevTools 馃洜

Open in GitHub Codespaces

Install mlflow from this PR

pip install git+https://github.com/mlflow/mlflow.git@refs/pull/10330/merge

Checkout with GitHub CLI

gh pr checkout 10330

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

Follow up of #8999.

On Windows, drive-relative paths without slash after drive letter and colon (ie. C:path/to/file) will be converted to a relative path.

So,

C:path/to/file -> path/to/file

This has security implication when there is a .. in the path.

C:../path/to/file -> ../path/to/file

This PR fixes this scenario by checking whether the 2nd character of the path provided is a :

Reference: https://stackoverflow.com/questions/23955968/windows-path-with-no-slash-after-drive-letter-and-colon-what-does-it-point-to

How is this PR tested?

  • Existing unit/integration tests
  • New unit/integration tests
  • Manual tests

Does this PR require documentation update?

  • No. You can skip the rest of this section.
  • Yes. I've updated:
    • Examples
    • API references
    • Instructions

Release Notes

Is this a user-facing change?

  • No. You can skip the rest of this section.
  • Yes. Give a description of this change to be included in the release notes for MLflow users.

What component(s), interfaces, languages, and integrations does this PR affect?

Components

  • area/artifacts: Artifact stores and artifact logging
  • area/build: Build and test infrastructure for MLflow
  • area/docs: MLflow documentation pages
  • area/examples: Example code
  • area/gateway: AI Gateway service, Gateway client APIs, third-party Gateway integrations
  • area/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registry
  • area/models: MLmodel format, model serialization/deserialization, flavors
  • area/recipes: Recipes, Recipe APIs, Recipe configs, Recipe Templates
  • area/projects: MLproject format, project running backends
  • area/scoring: MLflow Model server, model deployment tools, Spark UDFs
  • area/server-infra: MLflow Tracking server backend
  • area/tracking: Tracking Service, tracking client APIs, autologging

Interface

  • area/uiux: Front-end, user experience, plotting, JavaScript, JavaScript dev server
  • area/docker: Docker use across MLflow's components, such as MLflow Projects and MLflow Models
  • area/sqlalchemy: Use of SQLAlchemy in the Tracking Service or Model Registry
  • area/windows: Windows support

Language

  • language/r: R APIs and clients
  • language/java: Java APIs and clients
  • language/new: Proposals for new client languages

Integrations

  • integrations/azure: Azure and Azure ML integrations
  • integrations/sagemaker: SageMaker integrations
  • integrations/databricks: Databricks integrations

How should the PR be classified in the release notes? Choose one:

  • rn/none - No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" section
  • rn/breaking-change - The PR will be mentioned in the "Breaking Changes" section
  • rn/feature - A new user-facing feature worth mentioning in the release notes
  • rn/bug-fix - A user-facing bug fix worth mentioning in the release notes
  • rn/documentation - A user-facing documentation change worth mentioning in the release notes

Signed-off-by: Axel Chong <haxatron1@gmail.com>
Copy link

github-actions bot commented Nov 8, 2023

Documentation preview for 06dcac1 will be available here when this CircleCI job completes successfully.

More info

@github-actions github-actions bot added area/tracking Tracking service, tracking client APIs, autologging rn/none List under Small Changes in Changelogs. labels Nov 8, 2023
@Haxatron
Copy link
Contributor Author

Haxatron commented Nov 8, 2023

@serena-ruan @harupy, as you reviewed #8999, can you review this?

Comment on lines +580 to +583
r"C:path",
r"C:path/",
r"C:path/to/file",
r"C:../path/to/file",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I get r"C:../path/to/file" should be considered as bad path, but why the first three also bad? Relative path without .. should be good right?

Copy link
Contributor Author

@Haxatron Haxatron Nov 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When I tested on the mlartifacts API end point, using drive-relative path without .. will break out of mlartifacts directory for some reason (ie. instead of searching in dir/mlartifacts, MLFlow search in dir instead). Also, since it seems very edge-cased that someone would use these sort of paths, I decided to disallow them outright.

Copy link
Collaborator

@serena-ruan serena-ruan Nov 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Disallowing C:/path/to/file is a behavior change if it's supposed to be a safe path. Could we just disallow '..' by splitting the path on ':' as well?

Copy link
Contributor Author

@Haxatron Haxatron Nov 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What I meant above is that in C:path/to/file is also unsafe because in the /mlflow-artifacts/artifacts/ endpoint

/mlflow-artifacts/artifacts/C:path/to/file -> for some reason will access path/to/file instead of mlartifacts/path/to/file, which is unintended (we only want access to mlartifacts directory)

Therefore since it is unsafe, I decided to disallow these paths as it is extremely extremely unlikely to be used because:

  1. People would use /mlflow-artifacts/artifacts/path/to/file instead of /mlflow-artifacts/artifacts/C:path/to/file to access the file they want.

  2. Knowledge of these relative paths with drive C: (ie C:path/to/file) is quite obscure.

Copy link
Collaborator

@serena-ruan serena-ruan Nov 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/mlflow-artifacts/artifacts/C:path/to/file -> for some reason will access path/to/file instead of mlartifacts/path/to/file, which is unintended (we only want access to mlartifacts.)

This does look weird, they could just remove 'C:' for accessing relative paths. Thanks for the explanation :D

Copy link
Collaborator

@serena-ruan serena-ruan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@serena-ruan serena-ruan merged commit b68b435 into mlflow:master Nov 14, 2023
46 checks passed
KonakanchiSwathi pushed a commit to KonakanchiSwathi/mlflow that referenced this pull request Nov 29, 2023
Signed-off-by: swathi <konakanchi.swathi@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/tracking Tracking service, tracking client APIs, autologging rn/none List under Small Changes in Changelogs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants