-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Add documentation how to avoid data modification by tools #14239
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’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
nsoranzo
merged 6 commits into
galaxyproject:dev
from
bernt-matthias:doc/data-loss-protection
Jul 4, 2022
Merged
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
84f2c12
add documentation how to avoid data modification by tools
bernt-matthias d4473a9
Update doc/source/admin/production.md
bernt-matthias 99935b6
Apply suggestions from code review
bernt-matthias fe10f76
Update doc/source/admin/production.md
bernt-matthias a75e17e
move to new top level category
bernt-matthias ed5bdce
Apply suggestions from code review
bernt-matthias File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| # Security considerations | ||
|
|
||
| ### Protect Galaxy against data loss due to misbehaving tools | ||
|
|
||
| Tools have access to the paths of input and output data sets which are stored in | ||
| ``file_path`` and by default the credentials used for running tools are the same | ||
| as for running Galaxy. Thus its possible that tools modify data in Galaxy's | ||
| ``file_path``. Examples for such changes are: | ||
|
bernt-matthias marked this conversation as resolved.
Outdated
|
||
|
|
||
| - Creation of additional files, e.g. indices, which is a problem for cleaning up data, because Galaxy does not know about these files. | ||
| - Removal of input or output files of the tools. This will create problems with other tools using these data sets (note that most tool repositories use CI tests to to avoid this, but the problem may still occur). | ||
|
bernt-matthias marked this conversation as resolved.
Outdated
|
||
|
|
||
| Note that the tool only knows the paths to inputs and outputs, but if using the default configuration for other paths (e.g. configuration directory) also these paths are easily accessible. | ||
|
bernt-matthias marked this conversation as resolved.
Outdated
|
||
|
|
||
| There are three approaches to protect Galaxy against this: | ||
|
bernt-matthias marked this conversation as resolved.
Outdated
|
||
|
|
||
| - Use different credentials for running tools. This can be configured using the ``real_system_username`` config variable. | ||
| - Configure Galaxy to run jobs in a container and enable ``outputs_to_working_directory``. Then the tool will execute in an environment that allows write access only for the job working dir. All other paths will be accessible read only. | ||
| - Use pulsar to stage inputs and outputs | ||
|
bernt-matthias marked this conversation as resolved.
Outdated
|
||
|
|
||
| More information on pulsar configuration can be found in the [job configuration](jobs.md) documentation, and the other two are explained in [using a compute cluster](cluster.md). | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.