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 struct tsocket_address;
  32 struct dsdb_trust_routing_table;
  33
  34 enum dsdb_password_checked {
  35         DSDB_PASSWORD_NOT_CHECKED = 0, /* unused */
  36         DSDB_PASSWORD_RESET,
  37         DSDB_PASSWORD_CHECKED_AND_CORRECT
  38 };
  39
  40 #include "librpc/gen_ndr/security.h"
  41 #include <ldb.h>
  42 #include "lib/ldb-samba/ldif_handlers.h"
  43 #include "librpc/gen_ndr/samr.h"
  44 #include "librpc/gen_ndr/drsuapi.h"
  45 #include "librpc/gen_ndr/drsblobs.h"
  46 #include "dsdb/schema/schema.h"
  47 #include "dsdb/samdb/samdb_proto.h"
  48 #include "dsdb/common/dsdb_dn.h"
  49 #include "dsdb/common/util_links.h"
  50 #include "dsdb/common/proto.h"
  51 #include "../libds/common/flags.h"
  52
  53 #define DSDB_CONTROL_CURRENT_PARTITION_OID "1.3.6.1.4.1.7165.4.3.2"
  54 struct dsdb_control_current_partition {
  55         /*
  56          * this is the version of the dsdb_control_current_partition
  57          * version 0: initial implementation
  58          * version 1: got rid of backend and module fields
  59          */
  60 #define DSDB_CONTROL_CURRENT_PARTITION_VERSION 1
  61         uint32_t version;
  62         struct ldb_dn *dn;
  63 };
  64
  65
  66 /*
  67   flags in dsdb_repl_flags to control replication logic
  68  */
  69 #define DSDB_REPL_FLAG_PRIORITISE_INCOMING 1
  70 #define DSDB_REPL_FLAG_PARTIAL_REPLICA     2
  71 #define DSDB_REPL_FLAG_ADD_NCNAME          4
  72 #define DSDB_REPL_FLAG_EXPECT_NO_SECRETS   8
  73 #define DSDB_REPL_FLAG_OBJECT_SUBSET       16
  74 #define DSDB_REPL_FLAG_TARGETS_UPTODATE    32
  75
  76 #define DSDB_CONTROL_REPLICATED_UPDATE_OID "1.3.6.1.4.1.7165.4.3.3"
  77
  78 #define DSDB_CONTROL_DN_STORAGE_FORMAT_OID "1.3.6.1.4.1.7165.4.3.4"
  79 /* DSDB_CONTROL_DN_STORAGE_FORMAT_OID has NULL data and behaves very
  80  * much like LDB_CONTROL_EXTENDED_DN_OID when the DB stores an
  81  * extended DN, and otherwise returns normal DNs */
  82
  83 #define DSDB_CONTROL_PASSWORD_CHANGE_STATUS_OID "1.3.6.1.4.1.7165.4.3.8"
  84
  85 struct dsdb_user_pwd_settings {
  86         uint32_t pwdProperties;
  87         uint32_t pwdHistoryLength;
  88         int64_t maxPwdAge;
  89         int64_t minPwdAge;
  90         uint32_t minPwdLength;
  91         bool store_cleartext;
  92         const char *netbios_domain;
  93         const char *dns_domain;
  94         const char *realm;
  95 };
  96
  97 struct dsdb_control_password_change_status {
  98         struct dsdb_user_pwd_settings domain_data;
  99         enum samPwdChangeReason reject_reason;
 100 };
 101
 102 #define DSDB_CONTROL_PASSWORD_HASH_VALUES_OID "1.3.6.1.4.1.7165.4.3.9"
 103
 104 #define DSDB_CONTROL_PASSWORD_CHANGE_OLD_PW_CHECKED_OID "1.3.6.1.4.1.7165.4.3.10"
 105 struct dsdb_control_password_change {
 106         enum dsdb_password_checked old_password_checked;
 107 };
 108
 109 /**
 110    DSDB_CONTROL_APPLY_LINKS is internal to Samba4 - a token passed between repl_meta_data and linked_attributes modules
 111 */
 112 #define DSDB_CONTROL_APPLY_LINKS "1.3.6.1.4.1.7165.4.3.11"
 113
 114 /*
 115  * this should only be used for importing users from Samba3
 116  */
 117 #define DSDB_CONTROL_BYPASS_PASSWORD_HASH_OID "1.3.6.1.4.1.7165.4.3.12"
 118
 119 /**
 120   OID used to allow the replacement of replPropertyMetaData.
 121   It is used when the current replmetadata needs to be edited.
 122 */
 123 #define DSDB_CONTROL_CHANGEREPLMETADATA_OID "1.3.6.1.4.1.7165.4.3.14"
 124
 125 /* passed when we want to get the behaviour of the non-global catalog port */
 126 #define DSDB_CONTROL_NO_GLOBAL_CATALOG "1.3.6.1.4.1.7165.4.3.17"
 127
 128 /* passed when we want special behaviour for partial replicas */
 129 #define DSDB_CONTROL_PARTIAL_REPLICA "1.3.6.1.4.1.7165.4.3.18"
 130
 131 /* passed when we want special behaviour for dbcheck */
 132 #define DSDB_CONTROL_DBCHECK "1.3.6.1.4.1.7165.4.3.19"
 133
 134 /* passed when dbcheck wants to modify a read only replica (very special case) */
 135 #define DSDB_CONTROL_DBCHECK_MODIFY_RO_REPLICA "1.3.6.1.4.1.7165.4.3.19.1"
 136
 137 /* passed by dbcheck to fix duplicate linked attributes (bug #13095) */
 138 #define DSDB_CONTROL_DBCHECK_FIX_DUPLICATE_LINKS "1.3.6.1.4.1.7165.4.3.19.2"
 139
 140 /* passed by dbcheck to fix the DN string of a one-way-link (bug #13495) */
 141 #define DSDB_CONTROL_DBCHECK_FIX_LINK_DN_NAME "1.3.6.1.4.1.7165.4.3.19.3"
 142
 143 /* passed by dbcheck to fix the DN SID of a one-way-link (bug #13418) */
 144 #define DSDB_CONTROL_DBCHECK_FIX_LINK_DN_SID "1.3.6.1.4.1.7165.4.3.19.4"
 145
 146 /* passed when importing plain text password on upgrades */
 147 #define DSDB_CONTROL_PASSWORD_BYPASS_LAST_SET_OID "1.3.6.1.4.1.7165.4.3.20"
 148
 149 /*
 150  * passed from the descriptor module in order to
 151  * store the recalucated nTSecurityDescriptor without
 152  * modifying the replPropertyMetaData.
 153  */
 154 #define DSDB_CONTROL_SEC_DESC_PROPAGATION_OID "1.3.6.1.4.1.7165.4.3.21"
 155
 156 /*
 157  * passed when creating a interdomain trust account through LSA
 158  * to relax constraints in the samldb ldb module.
 159  */
 160 #define DSDB_CONTROL_PERMIT_INTERDOMAIN_TRUST_UAC_OID "1.3.6.1.4.1.7165.4.3.23"
 161
 162 /*
 163  * Internal control to mark requests as being part of Tombstone restoring
 164  * procedure - it requires slightly special behavior like:
 165  *  - a bit different security checks
 166  *  - restoring certain attributes to their default values, etc
 167  */
 168 #define DSDB_CONTROL_RESTORE_TOMBSTONE_OID "1.3.6.1.4.1.7165.4.3.24"
 169
 170 /**
 171   OID used to allow the replacement of replPropertyMetaData.
 172   It is used when the current replmetadata needs only to be re-sorted, but not edited.
 173 */
 174 #define DSDB_CONTROL_CHANGEREPLMETADATA_RESORT_OID "1.3.6.1.4.1.7165.4.3.25"
 175
 176 /*
 177  * pass the default state of pwdLastSet between the "samldb" and "password_hash"
 178  * modules.
 179  */
 180 #define DSDB_CONTROL_PASSWORD_DEFAULT_LAST_SET_OID "1.3.6.1.4.1.7165.4.3.26"
 181
 182 /*
 183  * pass the userAccountControl changes between the "samldb" and "password_hash"
 184  * modules.
 185  */
 186 #define DSDB_CONTROL_PASSWORD_USER_ACCOUNT_CONTROL_OID "1.3.6.1.4.1.7165.4.3.27"
 187 struct dsdb_control_password_user_account_control {
 188         uint32_t req_flags; /* the flags given by the client request */
 189         uint32_t old_flags; /* the old flags stored (0 on add) */
 190         uint32_t new_flags; /* the new flags stored */
 191 };
 192
 193 /*
 194  * Ignores strict checking when adding objects to samldb.
 195  * This is used when provisioning, as checking all objects when added
 196  * was slow due to an unindexed search.
 197  */
 198 #define DSDB_CONTROL_SKIP_DUPLICATES_CHECK_OID "1.3.6.1.4.1.7165.4.3.28"
 199
 200 /* passed when we want to thoroughly delete linked attributes */
 201 #define DSDB_CONTROL_REPLMD_VANISH_LINKS "1.3.6.1.4.1.7165.4.3.29"
 202
 203 /*
 204  * lockoutTime is a replicated attribute, but must be modified before
 205  * connectivity occurs to allow password lockouts.
 206  */
 207 #define DSDB_CONTROL_FORCE_RODC_LOCAL_CHANGE "1.3.6.1.4.1.7165.4.3.31"
 208
 209 #define DSDB_CONTROL_INVALID_NOT_IMPLEMENTED "1.3.6.1.4.1.7165.4.3.32"
 210
 211 /*
 212  * Used to pass "user password change" vs "password reset" from the ACL to the
 213  * password_hash module, ensuring both modules treat the request identical.
 214  */
 215 #define DSDB_CONTROL_PASSWORD_ACL_VALIDATION_OID "1.3.6.1.4.1.7165.4.3.33"
 216 struct dsdb_control_password_acl_validation {
 217         bool pwd_reset;
 218 };
 219
 220 /*
 221  * Used to pass the current transaction identifier from the audit_log
 222  * module to group membership auditing module
 223  */
 224 #define DSDB_CONTROL_TRANSACTION_IDENTIFIER_OID "1.3.6.1.4.1.7165.4.3.34"
 225 struct dsdb_control_transaction_identifier {
 226         struct GUID transaction_guid;
 227 };
 228
 229 #define DSDB_EXTENDED_REPLICATED_OBJECTS_OID "1.3.6.1.4.1.7165.4.4.1"
 230 struct dsdb_extended_replicated_object {
 231         struct ldb_message *msg;
 232         struct GUID object_guid;
 233         struct GUID *parent_guid;
 234         const char *when_changed;
 235         struct replPropertyMetaDataBlob *meta_data;
 236
 237         /* Only used for internal processing in repl_meta_data */
 238         struct ldb_dn *last_known_parent;
 239         struct ldb_dn *local_parent_dn;
 240 };
 241
 242 /*
 243  * the schema_dn is passed as struct ldb_dn in
 244  * req->op.extended.data
 245  */
 246 #define DSDB_EXTENDED_SCHEMA_UPDATE_NOW_OID "1.3.6.1.4.1.7165.4.4.2"
 247
 248 struct dsdb_extended_replicated_objects {
 249         /*
 250          * this is the version of the dsdb_extended_replicated_objects
 251          * version 0: initial implementation
 252          */
 253 #define DSDB_EXTENDED_REPLICATED_OBJECTS_VERSION 3
 254         uint32_t version;
 255
 256         /* DSDB_REPL_FLAG_* flags */
 257         uint32_t dsdb_repl_flags;
 258
 259         struct ldb_dn *partition_dn;
 260
 261         const struct repsFromTo1 *source_dsa;
 262         const struct drsuapi_DsReplicaCursor2CtrEx *uptodateness_vector;
 263
 264         uint32_t num_objects;
 265         struct dsdb_extended_replicated_object *objects;
 266
 267         uint32_t linked_attributes_count;
 268         struct drsuapi_DsReplicaLinkedAttribute *linked_attributes;
 269
 270         WERROR error;
 271
 272         bool originating_updates;
 273 };
 274
 275 /* In ldb.h: LDB_EXTENDED_SEQUENCE_NUMBER 1.3.6.1.4.1.7165.4.4.3 */
 276
 277 #define DSDB_EXTENDED_CREATE_PARTITION_OID "1.3.6.1.4.1.7165.4.4.4"
 278 struct dsdb_create_partition_exop {
 279         struct ldb_dn *new_dn;
 280 };
 281
 282 /* this takes a struct dsdb_fsmo_extended_op */
 283 #define DSDB_EXTENDED_ALLOCATE_RID_POOL "1.3.6.1.4.1.7165.4.4.5"
 284
 285 struct dsdb_fsmo_extended_op {
 286         uint64_t fsmo_info;
 287         struct GUID destination_dsa_guid;
 288 };
 289
 290 #define DSDB_EXTENDED_SCHEMA_UPGRADE_IN_PROGRESS_OID "1.3.6.1.4.1.7165.4.4.6"
 291
 292 /*
 293  * passed from the descriptor module in order to
 294  * store the recalucated nTSecurityDescriptor without
 295  * modifying the replPropertyMetaData.
 296  */
 297 #define DSDB_EXTENDED_SEC_DESC_PROPAGATION_OID "1.3.6.1.4.1.7165.4.4.7"
 298 struct dsdb_extended_sec_desc_propagation_op {
 299         struct ldb_dn *nc_root;
 300         struct GUID guid;
 301         bool include_self;
 302         struct GUID parent_guid;
 303 };
 304
 305 /* this takes no data */
 306 #define DSDB_EXTENDED_CREATE_OWN_RID_SET "1.3.6.1.4.1.7165.4.4.8"
 307
 308 /* this takes a struct dsdb_extended_allocate_rid */
 309 #define DSDB_EXTENDED_ALLOCATE_RID "1.3.6.1.4.1.7165.4.4.9"
 310
 311 struct dsdb_extended_allocate_rid {
 312         uint32_t rid;
 313 };
 314
 315 #define DSDB_EXTENDED_SCHEMA_LOAD "1.3.6.1.4.1.7165.4.4.10"
 316
 317 #define DSDB_OPENLDAP_DEREFERENCE_CONTROL "1.3.6.1.4.1.4203.666.5.16"
 318
 319 struct dsdb_openldap_dereference {
 320         const char *source_attribute;
 321         const char **dereference_attribute;
 322 };
 323
 324 struct dsdb_openldap_dereference_control {
 325         struct dsdb_openldap_dereference **dereference;
 326 };
 327
 328 struct dsdb_openldap_dereference_result {
 329         const char *source_attribute;
 330         const char *dereferenced_dn;
 331         int num_attributes;
 332         struct ldb_message_element *attributes;
 333 };
 334
 335 struct dsdb_openldap_dereference_result_control {
 336         struct dsdb_openldap_dereference_result **attributes;
 337 };
 338
 339 struct samldb_msds_intid_persistant {
 340         uint32_t msds_intid;
 341 };
 342
 343 #define SAMLDB_MSDS_INTID_OPAQUE "SAMLDB_MSDS_INTID_OPAQUE"
 344
 345 #define DSDB_PARTITION_DN "@PARTITION"
 346 #define DSDB_PARTITION_ATTR "partition"
 347
 348 #define DSDB_EXTENDED_DN_STORE_FORMAT_OPAQUE_NAME "dsdb_extended_dn_store_format"
 349 struct dsdb_extended_dn_store_format {
 350         bool store_extended_dn_in_ldb;
 351 };
 352
 353 #define DSDB_OPAQUE_PARTITION_MODULE_MSG_OPAQUE_NAME "DSDB_OPAQUE_PARTITION_MODULE_MSG"
 354
 355 #define DSDB_ACL_CHECKS_DIRSYNC_FLAG 0x1
 356 #define DSDB_SAMDB_MINIMUM_ALLOWED_RID   1000
 357
 358 #define DSDB_METADATA_SCHEMA_SEQ_NUM    "SCHEMA_SEQ_NUM"
 359
 360 /*
 361  * must be in LDB_FLAG_INTERNAL_MASK
 362  * see also the values in lib/ldb/include/ldb_module.h
 363  */
 364 #define DSDB_FLAG_INTERNAL_FORCE_META_DATA 0x10000
 365
 366 #define SAMBA_COMPATIBLE_FEATURES_ATTR "compatibleFeatures"
 367 #define SAMBA_REQUIRED_FEATURES_ATTR "requiredFeatures"
 368 #define SAMBA_FEATURES_SUPPORTED_FLAG "@SAMBA_FEATURES_SUPPORTED"
 369
 370 #define SAMBA_SORTED_LINKS_FEATURE "sortedLinks"
 371 #define SAMBA_ENCRYPTED_SECRETS_FEATURE "encryptedSecrets"
 372 /*
 373  * lmdb level one feature is an experimental release with basic support
 374  * for lmdb database files, instead of tdb.
 375  * - Keys are limited to 511 bytes long so GUID indexes are required
 376  * - Currently only the:
 377  *     partition data files
 378  *   are in lmdb format.
 379  */
 380 #define SAMBA_LMDB_LEVEL_ONE_FEATURE "lmdbLevelOne"
 381
 382 #endif /* __SAMDB_H__ */