3 * Copyright 1999 The OpenLDAP Foundation, Redwood City, California, USA
6 * Redistribution and use in source and binary forms are permitted only
7 * as authorized by the OpenLDAP Public License. A copy of this
8 * license is available at http://www.OpenLDAP.org/license.html or
9 * in file LICENSE in the top-level directory of the distribution.
12 * ldap-schema.h - Header for basic schema handling functions that can be
13 * used by both clients and servers.
16 #ifndef _LDAP_SCHEMA_H
17 #define _LDAP_SCHEMA_H 1
19 #include <ldap_cdefs.h>
23 /* Codes for parsing errors */
25 #define LDAP_SCHERR_OUTOFMEM 1
26 #define LDAP_SCHERR_UNEXPTOKEN 2
27 #define LDAP_SCHERR_NOLEFTPAREN 3
28 #define LDAP_SCHERR_NORIGHTPAREN 4
29 #define LDAP_SCHERR_NODIGIT 5
30 #define LDAP_SCHERR_BADNAME 6
31 #define LDAP_SCHERR_BADDESC 7
32 #define LDAP_SCHERR_BADSUP 8
33 #define LDAP_SCHERR_DUPOPT 9
34 #define LDAP_SCHERR_EMPTY 10
36 typedef struct ldap_syntax {
37 char *syn_oid; /* REQUIRED */
38 char *syn_desc; /* OPTIONAL */
41 typedef struct ldap_matchingrule {
42 char *mr_oid; /* REQUIRED */
43 char **mr_names; /* OPTIONAL */
44 char *mr_desc; /* OPTIONAL */
45 int mr_obsolete; /* OPTIONAL */
46 char *mr_syntax_oid; /* REQUIRED */
49 typedef struct ldap_attributetype {
50 char *at_oid; /* REQUIRED */
51 char **at_names; /* OPTIONAL */
52 char *at_desc; /* OPTIONAL */
53 int at_obsolete; /* 0=no, 1=yes */
54 char *at_sup_oid; /* OPTIONAL */
55 char *at_equality_oid; /* OPTIONAL */
56 char *at_ordering_oid; /* OPTIONAL */
57 char *at_substr_oid; /* OPTIONAL */
58 char *at_syntax_oid; /* OPTIONAL */
59 int at_syntax_len; /* OPTIONAL */
60 int at_single_value; /* 0=no, 1=yes */
61 int at_collective; /* 0=no, 1=yes */
62 int at_no_user_mod; /* 0=no, 1=yes */
63 int at_usage; /* 0=userApplications, 1=directoryOperation,
64 2=distributedOperation, 3=dSAOperation */
65 } LDAP_ATTRIBUTE_TYPE;
67 typedef struct ldap_objectclass {
68 char *oc_oid; /* REQUIRED */
69 char **oc_names; /* OPTIONAL */
70 char *oc_desc; /* OPTIONAL */
71 int oc_obsolete; /* 0=no, 1=yes */
72 char **oc_sup_oids; /* OPTIONAL */
73 int oc_kind; /* 0=ABSTRACT, 1=STRUCTURAL, 2=AUXILIARY */
74 char **oc_at_oids_must; /* OPTIONAL */
75 char **oc_at_oids_may; /* OPTIONAL */
78 #define LDAP_SCHEMA_NO 0
79 #define LDAP_SCHEMA_YES 1
81 #define LDAP_SCHEMA_USER_APPLICATIONS 0
82 #define LDAP_SCHEMA_DIRECTORY_OPERATION 1
83 #define LDAP_SCHEMA_DISTRIBUTED_OPERATION 2
84 #define LDAP_SCHEMA_DSA_OPERATION 3
86 #define LDAP_SCHEMA_ABSTRACT 0
87 #define LDAP_SCHEMA_STRUCTURAL 1
88 #define LDAP_SCHEMA_AUXILIARY 2
90 LDAP_F( LDAP_CONST char * )
91 ldap_syntax2name LDAP_P((
94 LDAP_F( LDAP_CONST char * )
95 ldap_matchingrule2name LDAP_P((
96 LDAP_MATCHING_RULE * mr ));
98 LDAP_F( LDAP_CONST char * )
99 ldap_attributetype2name LDAP_P((
100 LDAP_ATTRIBUTE_TYPE * at ));
102 LDAP_F( LDAP_CONST char * )
103 ldap_objectclass2name LDAP_P((
104 LDAP_OBJECT_CLASS * oc ));
107 ldap_syntax_free LDAP_P((
108 LDAP_SYNTAX * syn ));
111 ldap_matchingrule_free LDAP_P((
112 LDAP_MATCHING_RULE * mr ));
115 ldap_attributetype_free LDAP_P((
116 LDAP_ATTRIBUTE_TYPE * at ));
119 ldap_objectclass_free LDAP_P((
120 LDAP_OBJECT_CLASS * oc ));
122 LDAP_F( LDAP_OBJECT_CLASS * )
123 ldap_str2objectclass LDAP_P((
126 LDAP_CONST char ** errp ));
128 LDAP_F( LDAP_ATTRIBUTE_TYPE * )
129 ldap_str2attributetype LDAP_P((
132 LDAP_CONST char ** errp ));
134 LDAP_F( LDAP_SYNTAX * )
135 ldap_str2syntax LDAP_P((
138 LDAP_CONST char ** errp ));
140 LDAP_F( LDAP_MATCHING_RULE * )
141 ldap_str2matchingrule LDAP_P((
144 LDAP_CONST char ** errp ));
147 ldap_objectclass2str LDAP_P((
148 LDAP_CONST LDAP_OBJECT_CLASS * oc ));
151 ldap_attributetype2str LDAP_P((
152 LDAP_CONST LDAP_ATTRIBUTE_TYPE * at ));
155 ldap_syntax2str LDAP_P((
156 LDAP_CONST LDAP_SYNTAX * syn ));
159 ldap_matchingrule2str LDAP_P((
160 LDAP_CONST LDAP_MATCHING_RULE * mr ));
163 ldap_scherr2str LDAP_P((
164 int code )) LDAP_GCCATTR((const));