edf2475413
* fix: harden API token handling against rate-limit tampering and plaintext logging - Make `allowed_rate_limit` read-only on APITokenSerializer so users can no longer raise their own API token rate limit via PATCH (GHSA-xfgr-2x3f-g2cf). - Stop persisting API keys in plaintext in APITokenLogMiddleware: store a SHA-256 hash as the token identifier and redact sensitive request headers (X-Api-Key, Authorization, Cookie) before logging (GHSA-r5p8-cj3q-38cc). * refactor: remove MongoDB log sink and add per-log-type retention Logs are now written to and cleared from PostgreSQL only; MongoDB is no longer used as a log sink or archive. - Drop the MongoDB write/archival paths from the API request logger, the webhook log writer, and the cleanup tasks; Postgres is the sole sink. - Cleanup tasks now hard-delete expired rows in batches via `all_objects` (rows are removed immediately, not soft-deleted). - Add env-backed, per-log-type retention settings: API activity logs (API_ACTIVITY_LOG_RETENTION_DAYS, default 14), webhook logs (WEBHOOK_LOG_RETENTION_DAYS, default 14), email logs (EMAIL_LOG_RETENTION_DAYS, default 7). HARD_DELETE_AFTER_DAYS no longer drives any log cleanup. - Delete settings/mongo.py, remove MONGO_DB_* settings and the plane.mongo loggers, and drop the pymongo dependency. * chore: gitignore local advisories.md notes file * fix: use keyed HMAC-SHA256 for API token log identifier Address CodeQL "weak hashing of sensitive data" by hashing the API key with a SECRET_KEY-keyed HMAC instead of a bare SHA-256. The identifier is a non-reversible tokenization of a high-entropy key (not password storage); keying it also prevents precomputing the digest from a known key value. * chore: address review feedback on log cleanup and request logging - process_logs accepts extra kwargs so jobs enqueued by an older release (with a mongo_log arg) don't fail during a rolling deploy. - Log-cleanup batch delete failures are logged and skipped rather than aborting the run, so a single bad batch can't block the rest. - Extend logger middleware test to assert Authorization and Cookie headers are redacted; add a test that a failing cleanup batch is swallowed. * fix: fall back to default when a log retention env value is invalid Negative (or unparseable) retention values would compute a future cutoff and delete every log row. The retention settings now fall back to their defaults in that case via a shared `_retention_days` helper.
34 lines
1.1 KiB
Python
34 lines
1.1 KiB
Python
# Copyright (c) 2023-present Plane Software, Inc. and contributors
|
|
# SPDX-License-Identifier: AGPL-3.0-only
|
|
# See the LICENSE file for details.
|
|
|
|
"""Unit tests for the log-retention env parsing helper."""
|
|
|
|
import pytest
|
|
|
|
from plane.settings.common import _retention_days
|
|
|
|
ENV_VAR = "TEST_RETENTION_DAYS"
|
|
|
|
|
|
@pytest.mark.unit
|
|
class TestRetentionDays:
|
|
def test_uses_default_when_unset(self, monkeypatch):
|
|
monkeypatch.delenv(ENV_VAR, raising=False)
|
|
assert _retention_days(ENV_VAR, 14) == 14
|
|
|
|
def test_uses_env_value_when_valid(self, monkeypatch):
|
|
monkeypatch.setenv(ENV_VAR, "30")
|
|
assert _retention_days(ENV_VAR, 14) == 30
|
|
|
|
def test_zero_is_allowed(self, monkeypatch):
|
|
monkeypatch.setenv(ENV_VAR, "0")
|
|
assert _retention_days(ENV_VAR, 14) == 0
|
|
|
|
def test_negative_falls_back_to_default(self, monkeypatch):
|
|
monkeypatch.setenv(ENV_VAR, "-5")
|
|
assert _retention_days(ENV_VAR, 14) == 14
|
|
|
|
def test_unparseable_falls_back_to_default(self, monkeypatch):
|
|
monkeypatch.setenv(ENV_VAR, "abc")
|
|
assert _retention_days(ENV_VAR, 7) == 7
|