git.sur5r.net Git - openldap/blob - include/ldap_schema.h

   1 /* $OpenLDAP$ */
   2 /*
   3  * Copyright 1998-2001 The OpenLDAP Foundation, Redwood City, California, USA
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted only as authorized by the OpenLDAP
   8  * Public License.  A copy of this license is available at
   9  * http://www.OpenLDAP.org/license.html or in file LICENSE in the
  10  * top-level directory of the distribution.
  11  */
  12 /*
  13  * ldap-schema.h - Header for basic schema handling functions that can be
  14  *              used by both clients and servers.
  15  * these routines should be renamed ldap_x_...
  16  */
  17
  18 #ifndef _LDAP_SCHEMA_H
  19 #define _LDAP_SCHEMA_H 1
  20
  21 #include <ldap_cdefs.h>
  22
  23 LDAP_BEGIN_DECL
  24
  25 /* Codes for parsing errors */
  26
  27 #define LDAP_SCHERR_OUTOFMEM            1
  28 #define LDAP_SCHERR_UNEXPTOKEN          2
  29 #define LDAP_SCHERR_NOLEFTPAREN         3
  30 #define LDAP_SCHERR_NORIGHTPAREN        4
  31 #define LDAP_SCHERR_NODIGIT             5
  32 #define LDAP_SCHERR_BADNAME             6
  33 #define LDAP_SCHERR_BADDESC             7
  34 #define LDAP_SCHERR_BADSUP              8
  35 #define LDAP_SCHERR_DUPOPT              9
  36 #define LDAP_SCHERR_EMPTY               10
  37
  38 typedef struct ldap_schema_extension_item {
  39         char *lsei_name;
  40         char **lsei_values;
  41 } LDAPSchemaExtensionItem;
  42
  43 typedef struct ldap_syntax {
  44         char *syn_oid;          /* REQUIRED */
  45         char **syn_names;       /* OPTIONAL */
  46         char *syn_desc;         /* OPTIONAL */
  47         LDAPSchemaExtensionItem **syn_extensions; /* OPTIONAL */
  48 } LDAPSyntax;
  49
  50 typedef struct ldap_matchingrule {
  51         char *mr_oid;           /* REQUIRED */
  52         char **mr_names;        /* OPTIONAL */
  53         char *mr_desc;          /* OPTIONAL */
  54         int  mr_obsolete;       /* OPTIONAL */
  55         char *mr_syntax_oid;    /* REQUIRED */
  56         LDAPSchemaExtensionItem **mr_extensions; /* OPTIONAL */
  57 } LDAPMatchingRule;
  58
  59 typedef struct ldap_matchingruleuse {
  60         char *mru_oid;          /* REQUIRED */
  61         char **mru_names;       /* OPTIONAL */
  62         char *mru_desc;         /* OPTIONAL */
  63         int  mru_obsolete;      /* OPTIONAL */
  64         char **mru_applies_oids;        /* REQUIRED */
  65         LDAPSchemaExtensionItem **mru_extensions; /* OPTIONAL */
  66 } LDAPMatchingRuleUse;
  67
  68 typedef struct ldap_attributetype {
  69         char *at_oid;           /* REQUIRED */
  70         char **at_names;        /* OPTIONAL */
  71         char *at_desc;          /* OPTIONAL */
  72         int  at_obsolete;       /* 0=no, 1=yes */
  73         char *at_sup_oid;       /* OPTIONAL */
  74         char *at_equality_oid;  /* OPTIONAL */
  75         char *at_ordering_oid;  /* OPTIONAL */
  76         char *at_substr_oid;    /* OPTIONAL */
  77         char *at_syntax_oid;    /* OPTIONAL */
  78         int  at_syntax_len;     /* OPTIONAL */
  79         int  at_single_value;   /* 0=no, 1=yes */
  80         int  at_collective;     /* 0=no, 1=yes */
  81         int  at_no_user_mod;    /* 0=no, 1=yes */
  82         int  at_usage;          /* 0=userApplications, 1=directoryOperation,
  83                                    2=distributedOperation, 3=dSAOperation */
  84         LDAPSchemaExtensionItem **at_extensions; /* OPTIONAL */
  85 } LDAPAttributeType;
  86
  87 typedef struct ldap_objectclass {
  88         char *oc_oid;           /* REQUIRED */
  89         char **oc_names;        /* OPTIONAL */
  90         char *oc_desc;          /* OPTIONAL */
  91         int  oc_obsolete;       /* 0=no, 1=yes */
  92         char **oc_sup_oids;     /* OPTIONAL */
  93         int  oc_kind;           /* 0=ABSTRACT, 1=STRUCTURAL, 2=AUXILIARY */
  94         char **oc_at_oids_must; /* OPTIONAL */
  95         char **oc_at_oids_may;  /* OPTIONAL */
  96         LDAPSchemaExtensionItem **oc_extensions; /* OPTIONAL */
  97 } LDAPObjectClass;
  98
  99 #define LDAP_SCHEMA_NO                          0
 100 #define LDAP_SCHEMA_YES                         1
 101
 102 #define LDAP_SCHEMA_USER_APPLICATIONS           0
 103 #define LDAP_SCHEMA_DIRECTORY_OPERATION         1
 104 #define LDAP_SCHEMA_DISTRIBUTED_OPERATION       2
 105 #define LDAP_SCHEMA_DSA_OPERATION               3
 106
 107 #define LDAP_SCHEMA_ABSTRACT                    0
 108 #define LDAP_SCHEMA_STRUCTURAL                  1
 109 #define LDAP_SCHEMA_AUXILIARY                   2
 110
 111 /*
 112  * Flags that control how liberal the parsing routines are.
 113  */
 114 #define LDAP_SCHEMA_ALLOW_NONE          0x00 /* Strict parsing               */
 115 #define LDAP_SCHEMA_ALLOW_NO_OID        0x01 /* Allow missing oid            */
 116 #define LDAP_SCHEMA_ALLOW_QUOTED        0x02 /* Allow bogus extra quotes     */
 117 #define LDAP_SCHEMA_ALLOW_DESCR         0x04 /* Allow descr instead of OID   */
 118 #define LDAP_SCHEMA_ALLOW_DESCR_PREFIX  0x08 /* Allow descr as OID prefix    */
 119 #define LDAP_SCHEMA_ALLOW_ALL           0x0f /* Be very liberal in parsing   */
 120
 121 LDAP_F( LDAP_CONST char * )
 122 ldap_syntax2name LDAP_P((
 123         LDAPSyntax * syn ));
 124
 125 LDAP_F( LDAP_CONST char * )
 126 ldap_matchingrule2name LDAP_P((
 127         LDAPMatchingRule * mr ));
 128
 129 LDAP_F( LDAP_CONST char * )
 130 ldap_matchingruleuse2name LDAP_P((
 131         LDAPMatchingRuleUse * mru ));
 132
 133 LDAP_F( LDAP_CONST char * )
 134 ldap_attributetype2name LDAP_P((
 135         LDAPAttributeType * at ));
 136
 137 LDAP_F( LDAP_CONST char * )
 138 ldap_objectclass2name LDAP_P((
 139         LDAPObjectClass * oc ));
 140
 141 LDAP_F( void )
 142 ldap_syntax_free LDAP_P((
 143         LDAPSyntax * syn ));
 144
 145 LDAP_F( void )
 146 ldap_matchingrule_free LDAP_P((
 147         LDAPMatchingRule * mr ));
 148
 149 LDAP_F( void )
 150 ldap_matchingruleuse_free LDAP_P((
 151         LDAPMatchingRuleUse * mr ));
 152
 153 LDAP_F( void )
 154 ldap_attributetype_free LDAP_P((
 155         LDAPAttributeType * at ));
 156
 157 LDAP_F( void )
 158 ldap_objectclass_free LDAP_P((
 159         LDAPObjectClass * oc ));
 160
 161 LDAP_F( LDAPObjectClass * )
 162 ldap_str2objectclass LDAP_P((
 163         LDAP_CONST char * s,
 164         int * code,
 165         LDAP_CONST char ** errp,
 166         LDAP_CONST int flags ));
 167
 168 LDAP_F( LDAPAttributeType * )
 169 ldap_str2attributetype LDAP_P((
 170         LDAP_CONST char * s,
 171         int * code,
 172         LDAP_CONST char ** errp,
 173         LDAP_CONST int flags ));
 174
 175 LDAP_F( LDAPSyntax * )
 176 ldap_str2syntax LDAP_P((
 177         LDAP_CONST char * s,
 178         int * code,
 179         LDAP_CONST char ** errp,
 180         LDAP_CONST int flags ));
 181
 182 LDAP_F( LDAPMatchingRule * )
 183 ldap_str2matchingrule LDAP_P((
 184         LDAP_CONST char * s,
 185         int * code,
 186         LDAP_CONST char ** errp,
 187         LDAP_CONST int flags ));
 188
 189 LDAP_F( LDAPMatchingRuleUse * )
 190 ldap_str2matchingruleuse LDAP_P((
 191         LDAP_CONST char * s,
 192         int * code,
 193         LDAP_CONST char ** errp,
 194         LDAP_CONST int flags ));
 195
 196 LDAP_F( char * )
 197 ldap_objectclass2str LDAP_P((
 198         LDAP_CONST LDAPObjectClass * oc ));
 199
 200 LDAP_F( char * )
 201 ldap_attributetype2str LDAP_P((
 202         LDAP_CONST LDAPAttributeType * at ));
 203
 204 LDAP_F( char * )
 205 ldap_syntax2str LDAP_P((
 206         LDAP_CONST LDAPSyntax * syn ));
 207
 208 LDAP_F( char * )
 209 ldap_matchingrule2str LDAP_P((
 210         LDAP_CONST LDAPMatchingRule * mr ));
 211
 212 LDAP_F( char * )
 213 ldap_matchingruleuse2str LDAP_P((
 214         LDAP_CONST LDAPMatchingRuleUse * mru ));
 215
 216 LDAP_F( char * )
 217 ldap_scherr2str LDAP_P((
 218         int code )) LDAP_GCCATTR((const));
 219
 220 LDAP_END_DECL
 221
 222 #endif
 223