13cc31ca879b40712e14c6f45a71db23ac354b3f
[amitay/samba.git] / source4 / dsdb / schema / schema.h
1 /* 
2    Unix SMB/CIFS mplementation.
3    DSDB schema header
4    
5    Copyright (C) Stefan Metzmacher <metze@samba.org> 2006
6     
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 3 of the License, or
10    (at your option) any later version.
11    
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16    
17    You should have received a copy of the GNU General Public License
18    along with this program.  If not, see <http://www.gnu.org/licenses/>.
19    
20 */
21
22 #ifndef _DSDB_SCHEMA_H
23 #define _DSDB_SCHEMA_H
24
25 #include "prefixmap.h"
26
27 enum dsdb_dn_format {
28         DSDB_NORMAL_DN,
29         DSDB_BINARY_DN,
30         DSDB_STRING_DN,
31         DSDB_INVALID_DN
32 };
33
34
35 struct dsdb_attribute;
36 struct dsdb_class;
37 struct dsdb_schema;
38 struct dsdb_dn;
39
40 struct dsdb_syntax_ctx {
41         struct ldb_context *ldb;
42         const struct dsdb_schema *schema;
43
44         /* set when converting objects under Schema NC */
45         bool is_schema_nc;
46
47         /* remote prefixMap to be used for drsuapi_to_ldb conversions */
48         const struct dsdb_schema_prefixmap *pfm_remote;
49 };
50
51
52 struct dsdb_syntax {
53         const char *name;
54         const char *ldap_oid;
55         uint32_t oMSyntax;
56         struct ldb_val oMObjectClass;
57         const char *attributeSyntax_oid;
58         const char *equality;
59         const char *substring;
60         const char *comment;
61         const char *ldb_syntax;
62
63         WERROR (*drsuapi_to_ldb)(const struct dsdb_syntax_ctx *ctx,
64                                  const struct dsdb_attribute *attr,
65                                  const struct drsuapi_DsReplicaAttribute *in,
66                                  TALLOC_CTX *mem_ctx,
67                                  struct ldb_message_element *out);
68         WERROR (*ldb_to_drsuapi)(const struct dsdb_syntax_ctx *ctx,
69                                  const struct dsdb_attribute *attr,
70                                  const struct ldb_message_element *in,
71                                  TALLOC_CTX *mem_ctx,
72                                  struct drsuapi_DsReplicaAttribute *out);
73         WERROR (*validate_ldb)(const struct dsdb_syntax_ctx *ctx,
74                                const struct dsdb_attribute *attr,
75                                const struct ldb_message_element *in);
76 };
77
78 struct dsdb_attribute {
79         struct dsdb_attribute *prev, *next;
80
81         const char *cn;
82         const char *lDAPDisplayName;
83         const char *attributeID_oid;
84         uint32_t attributeID_id;
85         struct GUID schemaIDGUID;
86         uint32_t mAPIID;
87         uint32_t msDS_IntId;
88
89         struct GUID attributeSecurityGUID;
90         struct GUID objectGUID;
91
92         uint32_t searchFlags;
93         uint32_t systemFlags;
94         bool isMemberOfPartialAttributeSet;
95         uint32_t linkID;
96
97         const char *attributeSyntax_oid;
98         uint32_t attributeSyntax_id;
99         uint32_t oMSyntax;
100         struct ldb_val oMObjectClass;
101
102         bool isSingleValued;
103         uint32_t *rangeLower;
104         uint32_t *rangeUpper;
105         bool extendedCharsAllowed;
106
107         uint32_t schemaFlagsEx;
108         struct ldb_val msDs_Schema_Extensions;
109
110         bool showInAdvancedViewOnly;
111         const char *adminDisplayName;
112         const char *adminDescription;
113         const char *classDisplayName;
114         bool isEphemeral;
115         bool isDefunct;
116         bool systemOnly;
117
118         bool one_way_link;
119         enum dsdb_dn_format dn_format;
120
121         /* internal stuff */
122         const struct dsdb_syntax *syntax;
123         const struct ldb_schema_attribute *ldb_schema_attribute;
124 };
125
126 struct dsdb_class {
127         struct dsdb_class *prev, *next;
128
129         const char *cn;
130         const char *lDAPDisplayName;
131         const char *governsID_oid;
132         uint32_t governsID_id;
133         struct GUID schemaIDGUID;
134         struct GUID objectGUID;
135
136         uint32_t objectClassCategory;
137         const char *rDNAttID;
138         const char *defaultObjectCategory;
139
140         const char *subClassOf;
141
142         const char **systemAuxiliaryClass;
143         const char **systemPossSuperiors;
144         const char **systemMustContain;
145         const char **systemMayContain;
146
147         const char **auxiliaryClass;
148         const char **possSuperiors;
149         const char **mustContain;
150         const char **mayContain;
151         const char **possibleInferiors;
152         const char **systemPossibleInferiors;
153
154         const char *defaultSecurityDescriptor;
155
156         uint32_t schemaFlagsEx;
157         uint32_t systemFlags;
158         struct ldb_val msDs_Schema_Extensions;
159
160         bool showInAdvancedViewOnly;
161         const char *adminDisplayName;
162         const char *adminDescription;
163         const char *classDisplayName;
164         bool defaultHidingValue;
165         bool isDefunct;
166         bool systemOnly;
167
168         const char **supclasses;
169         const char **subclasses;
170         const char **subclasses_direct;
171         const char **posssuperiors;
172         uint32_t subClassOf_id;
173         uint32_t *systemAuxiliaryClass_ids;
174         uint32_t *auxiliaryClass_ids;
175         uint32_t *systemMayContain_ids;
176         uint32_t *systemMustContain_ids;
177         uint32_t *possSuperiors_ids;
178         uint32_t *mustContain_ids;
179         uint32_t *mayContain_ids;
180         uint32_t *systemPossSuperiors_ids;
181
182         /* An ordered index showing how this subClass fits into the
183          * subClass tree.  that is, an objectclass that is not
184          * subClassOf anything is 0 (just in case), and top is 1, and
185          * subClasses of top are 2, subclasses of those classes are
186          * 3 */ 
187         uint32_t subClass_order;
188 };
189
190 /**
191  * data stored in schemaInfo attribute
192  */
193 struct dsdb_schema_info {
194         uint32_t        revision;
195         struct GUID     invocation_id;
196 };
197
198
199 struct dsdb_schema {
200         struct ldb_dn *base_dn;
201
202         struct dsdb_schema_prefixmap *prefixmap;
203
204         /* 
205          * the last element of the prefix mapping table isn't a oid,
206          * it starts with 0xFF and has 21 bytes and is maybe a schema
207          * version number
208          *
209          * this is the content of the schemaInfo attribute of the
210          * Schema-Partition head object.
211          */
212         const char *schema_info;
213
214         /* We can also tell the schema version from the USN on the partition */
215         uint64_t loaded_usn;
216
217         struct dsdb_attribute *attributes;
218         struct dsdb_class *classes;
219
220         /* lists of classes sorted by various attributes, for faster
221            access */
222         uint32_t num_classes;
223         struct dsdb_class **classes_by_lDAPDisplayName;
224         struct dsdb_class **classes_by_governsID_id;
225         struct dsdb_class **classes_by_governsID_oid;
226         struct dsdb_class **classes_by_cn;
227
228         /* lists of attributes sorted by various fields */
229         uint32_t num_attributes;
230         struct dsdb_attribute **attributes_by_lDAPDisplayName;
231         struct dsdb_attribute **attributes_by_attributeID_id;
232         struct dsdb_attribute **attributes_by_attributeID_oid;
233         struct dsdb_attribute **attributes_by_linkID;
234         uint32_t num_int_id_attr;
235         struct dsdb_attribute **attributes_by_msDS_IntId;
236
237         struct {
238                 bool we_are_master;
239                 struct ldb_dn *master_dn;
240         } fsmo;
241
242         /* Was this schema loaded from ldb (if so, then we will reload it when we detect a change in ldb) */
243         struct ldb_module *loaded_from_module;
244         struct dsdb_schema *(*refresh_fn)(struct ldb_module *module, struct dsdb_schema *schema, bool is_global_schema);
245         bool refresh_in_progress;
246         /* an 'opaque' sequence number that the reload function may also wish to use */
247         uint64_t reload_seq_number;
248
249         /* Should the syntax handlers in this case handle all incoming OIDs automatically, assigning them as an OID if no text name is known? */
250         bool relax_OID_conversions;
251 };
252
253 enum dsdb_attr_list_query {
254         DSDB_SCHEMA_ALL_MAY,
255         DSDB_SCHEMA_ALL_MUST,
256         DSDB_SCHEMA_SYS_MAY,
257         DSDB_SCHEMA_SYS_MUST,
258         DSDB_SCHEMA_MAY,
259         DSDB_SCHEMA_MUST,
260         DSDB_SCHEMA_ALL
261 };
262
263 enum dsdb_schema_convert_target {
264         TARGET_OPENLDAP,
265         TARGET_FEDORA_DS,
266         TARGET_AD_SCHEMA_SUBENTRY
267 };
268
269 #include "dsdb/schema/proto.h"
270
271 #endif /* _DSDB_SCHEMA_H */