File access security guide #9156

freddyaboulton · 2024-08-20T16:21:24Z

Description

Pull out the "File Access" section from the "Sharing your App" guide into its own guide.

Take two of #9154

Closes: #(issue)

🎯 PRs Should Target Issues

Before your create a PR, please check to see if there is an existing issue for this change. If not, please create an issue before you create this PR, unless the fix is very small.

Not adhering to this guideline will result in the PR being closed.

Tests

PRs will only be merged if tests pass on CI. To run the tests locally, please set up your Gradio environment locally and run the tests: bash scripts/run_all_tests.sh
You may need to run the linters: bash scripts/format_backend.sh and bash scripts/format_frontend.sh

Add code Add code Add code emphasis

gradio-pr-bot · 2024-08-20T16:22:04Z

🪼 branch checks and previews

•	Name	Status	URL
	Spaces	ready!	Spaces preview
	Website	building...
	Storybook	ready!	Storybook preview
🦄	Changes	detected!	Details

Install Gradio from this PR

pip install https://gradio-pypi-previews.s3.amazonaws.com/cab9ba13ebec3bbe56ce358ab2ec7802b0b28240/gradio-4.42.0-py3-none-any.whl

Install Gradio Python Client from this PR

pip install "gradio-client @ git+https://github.com/gradio-app/gradio@cab9ba13ebec3bbe56ce358ab2ec7802b0b28240#subdirectory=client/python"

Install Gradio JS Client from this PR

npm install https://gradio-npm-previews.s3.amazonaws.com/cab9ba13ebec3bbe56ce358ab2ec7802b0b28240/gradio-client-1.5.1.tgz

gradio-pr-bot · 2024-08-20T16:22:12Z

🦄 change detected

This Pull Request includes changes to the following packages.

Package	Version
`website`	`minor`

Maintainers can select this checkbox to manually select packages to update.

With the following changelog entry.

File access security guide

Maintainers or the PR author can modify the PR title to modify this entry.

Something isn't right?

Maintainers can change the version label to modify the version bump.
If the bot has failed to detect any changes, or if this pull request needs to update multiple packages to different versions or requires a more comprehensive changelog entry, maintainers can update the changelog file directly.

guides/04_additional-features/07_sharing-your-app.md

guides/04_additional-features/08_file-access.md

abidlabs · 2024-08-20T18:34:46Z

guides/04_additional-features/08_file-access.md

+
+Sharing your Gradio app with others (by hosting it on Spaces, on your own server, or through temporary share links) **exposes** certain files on your machine to the internet.
+
+This guide will explain which ones as well as some best practices for making sure the files on your machine are secure.


Suggested change

This guide will explain which ones as well as some best practices for making sure the files on your machine are secure.

This guide explains which files are exposed as well as best practices for making sure the files on your machine are secure.

guides/04_additional-features/08_file-access.md

abidlabs · 2024-08-20T18:39:38Z

guides/04_additional-features/08_file-access.md

+
+First, it's important to understand that Gradio places files in a special `cache` before returning them to the frontend. For example, if your prediction function returns a video file, then Gradio will move that video to the `cache` after your prediction function runs and returns a URL the frontend can use to show the video. Any file in the `cache` is available via URL while the application is running.
+
+Tip: You can customize the location of the `cache` by setting the `GRADIO_TEMP_DIR` environment variable to an absolute path, such as `/home/usr/scripts/project/temp/`. 


Suggested change

Tip: You can customize the location of the `cache` by setting the `GRADIO_TEMP_DIR` environment variable to an absolute path, such as `/home/usr/scripts/project/temp/`.

Tip: You can customize the location of the cache by setting the `GRADIO_TEMP_DIR` environment variable to an absolute path, such as `/home/usr/scripts/project/temp/`.

abidlabs · 2024-08-20T18:41:15Z

guides/04_additional-features/08_file-access.md

+3. It is in the current working directory of the python interpreter.
+4. It is in the temp directory obtained by `tempfile.gettempdir()`.
+
+Additionally, files in the current working directory whose name starts with a period (`.`) will not be moved to the cache. If no criteria are met, the prediction function that created that file will error. Gradio performs this check so that arbitrary files on your machine are not moved to the cache.


Suggested change

Additionally, files in the current working directory whose name starts with a period (`.`) will not be moved to the cache. If no criteria are met, the prediction function that created that file will error. Gradio performs this check so that arbitrary files on your machine are not moved to the cache.

Note: files in the current working directory whose name starts with a period (`.`) will not be moved to the cache, since they often contain sensitive information for your application.

If none of these criteria are met, the prediction function that created that file will raise an exception instead of moving the file to cache. Gradio performs this check so that arbitrary files on your machine cannot be accessed.

guides/04_additional-features/08_file-access.md

abidlabs · 2024-08-20T18:45:34Z

guides/04_additional-features/08_file-access.md

+* Set a `max_file_size` for your application.
+* Do not treat arbitrary user input as input to a file-based component (`gr.Image`, `gr.File`, etc.).
+* Prefer to use absolute paths in `allowed_paths`. If a path in `allowed_paths` is a directory, any file within that directory can be accessed. If passing a directory is necessary, make sure it only contains files related to your application.
+* Run your gradio application from the same directory the application file is located in. This will narrow the scope of files Gradio will be allowed to move into the cache. 


Also might be worth adding a quick example:

python app.py

instead of

python Users/.../dev/app.py

abidlabs · 2024-08-20T18:46:19Z

guides/04_additional-features/08_file-access.md

+
+* Set a `max_file_size` for your application.
+* Do not treat arbitrary user input as input to a file-based component (`gr.Image`, `gr.File`, etc.).
+* Prefer to use absolute paths in `allowed_paths`. If a path in `allowed_paths` is a directory, any file within that directory can be accessed. If passing a directory is necessary, make sure it only contains files related to your application.


It sounds like you're connecting

Prefer to use absolute paths in allowed_paths.
and
If a path in allowed_paths is a directory, any file within that directory can be accessed. If passing a directory is necessary, make sure it only contains files related to your application.
but these are two independent points iiuc. I would separate them into two separate bullet points

The point I was trying to make is that if you add some_big_dir/ to allowed_paths, everything in it is exposed. I'm suggesting that the directories in allowed_paths are "as small as possible".

abidlabs · 2024-08-20T18:46:27Z

guides/04_additional-features/09_environment-variables.md

@@ -107,6 +107,15 @@ Environment variables in Gradio provide a way to customize your applications and
  ```


+### 12. `GRADIO_EXAMPLES_CACHE`


abidlabs · 2024-08-20T18:47:52Z

Went a bit overboard with the suggestions sorry @freddyaboulton 😅, take whatever sounds reasonable. Also there's one or two places in the Guides where we link to /guides/sharing-your-app#security-and-file-access, we should update those

freddyaboulton · 2024-08-20T20:19:17Z

Thanks @abidlabs - will address in a bit!

freddyaboulton · 2024-08-21T14:34:38Z

Should be good for another review @abidlabs !

abidlabs · 2024-08-21T18:46:20Z

guides/04_additional-features/08_file-access.md

+
+Note: files in the current working directory whose name starts with a period (`.`) will not be moved to the cache, since they often contain sensitive information. 
+
+If none of these criteria are met, the prediction function that created that file will raise an exception instead of moving the file to cache. Gradio performs this check so that arbitrary files on your machine cannot be accessed.


Suggested change

If none of these criteria are met, the prediction function that created that file will raise an exception instead of moving the file to cache. Gradio performs this check so that arbitrary files on your machine cannot be accessed.

If none of these criteria are met, the prediction function that is returning that file will raise an exception instead of moving the file to cache. Gradio performs this check so that arbitrary files on your machine cannot be accessed.

abidlabs · 2024-08-21T18:47:26Z

guides/04_additional-features/08_file-access.md

+
+While running, Gradio apps will NOT ALLOW users to access:
+
+- **Files that you explicitly block via the `blocked_paths` parameter in `launch()`**. You can pass in a list of additional directories or exact filepaths to the `blocked_paths` parameter in `launch()`. This parameter takes precedence over the files that Gradio exposes by default or by the `allowed_paths`.


I believe this is true:

Suggested change

- **Files that you explicitly block via the `blocked_paths` parameter in `launch()`**. You can pass in a list of additional directories or exact filepaths to the `blocked_paths` parameter in `launch()`. This parameter takes precedence over the files that Gradio exposes by default or by the `allowed_paths`.

- **Files that you explicitly block via the `blocked_paths` parameter in `launch()`**. You can pass in a list of additional directories or exact filepaths to the `blocked_paths` parameter in `launch()`. This parameter takes precedence over the files that Gradio exposes by default or by the `allowed_paths` parameter or by `gr.set_static_paths`.

abidlabs · 2024-08-21T18:48:18Z

guides/04_additional-features/08_file-access.md

+## Best Practices
+
+* Set a `max_file_size` for your application.
+* Do not treat arbitrary user input as input to a file-based component (`gr.Image`, `gr.File`, etc.). For example, the following interface would allow anyone to move an arbitrary file in your local directory to the cache: `gr.Interface(lambda s: s, "text", "file")`. This is because the user input is treated as an arbitrary file path. 


Suggested change

* Do not treat arbitrary user input as input to a file-based component (`gr.Image`, `gr.File`, etc.). For example, the following interface would allow anyone to move an arbitrary file in your local directory to the cache: `gr.Interface(lambda s: s, "text", "file")`. This is because the user input is treated as an arbitrary file path.

* Do not return arbitrary user input from a function that is connected to a file-based output component (`gr.Image`, `gr.File`, etc.). For example, the following interface would allow anyone to move an arbitrary file in your local directory to the cache: `gr.Interface(lambda s: s, "text", "file")`. This is because the user input is treated as an arbitrary file path.

abidlabs · 2024-08-21T18:48:28Z

guides/04_additional-features/08_file-access.md

+
+* Set a `max_file_size` for your application.
+* Do not treat arbitrary user input as input to a file-based component (`gr.Image`, `gr.File`, etc.). For example, the following interface would allow anyone to move an arbitrary file in your local directory to the cache: `gr.Interface(lambda s: s, "text", "file")`. This is because the user input is treated as an arbitrary file path. 
+* Make `allowed_paths` as small as possible. If a path in `allowed_paths` is a directory, any file within that directory can be accessed. Ma sure the entires of `allowed_paths` only contains files related to your application.


Suggested change

* Make `allowed_paths` as small as possible. If a path in `allowed_paths` is a directory, any file within that directory can be accessed. Ma sure the entires of `allowed_paths` only contains files related to your application.

* Make `allowed_paths` as small as possible. If a path in `allowed_paths` is a directory, any file within that directory can be accessed. Make sure the entires of `allowed_paths` only contains files related to your application.

abidlabs · 2024-08-21T18:48:37Z

guides/04_additional-features/08_file-access.md

+* Set a `max_file_size` for your application.
+* Do not treat arbitrary user input as input to a file-based component (`gr.Image`, `gr.File`, etc.). For example, the following interface would allow anyone to move an arbitrary file in your local directory to the cache: `gr.Interface(lambda s: s, "text", "file")`. This is because the user input is treated as an arbitrary file path. 
+* Make `allowed_paths` as small as possible. If a path in `allowed_paths` is a directory, any file within that directory can be accessed. Ma sure the entires of `allowed_paths` only contains files related to your application.
+* Run your gradio application from the same directory the application file is located in. This will narrow the scope of files Gradio will be allowed to move into the cache. For examples, prefer `python app.py` to `python Users/sources/project/app.py`.


Suggested change

* Run your gradio application from the same directory the application file is located in. This will narrow the scope of files Gradio will be allowed to move into the cache. For examples, prefer `python app.py` to `python Users/sources/project/app.py`.

* Run your gradio application from the same directory the application file is located in. This will narrow the scope of files Gradio will be allowed to move into the cache. For example, prefer `python app.py` to `python Users/sources/project/app.py`.

abidlabs

LGTM @freddyaboulton! Small comments

freddyaboulton · 2024-08-22T19:43:16Z

Thank you @abidlabs !

* first draft Add code Add code Add code emphasis * suggestions * redirects * add changeset * trigger ci * typos --------- Co-authored-by: gradio-pr-bot <[email protected]>

* Fix unified case * commit * Add code * add changeset * notebook * Lint * delete * Fix code * fix tests * File access security guide (#9156) * first draft Add code Add code Add code emphasis * suggestions * redirects * add changeset * trigger ci * typos --------- Co-authored-by: gradio-pr-bot <[email protected]> * redirect * typos * link * fix * See what the problem is * less time * fix * try again with busted cache * try again * Code * Demo and code --------- Co-authored-by: gradio-pr-bot <[email protected]> Co-authored-by: pngwn <[email protected]>

first draft

1ac5a51

Add code Add code Add code emphasis

freddyaboulton marked this pull request as ready for review August 20, 2024 16:27

freddyaboulton requested review from abidlabs, pngwn, aliabid94, aliabd, dawoodkhan82 and hannahblair August 20, 2024 16:27

abidlabs reviewed Aug 20, 2024

View reviewed changes

guides/04_additional-features/07_sharing-your-app.md Show resolved Hide resolved

abidlabs reviewed Aug 20, 2024

View reviewed changes

guides/04_additional-features/08_file-access.md Outdated Show resolved Hide resolved

abidlabs reviewed Aug 20, 2024

View reviewed changes

guides/04_additional-features/08_file-access.md Outdated Show resolved Hide resolved

abidlabs reviewed Aug 20, 2024

View reviewed changes

guides/04_additional-features/08_file-access.md Outdated Show resolved Hide resolved

abidlabs reviewed Aug 20, 2024

View reviewed changes

guides/04_additional-features/08_file-access.md Show resolved Hide resolved

abidlabs reviewed Aug 20, 2024

View reviewed changes

guides/04_additional-features/08_file-access.md Outdated Show resolved Hide resolved

abidlabs reviewed Aug 20, 2024

View reviewed changes

freddyaboulton and others added 4 commits August 20, 2024 17:02

suggestions

fef9636

redirects

f327ddd

add changeset

48cfb7a

Merge branch '5.0-dev' into file-access-security-guide-2

bdc5f7c

trigger ci

f3e6eeb

abidlabs reviewed Aug 21, 2024

View reviewed changes

abidlabs approved these changes Aug 21, 2024

View reviewed changes

freddyaboulton added 2 commits August 22, 2024 15:20

Merge branch '5.0-dev' into file-access-security-guide-2

981330d

typos

cab9ba1

freddyaboulton merged commit 8deeeb6 into 5.0-dev Aug 22, 2024
21 of 22 checks passed

freddyaboulton deleted the file-access-security-guide-2 branch August 22, 2024 19:43

freddyaboulton added a commit that referenced this pull request Aug 22, 2024

File access security guide (#9156)

821ed32

* first draft Add code Add code Add code emphasis * suggestions * redirects * add changeset * trigger ci * typos --------- Co-authored-by: gradio-pr-bot <[email protected]>

gradio-pr-bot mentioned this pull request Aug 22, 2024

chore: update versions (beta) #8829

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

File access security guide #9156

File access security guide #9156

freddyaboulton commented Aug 20, 2024

gradio-pr-bot commented Aug 20, 2024 •

edited

Loading

gradio-pr-bot commented Aug 20, 2024 •

edited

Loading

Something isn't right?

abidlabs Aug 20, 2024 •

edited

Loading

abidlabs Aug 20, 2024

abidlabs Aug 20, 2024

abidlabs Aug 20, 2024

abidlabs Aug 20, 2024

freddyaboulton Aug 20, 2024

abidlabs Aug 20, 2024

abidlabs commented Aug 20, 2024

freddyaboulton commented Aug 20, 2024

freddyaboulton commented Aug 21, 2024

abidlabs Aug 21, 2024

abidlabs Aug 21, 2024

abidlabs Aug 21, 2024

abidlabs Aug 21, 2024

abidlabs Aug 21, 2024

abidlabs left a comment

freddyaboulton commented Aug 22, 2024


		Sharing your Gradio app with others (by hosting it on Spaces, on your own server, or through temporary share links) exposes certain files on your machine to the internet.

		This guide will explain which ones as well as some best practices for making sure the files on your machine are secure.

	This guide will explain which ones as well as some best practices for making sure the files on your machine are secure.
	This guide explains which files are exposed as well as best practices for making sure the files on your machine are secure.


		First, it's important to understand that Gradio places files in a special `cache` before returning them to the frontend. For example, if your prediction function returns a video file, then Gradio will move that video to the `cache` after your prediction function runs and returns a URL the frontend can use to show the video. Any file in the `cache` is available via URL while the application is running.

		Tip: You can customize the location of the `cache` by setting the `GRADIO_TEMP_DIR` environment variable to an absolute path, such as `/home/usr/scripts/project/temp/`.

		@@ -107,6 +107,15 @@ Environment variables in Gradio provide a way to customize your applications and
		```


		### 12. `GRADIO_EXAMPLES_CACHE`


		Note: files in the current working directory whose name starts with a period (`.`) will not be moved to the cache, since they often contain sensitive information.

		If none of these criteria are met, the prediction function that created that file will raise an exception instead of moving the file to cache. Gradio performs this check so that arbitrary files on your machine cannot be accessed.


		While running, Gradio apps will NOT ALLOW users to access:

		- Files that you explicitly block via the `blocked_paths` parameter in `launch()`. You can pass in a list of additional directories or exact filepaths to the `blocked_paths` parameter in `launch()`. This parameter takes precedence over the files that Gradio exposes by default or by the `allowed_paths`.

	* Do not treat arbitrary user input as input to a file-based component (`gr.Image`, `gr.File`, etc.). For example, the following interface would allow anyone to move an arbitrary file in your local directory to the cache: `gr.Interface(lambda s: s, "text", "file")`. This is because the user input is treated as an arbitrary file path.
	* Do not return arbitrary user input from a function that is connected to a file-based output component (`gr.Image`, `gr.File`, etc.). For example, the following interface would allow anyone to move an arbitrary file in your local directory to the cache: `gr.Interface(lambda s: s, "text", "file")`. This is because the user input is treated as an arbitrary file path.

	* Make `allowed_paths` as small as possible. If a path in `allowed_paths` is a directory, any file within that directory can be accessed. Ma sure the entires of `allowed_paths` only contains files related to your application.
	* Make `allowed_paths` as small as possible. If a path in `allowed_paths` is a directory, any file within that directory can be accessed. Make sure the entires of `allowed_paths` only contains files related to your application.

	* Run your gradio application from the same directory the application file is located in. This will narrow the scope of files Gradio will be allowed to move into the cache. For examples, prefer `python app.py` to `python Users/sources/project/app.py`.
	* Run your gradio application from the same directory the application file is located in. This will narrow the scope of files Gradio will be allowed to move into the cache. For example, prefer `python app.py` to `python Users/sources/project/app.py`.

File access security guide #9156

File access security guide #9156

Conversation

freddyaboulton commented Aug 20, 2024

Description

🎯 PRs Should Target Issues

Tests

gradio-pr-bot commented Aug 20, 2024 • edited Loading

🪼 branch checks and previews

gradio-pr-bot commented Aug 20, 2024 • edited Loading

🦄 change detected

This Pull Request includes changes to the following packages.

With the following changelog entry.

Something isn't right?

abidlabs Aug 20, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abidlabs commented Aug 20, 2024

freddyaboulton commented Aug 20, 2024

freddyaboulton commented Aug 21, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abidlabs left a comment

Choose a reason for hiding this comment

freddyaboulton commented Aug 22, 2024

gradio-pr-bot commented Aug 20, 2024 •

edited

Loading

gradio-pr-bot commented Aug 20, 2024 •

edited

Loading

abidlabs Aug 20, 2024 •

edited

Loading