kanidm_proto/internal/
error.rs

1use super::credupdate::PasswordFeedback;
2use crate::attribute::Attribute;
3use serde::{Deserialize, Serialize};
4use std::fmt::{Display, Formatter};
5use utoipa::ToSchema;
6use uuid::Uuid;
7
8/* ===== errors ===== */
9#[derive(Serialize, Deserialize, Debug, PartialEq, Eq, ToSchema)]
10#[serde(rename_all = "lowercase")]
11pub enum SchemaError {
12    NotImplemented,
13    NoClassFound,
14    InvalidClass(Vec<String>),
15    MissingMustAttribute(Vec<Attribute>),
16    InvalidAttribute(String),
17    InvalidAttributeSyntax(String),
18    AttributeNotValidForClass(String),
19    SupplementsNotSatisfied(Vec<String>),
20    ExcludesNotSatisfied(Vec<String>),
21    EmptyFilter,
22    Corrupted,
23    PhantomAttribute(String),
24}
25
26#[derive(Serialize, Deserialize, Debug, PartialEq, Eq, ToSchema)]
27#[serde(rename_all = "lowercase")]
28pub enum PluginError {
29    Base(String),
30    ReferentialIntegrity(String),
31    CredImport(String),
32    Oauth2Secrets,
33}
34
35#[derive(Serialize, Deserialize, Debug, PartialEq, Eq, ToSchema)]
36#[serde(rename_all = "lowercase")]
37pub enum ConsistencyError {
38    Unknown,
39    // Class, Attribute
40    SchemaClassMissingAttribute(String, String),
41    SchemaClassPhantomAttribute(String, String),
42    SchemaUuidNotUnique(Uuid),
43    QueryServerSearchFailure,
44    EntryUuidCorrupt(u64),
45    UuidIndexCorrupt(String),
46    UuidNotUnique(String),
47    RefintNotUpheld(u64),
48    MemberOfInvalid(u64),
49    InvalidAttributeType(String),
50    DuplicateUniqueAttribute,
51    InvalidSpn(u64),
52    SqliteIntegrityFailure,
53    BackendAllIdsSync,
54    BackendIndexSync,
55    ChangelogDesynchronised(u64),
56    ChangeStateDesynchronised(u64),
57    RuvInconsistent(String),
58    DeniedName(Uuid),
59    KeyProviderUuidMissing { key_object: Uuid },
60    KeyProviderNoKeys { key_object: Uuid },
61    KeyProviderNotFound { key_object: Uuid, provider: Uuid },
62}
63
64#[derive(Serialize, Deserialize, Debug, ToSchema)]
65#[serde(rename_all = "lowercase")]
66pub enum OperationError {
67    // Logic errors, or "soft" errors. These are to guide the user or user-interface
68    // in some way.
69    SessionExpired,
70    DuplicateKey,
71    DuplicateLabel,
72    EmptyRequest,
73    Backend,
74    NoMatchingEntries,
75    NoMatchingAttributes,
76    UniqueConstraintViolation,
77    CorruptedEntry(u64),
78    CorruptedIndex(String),
79    ConsistencyError(Vec<ConsistencyError>),
80    SchemaViolation(SchemaError),
81    Plugin(PluginError),
82    FilterGeneration,
83    FilterParseError,
84    FilterUuidResolution,
85    InvalidAttributeName(String),
86    InvalidAttribute(String),
87    InvalidLabel,
88    InvalidDbState,
89    InvalidCacheState,
90    InvalidValueState,
91    InvalidEntryId,
92    InvalidRequestState,
93    InvalidSyncState,
94    InvalidState,
95    InvalidEntryState,
96    InvalidUuid,
97    InvalidReplChangeId,
98    InvalidAcpState(String),
99    InvalidSchemaState(String),
100    InvalidAccountState(String),
101    // This really oughta be EntryClass but its not in proto...
102    // It should at least be &'static str but we
103    // Serialize & Deserialize this enum...
104    MissingClass(String),
105    MissingAttribute(Attribute),
106    AttributeUniqueness(Vec<Attribute>),
107    MissingEntries,
108    ModifyAssertionFailed,
109    BackendEngine,
110    SqliteError, //(RusqliteError)
111    FsError,
112    SerdeJsonError,
113    SerdeCborError,
114    AccessDenied,
115    NotAuthenticated,
116    NotAuthorised,
117    InvalidAuthState(String),
118    InvalidSessionState,
119    SystemProtectedObject,
120    SystemProtectedAttribute,
121    PasswordQuality(Vec<PasswordFeedback>),
122    CryptographyError,
123    ResourceLimit,
124    QueueDisconnected,
125    Webauthn,
126    #[serde(with = "time::serde::timestamp")]
127    Wait(time::OffsetDateTime),
128    ReplReplayFailure,
129    ReplEntryNotChanged,
130    ReplInvalidRUVState,
131    ReplDomainLevelUnsatisfiable,
132    ReplDomainUuidMismatch,
133    ReplServerUuidSplitDataState,
134    TransactionAlreadyCommitted,
135    CannotStartMFADuringOngoingMFASession,
136    /// when you ask for a gid that overlaps a system reserved range
137    /// When a name is denied by the system config
138    ValueDenyName,
139    /// When the DB is potentially over-loaded a timeout can occur starting
140    /// your operation.
141    DatabaseLockAcquisitionTimeout,
142    /// Your change would introduce a reference loop
143    ReferenceLoop,
144    /// This session is not able to re-authenticate and has static privileges
145    SessionMayNotReauth,
146
147    // Specific internal errors.
148    AU0001InvalidState,
149    AU0002JwsSerialisation,
150    AU0003JwsSignature,
151    AU0004UserAuthTokenInvalid,
152    AU0005DelayedProcessFailure,
153    AU0006CredentialMayNotReauthenticate,
154    AU0007UserAuthTokenInvalid,
155    AU0008ClientAuthInfoPrevalidation,
156
157    // Kanidm Generic Errors
158    KG001TaskTimeout,
159    KG002TaskCommFailure,
160    KG003CacheClearFailed,
161    KG004UnknownFeatureUuid,
162    KG005HowDidYouEvenManageThis,
163    KG006DatastructureCorruption,
164
165    // Credential Update Errors
166    CU0001WebauthnAttestationNotTrusted,
167    CU0002WebauthnRegistrationError,
168    CU0003WebauthnUserNotVerified,
169
170    // The session is inconsistent and can't be committed, but the errors
171    // can be resolved.
172    CU0004SessionInconsistent,
173    // Another session used this intent token, and so it can't be committed.
174    CU0005IntentTokenConflict,
175    // The intent token was invalidated before we could commit.
176    CU0006IntentTokenInvalidated,
177    CU0007AccountEmailNotFound,
178    CU0008AccountMissingEmail,
179
180    // ValueSet errors
181    VS0001IncomingReplSshPublicKey,
182    VS0002CertificatePublicKeyDigest,
183    VS0003CertificateDerDecode,
184    VS0004CertificatePublicKeyDigest,
185    VS0005CertificatePublicKeyDigest,
186    // Value Errors
187    VL0001ValueSshPublicKeyString,
188
189    // LDAP Errors
190    LD0001AnonymousNotAllowed,
191
192    // DB low level errors.
193    DB0001MismatchedRestoreVersion,
194    DB0002MismatchedRestoreVersion,
195    DB0003FilterResolveCacheBuild,
196    DB0004DatabaseTooOld,
197
198    // SCIM
199    SC0001IncomingSshPublicKey,
200    SC0002ReferenceSyntaxInvalid,
201    SC0003MailSyntaxInvalid,
202    SC0004UuidSyntaxInvalid,
203    SC0005BoolSyntaxInvalid,
204    SC0006Uint32SyntaxInvalid,
205    SC0007UrlSyntaxInvalid,
206    SC0008SyntaxTypeSyntaxInvalid,
207    SC0009IndexTypeSyntaxInvalid,
208    SC0010DateTimeSyntaxInvalid,
209    SC0011AddressSyntaxInvalid,
210    SC0012CertificateSyntaxInvalid,
211    SC0013CertificateInvalidDer,
212    SC0014CertificateInvalidDigest,
213    SC0015CredentialTypeSyntaxInvalid,
214    SC0016InameSyntaxInvalid,
215    SC0017Iutf8SyntaxInvalid,
216    SC0018NsUniqueIdSyntaxInvalid,
217    SC0019Oauth2ScopeSyntaxInvalid,
218    SC0020Oauth2ScopeMapSyntaxInvalid,
219    SC0021Oauth2ScopeMapMissingGroupIdentifier,
220    SC0022Oauth2ClaimMapSyntaxInvalid,
221    SC0023Oauth2ClaimMapMissingGroupIdentifier,
222    SC0024SshPublicKeySyntaxInvalid,
223    SC0025UiHintSyntaxInvalid,
224    SC0026Utf8SyntaxInvalid,
225    SC0027ClassSetInvalid,
226    SC0028CreatedUuidsInvalid,
227    SC0029PaginationOutOfBounds,
228    SC0030Sha256SyntaxInvalid,
229    SC0031Int64SyntaxInvalid,
230    SC0032Uint64SyntaxInvalid,
231    SC0033AssertionContainsDuplicateUuids,
232    // Migration
233    MG0001InvalidReMigrationLevel,
234    MG0002RaiseDomainLevelExceedsMaximum,
235    MG0003ServerPhaseInvalidForMigration,
236    MG0004DomainLevelInDevelopment,
237    MG0005GidConstraintsNotMet,
238    MG0006SKConstraintsNotMet,
239    MG0007Oauth2StrictConstraintsNotMet,
240    MG0008SkipUpgradeAttempted,
241    MG0009InvalidTargetLevelForBootstrap,
242    MG0010DowngradeNotAllowed,
243    //
244    KP0001KeyProviderNotLoaded,
245    KP0002KeyProviderInvalidClass,
246    KP0003KeyProviderInvalidType,
247    KP0004KeyProviderMissingAttributeName,
248    KP0005KeyProviderDuplicate,
249    KP0006KeyObjectJwtEs256Generation,
250    KP0007KeyProviderDefaultNotAvailable,
251    KP0008KeyObjectMissingUuid,
252    KP0009KeyObjectPrivateToDer,
253    KP0010KeyObjectSignerToVerifier,
254    KP0011KeyObjectMissingClass,
255    KP0012KeyObjectMissingProvider,
256    KP0012KeyProviderNotLoaded,
257    KP0013KeyObjectJwsEs256DerInvalid,
258    KP0014KeyObjectSignerToVerifier,
259    KP0015KeyObjectJwsEs256DerInvalid,
260    KP0016KeyObjectJwsEs256DerInvalid,
261    KP0017KeyProviderNoSuchKey,
262    KP0018KeyProviderNoSuchKey,
263    KP0019KeyProviderUnsupportedAlgorithm,
264    KP0020KeyObjectNoActiveSigningKeys,
265    KP0021KeyObjectJwsEs256Signature,
266    KP0022KeyObjectJwsNotAssociated,
267    KP0023KeyObjectJwsKeyRevoked,
268    KP0024KeyObjectJwsInvalid,
269    KP0025KeyProviderNotAvailable,
270    KP0026KeyObjectNoSuchKey,
271    KP0027KeyObjectPublicToDer,
272    KP0028KeyObjectImportJwsEs256DerInvalid,
273    KP0029KeyObjectSignerToVerifier,
274    KP0030KeyObjectPublicToDer,
275    KP0031KeyObjectNotFound,
276    KP0032KeyProviderNoSuchKey,
277    KP0033KeyProviderNoSuchKey,
278    KP0034KeyProviderUnsupportedAlgorithm,
279    KP0035KeyObjectJweA128GCMGeneration,
280    KP0036KeyObjectPrivateToBytes,
281    KP0037KeyObjectImportJweA128GCMInvalid,
282    KP0038KeyObjectImportJweA128GCMInvalid,
283    KP0039KeyObjectJweNotAssociated,
284    KP0040KeyObjectJweInvalid,
285    KP0041KeyObjectJweRevoked,
286    KP0042KeyObjectNoActiveEncryptionKeys,
287    KP0043KeyObjectJweA128GCMEncryption,
288    KP0044KeyObjectJwsPublicJwk,
289
290    KP0045KeyObjectImportJwsRs256DerInvalid,
291    KP0046KeyObjectSignerToVerifier,
292    KP0047KeyObjectPublicToDer,
293    KP0048KeyObjectJwtRs256Generation,
294    KP0049KeyObjectSignerToVerifier,
295    KP0050KeyObjectPrivateToDer,
296    KP0051KeyObjectPublicToDer,
297    KP0052KeyObjectJwsRs256DerInvalid,
298    KP0053KeyObjectSignerToVerifier,
299    KP0054KeyObjectJwsRs256DerInvalid,
300    KP0055KeyObjectJwsRs256DerInvalid,
301    KP0056KeyObjectJwsRs256Signature,
302    KP0057KeyObjectJwsNotAssociated,
303    KP0058KeyObjectJwsInvalid,
304    KP0059KeyObjectJwsKeyRevoked,
305    KP0060KeyObjectJwsPublicJwk,
306    KP0061KeyObjectNoActiveSigningKeys,
307    KP0062KeyProviderNoSuchKey,
308
309    KP0063KeyObjectJwsHs256DerInvalid,
310    KP0064KeyObjectSignerToVerifier,
311    KP0065KeyObjectJwtHs256Generation,
312    KP0066KeyObjectJwsHs256DerInvalid,
313    KP0067KeyObjectSignerToVerifier,
314    KP0068KeyObjectJwsHs256DerInvalid,
315    KP0069KeyObjectNoActiveSigningKeys,
316    KP0070KeyObjectJwsHs256Signature,
317    KP0071KeyObjectPrivateToDer,
318
319    KP0072KeyObjectHs256Invalid,
320    KP0073KeyObjectHs256Invalid,
321    KP0074KeyObjectNoActiveSigningKeys,
322    KP0075KeyObjectHmacInvalidLength,
323    KP0076KeyObjectHkdfOutputLengthInvalid,
324    KP0077KeyProviderNoSuchKey,
325    KP0078KeyObjectNotFound,
326    KP0079KeyObjectNotFound,
327
328    KP0080KeyProviderNoSuchKey,
329
330    // Plugins
331    PL0001GidOverlapsSystemRange,
332
333    // Web UI
334    UI0001ChallengeSerialisation,
335    UI0002InvalidState,
336    UI0003InvalidOauth2Resume,
337    UI0004MemberAlreadyExists,
338
339    // Unixd Things
340    KU001InitWhileSessionActive,
341    KU002ContinueWhileSessionInActive,
342    KU003PamAuthFailed,
343    KU004PamInitFailed,
344    KU005ErrorCheckingAccount,
345    KU006OnlyRootAllowed,
346}
347
348impl PartialEq for OperationError {
349    fn eq(&self, other: &Self) -> bool {
350        // We do this to avoid InvalidPassword being checked as it's not
351        // derive PartialEq. Generally we only use the PartialEq for TESTING
352        // anyway.
353        std::mem::discriminant(self) == std::mem::discriminant(other)
354    }
355}
356
357impl Display for OperationError {
358    fn fmt(&self, f: &mut Formatter) -> std::fmt::Result {
359        let mut output = format!("{self:?}")
360            .split("::")
361            .last()
362            .unwrap_or("")
363            .to_string();
364
365        if let Some(msg) = self.message() {
366            output += &format!(" - {msg}");
367        };
368        f.write_str(&output)
369    }
370}
371
372impl OperationError {
373    /// Return the message associated with the error if there is one.
374    pub fn message(&self) -> Option<String> {
375        match self {
376            Self::SessionExpired => None,
377            Self::EmptyRequest => None,
378            Self::Backend => None,
379            Self::NoMatchingEntries => None,
380            Self::NoMatchingAttributes => None,
381            Self::UniqueConstraintViolation => Some("A unique constraint was violated resulting in multiple conflicting results.".into()),
382            Self::CorruptedEntry(_) => None,
383            Self::CorruptedIndex(_) => None,
384            Self::ConsistencyError(_) => None,
385            Self::SchemaViolation(_) => None,
386            Self::Plugin(_) => None,
387            Self::FilterGeneration => None,
388            Self::FilterParseError => None,
389            Self::FilterUuidResolution => None,
390            Self::InvalidAttributeName(_) => None,
391            Self::InvalidAttribute(_) => None,
392            Self::InvalidLabel => Some("The submitted label for this item is invalid.".into()),
393            Self::DuplicateLabel => Some("The submitted label for this item is already in use.".into()),
394            Self::DuplicateKey => Some("The submitted key already exists.".into()),
395            Self::InvalidDbState => None,
396            Self::InvalidCacheState => None,
397            Self::InvalidValueState => None,
398            Self::InvalidEntryId => None,
399            Self::InvalidRequestState => None,
400            Self::InvalidSyncState => None,
401            Self::InvalidState => None,
402            Self::InvalidEntryState => None,
403            Self::InvalidUuid => None,
404            Self::InvalidReplChangeId => None,
405            Self::InvalidAcpState(_) => None,
406            Self::InvalidSchemaState(_) => None,
407            Self::InvalidAccountState(val) => Some(format!("Invalid account state: {val}")),
408            Self::MissingClass(val) => Some(format!("Missing class: {val}")),
409            Self::MissingAttribute(val) => Some(format!("Missing attribute: {val}")),
410            Self::AttributeUniqueness(attrs) => Some(format!("The value of some attributes is not unique. {attrs:?}")),
411            Self::MissingEntries => None,
412            Self::ModifyAssertionFailed => None,
413            Self::BackendEngine => None,
414            Self::SqliteError => None,
415            Self::FsError => None,
416            Self::SerdeJsonError => None,
417            Self::SerdeCborError => None,
418            Self::AccessDenied => None,
419            Self::NotAuthenticated => None,
420            Self::NotAuthorised => None,
421            Self::InvalidAuthState(_) => None,
422            Self::InvalidSessionState => None,
423            Self::SystemProtectedObject => None,
424            Self::SystemProtectedAttribute => None,
425            Self::PasswordQuality(_) => None,
426            Self::CryptographyError => None,
427            Self::ResourceLimit => None,
428            Self::QueueDisconnected => None,
429            Self::Webauthn => None,
430            Self::Wait(_) => None,
431            Self::CannotStartMFADuringOngoingMFASession => Some("Cannot start a new MFA authentication flow when there already is one active.".into()),
432            Self::ReplReplayFailure => None,
433            Self::ReplEntryNotChanged => None,
434            Self::ReplInvalidRUVState => None,
435            Self::ReplDomainLevelUnsatisfiable => None,
436            Self::ReplDomainUuidMismatch => None,
437            Self::ReplServerUuidSplitDataState => None,
438            Self::TransactionAlreadyCommitted => None,
439            Self::ValueDenyName => None,
440            Self::DatabaseLockAcquisitionTimeout => Some("Unable to acquire a database lock - the current server may be too busy. Try again later.".into()),
441            Self::ReferenceLoop => Some("The change you have made would introduce an invalid reference loop. Unable to proceed.".into()),
442            Self::SessionMayNotReauth => Some("The current session is not able to re-authenticate to elevate privileges to read-write.".into()),
443
444    Self::AU0001InvalidState => Some("Invalid authentication session state for request".into()),
445    Self::AU0002JwsSerialisation => Some("JWS serialisation failed".into()),
446    Self::AU0003JwsSignature => Some("JWS signature failed".into()),
447    Self::AU0004UserAuthTokenInvalid => Some("User auth token was unable to be generated".into()),
448    Self::AU0005DelayedProcessFailure => Some("Delaying processing failure, unable to proceed".into()),
449    Self::AU0006CredentialMayNotReauthenticate => Some("Credential may not reauthenticate".into()),
450    Self::AU0007UserAuthTokenInvalid => Some("User auth token was unable to be generated".into()),
451    Self::AU0008ClientAuthInfoPrevalidation => Some("Client Authentication Info prevalidation did not occur when expected".into()),
452
453            Self::CU0001WebauthnAttestationNotTrusted => None,
454            Self::CU0002WebauthnRegistrationError => None,
455            Self::CU0003WebauthnUserNotVerified => Some("User Verification bit not set while registering credential, you may need to configure a PIN on this device.".into()),
456
457            Self::CU0004SessionInconsistent => Some("The session is unable to be committed due to unresolved warnings.".into()),
458            Self::CU0005IntentTokenConflict => Some("The intent token used to create this session has been reused in another browser/tab and may not proceed.".into()),
459            Self::CU0006IntentTokenInvalidated => Some("The intent token has been invalidated/revoked before the commit could be accepted. Has it been used in another browser or tab?".into()),
460            Self::CU0007AccountEmailNotFound => Some("The requested email to send the credential update intent token to is not registered to the account.".into()),
461            Self::CU0008AccountMissingEmail => Some("The account has no email addresses and may not have a credential update intent token sent to it.".into()),
462
463            Self::DB0001MismatchedRestoreVersion => None,
464            Self::DB0002MismatchedRestoreVersion => None,
465            Self::DB0003FilterResolveCacheBuild => None,
466            Self::DB0004DatabaseTooOld => Some("The database is too old to be migrated.".into()),
467            Self::KG001TaskTimeout => Some("Task timed out".into()),
468            Self::KG002TaskCommFailure => Some("Inter-Task communication failure".into()),
469            Self::KG003CacheClearFailed => Some("Failed to clear cache".into()),
470            Self::KG004UnknownFeatureUuid => None,
471            Self::KG005HowDidYouEvenManageThis => Some("You have damaged the fabric of space time and managed to perform an impossible action.".into()),
472            Self::KG006DatastructureCorruption => None,
473            Self::KP0001KeyProviderNotLoaded => None,
474            Self::KP0002KeyProviderInvalidClass => None,
475            Self::KP0003KeyProviderInvalidType => None,
476            Self::KP0004KeyProviderMissingAttributeName => None,
477            Self::KP0005KeyProviderDuplicate => None,
478            Self::KP0006KeyObjectJwtEs256Generation => None,
479            Self::KP0007KeyProviderDefaultNotAvailable => None,
480            Self::KP0008KeyObjectMissingUuid => None,
481            Self::KP0009KeyObjectPrivateToDer => None,
482            Self::KP0010KeyObjectSignerToVerifier => None,
483            Self::KP0011KeyObjectMissingClass => None,
484            Self::KP0012KeyObjectMissingProvider => None,
485            Self::KP0012KeyProviderNotLoaded => None,
486            Self::KP0013KeyObjectJwsEs256DerInvalid => None,
487            Self::KP0014KeyObjectSignerToVerifier => None,
488            Self::KP0015KeyObjectJwsEs256DerInvalid => None,
489            Self::KP0016KeyObjectJwsEs256DerInvalid => None,
490            Self::KP0017KeyProviderNoSuchKey => None,
491            Self::KP0018KeyProviderNoSuchKey => None,
492            Self::KP0019KeyProviderUnsupportedAlgorithm => None,
493            Self::KP0020KeyObjectNoActiveSigningKeys => None,
494            Self::KP0021KeyObjectJwsEs256Signature => None,
495            Self::KP0022KeyObjectJwsNotAssociated => None,
496            Self::KP0023KeyObjectJwsKeyRevoked => None,
497            Self::KP0024KeyObjectJwsInvalid => None,
498            Self::KP0025KeyProviderNotAvailable => None,
499            Self::KP0026KeyObjectNoSuchKey => None,
500            Self::KP0027KeyObjectPublicToDer => None,
501            Self::KP0028KeyObjectImportJwsEs256DerInvalid => None,
502            Self::KP0029KeyObjectSignerToVerifier => None,
503            Self::KP0030KeyObjectPublicToDer => None,
504            Self::KP0031KeyObjectNotFound => None,
505            Self::KP0032KeyProviderNoSuchKey => None,
506            Self::KP0033KeyProviderNoSuchKey => None,
507            Self::KP0034KeyProviderUnsupportedAlgorithm => None,
508            Self::KP0035KeyObjectJweA128GCMGeneration => None,
509            Self::KP0036KeyObjectPrivateToBytes => None,
510            Self::KP0037KeyObjectImportJweA128GCMInvalid => None,
511            Self::KP0038KeyObjectImportJweA128GCMInvalid => None,
512            Self::KP0039KeyObjectJweNotAssociated => None,
513            Self::KP0040KeyObjectJweInvalid => None,
514            Self::KP0041KeyObjectJweRevoked => None,
515            Self::KP0042KeyObjectNoActiveEncryptionKeys => None,
516            Self::KP0043KeyObjectJweA128GCMEncryption => None,
517            Self::KP0044KeyObjectJwsPublicJwk => None,
518
519            Self::KP0045KeyObjectImportJwsRs256DerInvalid => None,
520            Self::KP0046KeyObjectSignerToVerifier => None,
521            Self::KP0047KeyObjectPublicToDer => None,
522            Self::KP0048KeyObjectJwtRs256Generation => None,
523            Self::KP0049KeyObjectSignerToVerifier => None,
524            Self::KP0050KeyObjectPrivateToDer => None,
525            Self::KP0051KeyObjectPublicToDer => None,
526            Self::KP0052KeyObjectJwsRs256DerInvalid => None,
527            Self::KP0053KeyObjectSignerToVerifier => None,
528            Self::KP0054KeyObjectJwsRs256DerInvalid => None,
529            Self::KP0055KeyObjectJwsRs256DerInvalid => None,
530            Self::KP0056KeyObjectJwsRs256Signature => None,
531            Self::KP0057KeyObjectJwsNotAssociated => None,
532            Self::KP0058KeyObjectJwsInvalid => None,
533            Self::KP0059KeyObjectJwsKeyRevoked => None,
534            Self::KP0060KeyObjectJwsPublicJwk => None,
535            Self::KP0061KeyObjectNoActiveSigningKeys => None,
536            Self::KP0062KeyProviderNoSuchKey => None,
537            Self::KP0063KeyObjectJwsHs256DerInvalid => None,
538            Self::KP0064KeyObjectSignerToVerifier => None,
539            Self::KP0065KeyObjectJwtHs256Generation => None,
540            Self::KP0066KeyObjectJwsHs256DerInvalid => None,
541            Self::KP0067KeyObjectSignerToVerifier => None,
542            Self::KP0068KeyObjectJwsHs256DerInvalid => None,
543            Self::KP0069KeyObjectNoActiveSigningKeys => None,
544            Self::KP0070KeyObjectJwsHs256Signature => None,
545            Self::KP0071KeyObjectPrivateToDer => None,
546            Self::KP0072KeyObjectHs256Invalid => None,
547            Self::KP0073KeyObjectHs256Invalid => None,
548            Self::KP0074KeyObjectNoActiveSigningKeys => None,
549            Self::KP0075KeyObjectHmacInvalidLength => None,
550            Self::KP0076KeyObjectHkdfOutputLengthInvalid => None,
551            Self::KP0077KeyProviderNoSuchKey => None,
552            Self::KP0078KeyObjectNotFound => None,
553            Self::KP0079KeyObjectNotFound => None,
554            Self::KP0080KeyProviderNoSuchKey => None,
555
556            Self::KU001InitWhileSessionActive => Some("The session was active when the init function was called.".into()),
557            Self::KU002ContinueWhileSessionInActive => Some("Attempted to continue auth session while current session is inactive".into()),
558            Self::KU003PamAuthFailed => Some("Failed PAM account authentication step".into()),
559            Self::KU004PamInitFailed => Some("Failed to initialise PAM authentication".into()),
560            Self::KU005ErrorCheckingAccount => Some("Error checking account".into()),
561            Self::KU006OnlyRootAllowed => Some("Only root is allowed to perform this operation".into()),
562            Self::LD0001AnonymousNotAllowed => Some("Anonymous is not allowed to access LDAP with this method.".into()),
563            Self::MG0001InvalidReMigrationLevel => None,
564            Self::MG0002RaiseDomainLevelExceedsMaximum => None,
565            Self::MG0003ServerPhaseInvalidForMigration => None,
566            Self::MG0004DomainLevelInDevelopment => None,
567            Self::MG0005GidConstraintsNotMet => None,
568            Self::MG0006SKConstraintsNotMet => Some("Migration Constraints Not Met - Security Keys should not be present.".into()),
569            Self::MG0007Oauth2StrictConstraintsNotMet => Some("Migration Constraints Not Met - All OAuth2 clients must have strict-redirect-uri mode enabled.".into()),
570            Self::MG0008SkipUpgradeAttempted => Some("Skip Upgrade Attempted.".into()),
571            Self::MG0009InvalidTargetLevelForBootstrap => Some("The request target domain level was not valid for bootstrapping a new server instance".into()),
572            Self::MG0010DowngradeNotAllowed => Some("Downgrade Attempted".into()),
573            Self::PL0001GidOverlapsSystemRange => None,
574            Self::SC0001IncomingSshPublicKey => None,
575            Self::SC0002ReferenceSyntaxInvalid => Some("A SCIM Reference Set contained invalid syntax and can not be processed.".into()),
576            Self::SC0003MailSyntaxInvalid => Some("A SCIM Mail Address contained invalid syntax".into()),
577            Self::SC0004UuidSyntaxInvalid => Some("A SCIM Uuid contained invalid syntax".into()),
578            Self::SC0005BoolSyntaxInvalid => Some("A SCIM boolean contained invalid syntax".into()),
579            Self::SC0006Uint32SyntaxInvalid => Some("A SCIM Uint32 contained invalid syntax".into()),
580            Self::SC0007UrlSyntaxInvalid => Some("A SCIM Url contained invalid syntax".into()),
581            Self::SC0008SyntaxTypeSyntaxInvalid => Some("A SCIM SyntaxType contained invalid syntax".into()),
582            Self::SC0009IndexTypeSyntaxInvalid => Some("A SCIM IndexType contained invalid syntax".into()),
583            Self::SC0010DateTimeSyntaxInvalid => Some("A SCIM DateTime contained invalid syntax".into()),
584
585            Self::SC0011AddressSyntaxInvalid => Some("A SCIM Address contained invalid syntax".into()),
586            Self::SC0012CertificateSyntaxInvalid => Some("A SCIM Certificate contained invalid binary data".into()),
587            Self::SC0013CertificateInvalidDer => Some("A SCIM Certificate did not contain valid DER".into()),
588            Self::SC0014CertificateInvalidDigest => Some("A SCIM Certificate was unable to be digested".into()),
589            Self::SC0015CredentialTypeSyntaxInvalid => Some("A SCIM CredentialType contained invalid syntax".into()),
590            Self::SC0016InameSyntaxInvalid => Some("A SCIM Iname string contained invalid syntax".into()),
591            Self::SC0017Iutf8SyntaxInvalid => Some("A SCIM Iutf8 string contained invalid syntax".into()),
592            Self::SC0018NsUniqueIdSyntaxInvalid => Some("A SCIM NsUniqueID contained invalid syntax".into()),
593            Self::SC0019Oauth2ScopeSyntaxInvalid => Some("A SCIM Oauth2 Scope contained invalid syntax".into()),
594            Self::SC0020Oauth2ScopeMapSyntaxInvalid => Some("A SCIM Oauth2 Scope Map contained invalid syntax".into()),
595            Self::SC0021Oauth2ScopeMapMissingGroupIdentifier => Some("A SCIM Oauth2 Scope Map was missing a group name or uuid".into()),
596            Self::SC0022Oauth2ClaimMapSyntaxInvalid => Some("A SCIM Oauth2 Claim Map contained invalid syntax".into()),
597            Self::SC0023Oauth2ClaimMapMissingGroupIdentifier => Some("A SCIM Claim Map was missing a group name or uuid".into()),
598            Self::SC0024SshPublicKeySyntaxInvalid => Some("A SCIM Ssh Public Key contained invalid syntax".into()),
599            Self::SC0025UiHintSyntaxInvalid => Some("A SCIM UiHint contained invalid syntax".into()),
600            Self::SC0026Utf8SyntaxInvalid => Some("A SCIM Utf8 String Scope Map contained invalid syntax".into()),
601            Self::SC0027ClassSetInvalid => Some("The internal set of class templates used in this create operation was invalid. THIS IS A BUG.".into()),
602            Self::SC0028CreatedUuidsInvalid => Some("The internal create query did not return the set of created UUIDs. THIS IS A BUG".into()),
603            Self::SC0029PaginationOutOfBounds => Some("The requested range for pagination was out of bounds of the result set".into()),
604            Self::SC0030Sha256SyntaxInvalid => Some("A SCIM SHA256 hex string was invalid.".into()),
605            Self::SC0031Int64SyntaxInvalid => Some("A SCIM Int64 contained invalid syntax".into()),
606            Self::SC0032Uint64SyntaxInvalid => Some("A SCIM Uint64 contained invalid syntax".into()),
607            Self::SC0033AssertionContainsDuplicateUuids => Some("SCIM assertion contains duplicate entry ids, unable to proceed.".into()),
608            Self::UI0001ChallengeSerialisation => Some("The WebAuthn challenge was unable to be serialised.".into()),
609            Self::UI0002InvalidState => Some("The credential update process returned an invalid state transition.".into()),
610            Self::UI0003InvalidOauth2Resume => Some("The server attempted to resume OAuth2, but no OAuth2 session is in progress.".into()),
611            Self::UI0004MemberAlreadyExists => Some("The target is already a member.".into()),
612            Self::VL0001ValueSshPublicKeyString => None,
613            Self::VS0001IncomingReplSshPublicKey => None,
614            Self::VS0002CertificatePublicKeyDigest |
615            Self::VS0003CertificateDerDecode => Some("Decoding the stored certificate from DER failed.".into()),
616            Self::VS0004CertificatePublicKeyDigest |
617            Self::VS0005CertificatePublicKeyDigest => Some("The certificates public key is unable to be digested.".into()),
618
619        }
620    }
621}
622
623#[test]
624fn test_operationerror_as_nice_string() {
625    assert_eq!(
626        OperationError::CU0001WebauthnAttestationNotTrusted.to_string(),
627        "CU0001WebauthnAttestationNotTrusted".to_string()
628    );
629    assert_eq!(
630        OperationError::CU0003WebauthnUserNotVerified.to_string(),
631        "CU0003WebauthnUserNotVerified - User Verification bit not set while registering credential, you may need to configure a PIN on this device.".to_string()
632    );
633    assert_eq!(
634        OperationError::SessionExpired.to_string(),
635        "SessionExpired".to_string()
636    );
637    assert_eq!(
638        OperationError::CorruptedEntry(12345).to_string(),
639        "CorruptedEntry(12345)".to_string()
640    );
641}
kanidm_proto/internal/error.rs

kanidm_proto/internal/
error.rs
