Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 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
1 change: 1 addition & 0 deletions doc/source/admin/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ This documentation is in the midst of being ported and unified based on resource
config
config_logging
production
security
nginx
apache
scaling
Expand Down
21 changes: 21 additions & 0 deletions doc/source/admin/security.md
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
Comment thread
bernt-matthias marked this conversation as resolved.
Outdated
``file_path``. Examples for such changes are:
Comment thread
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).
Comment thread
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.
Comment thread
bernt-matthias marked this conversation as resolved.
Outdated

There are three approaches to protect Galaxy against this:
Comment thread
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
Comment thread
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).