kanidmd_lib/constants/
mod.rs

1// Re-export as needed
2
3pub mod entries;
4pub mod uuids;
5pub mod values;
6
7pub use self::entries::*;
8pub use self::uuids::*;
9pub use self::values::*;
10
11use std::time::Duration;
12
13// This value no longer requires incrementing during releases. It only
14// serves as a "once off" marker so that we know when the initial db
15// index is performed on first-run.
16//
17// It's also useful if we need to force a reindex due to a bug though :)
18pub const SYSTEM_INDEX_VERSION: i64 = 32;
19
20/*
21 * domain functional levels
22 *
23 * The idea here is to allow topology wide upgrades to be performed. We have to
24 * assume that across multiple kanidm instances there may be cases where we have version
25 * N and version N minus 1 as upgrades are rolled out.
26 *
27 * Imagine we set up a new cluster. Machine A and B both have level 1 support.
28 * We upgrade machine A. It has support up to level 2, but machine B does not.
29 * So the overall functional level is level 1. Then we upgrade B, which supports
30 * up to level 2. We still don't do the upgrade! The topology is still level 1
31 * unless an admin at this point *intervenes* and forces the update. OR what
32 * happens we we update machine A again and it now supports up to level 3, with
33 * a target level of 2. So we update machine A now to level 2, and that can
34 * still replicate to machine B since it also supports level 2.
35 *
36 * effectively it means that "some features" may be a "release behind" for users
37 * who don't muck with the levels, but it means that we can do mixed version
38 * upgrades.
39 */
40pub type DomainVersion = u32;
41
42/// Domain level 0 - this indicates that this instance
43/// is a new install and has never had a domain level
44/// previously.
45pub const DOMAIN_LEVEL_0: DomainVersion = 0;
46
47/// The domain's patch level - this is used for emergency migrations
48/// within a release cycle, and should not be changed otherwise.
49pub const PATCH_LEVEL_2: u32 = 2;
50
51/// Domain Level introduced with 1.6.0.
52/// Deprecated as of 1.8.0
53pub const DOMAIN_LEVEL_10: DomainVersion = 10;
54
55/// Domain Level introduced with 1.7.0.
56/// Deprecated as of 1.9.0
57pub const DOMAIN_LEVEL_11: DomainVersion = 11;
58
59/// Domain Level introduced with 1.8.0.
60/// Deprecated as of 1.10.0
61pub const DOMAIN_LEVEL_12: DomainVersion = 12;
62
63/// Domain Level introduced with 1.9.0.
64/// Deprecated as of 1.11.0
65pub const DOMAIN_LEVEL_13: DomainVersion = 13;
66
67/// Domain Level introduced with 1.10.0.
68/// Deprecated as of 1.12.0
69pub const DOMAIN_LEVEL_14: DomainVersion = 14;
70
71/// Domain Level introduced with 1.11.0.
72/// Deprecated as of 1.13.0
73pub const DOMAIN_LEVEL_1_11: DomainVersion = 15;
74
75/// Domain Level introduced with 1.12.0.
76/// Deprecated as of 1.14.0
77pub const DOMAIN_LEVEL_1_12: DomainVersion = 16;
78
79/// Domain Level introduced with 1.12.0.
80/// Deprecated as of 1.14.0
81pub const DOMAIN_LEVEL_1_13: DomainVersion = 17;
82
83// The target supported domain functional level. During development this is
84// the NEXT level that users will upgrade too. In other words if we are
85// developing 1.6.0-dev, then we need to set TGT_LEVEL to 10 which is
86// the corresponding level.
87pub const DOMAIN_TGT_LEVEL: DomainVersion = DOMAIN_LEVEL_1_12;
88// The current patch level if any out of band fixes are required.
89pub const DOMAIN_TGT_PATCH_LEVEL: u32 = PATCH_LEVEL_2;
90
91// The maximum supported domain functional level. This generally
92// represents a *future* version of the server which doesn't exist
93// yet.
94pub const DOMAIN_MAX_LEVEL: DomainVersion = DOMAIN_LEVEL_1_13;
95
96// This is the LOWEST level of database we can recreate. This is important for testing,
97// but we don't actually expect it to be used.
98pub const DOMAIN_MIN_CREATION_LEVEL: DomainVersion = DOMAIN_LEVEL_11;
99
100// The previous releases domain functional level
101pub const DOMAIN_PREVIOUS_TGT_LEVEL: DomainVersion = DOMAIN_TGT_LEVEL - 1;
102// The target domain functional level for the SUBSEQUENT release/dev cycle.
103pub const DOMAIN_TGT_NEXT_LEVEL: DomainVersion = DOMAIN_TGT_LEVEL + 1;
104
105// What domain level is the "one before" we could do a valid upgrade. We need to be able
106// to create this database, then attempt (and fail) to upgrade from it during tests. So
107// that technically means we have to keep one-extra migration level.
108pub const DOMAIN_MIGRATION_FROM_INVALID: DomainVersion = DOMAIN_MIN_CREATION_LEVEL;
109
110// What is the MINIMUM domain level we *could* allow migration from? This has to be
111// one greater than our minimum so we can test this, and in releases it's one version prior.
112#[cfg(test)]
113pub const DOMAIN_MIGRATION_FROM_MIN: DomainVersion = DOMAIN_MIN_CREATION_LEVEL + 1;
114#[cfg(not(test))]
115pub const DOMAIN_MIGRATION_FROM_MIN: DomainVersion = DOMAIN_PREVIOUS_TGT_LEVEL;
116
117// The minimum level that we can re-migrate from. Remember, this
118// means we should be able to move from min level to the next level. It doesn't mean
119// we have to be able to *create* this level. Generally this means it's "off by one"
120// to migration-from-min.
121#[cfg(test)]
122pub const DOMAIN_MIN_REMIGRATION_LEVEL: DomainVersion = DOMAIN_MIN_CREATION_LEVEL;
123#[cfg(not(test))]
124pub const DOMAIN_MIN_REMIGRATION_LEVEL: DomainVersion = DOMAIN_PREVIOUS_TGT_LEVEL - 1;
125
126// The minimum supported domain functional level (for replication)
127pub const DOMAIN_MINIMUM_REPLICATION_LEVEL: DomainVersion = DOMAIN_TGT_LEVEL;
128// The minimum supported domain functional level (for replication)
129pub const DOMAIN_MAXIMUM_REPLICATION_LEVEL: DomainVersion = DOMAIN_TGT_LEVEL;
130
131// On test builds define to 60 seconds
132#[cfg(test)]
133pub const PURGE_FREQUENCY: u64 = 60;
134// For production 10 minutes.
135#[cfg(not(test))]
136pub const PURGE_FREQUENCY: u64 = 600;
137
138/// The duration for which messages will be retained after their send_after time. Defaults to
139/// 7 days
140pub const DEFAULT_MESSAGE_RETENTION: Duration = Duration::from_secs(86400 * 7);
141
142/// The number of delayed actions to consider per write transaction. Higher
143/// values allow more coalescing to occur, but may consume more ram and cause
144/// some latency while dequeuing and writing those operations.
145pub const DELAYED_ACTION_BATCH_SIZE: usize = 256;
146
147/// The amount of time to wait to acquire a database ticket before timing out.
148/// Higher values allow greater operation queuing but can cause feedback
149/// loops where operations will stall for long periods.
150pub const DB_LOCK_ACQUIRE_TIMEOUT_MILLIS: u64 = 5000;
151
152#[cfg(test)]
153/// In test, we limit the changelog to 10 minutes.
154pub const CHANGELOG_MAX_AGE: u64 = 600;
155#[cfg(not(test))]
156/// A replica may be up to 7 days out of sync before being denied updates.
157pub const CHANGELOG_MAX_AGE: u64 = 7 * 86400;
158
159#[cfg(test)]
160/// In test, we limit the recyclebin to 5 minutes.
161pub const RECYCLEBIN_MAX_AGE: u64 = 300;
162#[cfg(not(test))]
163/// In production we allow 1 week
164pub const RECYCLEBIN_MAX_AGE: u64 = 7 * 86400;
165
166// 5 minute auth session window.
167pub const AUTH_SESSION_TIMEOUT: u64 = 300;
168// 5 minute mfa reg window
169pub const MFAREG_SESSION_TIMEOUT: u64 = 300;
170
171// Maximum - Sessions have no upper bound.
172pub const MAXIMUM_AUTH_SESSION_EXPIRY: u32 = u32::MAX;
173// Default - sessions last for 1 day
174pub const DEFAULT_AUTH_SESSION_EXPIRY: u32 = 86400;
175// Maximum - privileges last for 1 hour.
176pub const MAXIMUM_AUTH_PRIVILEGE_EXPIRY: u32 = 3600;
177// Default - privileges last for 10 minutes.
178pub const DEFAULT_AUTH_PRIVILEGE_EXPIRY: u32 = 600;
179// Default - directly privileged sessions only last 1 hour.
180pub const DEFAULT_AUTH_SESSION_LIMITED_EXPIRY: u32 = 3600;
181// Default - oauth refresh tokens last for 16 hours.
182pub const OAUTH_REFRESH_TOKEN_EXPIRY: u32 = 3600 * 16;
183
184/// How long access tokens should last. This is NOT the length
185/// of the refresh token, which is bound to the issuing session.
186pub const OAUTH2_ACCESS_TOKEN_EXPIRY: u32 = 15 * 60;
187
188/// The absolute maximum that can be requested for max-age requests in OIDC.
189pub const OAUTH2_OIDC_MAX_AGE_CLAMP: i64 = 86400;
190
191/// The amount of time a suppliers clock can be "ahead" before
192/// we warn about possible clock synchronisation issues.
193pub const REPL_SUPPLIER_ADVANCE_WINDOW: Duration = Duration::from_secs(600);
194
195/// The number of days that the default replication MTLS cert lasts for when
196/// configured manually. Defaults to 4 years (including 1 day for the leap year).
197pub const REPL_MTLS_CERTIFICATE_EXPIRY: u64 = 1461 * 86400;
198
199/// The default number of entries that a user may retrieve in a search
200pub const DEFAULT_LIMIT_SEARCH_MAX_RESULTS: u64 = 1024;
201/// The default number of entries than an api token may retrieve in a search;
202pub const DEFAULT_LIMIT_API_SEARCH_MAX_RESULTS: u64 = u64::MAX >> 1;
203/// the default number of entries that may be examined in a partially indexed
204/// query.
205pub const DEFAULT_LIMIT_SEARCH_MAX_FILTER_TEST: u64 = 2048;
206/// the default number of entries that may be examined in a partially indexed
207/// query by an api token.
208pub const DEFAULT_LIMIT_API_SEARCH_MAX_FILTER_TEST: u64 = 16384;
209/// The maximum number of items in a filter, regardless of nesting level.
210pub const DEFAULT_LIMIT_FILTER_MAX_ELEMENTS: u64 = 32;
211
212/// The maximum amount of recursion allowed in a filter.
213pub const DEFAULT_LIMIT_FILTER_DEPTH_MAX: u64 = 12;
214
215/// The maximum number of sessions allowed on a single entry.
216pub(crate) const SESSION_MAXIMUM: usize = 48;
217
218#[cfg(test)]
219// Test only certificate. This is a self-signed server cert.
220pub(crate) const TEST_X509_CERT_DATA: &str = r#"-----BEGIN CERTIFICATE-----
221MIICeDCCAh6gAwIBAgIBAjAKBggqhkjOPQQDAjCBhDELMAkGA1UEBhMCQVUxDDAK
222BgNVBAgMA1FMRDEPMA0GA1UECgwGS2FuaWRtMRwwGgYDVQQDDBNLYW5pZG0gR2Vu
223ZXJhdGVkIENBMTgwNgYDVQQLDC9EZXZlbG9wbWVudCBhbmQgRXZhbHVhdGlvbiAt
224IE5PVCBGT1IgUFJPRFVDVElPTjAeFw0yNTA3MjkwMzMxMDNaFw0yNTA4MDMwMzMx
225MDNaMHoxCzAJBgNVBAYTAkFVMQwwCgYDVQQIDANRTEQxDzANBgNVBAoMBkthbmlk
226bTESMBAGA1UEAwwJbG9jYWxob3N0MTgwNgYDVQQLDC9EZXZlbG9wbWVudCBhbmQg
227RXZhbHVhdGlvbiAtIE5PVCBGT1IgUFJPRFVDVElPTjBZMBMGByqGSM49AgEGCCqG
228SM49AwEHA0IABPFkpVzFH+feItm9JFFm/noge+BlZLpdGWOuSUvfoivAzCgPr7Kr
229nGd8kUzIyJermePzu2SVQLaEt/7GY8Ha+2ujgYkwgYYwCQYDVR0TBAIwADAOBgNV
230HQ8BAf8EBAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwEwHQYDVR0OBBYEFOjucEtX
231mj/wQ7npVaMOyDtLU6dUMB8GA1UdIwQYMBaAFNo5o+5ea0sNMlW/75VgGJCv2AcJ
232MBQGA1UdEQQNMAuCCWxvY2FsaG9zdDAKBggqhkjOPQQDAgNIADBFAiEA1TACf4eS
233g07LRiKhlMgA+6xxztxiZCuV6LakRp7FZdECIFp0rFSiFJdkLEO9IyqYc+zPW770
234ta41VMU3u9UQfHxF
235-----END CERTIFICATE-----
236"#;
kanidmd_lib/constants/mod.rs

kanidmd_lib/constants/
mod.rs
