Mercurial > p > roundup > code
diff roundup/cgi/templating.py @ 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 | 389b62b1d65b |
| children | 0663a7bcef6c |
line wrap: on
line diff
--- a/roundup/cgi/templating.py Mon Aug 11 02:37:49 2025 -0400 +++ b/roundup/cgi/templating.py Mon Aug 11 14:01:12 2025 -0400 @@ -31,7 +31,7 @@ from roundup.anypy import urllib_ from roundup.anypy.cgi_ import cgi from roundup.anypy.html import html_escape -from roundup.anypy.strings import StringIO, is_us, s2u, u2s, us2s +from roundup.anypy.strings import StringIO, b2s, bs2b, is_us, s2u, u2s, us2s from roundup.cgi import TranslationService, ZTUtils from roundup.cgi.timestamp import pack_timestamp from roundup.exceptions import RoundupException @@ -3615,6 +3615,113 @@ """HTML-quote the supplied text.""" return html_escape(html) + def embed_form_fields(self, excluded_fields=None): + """Used to create a hidden input field for each client.form element + + :param: excluded_fields string or something with + __contains__ dunder method (tuple, list, set...). + + Limitations: It ignores file input fields. + """ + if excluded_fields is None: + excluded_fields = () + elif isinstance(excluded_fields, str): + excluded_fields = (excluded_fields,) + elif hasattr(excluded_fields, '__contains__'): + pass + else: + raise ValueError(self._( + 'The excluded_fields parameter is invalid.' + 'It must have a __contains__ method.') + ) + + rtn = [] + + for field in self.client.form.list: + if field.name in excluded_fields: + continue + + if field.filename is not None: + import base64 + # FIXME if possible + rtn.append( + '<pre hidden data-name="%s" data-filename="%s" data-mimetype="%s">%s</pre>' % + ( + html_escape(field.name, quote=True), + html_escape(field.filename, quote=True), + html_escape(field.type, quote=True), + b2s(base64.b64encode(bs2b(field.value))), + ) + ) + continue + + hidden_input = ( + """<input type="hidden" name="%s" value="%s">""" % + ( + html_escape(field.name, quote=True), + html_escape(field.value, quote=True) + ) + ) + + rtn.append(hidden_input) + + return "\n".join(rtn) + + + """ + Possible solution to file retention issue: + From: https://stackoverflow.com/questions/16365668/pre-populate-html-form-f + + const transfer = new DataTransfer(); + transfer.items.add(new File(['file 1 content'], 'file 1.txt')); + transfer.items.add(new File(['file 2 content'], 'file 2.txt')); + document.querySelector('input').files = transfer.files; + + document.querySelector('form').addEventListener('submit', e => { + e.preventDefault(); + console.log(...new FormData(e.target)); + }); + + <form> + <input name="files" type="file" multiple /> <br /> + <button>Submit</button> + </form> + + Name would be @file for Roundup. + + see also: https://developer.mozilla.org/en-US/docs/Web/API/File/File + + open question: how to make sure the file contents are safely encoded + in javascript and yet still are saved properly on the server when + the form is submitted. + + maybe base64? https://developer.mozilla.org/en-US/docs/Glossary/Base64 + size increase may be an issue. + <pre id="file1-contents" + style="display: none">base64datastartshere...</pre> + then atob(pre.text) as file content? + + const transfer = new DataTransfer(); + file_list = document.querySelectorAll('pre[data-mimetype]'); + file_list.forEach( file => + transfer.items.add( + new File([window.atob(file.textContent)], + file.dataset.filename, + {"type": file.dataset.mimetype}) + ) + ) + + form = document.querySelector("form") + file_input = document.createElement('input') + file_input.setAttribute("hidden", "") + file_input = form.appendChild(file_input) + file_input.setAttribute("type", "file") + file_input.setAttribute("name", "@file") + file_input.setAttribute("multiple", "") + file_input.files = transfer.files + + """ + def __getattr__(self, name): """Try the tracker's templating_utils.""" if not hasattr(self.client.instance, 'templating_utils'):
