Make str.format_map with untrusted input safer (#2931)

This commit is contained in:
Raphael Michel
2022-12-08 13:49:07 +01:00
committed by GitHub
parent 11eecd739d
commit b64c5735a8
12 changed files with 89 additions and 42 deletions

View File

@@ -0,0 +1,34 @@
import logging
from string import Formatter
logger = logging.getLogger(__name__)
class SafeFormatter(Formatter):
"""
Customized version of ``str.format`` that (a) behaves just like ``str.format_map`` and
(b) does not allow any unwanted shenanigans like attribute access or format specifiers.
"""
def __init__(self, context):
self.context = context
def get_field(self, field_name, args, kwargs):
if '.' in field_name or '[' in field_name:
logger.warning(f'Ignored invalid field name "{field_name}"')
return ('{' + str(field_name) + '}', field_name)
return super().get_field(field_name, args, kwargs)
def get_value(self, key, args, kwargs):
if key not in self.context:
return '{' + str(key) + '}'
return self.context[key]
def format_field(self, value, format_spec):
# Ignore format _spec
return super().format_field(value, '')
def format_map(template, context):
if not isinstance(template, str):
template = str(template)
return SafeFormatter(context).format(template)