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