aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/lib/libldapschema/libldapschema.h
blob: 43f54fd0831cfa197f334761aa1c3bd3490a7ac5 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
/*
 *  LDAP Utilities
 *  Copyright (C) 2012, 2019 David M. Syzdek <david@syzdek.net>.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are
 *  met:
 *
 *     1. Redistributions of source code must retain the above copyright
 *        notice, this list of conditions and the following disclaimer.
 *
 *     2. Redistributions in binary form must reproduce the above copyright
 *        notice, this list of conditions and the following disclaimer in the
 *        documentation and/or other materials provided with the distribution.
 *
 *     3. Neither the name of the copyright holder nor the names of its
 *        contributors may be used to endorse or promote products derived from
 *        this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 *  IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 *  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 *  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 *  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 *  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 *  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 *  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
/**
 *  @file lib/libldapschema/libldapschema.h  contains shared functions and variables
 */
#ifndef _LIB_LIBLDAPSCHEMA_H
#define _LIB_LIBLDAPSCHEMA_H 1


///////////////
//           //
//  Headers  //
//           //
///////////////
#pragma mark - Functions

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <assert.h>

#define LDAP_DEPRECATED 1
#include <ldap.h>
#include <ldapschema.h>


///////////////////
//               //
//  Definitions  //
//               //
///////////////////
#pragma mark - Definitions


/////////////////
//             //
//  Datatypes  //
//             //
/////////////////
#pragma mark - Datatypes

/// LDAP schema descriptor state
struct ldap_schema
{
   int32_t                                errcode;          ///< last error code
   int32_t                                pad32;
   size_t                                 objerrs_len;      ///< number of objects with errors
   LDAPSchemaPointer *                    objerrs;          ///< objects with errors
   LDAPSchemaPointer *                    dups;             ///< array of duplicate oids
   size_t                                 dups_len;         ///< length of duplicate array
   LDAPSchemaPointer *                    oids;             ///< array of all known oids
   size_t                                 oids_len;         ///< length of oids array
   LDAPSchemaAlias **                     syntaxes;         ///< array of syntaxes
   size_t                                 syntaxes_len;     ///< length of syntaxes array
   LDAPSchemaAlias **                     attrs;            ///< array of attributeTypes
   size_t                                 attrs_len;        ///< length of attributeTypes array
   LDAPSchemaAlias **                     mtchngrls;        ///< array of objectClasses
   size_t                                 mtchngrls_len;    ///< length of objectClasses array
   LDAPSchemaAlias **                     objclses;         ///< array of objectClasses
   size_t                                 objclses_len;     ///< length of objectClasses array
   char **                                schema_errs;      ///< list of schema errors discovered
};


/// tracks progress of queries
struct ldapschema_cursor
{
   size_t                                 cursor;
};


/// LDAP schema extension
struct ldap_schema_extension
{
   char *                                 extension;
   char **                                values;
   size_t                                 values_len;
};


/// LDAP schema base data model
struct ldap_schema_model
{
   size_t                                 size;             ///< size of data struct
   uint32_t                               type;             ///< LDAP schema data type
   uint32_t                               flags;
   char  *                                definition;       ///< defintion of object
   char  *                                oid;              ///< oid of object
   char  *                                desc;             ///< description of object;
   const LDAPSchemaSpec *                 spec;
   LDAPSchemaExtension  **                extensions;
   size_t                                 extensions_len;
   char **                                errors;
};


/// LDAP schema object alias
struct ldap_schema_alias
{
   const char *                           alias;
   union
   {
      LDAPSchemaModel *                   model;
      LDAPSchemaObjectclass *             objectclass;
      LDAPSchemaAttributeType *           attributetype;
      LDAPSchemaMatchingRule *            matchingrule;
      LDAPSchemaSyntax *                  syntax;
   };
};


/// LDAP schema attributeType
struct ldap_schema_attributetype
{
   LDAPSchemaModel                        model;
   LDAPSchemaSyntax *                     syntax;
   uint64_t                               usage;
   size_t                                 names_len;
   size_t                                 allowed_by_len;
   size_t                                 required_by_len;
   size_t                                 min_upper;
   LDAPSchemaAttributeType *              sup;
   char *                                 sup_name;
   LDAPSchemaMatchingRule *               equality;
   LDAPSchemaMatchingRule *               ordering;
   LDAPSchemaMatchingRule *               substr;
   char **                                names;
   LDAPSchemaObjectclass **               allowed_by;
   LDAPSchemaObjectclass **               required_by;
};


/// LDAP schema objectclass
struct ldap_schema_objectclass
{
   LDAPSchemaModel                        model;
   uint64_t                               kind;
   size_t                                 names_len;
   size_t                                 must_len;
   size_t                                 may_len;
   size_t                                 inherit_must_len;
   size_t                                 inherit_may_len;
   char *                                 sup_name;
   LDAPSchemaObjectclass *                sup;
   char **                                names;
   LDAPSchemaAttributeType **             must;
   LDAPSchemaAttributeType **             may;
   LDAPSchemaAttributeType **             inherit_must;
   LDAPSchemaAttributeType **             inherit_may;
};


union ldap_schema_pointer
{
   LDAPSchemaModel *                      model;
   LDAPSchemaSyntax *                     syntax;
   LDAPSchemaObjectclass *                objectclass;
   LDAPSchemaAttributeType *              attributetype;
   LDAPSchemaMatchingRule *               matchingrule;
};


/// LDAP schema syntax
struct ldap_schema_syntax
{
   LDAPSchemaModel                        model;
   size_t                                 data_class;
   regex_t                                re;
   LDAPSchemaMatchingRule **              mtchngrls;
   size_t                                 mtchngrls_len;
   LDAPSchemaAttributeType **             attrs;
   size_t                                 attrs_len;
};


struct ldap_schema_matchingrule
{
   LDAPSchemaModel                        model;
   LDAPSchemaSyntax *                     syntax;
   LDAPSchemaAttributeType **             used_by;
   size_t                                 used_by_len;
   char **                                names;
   size_t                                 names_len;
};


//////////////////
//              //
//  Prototypes  //
//              //
//////////////////
#pragma mark - Prototypes

//------------------//
// memory functions //
//-------=----------//
#pragma mark memory functions


#endif /* end of header file */