s4-dsdb: added new control DSDB_MODIFY_PARTIAL_REPLICA
[Samba.git] / source4 / dsdb / samdb / samdb.h
blob4c89f242472f1c5e3594b1eb05dddb7ad1705889
1 /*
2 Unix SMB/CIFS implementation.
4 interface functions for the sam database
6 Copyright (C) Andrew Tridgell 2004
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.
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.
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/>.
22 #ifndef __SAMDB_H__
23 #define __SAMDB_H__
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;
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"
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
51 #define DSDB_CONTROL_CURRENT_PARTITION_VERSION 1
52 uint32_t version;
53 struct ldb_dn *dn;
58 flags in dsdb_repl_flags to control replication logic
60 #define DSDB_REPL_FLAG_PRIORITISE_INCOMING 1
61 #define DSDB_REPL_FLAG_PARTIAL_REPLICA 2
62 #define DSDB_REPL_FLAG_ADD_NCNAME 4
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;
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 */
75 #define DSDB_CONTROL_PASSWORD_CHANGE_STATUS_OID "1.3.6.1.4.1.7165.4.3.8"
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;
92 #define DSDB_CONTROL_PASSWORD_HASH_VALUES_OID "1.3.6.1.4.1.7165.4.3.9"
94 #define DSDB_CONTROL_PASSWORD_CHANGE_OID "1.3.6.1.4.1.7165.4.3.10"
96 /* passed when we want to get the behaviour of the non-global catalog port */
97 #define DSDB_CONTROL_NO_GLOBAL_CATALOG "1.3.6.1.4.1.7165.4.3.17"
99 /* passed when we want special behaviour for partial replicas */
100 #define DSDB_CONTROL_PARTIAL_REPLICA "1.3.6.1.4.1.7165.4.3.18"
102 struct dsdb_control_password_change {
103 const struct samr_Password *old_nt_pwd_hash;
104 const struct samr_Password *old_lm_pwd_hash;
108 DSDB_CONTROL_APPLY_LINKS is internal to Samba4 - a token passed between repl_meta_data and linked_attributes modules
110 #define DSDB_CONTROL_APPLY_LINKS "1.3.6.1.4.1.7165.4.3.11"
113 * this should only be used for importing users from Samba3
115 #define DSDB_CONTROL_BYPASS_PASSWORD_HASH_OID "1.3.6.1.4.1.7165.4.3.12"
118 OID used to allow the replacement of replPropertyMetaData.
119 It is used when the current replmetadata needs to be edited.
121 #define DSDB_CONTROL_CHANGEREPLMETADATA_OID "1.3.6.1.4.1.7165.4.3.14"
123 #define DSDB_EXTENDED_REPLICATED_OBJECTS_OID "1.3.6.1.4.1.7165.4.4.1"
124 struct dsdb_extended_replicated_object {
125 struct ldb_message *msg;
126 struct ldb_val guid_value;
127 const char *when_changed;
128 struct replPropertyMetaDataBlob *meta_data;
131 struct dsdb_extended_replicated_objects {
133 * this is the version of the dsdb_extended_replicated_objects
134 * version 0: initial implementation
136 #define DSDB_EXTENDED_REPLICATED_OBJECTS_VERSION 2
137 uint32_t version;
139 /* DSDB_REPL_FLAG_* flags */
140 uint32_t dsdb_repl_flags;
142 struct ldb_dn *partition_dn;
144 const struct repsFromTo1 *source_dsa;
145 const struct drsuapi_DsReplicaCursor2CtrEx *uptodateness_vector;
147 uint32_t num_objects;
148 struct dsdb_extended_replicated_object *objects;
150 uint32_t linked_attributes_count;
151 const struct drsuapi_DsReplicaLinkedAttribute *linked_attributes;
154 #define DSDB_EXTENDED_CREATE_PARTITION_OID "1.3.6.1.4.1.7165.4.4.4"
155 struct dsdb_create_partition_exop {
156 struct ldb_dn *new_dn;
160 * the schema_dn is passed as struct ldb_dn in
161 * req->op.extended.data
163 #define DSDB_EXTENDED_SCHEMA_UPDATE_NOW_OID "1.3.6.1.4.1.7165.4.4.2"
165 #define DSDB_OPENLDAP_DEREFERENCE_CONTROL "1.3.6.1.4.1.4203.666.5.16"
167 struct dsdb_openldap_dereference {
168 const char *source_attribute;
169 const char **dereference_attribute;
172 struct dsdb_openldap_dereference_control {
173 struct dsdb_openldap_dereference **dereference;
176 struct dsdb_openldap_dereference_result {
177 const char *source_attribute;
178 const char *dereferenced_dn;
179 int num_attributes;
180 struct ldb_message_element *attributes;
183 struct dsdb_openldap_dereference_result_control {
184 struct dsdb_openldap_dereference_result **attributes;
187 #define DSDB_PARTITION_DN "@PARTITION"
188 #define DSDB_PARTITION_ATTR "partition"
190 #define DSDB_EXTENDED_DN_STORE_FORMAT_OPAQUE_NAME "dsdb_extended_dn_store_format"
191 struct dsdb_extended_dn_store_format {
192 bool store_extended_dn_in_ldb;
195 #define DSDB_OPAQUE_PARTITION_MODULE_MSG_OPAQUE_NAME "DSDB_OPAQUE_PARTITION_MODULE_MSG"
197 /* this takes a struct dsdb_fsmo_extended_op */
198 #define DSDB_EXTENDED_ALLOCATE_RID_POOL "1.3.6.1.4.1.7165.4.4.5"
200 struct dsdb_fsmo_extended_op {
201 uint64_t fsmo_info;
202 struct GUID destination_dsa_guid;
205 #define DSDB_ACL_CHECKS_DIRSYNC_FLAG 0x1
206 #endif /* __SAMDB_H__ */