7605c65cdd77299bdcbe52116f578292e33b9fa6
[bbaumbach/samba-autobuild/.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 #include "librpc/gen_ndr/security.h"
33 #include <ldb.h>
34 #include "lib/ldb-samba/ldif_handlers.h"
35 #include "librpc/gen_ndr/samr.h"
36 #include "librpc/gen_ndr/drsuapi.h"
37 #include "librpc/gen_ndr/drsblobs.h"
38 #include "dsdb/schema/schema.h"
39 #include "dsdb/samdb/samdb_proto.h"
40 #include "dsdb/common/dsdb_dn.h"
41 #include "dsdb/common/proto.h"
42 #include "../libds/common/flags.h"
43
44 #define DSDB_CONTROL_CURRENT_PARTITION_OID "1.3.6.1.4.1.7165.4.3.2"
45 struct dsdb_control_current_partition {
46         /* 
47          * this is the version of the dsdb_control_current_partition
48          * version 0: initial implementation
49          * version 1: got rid of backend and module fields
50          */
51 #define DSDB_CONTROL_CURRENT_PARTITION_VERSION 1
52         uint32_t version;
53         struct ldb_dn *dn;
54 };
55
56
57 /*
58   flags in dsdb_repl_flags to control replication logic
59  */
60 #define DSDB_REPL_FLAG_PRIORITISE_INCOMING 1
61 #define DSDB_REPL_FLAG_PARTIAL_REPLICA     2
62 #define DSDB_REPL_FLAG_ADD_NCNAME          4
63
64
65 #define DSDB_CONTROL_REPLICATED_UPDATE_OID "1.3.6.1.4.1.7165.4.3.3"
66 struct dsdb_control_replicated_update {
67         uint32_t dsdb_repl_flags;
68 };
69
70 #define DSDB_CONTROL_DN_STORAGE_FORMAT_OID "1.3.6.1.4.1.7165.4.3.4"
71 /* DSDB_CONTROL_DN_STORAGE_FORMAT_OID has NULL data and behaves very
72  * much like LDB_CONTROL_EXTENDED_DN_OID when the DB stores an
73  * extended DN, and otherwise returns normal DNs */
74
75 #define DSDB_CONTROL_PASSWORD_CHANGE_STATUS_OID "1.3.6.1.4.1.7165.4.3.8"
76
77 struct dsdb_control_password_change_status {
78         struct {
79                 uint32_t pwdProperties;
80                 uint32_t pwdHistoryLength;
81                 int64_t maxPwdAge;
82                 int64_t minPwdAge;
83                 uint32_t minPwdLength;
84                 bool store_cleartext;
85                 const char *netbios_domain;
86                 const char *dns_domain;
87                 const char *realm;
88         } domain_data;
89         enum samPwdChangeReason reject_reason;
90 };
91
92 #define DSDB_CONTROL_PASSWORD_HASH_VALUES_OID "1.3.6.1.4.1.7165.4.3.9"
93
94 #define DSDB_CONTROL_PASSWORD_CHANGE_OID "1.3.6.1.4.1.7165.4.3.10"
95 struct dsdb_control_password_change {
96         const struct samr_Password *old_nt_pwd_hash;
97         const struct samr_Password *old_lm_pwd_hash;
98 };
99
100 /**
101    DSDB_CONTROL_APPLY_LINKS is internal to Samba4 - a token passed between repl_meta_data and linked_attributes modules
102 */
103 #define DSDB_CONTROL_APPLY_LINKS "1.3.6.1.4.1.7165.4.3.11"
104
105 /*
106  * this should only be used for importing users from Samba3
107  */
108 #define DSDB_CONTROL_BYPASS_PASSWORD_HASH_OID "1.3.6.1.4.1.7165.4.3.12"
109
110 /**
111   OID used to allow the replacement of replPropertyMetaData.
112   It is used when the current replmetadata needs to be edited.
113 */
114 #define DSDB_CONTROL_CHANGEREPLMETADATA_OID "1.3.6.1.4.1.7165.4.3.14"
115
116 /* passed when we want to get the behaviour of the non-global catalog port */
117 #define DSDB_CONTROL_NO_GLOBAL_CATALOG "1.3.6.1.4.1.7165.4.3.17"
118
119 /* passed when we want special behaviour for partial replicas */
120 #define DSDB_CONTROL_PARTIAL_REPLICA "1.3.6.1.4.1.7165.4.3.18"
121
122 /* passed when we want special behaviour for dbcheck */
123 #define DSDB_CONTROL_DBCHECK "1.3.6.1.4.1.7165.4.3.19"
124
125 /* passed when dbcheck wants to modify a read only replica (very special case) */
126 #define DSDB_CONTROL_DBCHECK_MODIFY_RO_REPLICA "1.3.6.1.4.1.7165.4.3.19.1"
127
128 /* passed when importing plain text password on upgrades */
129 #define DSDB_CONTROL_PASSWORD_BYPASS_LAST_SET_OID "1.3.6.1.4.1.7165.4.3.20"
130
131 /*
132  * passed from the descriptor module in order to
133  * store the recalucated nTSecurityDescriptor without
134  * modifying the replPropertyMetaData.
135  */
136 #define DSDB_CONTROL_SEC_DESC_PROPAGATION_OID "1.3.6.1.4.1.7165.4.3.21"
137
138 #define DSDB_EXTENDED_REPLICATED_OBJECTS_OID "1.3.6.1.4.1.7165.4.4.1"
139 struct dsdb_extended_replicated_object {
140         struct ldb_message *msg;
141         struct ldb_val guid_value;
142         struct ldb_val parent_guid_value;
143         const char *when_changed;
144         struct replPropertyMetaDataBlob *meta_data;
145
146         /* Only used for internal processing in repl_meta_data */
147         struct ldb_dn *last_known_parent;
148 };
149
150 struct dsdb_extended_replicated_objects {
151         /* 
152          * this is the version of the dsdb_extended_replicated_objects
153          * version 0: initial implementation
154          */
155 #define DSDB_EXTENDED_REPLICATED_OBJECTS_VERSION 2
156         uint32_t version;
157
158         /* DSDB_REPL_FLAG_* flags */
159         uint32_t dsdb_repl_flags;
160
161         struct ldb_dn *partition_dn;
162
163         const struct repsFromTo1 *source_dsa;
164         const struct drsuapi_DsReplicaCursor2CtrEx *uptodateness_vector;
165
166         uint32_t num_objects;
167         struct dsdb_extended_replicated_object *objects;
168
169         uint32_t linked_attributes_count;
170         const struct drsuapi_DsReplicaLinkedAttribute *linked_attributes;
171 };
172
173 #define DSDB_EXTENDED_CREATE_PARTITION_OID "1.3.6.1.4.1.7165.4.4.4"
174 struct dsdb_create_partition_exop {
175         struct ldb_dn *new_dn;
176 };
177
178 /*
179  * the schema_dn is passed as struct ldb_dn in
180  * req->op.extended.data
181  */
182 #define DSDB_EXTENDED_SCHEMA_UPDATE_NOW_OID "1.3.6.1.4.1.7165.4.4.2"
183
184 #define DSDB_EXTENDED_SCHEMA_UPGRADE_IN_PROGRESS_OID "1.3.6.1.4.1.7165.4.4.6"
185
186 #define DSDB_OPENLDAP_DEREFERENCE_CONTROL "1.3.6.1.4.1.4203.666.5.16"
187
188 struct dsdb_openldap_dereference {
189         const char *source_attribute;
190         const char **dereference_attribute;
191 };
192
193 struct dsdb_openldap_dereference_control {
194         struct dsdb_openldap_dereference **dereference;
195 };
196
197 struct dsdb_openldap_dereference_result {
198         const char *source_attribute;
199         const char *dereferenced_dn;
200         int num_attributes;
201         struct ldb_message_element *attributes;
202 };
203
204 struct dsdb_openldap_dereference_result_control {
205         struct dsdb_openldap_dereference_result **attributes;
206 };
207
208 struct samldb_msds_intid_persistant {
209         uint32_t msds_intid;
210         uint64_t usn;
211 };
212
213 #define SAMLDB_MSDS_INTID_OPAQUE "SAMLDB_MSDS_INTID_OPAQUE"
214
215 #define DSDB_PARTITION_DN "@PARTITION"
216 #define DSDB_PARTITION_ATTR "partition"
217
218 #define DSDB_EXTENDED_DN_STORE_FORMAT_OPAQUE_NAME "dsdb_extended_dn_store_format"
219 struct dsdb_extended_dn_store_format {
220         bool store_extended_dn_in_ldb;
221 };
222
223 #define DSDB_OPAQUE_LAST_SCHEMA_UPDATE_MSG_OPAQUE_NAME "DSDB_OPAQUE_LAST_SCHEMA_UPDATE"
224 #define DSDB_OPAQUE_PARTITION_MODULE_MSG_OPAQUE_NAME "DSDB_OPAQUE_PARTITION_MODULE_MSG"
225
226 /* this takes a struct dsdb_fsmo_extended_op */
227 #define DSDB_EXTENDED_ALLOCATE_RID_POOL "1.3.6.1.4.1.7165.4.4.5"
228
229 struct dsdb_fsmo_extended_op {
230         uint64_t fsmo_info;
231         struct GUID destination_dsa_guid;
232 };
233
234 /*
235  * passed from the descriptor module in order to
236  * store the recalucated nTSecurityDescriptor without
237  * modifying the replPropertyMetaData.
238  */
239 #define DSDB_EXTENDED_SEC_DESC_PROPAGATION_OID "1.3.6.1.4.1.7165.4.4.7"
240 struct dsdb_extended_sec_desc_propagation_op {
241         struct ldb_dn *nc_root;
242         struct ldb_dn *dn;
243         bool include_self;
244 };
245
246 #define DSDB_ACL_CHECKS_DIRSYNC_FLAG 0x1
247
248 #define DSDB_METADATA_SCHEMA_SEQ_NUM    "SCHEMA_SEQ_NUM"
249 #endif /* __SAMDB_H__ */