kanidmd_lib/constants/
entries.rs

1//! Constant Entries for the IDM
2use std::fmt::Display;
3
4use crate::value::PartialValue;
5use crate::value::Value;
6use crate::valueset::{ValueSet, ValueSetIutf8};
7pub use kanidm_proto::attribute::Attribute;
8use kanidm_proto::constants::*;
9use kanidm_proto::scim_v1::client::ScimFilter;
10use kanidm_proto::scim_v1::JsonValue;
11
12//TODO: This would do well in the proto lib
13// together with all the other definitions.
14// That way`OperationError::MissingClass` can
15// Directly reference the entryclass rather
16// than relying on its string name
17#[derive(Copy, Clone, Debug)]
18pub enum EntryClass {
19    AccessControlCreate,
20    AccessControlDelete,
21    AccessControlModify,
22    AccessControlProfile,
23    AccessControlReceiverEntryManager,
24    AccessControlReceiverGroup,
25    AccessControlSearch,
26    AccessControlTargetScope,
27    Account,
28    AccountPolicy,
29    Application,
30    AttributeType,
31    Builtin,
32    Class,
33    ClassType,
34    ClientCertificate,
35    Conflict,
36    DomainInfo,
37    DynGroup,
38    ExtensibleObject,
39    Group,
40    KeyProvider,
41    KeyProviderInternal,
42    KeyObject,
43    KeyObjectJwtEs256,
44    KeyObjectJwtRs256,
45    KeyObjectJweA128GCM,
46    KeyObjectInternal,
47    MemberOf,
48    OAuth2ResourceServer,
49    OAuth2ResourceServerBasic,
50    OAuth2ResourceServerPublic,
51    OAuth2DeviceCodeSession,
52    Object,
53    OrgPerson,
54    Person,
55    PosixAccount,
56    PosixGroup,
57    Recycled,
58    Service,
59    ServiceAccount,
60    SyncAccount,
61    SyncObject,
62    Tombstone,
63    User,
64    System,
65    SystemInfo,
66    SystemConfig,
67    #[cfg(any(test, debug_assertions))]
68    TestClass,
69}
70
71impl From<EntryClass> for ScimFilter {
72    fn from(ec: EntryClass) -> Self {
73        ScimFilter::Equal(Attribute::Class.into(), ec.into())
74    }
75}
76
77impl From<EntryClass> for &'static str {
78    fn from(val: EntryClass) -> Self {
79        match val {
80            EntryClass::AccessControlCreate => ACCESS_CONTROL_CREATE,
81            EntryClass::AccessControlDelete => ACCESS_CONTROL_DELETE,
82            EntryClass::AccessControlModify => ACCESS_CONTROL_MODIFY,
83            EntryClass::AccessControlProfile => ACCESS_CONTROL_PROFILE,
84            EntryClass::AccessControlReceiverEntryManager => ACCESS_CONTROL_RECEIVER_ENTRY_MANAGER,
85            EntryClass::AccessControlReceiverGroup => ACCESS_CONTROL_RECEIVER_GROUP,
86            EntryClass::AccessControlSearch => ACCESS_CONTROL_SEARCH,
87            EntryClass::AccessControlTargetScope => ACCESS_CONTROL_TARGET_SCOPE,
88            EntryClass::Account => ENTRYCLASS_ACCOUNT,
89            EntryClass::AccountPolicy => ENTRYCLASS_ACCOUNT_POLICY,
90            EntryClass::Application => ENTRYCLASS_APPLICATION,
91            EntryClass::AttributeType => ENTRYCLASS_ATTRIBUTE_TYPE,
92            EntryClass::Builtin => ENTRYCLASS_BUILTIN,
93            EntryClass::Class => ENTRYCLASS_CLASS,
94            EntryClass::ClassType => ENTRYCLASS_CLASS_TYPE,
95            EntryClass::ClientCertificate => ENTRYCLASS_CLIENT_CERTIFICATE,
96            EntryClass::Conflict => ENTRYCLASS_CONFLICT,
97            EntryClass::DomainInfo => ENTRYCLASS_DOMAIN_INFO,
98            EntryClass::DynGroup => ENTRYCLASS_DYN_GROUP,
99            EntryClass::ExtensibleObject => ENTRYCLASS_EXTENSIBLE_OBJECT,
100            EntryClass::Group => ENTRYCLASS_GROUP,
101            EntryClass::KeyProvider => ENTRYCLASS_KEY_PROVIDER,
102            EntryClass::KeyProviderInternal => ENTRYCLASS_KEY_PROVIDER_INTERNAL,
103            EntryClass::KeyObject => ENTRYCLASS_KEY_OBJECT,
104            EntryClass::KeyObjectJwtEs256 => ENTRYCLASS_KEY_OBJECT_JWT_ES256,
105            EntryClass::KeyObjectJwtRs256 => ENTRYCLASS_KEY_OBJECT_JWT_RS256,
106            EntryClass::KeyObjectJweA128GCM => ENTRYCLASS_KEY_OBJECT_JWE_A128GCM,
107            EntryClass::KeyObjectInternal => ENTRYCLASS_KEY_OBJECT_INTERNAL,
108            EntryClass::MemberOf => ENTRYCLASS_MEMBER_OF,
109            EntryClass::OAuth2DeviceCodeSession => OAUTH2_DEVICE_CODE_SESSION,
110            EntryClass::OAuth2ResourceServer => OAUTH2_RESOURCE_SERVER,
111            EntryClass::OAuth2ResourceServerBasic => OAUTH2_RESOURCE_SERVER_BASIC,
112            EntryClass::OAuth2ResourceServerPublic => OAUTH2_RESOURCE_SERVER_PUBLIC,
113            EntryClass::Object => ENTRYCLASS_OBJECT,
114            EntryClass::OrgPerson => ENTRYCLASS_ORG_PERSON,
115            EntryClass::Person => ENTRYCLASS_PERSON,
116            EntryClass::PosixAccount => ENTRYCLASS_POSIX_ACCOUNT,
117            EntryClass::PosixGroup => ENTRYCLASS_POSIX_GROUP,
118            EntryClass::Recycled => ENTRYCLASS_RECYCLED,
119            EntryClass::Service => ENTRYCLASS_SERVICE,
120            EntryClass::ServiceAccount => ENTRYCLASS_SERVICE_ACCOUNT,
121            EntryClass::SyncAccount => ENTRYCLASS_SYNC_ACCOUNT,
122            EntryClass::SyncObject => ENTRYCLASS_SYNC_OBJECT,
123            EntryClass::System => ENTRYCLASS_SYSTEM,
124            EntryClass::SystemConfig => ENTRYCLASS_SYSTEM_CONFIG,
125            EntryClass::SystemInfo => ENTRYCLASS_SYSTEM_INFO,
126            EntryClass::Tombstone => ENTRYCLASS_TOMBSTONE,
127            #[cfg(any(test, debug_assertions))]
128            EntryClass::TestClass => TEST_ENTRYCLASS_TEST_CLASS,
129            EntryClass::User => ENTRYCLASS_USER,
130        }
131    }
132}
133
134impl From<EntryClass> for JsonValue {
135    fn from(value: EntryClass) -> Self {
136        Self::String(value.as_ref().to_string())
137    }
138}
139
140impl AsRef<str> for EntryClass {
141    fn as_ref(&self) -> &str {
142        self.into()
143    }
144}
145
146impl From<&EntryClass> for &'static str {
147    fn from(value: &EntryClass) -> Self {
148        (*value).into()
149    }
150}
151
152impl From<EntryClass> for String {
153    fn from(val: EntryClass) -> Self {
154        let s: &'static str = val.into();
155        s.to_string()
156    }
157}
158
159impl From<EntryClass> for Value {
160    fn from(val: EntryClass) -> Self {
161        Value::new_iutf8(val.into())
162    }
163}
164
165impl From<EntryClass> for PartialValue {
166    fn from(val: EntryClass) -> Self {
167        PartialValue::new_iutf8(val.into())
168    }
169}
170
171impl From<EntryClass> for crate::prelude::AttrString {
172    fn from(val: EntryClass) -> Self {
173        crate::prelude::AttrString::from(val.to_string())
174    }
175}
176
177impl Display for EntryClass {
178    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> std::fmt::Result {
179        let s: String = (*self).into();
180        write!(f, "{s}")
181    }
182}
183
184impl EntryClass {
185    pub fn to_value(self) -> Value {
186        let s: &'static str = self.into();
187        Value::new_iutf8(s)
188    }
189
190    pub fn to_valueset(self) -> ValueSet {
191        let s: &'static str = self.into();
192        ValueSetIutf8::new(s)
193    }
194
195    pub fn to_partialvalue(self) -> PartialValue {
196        let s: &'static str = self.into();
197        PartialValue::new_iutf8(s)
198    }
199
200    /// Return a filter that'll match this class
201    pub fn as_f_eq(&self) -> crate::filter::FC {
202        crate::filter::f_eq(Attribute::Class, self.to_partialvalue())
203    }
204}
205
206// ============ TEST DATA ============
207#[cfg(test)]
208use crate::entry::{Entry, EntryInit, EntryInitNew, EntryNew};
209
210#[cfg(test)]
211lazy_static! {
212    pub static ref E_TESTPERSON_1: EntryInitNew = entry_init!(
213        (Attribute::Class, EntryClass::Object.to_value()),
214        (Attribute::Class, EntryClass::Account.to_value()),
215        (Attribute::Class, EntryClass::Person.to_value()),
216        (Attribute::Name, Value::new_iname("testperson1")),
217        (Attribute::DisplayName, Value::new_utf8s("Test Person 1")),
218        (
219            Attribute::Uuid,
220            Value::Uuid(super::uuids::UUID_TESTPERSON_1)
221        )
222    );
223    pub static ref E_TESTPERSON_2: EntryInitNew = entry_init!(
224        (Attribute::Class, EntryClass::Object.to_value()),
225        (Attribute::Class, EntryClass::Account.to_value()),
226        (Attribute::Class, EntryClass::Person.to_value()),
227        (Attribute::Name, Value::new_iname("testperson2")),
228        (Attribute::DisplayName, Value::new_utf8s("Test Person 2")),
229        (
230            Attribute::Uuid,
231            Value::Uuid(super::uuids::UUID_TESTPERSON_2)
232        )
233    );
234}