s4-dsdb: Try to avoid much of the time a db search for msDS-IntID
[ddiss/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 #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 importing plain text password on upgrades */
126 #define DSDB_CONTROL_PASSWORD_BYPASS_LAST_SET_OID "1.3.6.1.4.1.7165.4.3.20"
127
128 #define DSDB_EXTENDED_REPLICATED_OBJECTS_OID "1.3.6.1.4.1.7165.4.4.1"
129 struct dsdb_extended_replicated_object {
130         struct ldb_message *msg;
131         struct ldb_val guid_value;
132         const char *when_changed;
133         struct replPropertyMetaDataBlob *meta_data;
134 };
135
136 struct dsdb_extended_replicated_objects {
137         /* 
138          * this is the version of the dsdb_extended_replicated_objects
139          * version 0: initial implementation
140          */
141 #define DSDB_EXTENDED_REPLICATED_OBJECTS_VERSION 2
142         uint32_t version;
143
144         /* DSDB_REPL_FLAG_* flags */
145         uint32_t dsdb_repl_flags;
146
147         struct ldb_dn *partition_dn;
148
149         const struct repsFromTo1 *source_dsa;
150         const struct drsuapi_DsReplicaCursor2CtrEx *uptodateness_vector;
151
152         uint32_t num_objects;
153         struct dsdb_extended_replicated_object *objects;
154
155         uint32_t linked_attributes_count;
156         const struct drsuapi_DsReplicaLinkedAttribute *linked_attributes;
157 };
158
159 #define DSDB_EXTENDED_CREATE_PARTITION_OID "1.3.6.1.4.1.7165.4.4.4"
160 struct dsdb_create_partition_exop {
161         struct ldb_dn *new_dn;
162 };
163
164 /*
165  * the schema_dn is passed as struct ldb_dn in
166  * req->op.extended.data
167  */
168 #define DSDB_EXTENDED_SCHEMA_UPDATE_NOW_OID "1.3.6.1.4.1.7165.4.4.2"
169
170 #define DSDB_EXTENDED_SCHEMA_UPGRADE_IN_PROGRESS_OID "1.3.6.1.4.1.7165.4.4.6"
171
172 #define DSDB_OPENLDAP_DEREFERENCE_CONTROL "1.3.6.1.4.1.4203.666.5.16"
173
174 struct dsdb_openldap_dereference {
175         const char *source_attribute;
176         const char **dereference_attribute;
177 };
178
179 struct dsdb_openldap_dereference_control {
180         struct dsdb_openldap_dereference **dereference;
181 };
182
183 struct dsdb_openldap_dereference_result {
184         const char *source_attribute;
185         const char *dereferenced_dn;
186         int num_attributes;
187         struct ldb_message_element *attributes;
188 };
189
190 struct dsdb_openldap_dereference_result_control {
191         struct dsdb_openldap_dereference_result **attributes;
192 };
193
194 struct samldb_msds_intid_persistant {
195         uint32_t msds_intid;
196         uint64_t usn;
197 };
198
199 #define SAMLDB_MSDS_INTID_OPAQUE "SAMLDB_MSDS_INTID_OPAQUE"
200
201 #define DSDB_PARTITION_DN "@PARTITION"
202 #define DSDB_PARTITION_ATTR "partition"
203
204 #define DSDB_EXTENDED_DN_STORE_FORMAT_OPAQUE_NAME "dsdb_extended_dn_store_format"
205 struct dsdb_extended_dn_store_format {
206         bool store_extended_dn_in_ldb;
207 };
208
209 #define DSDB_OPAQUE_LAST_SCHEMA_UPDATE_MSG_OPAQUE_NAME "DSDB_OPAQUE_LAST_SCHEMA_UPDATE"
210 #define DSDB_OPAQUE_PARTITION_MODULE_MSG_OPAQUE_NAME "DSDB_OPAQUE_PARTITION_MODULE_MSG"
211
212 /* this takes a struct dsdb_fsmo_extended_op */
213 #define DSDB_EXTENDED_ALLOCATE_RID_POOL "1.3.6.1.4.1.7165.4.4.5"
214
215 struct dsdb_fsmo_extended_op {
216         uint64_t fsmo_info;
217         struct GUID destination_dsa_guid;
218 };
219
220 #define DSDB_ACL_CHECKS_DIRSYNC_FLAG 0x1
221 #endif /* __SAMDB_H__ */