source4/dsdb/schema/schema.h

   1 /*
   2    Unix SMB/CIFS mplementation.
   3    DSDB schema header
   4
   5    Copyright (C) Stefan Metzmacher <metze@samba.org> 2006
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20 */
  21
  22 #ifndef _DSDB_SCHEMA_H
  23 #define _DSDB_SCHEMA_H
  24
  25 #include "prefixmap.h"
  26
  27 struct dsdb_attribute;
  28 struct dsdb_class;
  29 struct dsdb_schema;
  30
  31 struct dsdb_syntax_ctx {
  32         struct ldb_context *ldb;
  33         const struct dsdb_schema *schema;
  34 };
  35
  36
  37 struct dsdb_syntax {
  38         const char *name;
  39         const char *ldap_oid;
  40         uint32_t oMSyntax;
  41         struct ldb_val oMObjectClass;
  42         const char *attributeSyntax_oid;
  43         const char *equality;
  44         const char *substring;
  45         const char *comment;
  46         const char *ldb_syntax;
  47
  48         WERROR (*drsuapi_to_ldb)(struct ldb_context *ldb,
  49                                  const struct dsdb_schema *schema,
  50                                  const struct dsdb_attribute *attr,
  51                                  const struct drsuapi_DsReplicaAttribute *in,
  52                                  TALLOC_CTX *mem_ctx,
  53                                  struct ldb_message_element *out);
  54         WERROR (*ldb_to_drsuapi)(const struct dsdb_syntax_ctx *ctx,
  55                                  const struct dsdb_attribute *attr,
  56                                  const struct ldb_message_element *in,
  57                                  TALLOC_CTX *mem_ctx,
  58                                  struct drsuapi_DsReplicaAttribute *out);
  59         WERROR (*validate_ldb)(const struct dsdb_syntax_ctx *ctx,
  60                                const struct dsdb_attribute *attr,
  61                                const struct ldb_message_element *in);
  62 };
  63
  64 struct dsdb_attribute {
  65         struct dsdb_attribute *prev, *next;
  66
  67         const char *cn;
  68         const char *lDAPDisplayName;
  69         const char *attributeID_oid;
  70         uint32_t attributeID_id;
  71         struct GUID schemaIDGUID;
  72         uint32_t mAPIID;
  73         uint32_t msDS_IntId;
  74
  75         struct GUID attributeSecurityGUID;
  76         struct GUID objectGUID;
  77
  78         uint32_t searchFlags;
  79         uint32_t systemFlags;
  80         bool isMemberOfPartialAttributeSet;
  81         uint32_t linkID;
  82
  83         const char *attributeSyntax_oid;
  84         uint32_t attributeSyntax_id;
  85         uint32_t oMSyntax;
  86         struct ldb_val oMObjectClass;
  87
  88         bool isSingleValued;
  89         uint32_t *rangeLower;
  90         uint32_t *rangeUpper;
  91         bool extendedCharsAllowed;
  92
  93         uint32_t schemaFlagsEx;
  94         struct ldb_val msDs_Schema_Extensions;
  95
  96         bool showInAdvancedViewOnly;
  97         const char *adminDisplayName;
  98         const char *adminDescription;
  99         const char *classDisplayName;
 100         bool isEphemeral;
 101         bool isDefunct;
 102         bool systemOnly;
 103
 104         /* internal stuff */
 105         const struct dsdb_syntax *syntax;
 106         const struct ldb_schema_attribute *ldb_schema_attribute;
 107 };
 108
 109 struct dsdb_class {
 110         struct dsdb_class *prev, *next;
 111
 112         const char *cn;
 113         const char *lDAPDisplayName;
 114         const char *governsID_oid;
 115         uint32_t governsID_id;
 116         struct GUID schemaIDGUID;
 117         struct GUID objectGUID;
 118
 119         uint32_t objectClassCategory;
 120         const char *rDNAttID;
 121         const char *defaultObjectCategory;
 122
 123         const char *subClassOf;
 124
 125         const char **systemAuxiliaryClass;
 126         const char **systemPossSuperiors;
 127         const char **systemMustContain;
 128         const char **systemMayContain;
 129
 130         const char **auxiliaryClass;
 131         const char **possSuperiors;
 132         const char **mustContain;
 133         const char **mayContain;
 134         const char **possibleInferiors;
 135         const char **systemPossibleInferiors;
 136
 137         const char *defaultSecurityDescriptor;
 138
 139         uint32_t schemaFlagsEx;
 140         struct ldb_val msDs_Schema_Extensions;
 141
 142         bool showInAdvancedViewOnly;
 143         const char *adminDisplayName;
 144         const char *adminDescription;
 145         const char *classDisplayName;
 146         bool defaultHidingValue;
 147         bool isDefunct;
 148         bool systemOnly;
 149
 150         const char **supclasses;
 151         const char **subclasses;
 152         const char **subclasses_direct;
 153         const char **posssuperiors;
 154         uint32_t subClassOf_id;
 155         uint32_t *systemAuxiliaryClass_ids;
 156         uint32_t *auxiliaryClass_ids;
 157         uint32_t *systemMayContain_ids;
 158         uint32_t *systemMustContain_ids;
 159         uint32_t *possSuperiors_ids;
 160         uint32_t *mustContain_ids;
 161         uint32_t *mayContain_ids;
 162         uint32_t *systemPossSuperiors_ids;
 163
 164         /* An ordered index showing how this subClass fits into the
 165          * subClass tree.  that is, an objectclass that is not
 166          * subClassOf anything is 0 (just in case), and top is 1, and
 167          * subClasses of top are 2, subclasses of those classes are
 168          * 3 */
 169         uint32_t subClass_order;
 170 };
 171
 172 /**
 173  * data stored in schemaInfo attribute
 174  */
 175 struct dsdb_schema_info {
 176         uint32_t        revision;
 177         struct GUID     invocation_id;
 178 };
 179
 180
 181 struct dsdb_schema {
 182         struct ldb_dn *base_dn;
 183
 184         struct dsdb_schema_prefixmap *prefixmap;
 185
 186         /*
 187          * the last element of the prefix mapping table isn't a oid,
 188          * it starts with 0xFF and has 21 bytes and is maybe a schema
 189          * version number
 190          *
 191          * this is the content of the schemaInfo attribute of the
 192          * Schema-Partition head object.
 193          */
 194         const char *schema_info;
 195
 196         /* We can also tell the schema version from the USN on the partition */
 197         uint64_t loaded_usn;
 198
 199         struct dsdb_attribute *attributes;
 200         struct dsdb_class *classes;
 201
 202         /* lists of classes sorted by various attributes, for faster
 203            access */
 204         uint32_t num_classes;
 205         struct dsdb_class **classes_by_lDAPDisplayName;
 206         struct dsdb_class **classes_by_governsID_id;
 207         struct dsdb_class **classes_by_governsID_oid;
 208         struct dsdb_class **classes_by_cn;
 209
 210         /* lists of attributes sorted by various fields */
 211         uint32_t num_attributes;
 212         struct dsdb_attribute **attributes_by_lDAPDisplayName;
 213         struct dsdb_attribute **attributes_by_attributeID_id;
 214         struct dsdb_attribute **attributes_by_attributeID_oid;
 215         struct dsdb_attribute **attributes_by_linkID;
 216         uint32_t num_int_id_attr;
 217         struct dsdb_attribute **attributes_by_msDS_IntId;
 218
 219         struct {
 220                 bool we_are_master;
 221                 struct ldb_dn *master_dn;
 222         } fsmo;
 223
 224         /* Was this schema loaded from ldb (if so, then we will reload it when we detect a change in ldb) */
 225         struct ldb_module *loaded_from_module;
 226         struct dsdb_schema *(*refresh_fn)(struct ldb_module *module, struct dsdb_schema *schema, bool is_global_schema);
 227         bool refresh_in_progress;
 228         /* an 'opaque' sequence number that the reload function may also wish to use */
 229         uint64_t reload_seq_number;
 230
 231         /* Should the syntax handlers in this case handle all incoming OIDs automatically, assigning them as an OID if no text name is known? */
 232         bool relax_OID_conversions;
 233 };
 234
 235 enum dsdb_attr_list_query {
 236         DSDB_SCHEMA_ALL_MAY,
 237         DSDB_SCHEMA_ALL_MUST,
 238         DSDB_SCHEMA_SYS_MAY,
 239         DSDB_SCHEMA_SYS_MUST,
 240         DSDB_SCHEMA_MAY,
 241         DSDB_SCHEMA_MUST,
 242         DSDB_SCHEMA_ALL
 243 };
 244
 245 enum dsdb_schema_convert_target {
 246         TARGET_OPENLDAP,
 247         TARGET_FEDORA_DS,
 248         TARGET_AD_SCHEMA_SUBENTRY
 249 };
 250
 251 #include "dsdb/schema/proto.h"
 252
 253 #endif /* _DSDB_SCHEMA_H */