Skip to content

Commit 28a8287

Browse files
Move security details into the docs
Signed-off-by: Jean-Christophe Morin <[email protected]>
1 parent 99839c9 commit 28a8287

File tree

2 files changed

+34
-20
lines changed

2 files changed

+34
-20
lines changed

SECURITY.md

+1-20
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,6 @@
11
# Security Policy
22

3-
## Threat Model
4-
5-
List assumptions (rez will run inside an internal network, we assume good intentions, package definitions are written in python and executed)
6-
7-
Access to shared filesystem
8-
9-
The current assumptions are:
10-
* Rez was designed to be used within a studio environment.
11-
* Package definitions, both for building packages and resulting from a build are Python files (`package.py`). Rez will read and load them in memory at resolve time.
12-
* Rez config files can be written in YAML or Python.
13-
* Package definitions and config files written in Python can contain arbitrary code.
14-
* Rez will create new shells via subprocesses.
15-
* Packages can inject environment variables into the resulting shells via [commands](https://rez.readthedocs.io/en/stable/package_commands.html).
16-
* Packages can inject arbitrary commands to be executed when the shells are started via [commands](https://rez.readthedocs.io/en/stable/package_commands.html).
17-
18-
With that in mind, the main entry points are config files (written in python) and pacakge definition files.
19-
Config files will be loaded from default paths and it's also posssible to tell rez
20-
to load them from any arbitraty path using the [REZ_CONFIG_FILE](https://rez.readthedocs.io/en/stable/environment.html#envvar-REZ_CONFIG_FILE) which can contain more than one path.
21-
22-
Document that it can talk to memcached and RabbitMQ (AMQP).
3+
All security information can be found in https://rez.readthedocs.io/en/stable/security.html.
234

245
## Supported Versions
256

docs/source/security.rst

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
========
2+
Security
3+
========
4+
5+
.. important::
6+
This page is a work in progress.
7+
8+
TODO: List assumptions (rez will run inside an internal network, we assume good intentions, package definitions are written in python and executed). Access to shared filesystem.
9+
10+
Security Considerations
11+
=======================
12+
13+
The current assumptions are:
14+
* It designed to be used within a studio environment.
15+
* Package definitions, both for building packages and resulting from a build are Python
16+
files (`package.py`). Rez will read and load them in memory at resolve time.
17+
* Config files can be written in YAML or Python.
18+
* Package definitions and config files written in Python can contain arbitrary code.
19+
* It will create new shells via subprocesses.
20+
* Packages can inject environment variables into the resulting shells via
21+
[commands](https://rez.readthedocs.io/en/stable/package_commands.html).
22+
* Packages can inject arbitrary commands to be executed when the shells are started
23+
via [commands](https://rez.readthedocs.io/en/stable/package_commands.html).
24+
25+
With that in mind, the main entry points are config files (written in python) and package definition files.
26+
Config files will be loaded from default paths and it's also posssible to tell rez
27+
to load them from any arbitrary path using the [REZ_CONFIG_FILE](https://rez.readthedocs.io/en/stable/environment.html#envvar-REZ_CONFIG_FILE)
28+
environment variable which can contain more than one path.
29+
30+
Document that it can talk to memcached and RabbitMQ (AMQP).
31+
32+
* File permissions
33+
* How to mitigate risks

0 commit comments

Comments
 (0)