Invalid format 'format' for '%' style

[obilodeau]

Stacktrace trying to use PyRDP mitm on arch linux:

Traceback (most recent call last):
  File "./bin/pyrdp-mitm.py", line 302, in <module>
    main()
  File "./bin/pyrdp-mitm.py", line 176, in main
    prepareLoggers(logLevel, args.log_filter, args.sensor_id, outDir)
  File "./bin/pyrdp-mitm.py", line 83, in prepareLoggers
    log.prepareSSLLogger(logDir / "ssl.log")
  File "/home/olivier/Documents/gosecure/src/pyrdp/pyrdp/logging/log.py", line 37, in prepareSSLLogger
    formatter = SSLSecretFormatter()
  File "/home/olivier/Documents/gosecure/src/pyrdp/pyrdp/logging/formatters.py", line 75, in __init__
    super().__init__("format")
  File "/usr/lib/python3.8/logging/__init__.py", line 576, in __init__
    self._style.validate()
  File "/usr/lib/python3.8/logging/__init__.py", line 429, in validate
    raise ValueError("Invalid format '%s' for '%s' style" % (self._fmt, self.default_format[0]))
ValueError: Invalid format 'format' for '%' style

I recently upgraded to Python 3.8 and the Formatter class changed: https://docs.python.org/3/library/logging.html#logging.Formatter. I think this is what caused it.

[Res260]

That would make sense. When thinking about the logging infrastructure, we made the decision to tweak our logging beyond the "intended" use of %()s-style formatting.

We use arbitrary names which are passed to the logging operation by a dictionnary in the second argument (ex myLogger.info('my log statement with a non-standard %(variable)s', {'variable': 'variable name'}) )

hmu if you need details

[Res260]

If I understand correctly, setting validate=False in the Formatter's constructor would fix the problem.

[obilodeau]

It's simpler than that. I'm pushing the patch in a few seconds.

[Res260]

You can wait a bit to have 1337 commits for a little bit longer :D

[obilodeau]

Haha too late 😭