Mercurial > p > roundup > code
view roundup/cgi/TAL/DummyEngine.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 | d26921b851c3 |
| children | fed0f839c260 |
line wrap: on
line source
############################################################################## # # Copyright (c) 2001, 2002 Zope Corporation and Contributors. # All Rights Reserved. # # This software is subject to the provisions of the Zope Public License, # Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution. # THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED # WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED # WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS # FOR A PARTICULAR PURPOSE. # ############################################################################## # Modifications for Roundup: # 1. commented out ITALES references # 2. implemented ustr as str """ Dummy TALES engine so that I can test out the TAL implementation. """ import re import sys from .TALDefs import NAME_RE, TALESError, ErrorInfo #from ITALES import ITALESCompiler, ITALESEngine #from DocumentTemplate.DT_Util import ustr ustr = str IDomain = None if 'Zope' in sys.modules: try: from Zope.I18n.ITranslationService import ITranslationService from Zope.I18n.IDomain import IDomain except ImportError: pass if IDomain is None: # Before 2.7, or not in Zope class ITranslationService: pass class IDomain: pass class _Default: pass Default = _Default() name_match = re.compile(r"(?s)(%s):(.*)\Z" % NAME_RE).match class CompilerError(BaseException): pass class DummyEngine: position = None source_file = None #__implements__ = ITALESCompiler, ITALESEngine def __init__(self, macros=None): if macros is None: macros = {} self.macros = macros dict = {'nothing': None, 'default': Default} self.locals = self.globals = dict self.stack = [dict] self.translationService = DummyTranslationService() def getCompilerError(self): return CompilerError def getCompiler(self): return self def setSourceFile(self, source_file): self.source_file = source_file def setPosition(self, position): self.position = position def compile(self, expr): return "$%s$" % expr def uncompile(self, expression): assert expression.startswith("$") and expression.endswith("$"),expression return expression[1:-1] def beginScope(self): self.stack.append(self.locals) def endScope(self): assert len(self.stack) > 1, "more endScope() than beginScope() calls" self.locals = self.stack.pop() def setLocal(self, name, value): if self.locals is self.stack[-1]: # Unmerge this scope's locals from previous scope of first set self.locals = self.locals.copy() self.locals[name] = value def setGlobal(self, name, value): self.globals[name] = value def evaluate(self, expression): assert expression.startswith("$") and expression.endswith("$"), expression expression = expression[1:-1] m = name_match(expression) if m: type, expr = m.group(1, 2) else: type = "path" expr = expression if type in ("string", "str"): return expr if type in ("path", "var", "global", "local"): return self.evaluatePathOrVar(expr) if type == "not": return not self.evaluate(expr) if type == "exists": return expr in self.locals or expr in self.globals if type == "python": try: return eval(expr, self.globals, self.locals) except: raise TALESError("evaluation error in %s" % repr(expr)) if type == "position": # Insert the current source file name, line number, # and column offset. if self.position: lineno, offset = self.position else: lineno, offset = None, None return '%s (%s,%s)' % (self.source_file, lineno, offset) raise TALESError("unrecognized expression: " + repr(expression)) def evaluatePathOrVar(self, expr): expr = expr.strip() if expr in self.locals: return self.locals[expr] elif expr in self.globals: return self.globals[expr] else: raise TALESError("unknown variable: %s" % repr(expr)) def evaluateValue(self, expr): return self.evaluate(expr) def evaluateBoolean(self, expr): return self.evaluate(expr) def evaluateText(self, expr): text = self.evaluate(expr) if text is not None and text is not Default: text = ustr(text) return text def evaluateStructure(self, expr): # XXX Should return None or a DOM tree return self.evaluate(expr) def evaluateSequence(self, expr): # XXX Should return a sequence return self.evaluate(expr) def evaluateMacro(self, macroName): assert macroName.startswith("$") and macroName.endswith("$"), macroName macroName = macroName[1:-1] file, localName = self.findMacroFile(macroName) if not file: # Local macro macro = self.macros[localName] else: # External macro import driver program, macros = driver.compilefile(file) macro = macros.get(localName) if not macro: raise TALESError("macro %s not found in file %s" % (localName, file)) return macro def findMacroDocument(self, macroName): file, localName = self.findMacroFile(macroName) if not file: return file, localName import driver doc = driver.parsefile(file) return doc, localName def findMacroFile(self, macroName): if not macroName: raise TALESError("empty macro name") i = macroName.rfind('/') if i < 0: # No slash -- must be a locally defined macro return None, macroName else: # Up to last slash is the filename fileName = macroName[:i] localName = macroName[i+1:] return fileName, localName def setRepeat(self, name, expr): seq = self.evaluateSequence(expr) return Iterator(name, seq, self) def createErrorInfo(self, err, position): return ErrorInfo(err, position) def getDefault(self): return Default def translate(self, domain, msgid, mapping, default=None): return self.translationService.translate(domain, msgid, mapping, default=default) class Iterator: # This is not an implementation of a Python iterator. The next() # method returns true or false to indicate whether another item is # available; if there is another item, the iterator instance calls # setLocal() on the evaluation engine passed to the constructor. def __init__(self, name, seq, engine): self.name = name self.seq = seq self.engine = engine self.nextIndex = 0 def next(self): i = self.nextIndex try: item = self.seq[i] except IndexError: return 0 self.nextIndex = i+1 self.engine.setLocal(self.name, item) return 1 class DummyDomain: __implements__ = IDomain def translate(self, msgid, mapping=None, context=None, target_language=None, default=None): # This is a fake translation service which simply uppercases non # ${name} placeholder text in the message id. # # First, transform a string with ${name} placeholders into a list of # substrings. Then upcase everything but the placeholders, then glue # things back together. # simulate an unknown msgid by returning None if msgid == "don't translate me": text = default else: text = msgid.upper() def repl(m, mapping=mapping): return ustr(mapping[m.group(m.lastindex).lower()]) cre = re.compile(r'\$(?:(%s)|\{(%s)\})' % (NAME_RE, NAME_RE)) return cre.sub(repl, text) class DummyTranslationService: __implements__ = ITranslationService def translate(self, domain, msgid, mapping=None, context=None, target_language=None, default=None): return self.getDomain(domain).translate(msgid, mapping, context, target_language, default=default) def getDomain(self, domain): return DummyDomain()
