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

kanidmd_lib/constants/
mod.rs
