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

   1 /* $OpenLDAP$ */
   2 /*
   3  * Copyright 1999 The OpenLDAP Foundation, Redwood City, California, USA
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms are permitted only
   7  * as authorized by the OpenLDAP Public License.  A copy of this
   8  * license is available at http://www.OpenLDAP.org/license.html or
   9  * in file LICENSE in the top-level directory of the distribution.
  10  */
  11 /*
  12  * ldap-schema.h - Header for basic schema handling functions that can be
  13  *              used by both clients and servers.
  14  */
  15
  16 #ifndef _LDAP_SCHEMA_H
  17 #define _LDAP_SCHEMA_H 1
  18
  19 #include <ldap_cdefs.h>
  20
  21 LDAP_BEGIN_DECL
  22
  23 /* Codes for parsing errors */
  24
  25 #define LDAP_SCHERR_OUTOFMEM            1
  26 #define LDAP_SCHERR_UNEXPTOKEN          2
  27 #define LDAP_SCHERR_NOLEFTPAREN         3
  28 #define LDAP_SCHERR_NORIGHTPAREN        4
  29 #define LDAP_SCHERR_NODIGIT             5
  30 #define LDAP_SCHERR_BADNAME             6
  31 #define LDAP_SCHERR_BADDESC             7
  32 #define LDAP_SCHERR_BADSUP              8
  33 #define LDAP_SCHERR_DUPOPT              9
  34 #define LDAP_SCHERR_EMPTY               10
  35
  36 typedef struct ldap_syntax {
  37         char *syn_oid;          /* REQUIRED */
  38         char *syn_desc;         /* OPTIONAL */
  39 } LDAP_SYNTAX;
  40
  41 typedef struct ldap_matchingrule {
  42         char *mr_oid;           /* REQUIRED */
  43         char **mr_names;        /* OPTIONAL */
  44         char *mr_desc;          /* OPTIONAL */
  45         int  mr_obsolete;       /* OPTIONAL */
  46         char *mr_syntax_oid;    /* REQUIRED */
  47 } LDAP_MATCHING_RULE;
  48
  49 typedef struct ldap_attributetype {
  50         char *at_oid;           /* REQUIRED */
  51         char **at_names;        /* OPTIONAL */
  52         char *at_desc;          /* OPTIONAL */
  53         int  at_obsolete;       /* 0=no, 1=yes */
  54         char *at_sup_oid;       /* OPTIONAL */
  55         char *at_equality_oid;  /* OPTIONAL */
  56         char *at_ordering_oid;  /* OPTIONAL */
  57         char *at_substr_oid;    /* OPTIONAL */
  58         char *at_syntax_oid;    /* OPTIONAL */
  59         int  at_syntax_len;     /* OPTIONAL */
  60         int  at_single_value;   /* 0=no, 1=yes */
  61         int  at_collective;     /* 0=no, 1=yes */
  62         int  at_no_user_mod;    /* 0=no, 1=yes */
  63         int  at_usage;          /* 0=userApplications, 1=directoryOperation,
  64                                    2=distributedOperation, 3=dSAOperation */
  65 } LDAP_ATTRIBUTE_TYPE;
  66
  67 typedef struct ldap_objectclass {
  68         char *oc_oid;           /* REQUIRED */
  69         char **oc_names;        /* OPTIONAL */
  70         char *oc_desc;          /* OPTIONAL */
  71         int  oc_obsolete;       /* 0=no, 1=yes */
  72         char **oc_sup_oids;     /* OPTIONAL */
  73         int  oc_kind;           /* 0=ABSTRACT, 1=STRUCTURAL, 2=AUXILIARY */
  74         char **oc_at_oids_must; /* OPTIONAL */
  75         char **oc_at_oids_may;  /* OPTIONAL */
  76 } LDAP_OBJECT_CLASS;
  77
  78 #define LDAP_SCHEMA_NO                          0
  79 #define LDAP_SCHEMA_YES                         1
  80
  81 #define LDAP_SCHEMA_USER_APPLICATIONS           0
  82 #define LDAP_SCHEMA_DIRECTORY_OPERATION         1
  83 #define LDAP_SCHEMA_DISTRIBUTED_OPERATION       2
  84 #define LDAP_SCHEMA_DSA_OPERATION               3
  85
  86 #define LDAP_SCHEMA_ABSTRACT                    0
  87 #define LDAP_SCHEMA_STRUCTURAL                  1
  88 #define LDAP_SCHEMA_AUXILIARY                   2
  89
  90 LDAP_F( LDAP_CONST char * )
  91 ldap_syntax2name LDAP_P((
  92         LDAP_SYNTAX * syn ));
  93
  94 LDAP_F( LDAP_CONST char * )
  95 ldap_matchingrule2name LDAP_P((
  96         LDAP_MATCHING_RULE * mr ));
  97
  98 LDAP_F( LDAP_CONST char * )
  99 ldap_attributetype2name LDAP_P((
 100         LDAP_ATTRIBUTE_TYPE * at ));
 101
 102 LDAP_F( LDAP_CONST char * )
 103 ldap_objectclass2name LDAP_P((
 104         LDAP_OBJECT_CLASS * oc ));
 105
 106 LDAP_F( void )
 107 ldap_syntax_free LDAP_P((
 108         LDAP_SYNTAX * syn ));
 109
 110 LDAP_F( void )
 111 ldap_matchingrule_free LDAP_P((
 112         LDAP_MATCHING_RULE * mr ));
 113
 114 LDAP_F( void )
 115 ldap_attributetype_free LDAP_P((
 116         LDAP_ATTRIBUTE_TYPE * at ));
 117
 118 LDAP_F( void )
 119 ldap_objectclass_free LDAP_P((
 120         LDAP_OBJECT_CLASS * oc ));
 121
 122 LDAP_F( LDAP_OBJECT_CLASS * )
 123 ldap_str2objectclass LDAP_P((
 124         LDAP_CONST char * s,
 125         int * code,
 126         LDAP_CONST char ** errp ));
 127
 128 LDAP_F( LDAP_ATTRIBUTE_TYPE * )
 129 ldap_str2attributetype LDAP_P((
 130         LDAP_CONST char * s,
 131         int * code,
 132         LDAP_CONST char ** errp ));
 133
 134 LDAP_F( LDAP_SYNTAX * )
 135 ldap_str2syntax LDAP_P((
 136         LDAP_CONST char * s,
 137         int * code,
 138         LDAP_CONST char ** errp ));
 139
 140 LDAP_F( LDAP_MATCHING_RULE * )
 141 ldap_str2matchingrule LDAP_P((
 142         LDAP_CONST char * s,
 143         int * code,
 144         LDAP_CONST char ** errp ));
 145
 146 LDAP_F( char *)
 147 ldap_objectclass2str LDAP_P((
 148         LDAP_CONST LDAP_OBJECT_CLASS * oc ));
 149
 150 LDAP_F( char *)
 151 ldap_attributetype2str LDAP_P((
 152         LDAP_CONST LDAP_ATTRIBUTE_TYPE * at ));
 153
 154 LDAP_F( char *)
 155 ldap_syntax2str LDAP_P((
 156         LDAP_CONST LDAP_SYNTAX * syn ));
 157
 158 LDAP_F( char *)
 159 ldap_matchingrule2str LDAP_P((
 160         LDAP_CONST LDAP_MATCHING_RULE * mr ));
 161
 162 LDAP_F( char *)
 163 ldap_scherr2str LDAP_P((
 164         int code )) LDAP_GCCATTR((const));
 165
 166 LDAP_END_DECL
 167
 168 #endif
 169