Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Log bad put request content #1500

Merged
merged 7 commits into from
May 29, 2024
Merged

Log bad put request content #1500

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4678612
add option to log bad PUT request content
pbiering May 29, 2024
2c0da6f
extend copyright
pbiering May 29, 2024
496b9f1
extend copyright
pbiering May 29, 2024
fb7630f
fix/adjustment reported by test
pbiering May 29, 2024
86a69b4
Update test.yml, downgrade setup-python
pbiering May 29, 2024
b1ae3ed
Update test.yml, back to v5, more local tests are required
pbiering May 29, 2024
c6d01b7
downgrade requirement to typeguard<4.3 for tests to avoid broken test…
pbiering May 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions config
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,9 @@
# Don't include passwords in logs
#mask_passwords = True

# Log bad PUT request content
#bad_put_request_content = False


[headers]

Expand Down
2 changes: 2 additions & 0 deletions radicale/app/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
# Copyright © 2008 Pascal Halter
# Copyright © 2008-2017 Guillaume Ayoub
# Copyright © 2017-2019 Unrud <unrud@outlook.com>
# Copyright © 2024-2024 Peter Bieringer <pb@bieringer.de>
#
# This library is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down Expand Up @@ -80,6 +81,7 @@ def __init__(self, configuration: config.Configuration) -> None:
"""
super().__init__(configuration)
self._mask_passwords = configuration.get("logging", "mask_passwords")
self._bad_put_request_content = configuration.get("logging", "bad_put_request_content")
self._auth_delay = configuration.get("auth", "delay")
self._internal_server = configuration.get("server", "_internal_server")
self._max_content_length = configuration.get(
Expand Down
2 changes: 2 additions & 0 deletions radicale/app/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# This file is part of Radicale - CalDAV and CardDAV server
# Copyright © 2020 Unrud <unrud@outlook.com>
# Copyright © 2024-2024 Peter Bieringer <pb@bieringer.de>
#
# This library is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down Expand Up @@ -48,6 +49,7 @@ def __init__(self, configuration: config.Configuration) -> None:
self._rights = rights.load(configuration)
self._web = web.load(configuration)
self._encoding = configuration.get("encoding", "request")
self._log_bad_put_request_content = configuration.get("logging", "bad_put_request_content")
self._hook = hook.load(configuration)

def _read_xml_request_body(self, environ: types.WSGIEnviron
Expand Down
3 changes: 3 additions & 0 deletions radicale/app/put.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
# Copyright © 2008 Pascal Halter
# Copyright © 2008-2017 Guillaume Ayoub
# Copyright © 2017-2018 Unrud <unrud@outlook.com>
# Copyright © 2024-2024 Peter Bieringer <pb@bieringer.de>
#
# This library is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down Expand Up @@ -146,6 +147,8 @@ def do_PUT(self, environ: types.WSGIEnviron, base_prefix: str,
except Exception as e:
logger.warning(
"Bad PUT request on %r (read_components): %s", path, e, exc_info=True)
if self._log_bad_put_request_content:
logger.warning("Bad PUT request content of %r:\n%s", path, content)
return httputils.BAD_REQUEST
(prepared_items, prepared_tag, prepared_write_whole_collection,
prepared_props, prepared_exc_info) = prepare(
Expand Down
5 changes: 5 additions & 0 deletions radicale/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
# Copyright © 2008 Nicolas Kandel
# Copyright © 2008 Pascal Halter
# Copyright © 2017-2019 Unrud <unrud@outlook.com>
# Copyright © 2024-2024 Peter Bieringer <pb@bieringer.de>
#
# This library is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down Expand Up @@ -247,6 +248,10 @@ def _convert_to_bool(value: Any) -> bool:
"value": "info",
"help": "threshold for the logger",
"type": logging_level}),
("bad_put_request_content", {
"value": "False",
"help": "log bad PUT request content",
"type": bool}),
("mask_passwords", {
"value": "True",
"help": "mask passwords in logs",
Expand Down
2 changes: 1 addition & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
"pika>=1.1.0",
"setuptools; python_version<'3.9'"]
bcrypt_requires = ["bcrypt"]
test_requires = ["pytest>=7", "typeguard>=4", "waitress", *bcrypt_requires]
test_requires = ["pytest>=7", "typeguard<4.3", "waitress", *bcrypt_requires]

setup(
name="Radicale",
Expand Down
Loading