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
  69 #define DSDB_CONTROL_REPLICATED_UPDATE_OID "1.3.6.1.4.1.7165.4.3.3"
  70
  71 #define DSDB_CONTROL_DN_STORAGE_FORMAT_OID "1.3.6.1.4.1.7165.4.3.4"
  72 /* DSDB_CONTROL_DN_STORAGE_FORMAT_OID has NULL data and behaves very
  73  * much like LDB_CONTROL_EXTENDED_DN_OID when the DB stores an
  74  * extended DN, and otherwise returns normal DNs */
  75
  76 #define DSDB_CONTROL_PASSWORD_CHANGE_STATUS_OID "1.3.6.1.4.1.7165.4.3.8"
  77
  78 struct dsdb_control_password_change_status {
  79         struct {
  80                 uint32_t pwdProperties;
  81                 uint32_t pwdHistoryLength;
  82                 int64_t maxPwdAge;
  83                 int64_t minPwdAge;
  84                 uint32_t minPwdLength;
  85                 bool store_cleartext;
  86                 const char *netbios_domain;
  87                 const char *dns_domain;
  88                 const char *realm;
  89         } domain_data;
  90         enum samPwdChangeReason reject_reason;
  91 };
  92
  93 #define DSDB_CONTROL_PASSWORD_HASH_VALUES_OID "1.3.6.1.4.1.7165.4.3.9"
  94
  95 #define DSDB_CONTROL_PASSWORD_CHANGE_OID "1.3.6.1.4.1.7165.4.3.10"
  96 struct dsdb_control_password_change {
  97         const struct samr_Password *old_nt_pwd_hash;
  98         const struct samr_Password *old_lm_pwd_hash;
  99 };
 100
 101 /**
 102    DSDB_CONTROL_APPLY_LINKS is internal to Samba4 - a token passed between repl_meta_data and linked_attributes modules
 103 */
 104 #define DSDB_CONTROL_APPLY_LINKS "1.3.6.1.4.1.7165.4.3.11"
 105
 106 /*
 107  * this should only be used for importing users from Samba3
 108  */
 109 #define DSDB_CONTROL_BYPASS_PASSWORD_HASH_OID "1.3.6.1.4.1.7165.4.3.12"
 110
 111 /**
 112   OID used to allow the replacement of replPropertyMetaData.
 113   It is used when the current replmetadata needs to be edited.
 114 */
 115 #define DSDB_CONTROL_CHANGEREPLMETADATA_OID "1.3.6.1.4.1.7165.4.3.14"
 116
 117 /* passed when we want to get the behaviour of the non-global catalog port */
 118 #define DSDB_CONTROL_NO_GLOBAL_CATALOG "1.3.6.1.4.1.7165.4.3.17"
 119
 120 /* passed when we want special behaviour for partial replicas */
 121 #define DSDB_CONTROL_PARTIAL_REPLICA "1.3.6.1.4.1.7165.4.3.18"
 122
 123 /* passed when we want special behaviour for dbcheck */
 124 #define DSDB_CONTROL_DBCHECK "1.3.6.1.4.1.7165.4.3.19"
 125
 126 /* passed when dbcheck wants to modify a read only replica (very special case) */
 127 #define DSDB_CONTROL_DBCHECK_MODIFY_RO_REPLICA "1.3.6.1.4.1.7165.4.3.19.1"
 128
 129 /* passed when importing plain text password on upgrades */
 130 #define DSDB_CONTROL_PASSWORD_BYPASS_LAST_SET_OID "1.3.6.1.4.1.7165.4.3.20"
 131
 132 /*
 133  * passed from the descriptor module in order to
 134  * store the recalucated nTSecurityDescriptor without
 135  * modifying the replPropertyMetaData.
 136  */
 137 #define DSDB_CONTROL_SEC_DESC_PROPAGATION_OID "1.3.6.1.4.1.7165.4.3.21"
 138
 139 /*
 140  * passed when creating a interdomain trust account through LSA
 141  * to relax constraints in the samldb ldb module.
 142  */
 143 #define DSDB_CONTROL_PERMIT_INTERDOMAIN_TRUST_UAC_OID "1.3.6.1.4.1.7165.4.3.23"
 144
 145 /*
 146  * Internal control to mark requests as being part of Tombstone restoring
 147  * procedure - it requires slightly special behavior like:
 148  *  - a bit different security checks
 149  *  - restoring certain attributes to their default values, etc
 150  */
 151 #define DSDB_CONTROL_RESTORE_TOMBSTONE_OID "1.3.6.1.4.1.7165.4.3.24"
 152
 153 /**
 154   OID used to allow the replacement of replPropertyMetaData.
 155   It is used when the current replmetadata needs only to be re-sorted, but not edited.
 156 */
 157 #define DSDB_CONTROL_CHANGEREPLMETADATA_RESORT_OID "1.3.6.1.4.1.7165.4.3.25"
 158
 159 /*
 160  * pass the default state of pwdLastSet between the "samldb" and "password_hash"
 161  * modules.
 162  */
 163 #define DSDB_CONTROL_PASSWORD_DEFAULT_LAST_SET_OID "1.3.6.1.4.1.7165.4.3.26"
 164
 165 /*
 166  * pass the userAccountControl changes between the "samldb" and "password_hash"
 167  * modules.
 168  */
 169 #define DSDB_CONTROL_PASSWORD_USER_ACCOUNT_CONTROL_OID "1.3.6.1.4.1.7165.4.3.27"
 170 struct dsdb_control_password_user_account_control {
 171         uint32_t req_flags; /* the flags given by the client request */
 172         uint32_t old_flags; /* the old flags stored (0 on add) */
 173         uint32_t new_flags; /* the new flags stored */
 174 };
 175
 176 /*
 177  * Ignores strict checking when adding objects to samldb.
 178  * This is used when provisioning, as checking all objects when added
 179  * was slow due to an unindexed search.
 180  */
 181 #define DSDB_CONTROL_SKIP_DUPLICATES_CHECK_OID "1.3.6.1.4.1.7165.4.3.28"
 182
 183 /* passed when we want to thoroughly delete linked attributes */
 184 #define DSDB_CONTROL_REPLMD_VANISH_LINKS "1.3.6.1.4.1.7165.4.3.29"
 185
 186 /*
 187  * lockoutTime is a replicated attribute, but must be modified before
 188  * connectivity occurs to allow password lockouts.
 189  */
 190 #define DSDB_CONTROL_FORCE_RODC_LOCAL_CHANGE "1.3.6.1.4.1.7165.4.3.31"
 191
 192 #define DSDB_CONTROL_INVALID_NOT_IMPLEMENTED "1.3.6.1.4.1.7165.4.3.32"
 193
 194 #define DSDB_EXTENDED_REPLICATED_OBJECTS_OID "1.3.6.1.4.1.7165.4.4.1"
 195 struct dsdb_extended_replicated_object {
 196         struct ldb_message *msg;
 197         struct GUID object_guid;
 198         struct GUID *parent_guid;
 199         const char *when_changed;
 200         struct replPropertyMetaDataBlob *meta_data;
 201
 202         /* Only used for internal processing in repl_meta_data */
 203         struct ldb_dn *last_known_parent;
 204         struct ldb_dn *local_parent_dn;
 205 };
 206
 207 struct dsdb_extended_replicated_objects {
 208         /*
 209          * this is the version of the dsdb_extended_replicated_objects
 210          * version 0: initial implementation
 211          */
 212 #define DSDB_EXTENDED_REPLICATED_OBJECTS_VERSION 3
 213         uint32_t version;
 214
 215         /* DSDB_REPL_FLAG_* flags */
 216         uint32_t dsdb_repl_flags;
 217
 218         struct ldb_dn *partition_dn;
 219
 220         const struct repsFromTo1 *source_dsa;
 221         const struct drsuapi_DsReplicaCursor2CtrEx *uptodateness_vector;
 222
 223         uint32_t num_objects;
 224         struct dsdb_extended_replicated_object *objects;
 225
 226         uint32_t linked_attributes_count;
 227         struct drsuapi_DsReplicaLinkedAttribute *linked_attributes;
 228
 229         WERROR error;
 230
 231         bool originating_updates;
 232 };
 233
 234 #define DSDB_EXTENDED_CREATE_PARTITION_OID "1.3.6.1.4.1.7165.4.4.4"
 235 struct dsdb_create_partition_exop {
 236         struct ldb_dn *new_dn;
 237 };
 238
 239 /*
 240  * the schema_dn is passed as struct ldb_dn in
 241  * req->op.extended.data
 242  */
 243 #define DSDB_EXTENDED_SCHEMA_UPDATE_NOW_OID "1.3.6.1.4.1.7165.4.4.2"
 244
 245 #define DSDB_EXTENDED_SCHEMA_UPGRADE_IN_PROGRESS_OID "1.3.6.1.4.1.7165.4.4.6"
 246
 247 #define DSDB_OPENLDAP_DEREFERENCE_CONTROL "1.3.6.1.4.1.4203.666.5.16"
 248
 249 struct dsdb_openldap_dereference {
 250         const char *source_attribute;
 251         const char **dereference_attribute;
 252 };
 253
 254 struct dsdb_openldap_dereference_control {
 255         struct dsdb_openldap_dereference **dereference;
 256 };
 257
 258 struct dsdb_openldap_dereference_result {
 259         const char *source_attribute;
 260         const char *dereferenced_dn;
 261         int num_attributes;
 262         struct ldb_message_element *attributes;
 263 };
 264
 265 struct dsdb_openldap_dereference_result_control {
 266         struct dsdb_openldap_dereference_result **attributes;
 267 };
 268
 269 struct samldb_msds_intid_persistant {
 270         uint32_t msds_intid;
 271 };
 272
 273 #define SAMLDB_MSDS_INTID_OPAQUE "SAMLDB_MSDS_INTID_OPAQUE"
 274
 275 #define DSDB_PARTITION_DN "@PARTITION"
 276 #define DSDB_PARTITION_ATTR "partition"
 277
 278 #define DSDB_EXTENDED_DN_STORE_FORMAT_OPAQUE_NAME "dsdb_extended_dn_store_format"
 279 struct dsdb_extended_dn_store_format {
 280         bool store_extended_dn_in_ldb;
 281 };
 282
 283 #define DSDB_OPAQUE_PARTITION_MODULE_MSG_OPAQUE_NAME "DSDB_OPAQUE_PARTITION_MODULE_MSG"
 284
 285 /* this takes a struct dsdb_fsmo_extended_op */
 286 #define DSDB_EXTENDED_ALLOCATE_RID_POOL "1.3.6.1.4.1.7165.4.4.5"
 287
 288 struct dsdb_fsmo_extended_op {
 289         uint64_t fsmo_info;
 290         struct GUID destination_dsa_guid;
 291 };
 292
 293 /* this takes no data */
 294 #define DSDB_EXTENDED_CREATE_OWN_RID_SET "1.3.6.1.4.1.7165.4.4.8"
 295
 296 /* this takes a struct dsdb_extended_allocate_rid */
 297 #define DSDB_EXTENDED_ALLOCATE_RID "1.3.6.1.4.1.7165.4.4.9"
 298
 299 struct dsdb_extended_allocate_rid {
 300         uint32_t rid;
 301 };
 302
 303 /*
 304  * passed from the descriptor module in order to
 305  * store the recalucated nTSecurityDescriptor without
 306  * modifying the replPropertyMetaData.
 307  */
 308 #define DSDB_EXTENDED_SEC_DESC_PROPAGATION_OID "1.3.6.1.4.1.7165.4.4.7"
 309 struct dsdb_extended_sec_desc_propagation_op {
 310         struct ldb_dn *nc_root;
 311         struct ldb_dn *dn;
 312         bool include_self;
 313 };
 314
 315 #define DSDB_ACL_CHECKS_DIRSYNC_FLAG 0x1
 316 #define DSDB_SAMDB_MINIMUM_ALLOWED_RID   1000
 317
 318 #define DSDB_METADATA_SCHEMA_SEQ_NUM    "SCHEMA_SEQ_NUM"
 319
 320 /*
 321  * must be in LDB_FLAG_INTERNAL_MASK
 322  * see also the values in lib/ldb/include/ldb_module.h
 323  */
 324 #define DSDB_FLAG_INTERNAL_FORCE_META_DATA 0x10000
 325
 326 #define SAMBA_COMPATIBLE_FEATURES_ATTR "compatibleFeatures"
 327 #define SAMBA_REQUIRED_FEATURES_ATTR "requiredFeatures"
 328 #define SAMBA_FEATURES_SUPPORTED_FLAG "@SAMBA_FEATURES_SUPPORTED"
 329
 330 #define SAMBA_SORTED_LINKS_FEATURE "sortedLinks"
 331
 332 #endif /* __SAMDB_H__ */