Skip to content

Commit 415182b

Browse files
committed
Improve documention on access to templates and static_files.
1 parent 9a41c8d commit 415182b

File tree

3 files changed

+22
-6
lines changed

3 files changed

+22
-6
lines changed

CHANGES.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,9 @@ Fixed:
5252
- issue2551195 - port scripts from optparse to argparse (Ralf Schlatterbeck)
5353
- issue2551246 - mitigation, document how -u doesn't work for
5454
roundup-admin. (John Rouillard)
55+
- Document better that files in the template or static_files
56+
directories accessed via @@file are available to any user with the
57+
url.
5558

5659
Features:
5760

doc/customizing.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2309,6 +2309,16 @@ Serving static content
23092309
See the previous section `determining web context`_ where it describes
23102310
``@@file`` paths.
23112311

2312+
These files are served without any permission checks. Any user on the
2313+
internet with the url can download the file.
2314+
2315+
This is rarely an issue since the html templates are just source code
2316+
and much of it can be found in the Roundup repository. Other
2317+
decoration (logos, stylesheets) are similarly not security sensitive.
2318+
You can use the static_files setting in config.ini to eliminate
2319+
access to the templates directory if desired.
2320+
2321+
If a file resolves to a symbolic link, it is not served.
23122322

23132323
Performing actions in web requests
23142324
----------------------------------

roundup/configuration.py

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -991,13 +991,16 @@ def str2value(self, value):
991991
"Path to the HTML templates directory."),
992992
(MultiFilePathOption, "static_files", "",
993993
"A list of space separated directory paths (or a single\n"
994-
"directory). These directories hold additional static\n"
995-
"files available via Web UI. These directories may\n"
996-
"contain sitewide images, CSS stylesheets etc. If a '-'\n"
997-
"is included, the list processing ends and the TEMPLATES\n"
998-
"directory is not searched after the specified\n"
994+
"directory). These directories hold additional public\n"
995+
"static files available via Web UI. These directories\n"
996+
"may contain sitewide images, CSS stylesheets etc. If a\n"
997+
"'-' is included, the list processing ends and the\n"
998+
"TEMPLATES directory is not searched after the specified\n"
999999
"directories. If this option is not set, all static\n"
1000-
"files are taken from the TEMPLATES directory."),
1000+
"files are taken from the TEMPLATES directory. Access to\n"
1001+
"these files is public, it is not checked against\n"
1002+
"registered users. So do not put any sensitive data in\n"
1003+
"the files in these directories."),
10011004
(MailAddressOption, "admin_email", "roundup-admin",
10021005
"Email address that roundup will complain to if it runs\n"
10031006
"into trouble.\n"

0 commit comments

Comments
 (0)