01eb1f3c0879be80c634d02ec6ed8ff6e00db22e
[samba.git] / source4 / dsdb / samdb / samdb.h
1 /* 
2    Unix SMB/CIFS implementation.
3
4    interface functions for the sam database
5
6    Copyright (C) Andrew Tridgell 2004
7    
8    This program is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 3 of the License, or
11    (at your option) any later version.
12    
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17    
18    You should have received a copy of the GNU General Public License
19    along with this program.  If not, see <http://www.gnu.org/licenses/>.
20 */
21
22 #ifndef __SAMDB_H__
23 #define __SAMDB_H__
24
25 struct auth_session_info;
26 struct dsdb_control_current_partition;
27 struct dsdb_extended_replicated_object;
28 struct dsdb_extended_replicated_objects;
29 struct loadparm_context;
30 struct tevent_context;
31
32 struct dsdb_trust_routing_table;
33
34 #include "librpc/gen_ndr/security.h"
35 #include <ldb.h>
36 #include "lib/ldb-samba/ldif_handlers.h"
37 #include "librpc/gen_ndr/samr.h"
38 #include "librpc/gen_ndr/drsuapi.h"
39 #include "librpc/gen_ndr/drsblobs.h"
40 #include "dsdb/schema/schema.h"
41 #include "dsdb/samdb/samdb_proto.h"
42 #include "dsdb/common/dsdb_dn.h"
43 #include "dsdb/common/util_links.h"
44 #include "dsdb/common/proto.h"
45 #include "../libds/common/flags.h"
46
47 #define DSDB_CONTROL_CURRENT_PARTITION_OID "1.3.6.1.4.1.7165.4.3.2"
48 struct dsdb_control_current_partition {
49         /* 
50          * this is the version of the dsdb_control_current_partition
51          * version 0: initial implementation
52          * version 1: got rid of backend and module fields
53          */
54 #define DSDB_CONTROL_CURRENT_PARTITION_VERSION 1
55         uint32_t version;
56         struct ldb_dn *dn;
57 };
58
59
60 /*
61   flags in dsdb_repl_flags to control replication logic
62  */
63 #define DSDB_REPL_FLAG_PRIORITISE_INCOMING 1
64 #define DSDB_REPL_FLAG_PARTIAL_REPLICA     2
65 #define DSDB_REPL_FLAG_ADD_NCNAME          4
66 #define DSDB_REPL_FLAG_EXPECT_NO_SECRETS   8
67 #define DSDB_REPL_FLAG_OBJECT_SUBSET       16
68 #define DSDB_REPL_FLAG_TARGETS_UPTODATE    32
69
70 #define DSDB_CONTROL_REPLICATED_UPDATE_OID "1.3.6.1.4.1.7165.4.3.3"
71
72 #define DSDB_CONTROL_DN_STORAGE_FORMAT_OID "1.3.6.1.4.1.7165.4.3.4"
73 /* DSDB_CONTROL_DN_STORAGE_FORMAT_OID has NULL data and behaves very
74  * much like LDB_CONTROL_EXTENDED_DN_OID when the DB stores an
75  * extended DN, and otherwise returns normal DNs */
76
77 #define DSDB_CONTROL_PASSWORD_CHANGE_STATUS_OID "1.3.6.1.4.1.7165.4.3.8"
78
79 struct dsdb_control_password_change_status {
80         struct {
81                 uint32_t pwdProperties;
82                 uint32_t pwdHistoryLength;
83                 int64_t maxPwdAge;
84                 int64_t minPwdAge;
85                 uint32_t minPwdLength;
86                 bool store_cleartext;
87                 const char *netbios_domain;
88                 const char *dns_domain;
89                 const char *realm;
90         } domain_data;
91         enum samPwdChangeReason reject_reason;
92 };
93
94 #define DSDB_CONTROL_PASSWORD_HASH_VALUES_OID "1.3.6.1.4.1.7165.4.3.9"
95
96 #define DSDB_CONTROL_PASSWORD_CHANGE_OID "1.3.6.1.4.1.7165.4.3.10"
97 struct dsdb_control_password_change {
98         const struct samr_Password *old_nt_pwd_hash;
99         const struct samr_Password *old_lm_pwd_hash;
100 };
101
102 /**
103    DSDB_CONTROL_APPLY_LINKS is internal to Samba4 - a token passed between repl_meta_data and linked_attributes modules
104 */
105 #define DSDB_CONTROL_APPLY_LINKS "1.3.6.1.4.1.7165.4.3.11"
106
107 /*
108  * this should only be used for importing users from Samba3
109  */
110 #define DSDB_CONTROL_BYPASS_PASSWORD_HASH_OID "1.3.6.1.4.1.7165.4.3.12"
111
112 /**
113   OID used to allow the replacement of replPropertyMetaData.
114   It is used when the current replmetadata needs to be edited.
115 */
116 #define DSDB_CONTROL_CHANGEREPLMETADATA_OID "1.3.6.1.4.1.7165.4.3.14"
117
118 /* passed when we want to get the behaviour of the non-global catalog port */
119 #define DSDB_CONTROL_NO_GLOBAL_CATALOG "1.3.6.1.4.1.7165.4.3.17"
120
121 /* passed when we want special behaviour for partial replicas */
122 #define DSDB_CONTROL_PARTIAL_REPLICA "1.3.6.1.4.1.7165.4.3.18"
123
124 /* passed when we want special behaviour for dbcheck */
125 #define DSDB_CONTROL_DBCHECK "1.3.6.1.4.1.7165.4.3.19"
126
127 /* passed when dbcheck wants to modify a read only replica (very special case) */
128 #define DSDB_CONTROL_DBCHECK_MODIFY_RO_REPLICA "1.3.6.1.4.1.7165.4.3.19.1"
129
130 /* passed when importing plain text password on upgrades */
131 #define DSDB_CONTROL_PASSWORD_BYPASS_LAST_SET_OID "1.3.6.1.4.1.7165.4.3.20"
132
133 /*
134  * passed from the descriptor module in order to
135  * store the recalucated nTSecurityDescriptor without
136  * modifying the replPropertyMetaData.
137  */
138 #define DSDB_CONTROL_SEC_DESC_PROPAGATION_OID "1.3.6.1.4.1.7165.4.3.21"
139
140 /*
141  * passed when creating a interdomain trust account through LSA
142  * to relax constraints in the samldb ldb module.
143  */
144 #define DSDB_CONTROL_PERMIT_INTERDOMAIN_TRUST_UAC_OID "1.3.6.1.4.1.7165.4.3.23"
145
146 /*
147  * Internal control to mark requests as being part of Tombstone restoring
148  * procedure - it requires slightly special behavior like:
149  *  - a bit different security checks
150  *  - restoring certain attributes to their default values, etc
151  */
152 #define DSDB_CONTROL_RESTORE_TOMBSTONE_OID "1.3.6.1.4.1.7165.4.3.24"
153
154 /**
155   OID used to allow the replacement of replPropertyMetaData.
156   It is used when the current replmetadata needs only to be re-sorted, but not edited.
157 */
158 #define DSDB_CONTROL_CHANGEREPLMETADATA_RESORT_OID "1.3.6.1.4.1.7165.4.3.25"
159
160 /*
161  * pass the default state of pwdLastSet between the "samldb" and "password_hash"
162  * modules.
163  */
164 #define DSDB_CONTROL_PASSWORD_DEFAULT_LAST_SET_OID "1.3.6.1.4.1.7165.4.3.26"
165
166 /*
167  * pass the userAccountControl changes between the "samldb" and "password_hash"
168  * modules.
169  */
170 #define DSDB_CONTROL_PASSWORD_USER_ACCOUNT_CONTROL_OID "1.3.6.1.4.1.7165.4.3.27"
171 struct dsdb_control_password_user_account_control {
172         uint32_t req_flags; /* the flags given by the client request */
173         uint32_t old_flags; /* the old flags stored (0 on add) */
174         uint32_t new_flags; /* the new flags stored */
175 };
176
177 /*
178  * Ignores strict checking when adding objects to samldb.
179  * This is used when provisioning, as checking all objects when added
180  * was slow due to an unindexed search.
181  */
182 #define DSDB_CONTROL_SKIP_DUPLICATES_CHECK_OID "1.3.6.1.4.1.7165.4.3.28"
183
184 /* passed when we want to thoroughly delete linked attributes */
185 #define DSDB_CONTROL_REPLMD_VANISH_LINKS "1.3.6.1.4.1.7165.4.3.29"
186
187 /*
188  * lockoutTime is a replicated attribute, but must be modified before
189  * connectivity occurs to allow password lockouts.
190  */
191 #define DSDB_CONTROL_FORCE_RODC_LOCAL_CHANGE "1.3.6.1.4.1.7165.4.3.31"
192
193 #define DSDB_CONTROL_INVALID_NOT_IMPLEMENTED "1.3.6.1.4.1.7165.4.3.32"
194
195 #define DSDB_EXTENDED_REPLICATED_OBJECTS_OID "1.3.6.1.4.1.7165.4.4.1"
196 struct dsdb_extended_replicated_object {
197         struct ldb_message *msg;
198         struct GUID object_guid;
199         struct GUID *parent_guid;
200         const char *when_changed;
201         struct replPropertyMetaDataBlob *meta_data;
202
203         /* Only used for internal processing in repl_meta_data */
204         struct ldb_dn *last_known_parent;
205         struct ldb_dn *local_parent_dn;
206 };
207
208 struct dsdb_extended_replicated_objects {
209         /* 
210          * this is the version of the dsdb_extended_replicated_objects
211          * version 0: initial implementation
212          */
213 #define DSDB_EXTENDED_REPLICATED_OBJECTS_VERSION 3
214         uint32_t version;
215
216         /* DSDB_REPL_FLAG_* flags */
217         uint32_t dsdb_repl_flags;
218
219         struct ldb_dn *partition_dn;
220
221         const struct repsFromTo1 *source_dsa;
222         const struct drsuapi_DsReplicaCursor2CtrEx *uptodateness_vector;
223
224         uint32_t num_objects;
225         struct dsdb_extended_replicated_object *objects;
226
227         uint32_t linked_attributes_count;
228         struct drsuapi_DsReplicaLinkedAttribute *linked_attributes;
229
230         WERROR error;
231
232         bool originating_updates;
233 };
234
235 #define DSDB_EXTENDED_CREATE_PARTITION_OID "1.3.6.1.4.1.7165.4.4.4"
236 struct dsdb_create_partition_exop {
237         struct ldb_dn *new_dn;
238 };
239
240 /*
241  * the schema_dn is passed as struct ldb_dn in
242  * req->op.extended.data
243  */
244 #define DSDB_EXTENDED_SCHEMA_UPDATE_NOW_OID "1.3.6.1.4.1.7165.4.4.2"
245
246 #define DSDB_EXTENDED_SCHEMA_UPGRADE_IN_PROGRESS_OID "1.3.6.1.4.1.7165.4.4.6"
247
248 #define DSDB_OPENLDAP_DEREFERENCE_CONTROL "1.3.6.1.4.1.4203.666.5.16"
249
250 struct dsdb_openldap_dereference {
251         const char *source_attribute;
252         const char **dereference_attribute;
253 };
254
255 struct dsdb_openldap_dereference_control {
256         struct dsdb_openldap_dereference **dereference;
257 };
258
259 struct dsdb_openldap_dereference_result {
260         const char *source_attribute;
261         const char *dereferenced_dn;
262         int num_attributes;
263         struct ldb_message_element *attributes;
264 };
265
266 struct dsdb_openldap_dereference_result_control {
267         struct dsdb_openldap_dereference_result **attributes;
268 };
269
270 struct samldb_msds_intid_persistant {
271         uint32_t msds_intid;
272 };
273
274 #define SAMLDB_MSDS_INTID_OPAQUE "SAMLDB_MSDS_INTID_OPAQUE"
275
276 #define DSDB_PARTITION_DN "@PARTITION"
277 #define DSDB_PARTITION_ATTR "partition"
278
279 #define DSDB_EXTENDED_DN_STORE_FORMAT_OPAQUE_NAME "dsdb_extended_dn_store_format"
280 struct dsdb_extended_dn_store_format {
281         bool store_extended_dn_in_ldb;
282 };
283
284 #define DSDB_OPAQUE_PARTITION_MODULE_MSG_OPAQUE_NAME "DSDB_OPAQUE_PARTITION_MODULE_MSG"
285
286 /* this takes a struct dsdb_fsmo_extended_op */
287 #define DSDB_EXTENDED_ALLOCATE_RID_POOL "1.3.6.1.4.1.7165.4.4.5"
288
289 struct dsdb_fsmo_extended_op {
290         uint64_t fsmo_info;
291         struct GUID destination_dsa_guid;
292 };
293
294 /* this takes no data */
295 #define DSDB_EXTENDED_CREATE_OWN_RID_SET "1.3.6.1.4.1.7165.4.4.8"
296
297 /* this takes a struct dsdb_extended_allocate_rid */
298 #define DSDB_EXTENDED_ALLOCATE_RID "1.3.6.1.4.1.7165.4.4.9"
299
300 struct dsdb_extended_allocate_rid {
301         uint32_t rid;
302 };
303
304 /*
305  * passed from the descriptor module in order to
306  * store the recalucated nTSecurityDescriptor without
307  * modifying the replPropertyMetaData.
308  */
309 #define DSDB_EXTENDED_SEC_DESC_PROPAGATION_OID "1.3.6.1.4.1.7165.4.4.7"
310 struct dsdb_extended_sec_desc_propagation_op {
311         struct ldb_dn *nc_root;
312         struct ldb_dn *dn;
313         bool include_self;
314 };
315
316 #define DSDB_ACL_CHECKS_DIRSYNC_FLAG 0x1
317 #define DSDB_SAMDB_MINIMUM_ALLOWED_RID   1000
318
319 #define DSDB_METADATA_SCHEMA_SEQ_NUM    "SCHEMA_SEQ_NUM"
320
321 /*
322  * must be in LDB_FLAG_INTERNAL_MASK
323  * see also the values in lib/ldb/include/ldb_module.h
324  */
325 #define DSDB_FLAG_INTERNAL_FORCE_META_DATA 0x10000
326
327 #define SAMBA_COMPATIBLE_FEATURES_ATTR "compatibleFeatures"
328 #define SAMBA_REQUIRED_FEATURES_ATTR "requiredFeatures"
329 #define SAMBA_FEATURES_SUPPORTED_FLAG "@SAMBA_FEATURES_SUPPORTED"
330
331 #define SAMBA_SORTED_LINKS_FEATURE "sortedLinks"
332
333 #endif /* __SAMDB_H__ */