codlet-core 0.14.1

Core authentication primitives for codlet: code policy, generation, normalization, keyed lookup derivation, lifecycle state machines, and storage traits.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

#![forbid(unsafe_code)]
#![doc = include_str!("../README.md")]

//! # codlet-core
//!
//! Runtime-neutral authentication primitives. This crate contains pure types,
//! policy objects, cryptographic lookup-key derivation, lifecycle state
//! machines, storage traits, and audit events. It deliberately contains no web
//! framework, database, or async-executor dependencies (RFC-002).
//!
//! ## Boundary
//!
//! codlet authenticates a subject. The host application authorizes that
//! subject (RFC-001). Nothing in this crate decides community membership,
//! roles, permissions, or resource access.
//!
//! ## Status
//!
//! This release completes the M3 primitive layer:
//!
//! - [`code`]    — code policy, generation, normalization, validation (RFC-003)
//! - [`hashing`] — HMAC lookup-key derivation, key providers, domain
//!                 separation, key versioning (RFC-004)
//! - [`rng`]     — fail-closed randomness abstraction (RFC-020)
//! - [`secret`]  — redacted secret newtypes and opaque IDs (RFC-019)
//! - [`clock`]   — `Clock` trait for testable time (RFC-020)
//! - [`state`]   — pure lifecycle classifiers: claim, session, form-token
//!                 consume (RFC-005/006/007)
//! - [`store`]   — `CodeStore`, `SessionStore`, `FormTokenStore`,
//!                 `RateLimitStore` traits (RFC-005/006/007/008)
//! - [`cookie`]  — secure cookie policy and builder (RFC-006)
//! - [`audit`]   — `CodeAuthEvent` vocabulary and `AuditSink` trait (RFC-012)
//! - [`metrics`] — `MetricsObserver` trait, counter names, `Outcome` (RFC-024)
//! - [`admin`]   — `CodeAdminStore` extension trait, `CodeMeta`, admin API
//!                 (RFC-030)
//! - [`auth`]    — high-level orchestration managers: `CodeAuth`,
//!                 `SessionManager`, `FormTokenManager`, `NoRateLimit`
//!                 (RFC-013)
//! - [`error`]   — two-layer error model: internal causes + public-safe
//!                 failures (RFC-012/021)
//! - `mem`       — in-memory stores (`test-utils` feature only, RFC-011/008)

/// The codlet wire/format version embedded in domain-separated HMAC inputs.
///
/// Bumping this is a breaking change to every stored lookup key and MUST be
/// accompanied by a key-version migration (RFC-004).
pub const FORMAT_VERSION: &str = "codlet/v1";

pub mod admin;
pub mod audit;
pub mod auth;
pub mod clock;
pub mod code;
pub mod cookie;
pub mod error;
pub mod hashing;
pub mod metrics;
pub mod rng;
pub mod secret;
pub mod state;
pub mod store;

/// In-memory store implementations for tests and local development.
///
/// **Not for production.** Gated behind the `test-utils` feature.
#[cfg(any(test, feature = "test-utils"))]
pub mod mem;

// Convenience re-exports for the most common types.
pub use audit::{AuditSink, CodeAuthEvent, NoopAuditSink};
pub use auth::{
    CodeAuth, FormTokenError, FormTokenManager, IssuedSession, NoRateLimit, RedeemError,
    RedeemSuccess, SessionError, SessionManager,
};
pub use clock::{Clock, SystemClock};
pub use code::{Alphabet, CodePolicy, generate_code, normalize, validate_code_input};
pub use cookie::{CookiePolicy, CookieProfile, SameSitePolicy};
pub use error::{
    CodeInputError, KeyError, PolicyError, PublicFormError, PublicRedemptionError,
    PublicSessionError, RandomError, RedemptionFailReason,
};
pub use hashing::{
    HmacKeyRef, KeyProvider, KeyVersion, LookupKey, SecretDomain, SecretHasher, StaticKeyProvider,
};
pub use metrics::{MetricsObserver, NoopMetrics, Outcome, counter};
pub use rng::{RandomSource, SystemRandom};
pub use secret::{
    CodeId, FormTokenSecret, NormalizedCode, PlainCode, Purpose, ScopeKey, SecretString, SessionId,
    SessionSecret, SubjectId,
};
pub use state::{
    ClaimOutcome, SessionValidationOutcome, TokenConsumeOutcome, classify_claim, classify_session,
    classify_token_consume,
};
pub use store::{
    error::{PublicAuthError, StoreError},
    ratelimit::{
        RateLimitKey, RateLimitOutcome, RateLimitPolicy, RateLimitStore, RateLimitUnavailable,
    },
    token::TokenSubject,
};

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn format_version_is_stable() {
        // Guard against an accidental format bump. Changing this string is a
        // breaking change requiring a key-version migration (RFC-004).
        assert_eq!(FORMAT_VERSION, "codlet/v1");
    }
}