reverse-proxy/tasks/fix/token-bucket-field-visibility.md at 9a3b8831c77073a9882fcb82c115eb5fcdd724a8

Files

glm-5.1 54f1725173 Decompose security review #003 findings into 17 fix tasks and 1 review task

Address 4 critical, 8 warning, and 5 suggestion findings from the
security and bug review by creating atomic, dependency-ordered tasks:

Critical fixes (C1-C4): rate limiter IP source (ADR-025), InFlightCounter
increment + drain interval, connector timeout ceiling (ADR-026), JSON format
without log file.

Validation tightening (W1, W2): upstream host validation, ACME contact email
validation.

Robustness (W3, W4, W5, W12): upstream URI error handling (502 not silent
drop), admin socket resource limits (ADR-027), TlsMode wildcard mismatch,
http_port u32→u16.

Code quality (W6, W10, W11, S1, S3, W8/W9): config type consolidation,
TokenBucket field visibility, reload_mutex #[cfg(test)], dead code removal,
root cert count logging, misleading test names.

Test coverage (S10): rate limiter ConnectInfo tests (depends on C1 fix).

Review: post-security-fix-review checkpoint covering all critical fixes
and sensitive config consolidation path.

2026-06-12 13:42:37 +00:00

1.6 KiB

Raw Blame History

id, name, status, depends_on, scope, risk, impact, level, review_findings

name

status

depends_on

scope

risk

impact

level

review_findings

fix/token-bucket-field-visibility

Make TokenBucket fields private except last_access (W10, S6)

pending

single

trivial

isolated

implementation

W10

Description

All TokenBucket fields are pub but only last_access is read externally (by evict_stale in rate_limit/mod.rs). The other fields (tokens, last_refill, rate, max) should be private to prevent accidental direct mutation that bypasses try_consume/refill logic.

Changes Required

src/rate_limit/bucket.rs:

Make tokens, last_refill, rate, max private (remove pub)
Keep last_access as pub(crate) for evict_stale access
TokenBucket::new() already exists as a constructor, so no changes needed there
Update any unit tests that directly access private fields. The tests in bucket.rs are in the same module so they have access to private fields. Tests in mod.rs may need adjustment if they access bucket.tokens etc.

Acceptance Criteria

tokens, last_refill, rate, max fields are private
last_access is pub(crate)
new() constructor is the only way to create a TokenBucket externally
evict_stale still compiles and works (uses last_access)
All unit tests pass (in-module tests can still access private fields)
cargo clippy passes with no warnings

References

docs/reviews/003-security-and-bug-review.md — W10, S6 findings
src/rate_limit/bucket.rs — TokenBucket struct
src/rate_limit/mod.rs — evict_stale

Notes

To be filled on completion

Summary