docs(mcp): describe the legacy KDF grace window as default-on

litereview flagged that the session/bridge docstrings still called the
grace window opt-in after the default flipped on; align them with the
LITELLM_MCP_LEGACY_KDF_GRACE=false opt-out semantics.
This commit is contained in:
yucheng-berri 2026-10-14 02:11:08 -07:00
parent 3d589dc35b
commit 2d8b2dcb25
2 changed files with 4 additions and 4 deletions

View file

@ -67,7 +67,7 @@ def envelope_keys_from_master_key(master_key: str) -> EnvelopeKeys:
@lru_cache(maxsize=8)
def _legacy_envelope_keys(master_key: str) -> EnvelopeKeys | None:
"""The pre-rotation scrypt subkeys, kept so envelopes minted before the KDF rotation
can still be opened during the opt-in grace window. ``None`` when scrypt is unavailable."""
can still be opened during the default-on grace window. ``None`` when scrypt is unavailable."""
signing: Final = legacy_scrypt(master_key, _SIGNING_KEY_DOMAIN)
encryption: Final = legacy_scrypt(master_key, _ENCRYPTION_KEY_DOMAIN)
if signing is None or encryption is None:
@ -78,7 +78,7 @@ def _legacy_envelope_keys(master_key: str) -> EnvelopeKeys | None:
def legacy_envelope_keys_from_master_key(
master_key: str, environ: Callable[[str], str | None] = os.environ.get
) -> EnvelopeKeys | None:
"""The legacy envelope keys when the operator enabled the KDF grace window, else ``None``."""
"""The legacy envelope keys unless the operator explicitly disabled the KDF grace window."""
if not legacy_kdf_grace_enabled(environ):
return None
return _legacy_envelope_keys(master_key)

View file

@ -65,7 +65,7 @@ def session_keys_from_master_key(master_key: str) -> SessionKeys:
@lru_cache(maxsize=8)
def _legacy_session_keys(master_key: str) -> SessionKeys | None:
"""The pre-rotation scrypt signing key, kept so session tokens minted before the KDF
rotation can still be opened during the opt-in grace window. ``None`` when scrypt is
rotation can still be opened during the default-on grace window. ``None`` when scrypt is
unavailable."""
signing: Final = legacy_scrypt(master_key, _SESSION_SIGNING_KEY_DOMAIN)
if signing is None:
@ -78,7 +78,7 @@ def legacy_session_keys_from_master_key(
active: SessionSigningKeys,
environ: Callable[[str], str | None] = os.environ.get,
) -> SessionKeys | None:
"""The legacy session key when the operator enabled the KDF grace window, else ``None``.
"""The legacy session key unless the operator explicitly disabled the KDF grace window.
The fallback only applies to the default master-key HS256 path: a configured
``mcp_session_token_signing`` RS256 key was never scrypt-derived, so an