systemprompt_users/lib.rs
1//! # systemprompt-users
2//!
3//! User management for the systemprompt.io AI governance platform. The crate
4//! provides:
5//!
6//! - **6-tier RBAC** — typed `UserRole` and policy-aware promotion/demotion
7//! helpers in [`UserAdminService`].
8//! - **Sessions** — lifecycle management for browser, API, and anonymous
9//! sessions including bulk-end and recent-activity queries.
10//! - **API keys** — issuance, hashing, and verification via [`ApiKeyService`].
11//! - **Device certificates** — enrollment and rotation via
12//! [`DeviceCertService`].
13//! - **IP bans** — typed [`BannedIpRepository`] with metadata-aware queries.
14//! - **Cleanup job** — purges anonymous users past the retention window.
15//!
16//! ## Feature flags
17//!
18//! | Feature | Default | Effect |
19//! |---------|---------|--------|
20//! | _none_ | n/a | The crate exposes a single feature surface; all modules are compiled unconditionally. The `[package.metadata.docs.rs] all-features = true` setting is retained so future feature additions automatically appear in published docs. |
21//!
22//! ## Layering
23//!
24//! `systemprompt-users` is a **domain** crate. It depends downward on
25//! `systemprompt-database`, `systemprompt-extension`, `systemprompt-models`,
26//! `systemprompt-traits`, `systemprompt-provider-contracts`, and
27//! `systemprompt-identifiers`.
28//!
29//! Copyright (c) systemprompt.io — Business Source License 1.1.
30//! See <https://systemprompt.io> for licensing details.
31
32#![expect(
33 missing_debug_implementations,
34 reason = "service types in this crate hold pools/clients that intentionally do not implement \
35 Debug"
36)]
37
38pub mod error;
39pub(crate) mod extension;
40pub mod jobs;
41pub(crate) mod models;
42pub(crate) mod repository;
43pub(crate) mod services;
44
45pub use extension::UsersExtension;
46
47pub use error::{Result, UserError, UserResult};
48pub use models::{
49 NewApiKey, User, UserActivity, UserApiKey, UserCountBreakdown, UserDeviceCert, UserExport,
50 UserRole, UserSession, UserStats, UserStatus, UserWithSessions,
51};
52pub use repository::{
53 BanDuration, BanIpParams, BanIpWithMetadataParams, BannedIp, BannedIpRepository,
54 CreateApiKeyParams, EnrollDeviceCertParams, MergeResult, UserRepository,
55};
56pub use services::{
57 API_KEY_PREFIX, ApiKeyService, DemoteResult, DeviceCertService, EnrollDeviceCertServiceParams,
58 IssueApiKeyParams, PromoteResult, UpdateUserParams, UserAdminService, UserService,
59};
60
61pub use systemprompt_traits::auth::{RoleProvider, UserProvider};