Mercurial > p > roundup > code
annotate doc/format_config.awk @ 8411:ef1ea918b07a reauth-confirm_id
feat(security): Add user confirmation/reauth for sensitive changes
Auditors can raise Reauth(reason) exception to require the user to
enter a token (e.g. account password) to verify the user is performing
the change.
Naming is subject to change.
actions.py: New ReauthAction class handler and verifyPassword() method
for overriding if needed.
client.py: Handle Reauth exception by calling Client:reauth() method.
Default client:reauth method. Add 'reauth' action declaration.
exceptions.py: Define and document Reauth exception as a subclass of
RoundupCGIException.
templating.py: Define method utils.embed_form_fields().
The original form making a change to the database has a lot of form
fields. These need to be resubmitted to Roundup as part of the form
submission that verifies the user's password.
This method turns all non file form fields into type=hidden inputs.
It escapes the names and values to prevent XSS.
For file form fields, it base64 encodes the contents and puts them
in hidden pre blocks. The pre blocks have data attributes for the
filename, filetype and the original field name. (Note the original
field name is not used.)
This stops the file content data (maybe binary e.g. jpegs) from
breaking the html page. The reauth template runs JavaScript that
turns the encoded data inside the pre tags back into a file. Then
it adds a multiple file input control to the page and attaches all
the files to it. This file input is submitted with the rest of the
fields.
_generic.reauth.html (multiple tracker templates): Generates a form
with id=reauth_form to:
display any message from the Reauth exception to the user (e.g. why
user is asked to auth).
get the user's password
submit the form
embed all the form data that triggered the reauth
recreate any file data that was submitted as part of the form and
generate a new file input to push the data to the back end
It has the JavaScript routine (as an IIFE) that regenerates a file
input without user intervention.
All the TAL based tracker templates use the same form. There is also
one for the jinja2 template. The JavaScript for both is the same.
reference.txt: document embed_form_fields utility method.
upgrading.txt: initial upgrading docs.
TODO:
Finalize naming. I am leaning toward ConfirmID rather than Reauth.
Still looking for a standard name for this workflow.
Externalize the javascript in _generic.reauth.html to a seperate file
and use utils.readfile() to embed it or change the script to load it
from a @@file url.
Clean up upgrading.txt with just steps to implement and less feature
detail/internals.
Document internals/troubleshooting in reference.txt.
Add tests using live server.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Mon, 11 Aug 2025 14:01:12 -0400 |
| parents | 20943bf4f1b7 |
| children |
| rev | line source |
|---|---|
|
8036
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
1 #! /bin/awk |
|
8274
c3bf229d3d4b
doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents:
8036
diff
changeset
|
2 BEGIN {SECRET_KEY = "DWmbKgVUy6fF5D2Y5TD5Az+dnHhMYKCCpJzIY3H8nsU="} |
|
8036
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
3 |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
4 # delete first 8 lines |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
5 NR < 9 {next} |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
6 |
|
8274
c3bf229d3d4b
doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents:
8036
diff
changeset
|
7 # To prevent new file generation from causing the secret_key to |
|
c3bf229d3d4b
doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents:
8036
diff
changeset
|
8 # change, we replace the secret key with a fixed value. |
|
8368
20943bf4f1b7
build - fix issue with secret_key substitution in tracker config.
John Rouillard <rouilj@ieee.org>
parents:
8274
diff
changeset
|
9 /^# Default: [0-9A-z+=/]{44}/ {sub(/[0-9A-z+=/]{44}/, SECRET_KEY)} |
|
20943bf4f1b7
build - fix issue with secret_key substitution in tracker config.
John Rouillard <rouilj@ieee.org>
parents:
8274
diff
changeset
|
10 /^secret_key = [0-9A-z+=/]{44}/ {sub(/[0-9A-Za-z+=/]{44}/, SECRET_KEY)} |
|
8274
c3bf229d3d4b
doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents:
8036
diff
changeset
|
11 |
|
8036
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
12 # When we see a section [label]: |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
13 # emit section index marker, |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
14 # emit section anchor |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
15 # set up for code formating |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
16 # emit any comments/blank line that are accumulated before the |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
17 # section marker |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
18 # print the indented section marker |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
19 # |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
20 # zero the accumulator and the variable that prevents large blocks |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
21 # of empty lines. |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
22 /^\[([a-z]*)\]/ { match($0, /^\[([a-z]*)\].*/, section_match); |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
23 section = section_match[1]; |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
24 print("\n\n.. index:: config.ini; sections " section); |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
25 print(".. _`config-ini-section-" section "`:"); |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
26 print(".. code:: ini\n"); |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
27 if (accumulate) { |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
28 print(" " accumulate "\n"); |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
29 } |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
30 print(" " $0); |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
31 accumulate = ""; |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
32 prev_line_is_blank = 0; |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
33 } |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
34 |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
35 # if the line is a setting line (even if commented out) |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
36 # print the accumulated comments/blank lines and the setting line |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
37 # zero the accumulator and the variable that prevents blocks of blank lines |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
38 # get the next input line |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
39 /^#?[a-z0-9_-]* =/ { print accumulate "\n " $0; |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
40 accumulate = ""; |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
41 prev_line_is_blank = 0; |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
42 next; |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
43 } |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
44 |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
45 # accumulate comment lines and indent them |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
46 /^#/ { accumulate = accumulate "\n " $0; prev_line_is_blank = 0;} |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
47 |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
48 # accumulate a blank line only if the previous line was not blank. |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
49 /^$/ { if (! prev_line_is_blank) {accumulate = accumulate $0}; |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
50 prev_line_is_blank = 1; |
|
8b5f8b950f58
docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff
changeset
|
51 } |
|
8274
c3bf229d3d4b
doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents:
8036
diff
changeset
|
52 |
