Mercurial > p > roundup > code
view roundup/cgi/TranslationService.py @ 8575:b1024bf0d9f7
feature: add nonceless/tokenless CSRF protection
Add tokenless CSRF protection following:
https://words.filippo.io/csrf/
Must be enabled using use_tokenless_csrf_protection in config.ini. By
default it's off. If enabled the older csrf_* settings are ignored.
The allowed_api_origins setting is still used for Origin comparisons.
This should also improve performance as a nonce isn't required so
generating random nonce and saving it to the otks database is
eliminated.
doc/admin_guide.txt, doc/reference.txt doc/upgrading.txt
doc updates.
roundup/configuration.py
add use_tokenless_csrf_protection setting.
move allowed_api_origins directly after
use_tokenless_csrf_protection and before the older csrf_* settings.
It's used by both of them.
Rewrite description of allowed_api_origins as its applied to all
URLs with tokenless protection, not just API URLs.
roundup/anypy/urllib_.py
import urlsplit, it is used in new code.
urlparse() is less efficient and splits params out of the path
component.
Since Roundup doesn't require that params be split from the path. I
expect future patch will replace urlparse() with urlsplit() globally
and not need urlparse().
roundup/cgi/client.py
add handle_csrf_tokenless() and call from handle_csrf() if
use_tokenless_csrf_protection is enabled.
refactor code that expires csrf tokens when used with the wrong
methods (i.e. GET) into expire_exposed_keys(). Call same from
handle_csrf and handle_csrf_tokenless. Also improve logging if this
happens including both Referer and Origin headers if available.
Arguably we dont care about CSRF tokens exposed via
GET/HEAD/OPTIONS in the tokenless case, but this cleans them up in
case the admin has to switch back. At some future date we can
delete all the nonce based CSRF from 2018.
Update handle_csrf() docstring about calling/returning
handle_csrf_tokenless() when enabled. Call
expire_exposed_keys(method) if token is supplied with wrong method.
roundup/cgi/templating.py
disable nonce generation/save and always return "0" when
use_tokenless_csrf_protection enabled.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sun, 19 Apr 2026 20:50:07 -0400 |
| parents | 07ce4e4110f5 |
| children |
line wrap: on
line source
# TranslationService for Roundup templates # # This module is free software, you may redistribute it # and/or modify under the same terms as Python. # # This module provides National Language Support # for Roundup templating - much like roundup.i18n # module for Roundup command line interface. # The only difference is that translator objects # returned by get_translation() have one additional # method which is used by TAL engines: # # translate(domain, msgid, mapping, context, target_language, default) # from roundup import i18n from roundup.cgi.PageTemplates import Expressions, PathIterator, TALES from roundup.cgi.TAL import TALInterpreter from roundup.anypy.strings import us2u, u2s ### Translation classes class TranslationServiceMixin: def translate(self, domain, msgid, mapping=None, context=None, target_language=None, default=None): _msg = self.gettext(msgid) # print ("TRANSLATE", msgid, _msg, mapping, context) _msg = TALInterpreter.interpolate(_msg, mapping) return _msg if hasattr(i18n.RoundupTranslations, 'ugettext'): def gettext(self, msgid): msgid = us2u(msgid) msgtrans = self.ugettext(msgid) return u2s(msgtrans) def ngettext(self, singular, plural, number): singular = us2u(singular) plural = us2u(plural) msgtrans = self.ungettext(singular, plural, number) return u2s(msgtrans) class TranslationService(TranslationServiceMixin, i18n.RoundupTranslations): pass class NullTranslationService(TranslationServiceMixin, i18n.RoundupNullTranslations): if hasattr(i18n.RoundupNullTranslations, 'ugettext'): def ugettext(self, message): if self._fallback: return self._fallback.ugettext(message) # Sometimes the untranslatable message is a UTF-8 encoded string # (thanks to PageTemplate's internals). message = us2u(message) return message ### TAL patching # # Template Attribute Language (TAL) uses only global translation service, # which is not thread-safe. We will use context variable 'i18n' # to access request-dependent transalation service (with domain # and target language set during initializations of the roundup # client interface. # class Context(TALES.Context): def __init__(self, compiler, contexts): TALES.Context.__init__(self, compiler, contexts) if not self.contexts.get('i18n', None): # if the context contains no TranslationService, # create default one self.contexts['i18n'] = get_translation() self.i18n = self.contexts['i18n'] def translate(self, domain, msgid, mapping=None, context=None, target_language=None, default=None): if context is None: context = self.contexts.get('here') return self.i18n.translate(domain, msgid, mapping=mapping, context=context, default=default, target_language=target_language) class Engine(TALES.Engine): def getContext(self, contexts=None, **kwcontexts): if contexts is not None: if kwcontexts: kwcontexts.update(contexts) else: kwcontexts = contexts return Context(self, kwcontexts) # patching TAL like this is a dirty hack, # but i see no other way to specify different Context class Expressions._engine = Engine(PathIterator.Iterator) Expressions.installHandlers(Expressions._engine) ### main API function def get_translation(language=None, tracker_home=None, translation_class=TranslationService, null_translation_class=NullTranslationService): """Return Translation object for given language and domain Arguments 'translation_class' and 'null_translation_class' specify the classes that are instantiated for existing and non-existing translations, respectively. """ return i18n.get_translation(language=language, tracker_home=tracker_home, translation_class=translation_class, null_translation_class=null_translation_class) # vim: set et sts=4 sw=4 :
