/* $OpenLDAP$ */

[0] Fix | Delete

/* This work is part of OpenLDAP Software <http://www.openldap.org/>.

[1] Fix | Delete

*

[2] Fix | Delete

* Copyright 1998-2018 The OpenLDAP Foundation.

[3] Fix | Delete

* All rights reserved.

[4] Fix | Delete

*

[5] Fix | Delete

* Redistribution and use in source and binary forms, with or without

[6] Fix | Delete

* modification, are permitted only as authorized by the OpenLDAP

[7] Fix | Delete

* Public License.

[8] Fix | Delete

*

[9] Fix | Delete

* A copy of this license is available in file LICENSE in the

[10] Fix | Delete

* top-level directory of the distribution or, alternatively, at

[11] Fix | Delete

* <http://www.OpenLDAP.org/license.html>.

[12] Fix | Delete

*/

[13] Fix | Delete

[14] Fix | Delete

/* ldap-schema.h - Header for basic schema handling functions that can be

[15] Fix | Delete

* used by both clients and servers.

[16] Fix | Delete

* these routines should be renamed ldap_x_...

[17] Fix | Delete

*/

[18] Fix | Delete

[19] Fix | Delete

#ifndef _LDAP_SCHEMA_H

[20] Fix | Delete

#define _LDAP_SCHEMA_H 1

[21] Fix | Delete

[22] Fix | Delete

#include <ldap_cdefs.h>

[23] Fix | Delete

[24] Fix | Delete

LDAP_BEGIN_DECL

[25] Fix | Delete

[26] Fix | Delete

/* Codes for parsing errors */

[27] Fix | Delete

[28] Fix | Delete

#define LDAP_SCHERR_OUTOFMEM 1

[29] Fix | Delete

#define LDAP_SCHERR_UNEXPTOKEN 2

[30] Fix | Delete

#define LDAP_SCHERR_NOLEFTPAREN 3

[31] Fix | Delete

#define LDAP_SCHERR_NORIGHTPAREN 4

[32] Fix | Delete

#define LDAP_SCHERR_NODIGIT 5

[33] Fix | Delete

#define LDAP_SCHERR_BADNAME 6

[34] Fix | Delete

#define LDAP_SCHERR_BADDESC 7

[35] Fix | Delete

#define LDAP_SCHERR_BADSUP 8

[36] Fix | Delete

#define LDAP_SCHERR_DUPOPT 9

[37] Fix | Delete

#define LDAP_SCHERR_EMPTY 10

[38] Fix | Delete

#define LDAP_SCHERR_MISSING 11

[39] Fix | Delete

#define LDAP_SCHERR_OUT_OF_ORDER 12

[40] Fix | Delete

[41] Fix | Delete

typedef struct ldap_schema_extension_item {

[42] Fix | Delete

char *lsei_name;

[43] Fix | Delete

char **lsei_values;

[44] Fix | Delete

} LDAPSchemaExtensionItem;

[45] Fix | Delete

[46] Fix | Delete

typedef struct ldap_syntax {

[47] Fix | Delete

char *syn_oid; /* REQUIRED */

[48] Fix | Delete

char **syn_names; /* OPTIONAL */

[49] Fix | Delete

char *syn_desc; /* OPTIONAL */

[50] Fix | Delete

LDAPSchemaExtensionItem **syn_extensions; /* OPTIONAL */

[51] Fix | Delete

} LDAPSyntax;

[52] Fix | Delete

[53] Fix | Delete

typedef struct ldap_matchingrule {

[54] Fix | Delete

char *mr_oid; /* REQUIRED */

[55] Fix | Delete

char **mr_names; /* OPTIONAL */

[56] Fix | Delete

char *mr_desc; /* OPTIONAL */

[57] Fix | Delete

int mr_obsolete; /* OPTIONAL */

[58] Fix | Delete

char *mr_syntax_oid; /* REQUIRED */

[59] Fix | Delete

LDAPSchemaExtensionItem **mr_extensions; /* OPTIONAL */

[60] Fix | Delete

} LDAPMatchingRule;

[61] Fix | Delete

[62] Fix | Delete

typedef struct ldap_matchingruleuse {

[63] Fix | Delete

char *mru_oid; /* REQUIRED */

[64] Fix | Delete

char **mru_names; /* OPTIONAL */

[65] Fix | Delete

char *mru_desc; /* OPTIONAL */

[66] Fix | Delete

int mru_obsolete; /* OPTIONAL */

[67] Fix | Delete

char **mru_applies_oids; /* REQUIRED */

[68] Fix | Delete

LDAPSchemaExtensionItem **mru_extensions; /* OPTIONAL */

[69] Fix | Delete

} LDAPMatchingRuleUse;

[70] Fix | Delete

[71] Fix | Delete

typedef struct ldap_attributetype {

[72] Fix | Delete

char *at_oid; /* REQUIRED */

[73] Fix | Delete

char **at_names; /* OPTIONAL */

[74] Fix | Delete

char *at_desc; /* OPTIONAL */

[75] Fix | Delete

int at_obsolete; /* 0=no, 1=yes */

[76] Fix | Delete

char *at_sup_oid; /* OPTIONAL */

[77] Fix | Delete

char *at_equality_oid; /* OPTIONAL */

[78] Fix | Delete

char *at_ordering_oid; /* OPTIONAL */

[79] Fix | Delete

char *at_substr_oid; /* OPTIONAL */

[80] Fix | Delete

char *at_syntax_oid; /* OPTIONAL */

[81] Fix | Delete

int at_syntax_len; /* OPTIONAL */

[82] Fix | Delete

int at_single_value; /* 0=no, 1=yes */

[83] Fix | Delete

int at_collective; /* 0=no, 1=yes */

[84] Fix | Delete

int at_no_user_mod; /* 0=no, 1=yes */

[85] Fix | Delete

int at_usage; /* 0=userApplications, 1=directoryOperation,

[86] Fix | Delete

2=distributedOperation, 3=dSAOperation */

[87] Fix | Delete

LDAPSchemaExtensionItem **at_extensions; /* OPTIONAL */

[88] Fix | Delete

} LDAPAttributeType;

[89] Fix | Delete

[90] Fix | Delete

typedef struct ldap_objectclass {

[91] Fix | Delete

char *oc_oid; /* REQUIRED */

[92] Fix | Delete

char **oc_names; /* OPTIONAL */

[93] Fix | Delete

char *oc_desc; /* OPTIONAL */

[94] Fix | Delete

int oc_obsolete; /* 0=no, 1=yes */

[95] Fix | Delete

char **oc_sup_oids; /* OPTIONAL */

[96] Fix | Delete

int oc_kind; /* 0=ABSTRACT, 1=STRUCTURAL, 2=AUXILIARY */

[97] Fix | Delete

char **oc_at_oids_must; /* OPTIONAL */

[98] Fix | Delete

char **oc_at_oids_may; /* OPTIONAL */

[99] Fix | Delete

LDAPSchemaExtensionItem **oc_extensions; /* OPTIONAL */

[100] Fix | Delete

} LDAPObjectClass;

[101] Fix | Delete

[102] Fix | Delete

typedef struct ldap_contentrule {

[103] Fix | Delete

char *cr_oid; /* REQUIRED */

[104] Fix | Delete

char **cr_names; /* OPTIONAL */

[105] Fix | Delete

char *cr_desc; /* OPTIONAL */

[106] Fix | Delete

char **cr_sup_oids; /* OPTIONAL */

[107] Fix | Delete

int cr_obsolete; /* 0=no, 1=yes */

[108] Fix | Delete

char **cr_oc_oids_aux; /* OPTIONAL */

[109] Fix | Delete

char **cr_at_oids_must; /* OPTIONAL */

[110] Fix | Delete

char **cr_at_oids_may; /* OPTIONAL */

[111] Fix | Delete

char **cr_at_oids_not; /* OPTIONAL */

[112] Fix | Delete

LDAPSchemaExtensionItem **cr_extensions; /* OPTIONAL */

[113] Fix | Delete

} LDAPContentRule;

[114] Fix | Delete

[115] Fix | Delete

typedef struct ldap_nameform {

[116] Fix | Delete

char *nf_oid; /* REQUIRED */

[117] Fix | Delete

char **nf_names; /* OPTIONAL */

[118] Fix | Delete

char *nf_desc; /* OPTIONAL */

[119] Fix | Delete

int nf_obsolete; /* 0=no, 1=yes */

[120] Fix | Delete

char *nf_objectclass; /* REQUIRED */

[121] Fix | Delete

char **nf_at_oids_must; /* REQUIRED */

[122] Fix | Delete

char **nf_at_oids_may; /* OPTIONAL */

[123] Fix | Delete

LDAPSchemaExtensionItem **nf_extensions; /* OPTIONAL */

[124] Fix | Delete

} LDAPNameForm;

[125] Fix | Delete

[126] Fix | Delete

typedef struct ldap_structurerule {

[127] Fix | Delete

int sr_ruleid; /* REQUIRED */

[128] Fix | Delete

char **sr_names; /* OPTIONAL */

[129] Fix | Delete

char *sr_desc; /* OPTIONAL */

[130] Fix | Delete

int sr_obsolete; /* 0=no, 1=yes */

[131] Fix | Delete

char *sr_nameform; /* REQUIRED */

[132] Fix | Delete

int sr_nsup_ruleids;/* number of sr_sup_ruleids */

[133] Fix | Delete

int *sr_sup_ruleids;/* OPTIONAL */

[134] Fix | Delete

LDAPSchemaExtensionItem **sr_extensions; /* OPTIONAL */

[135] Fix | Delete

} LDAPStructureRule;

[136] Fix | Delete

[137] Fix | Delete

/*

[138] Fix | Delete

* Misc macros

[139] Fix | Delete

*/

[140] Fix | Delete

#define LDAP_SCHEMA_NO 0

[141] Fix | Delete

#define LDAP_SCHEMA_YES 1

[142] Fix | Delete

[143] Fix | Delete

#define LDAP_SCHEMA_USER_APPLICATIONS 0

[144] Fix | Delete

#define LDAP_SCHEMA_DIRECTORY_OPERATION 1

[145] Fix | Delete

#define LDAP_SCHEMA_DISTRIBUTED_OPERATION 2

[146] Fix | Delete

#define LDAP_SCHEMA_DSA_OPERATION 3

[147] Fix | Delete

[148] Fix | Delete

#define LDAP_SCHEMA_ABSTRACT 0

[149] Fix | Delete

#define LDAP_SCHEMA_STRUCTURAL 1

[150] Fix | Delete

#define LDAP_SCHEMA_AUXILIARY 2

[151] Fix | Delete

[152] Fix | Delete

[153] Fix | Delete

/*

[154] Fix | Delete

* Flags that control how liberal the parsing routines are.

[155] Fix | Delete

*/

[156] Fix | Delete

#define LDAP_SCHEMA_ALLOW_NONE 0x00U /* Strict parsing */

[157] Fix | Delete

#define LDAP_SCHEMA_ALLOW_NO_OID 0x01U /* Allow missing oid */

[158] Fix | Delete

#define LDAP_SCHEMA_ALLOW_QUOTED 0x02U /* Allow bogus extra quotes */

[159] Fix | Delete

#define LDAP_SCHEMA_ALLOW_DESCR 0x04U /* Allow descr instead of OID */

[160] Fix | Delete

#define LDAP_SCHEMA_ALLOW_DESCR_PREFIX 0x08U /* Allow descr as OID prefix */

[161] Fix | Delete

#define LDAP_SCHEMA_ALLOW_OID_MACRO 0x10U /* Allow OID macros in slapd */

[162] Fix | Delete

#define LDAP_SCHEMA_ALLOW_OUT_OF_ORDER_FIELDS 0x20U /* Allow fields in most any order */

[163] Fix | Delete

#define LDAP_SCHEMA_ALLOW_ALL 0x3fU /* Be very liberal in parsing */

[164] Fix | Delete

#define LDAP_SCHEMA_SKIP 0x80U /* Don't malloc any result */

[165] Fix | Delete

[166] Fix | Delete

[167] Fix | Delete

LDAP_F( LDAP_CONST char * )

[168] Fix | Delete

ldap_syntax2name LDAP_P((

[169] Fix | Delete

LDAPSyntax * syn ));

[170] Fix | Delete

[171] Fix | Delete

LDAP_F( LDAP_CONST char * )

[172] Fix | Delete

ldap_matchingrule2name LDAP_P((

[173] Fix | Delete

LDAPMatchingRule * mr ));

[174] Fix | Delete

[175] Fix | Delete

LDAP_F( LDAP_CONST char * )

[176] Fix | Delete

ldap_matchingruleuse2name LDAP_P((

[177] Fix | Delete

LDAPMatchingRuleUse * mru ));

[178] Fix | Delete

[179] Fix | Delete

LDAP_F( LDAP_CONST char * )

[180] Fix | Delete

ldap_attributetype2name LDAP_P((

[181] Fix | Delete

LDAPAttributeType * at ));

[182] Fix | Delete

[183] Fix | Delete

LDAP_F( LDAP_CONST char * )

[184] Fix | Delete

ldap_objectclass2name LDAP_P((

[185] Fix | Delete

LDAPObjectClass * oc ));

[186] Fix | Delete

[187] Fix | Delete

LDAP_F( LDAP_CONST char * )

[188] Fix | Delete

ldap_contentrule2name LDAP_P((

[189] Fix | Delete

LDAPContentRule * cr ));

[190] Fix | Delete

[191] Fix | Delete

LDAP_F( LDAP_CONST char * )

[192] Fix | Delete

ldap_nameform2name LDAP_P((

[193] Fix | Delete

LDAPNameForm * nf ));

[194] Fix | Delete

[195] Fix | Delete

LDAP_F( LDAP_CONST char * )

[196] Fix | Delete

ldap_structurerule2name LDAP_P((

[197] Fix | Delete

LDAPStructureRule * sr ));

[198] Fix | Delete

[199] Fix | Delete

LDAP_F( void )

[200] Fix | Delete

ldap_syntax_free LDAP_P((

[201] Fix | Delete

LDAPSyntax * syn ));

[202] Fix | Delete

[203] Fix | Delete

LDAP_F( void )

[204] Fix | Delete

ldap_matchingrule_free LDAP_P((

[205] Fix | Delete

LDAPMatchingRule * mr ));

[206] Fix | Delete

[207] Fix | Delete

LDAP_F( void )

[208] Fix | Delete

ldap_matchingruleuse_free LDAP_P((

[209] Fix | Delete

LDAPMatchingRuleUse * mr ));

[210] Fix | Delete

[211] Fix | Delete

LDAP_F( void )

[212] Fix | Delete

ldap_attributetype_free LDAP_P((

[213] Fix | Delete

LDAPAttributeType * at ));

[214] Fix | Delete

[215] Fix | Delete

LDAP_F( void )

[216] Fix | Delete

ldap_objectclass_free LDAP_P((

[217] Fix | Delete

LDAPObjectClass * oc ));

[218] Fix | Delete

[219] Fix | Delete

LDAP_F( void )

[220] Fix | Delete

ldap_contentrule_free LDAP_P((

[221] Fix | Delete

LDAPContentRule * cr ));

[222] Fix | Delete

[223] Fix | Delete

LDAP_F( void )

[224] Fix | Delete

ldap_nameform_free LDAP_P((

[225] Fix | Delete

LDAPNameForm * nf ));

[226] Fix | Delete

[227] Fix | Delete

LDAP_F( void )

[228] Fix | Delete

ldap_structurerule_free LDAP_P((

[229] Fix | Delete

LDAPStructureRule * sr ));

[230] Fix | Delete

[231] Fix | Delete

LDAP_F( LDAPStructureRule * )

[232] Fix | Delete

ldap_str2structurerule LDAP_P((

[233] Fix | Delete

LDAP_CONST char * s,

[234] Fix | Delete

int * code,

[235] Fix | Delete

LDAP_CONST char ** errp,

[236] Fix | Delete

LDAP_CONST unsigned flags ));

[237] Fix | Delete

[238] Fix | Delete

LDAP_F( LDAPNameForm * )

[239] Fix | Delete

ldap_str2nameform LDAP_P((

[240] Fix | Delete

LDAP_CONST char * s,

[241] Fix | Delete

int * code,

[242] Fix | Delete

LDAP_CONST char ** errp,

[243] Fix | Delete

LDAP_CONST unsigned flags ));

[244] Fix | Delete

[245] Fix | Delete

LDAP_F( LDAPContentRule * )

[246] Fix | Delete

ldap_str2contentrule LDAP_P((

[247] Fix | Delete

LDAP_CONST char * s,

[248] Fix | Delete

int * code,

[249] Fix | Delete

LDAP_CONST char ** errp,

[250] Fix | Delete

LDAP_CONST unsigned flags ));

[251] Fix | Delete

[252] Fix | Delete

LDAP_F( LDAPObjectClass * )

[253] Fix | Delete

ldap_str2objectclass LDAP_P((

[254] Fix | Delete

LDAP_CONST char * s,

[255] Fix | Delete

int * code,

[256] Fix | Delete

LDAP_CONST char ** errp,

[257] Fix | Delete

LDAP_CONST unsigned flags ));

[258] Fix | Delete

[259] Fix | Delete

LDAP_F( LDAPAttributeType * )

[260] Fix | Delete

ldap_str2attributetype LDAP_P((

[261] Fix | Delete

LDAP_CONST char * s,

[262] Fix | Delete

int * code,

[263] Fix | Delete

LDAP_CONST char ** errp,

[264] Fix | Delete

LDAP_CONST unsigned flags ));

[265] Fix | Delete

[266] Fix | Delete

LDAP_F( LDAPSyntax * )

[267] Fix | Delete

ldap_str2syntax LDAP_P((

[268] Fix | Delete

LDAP_CONST char * s,

[269] Fix | Delete

int * code,

[270] Fix | Delete

LDAP_CONST char ** errp,

[271] Fix | Delete

LDAP_CONST unsigned flags ));

[272] Fix | Delete

[273] Fix | Delete

LDAP_F( LDAPMatchingRule * )

[274] Fix | Delete

ldap_str2matchingrule LDAP_P((

[275] Fix | Delete

LDAP_CONST char * s,

[276] Fix | Delete

int * code,

[277] Fix | Delete

LDAP_CONST char ** errp,

[278] Fix | Delete

LDAP_CONST unsigned flags ));

[279] Fix | Delete

[280] Fix | Delete

LDAP_F( LDAPMatchingRuleUse * )

[281] Fix | Delete

ldap_str2matchingruleuse LDAP_P((

[282] Fix | Delete

LDAP_CONST char * s,

[283] Fix | Delete

int * code,

[284] Fix | Delete

LDAP_CONST char ** errp,

[285] Fix | Delete

LDAP_CONST unsigned flags ));

[286] Fix | Delete

[287] Fix | Delete

LDAP_F( char * )

[288] Fix | Delete

ldap_structurerule2str LDAP_P((

[289] Fix | Delete

LDAPStructureRule * sr ));

[290] Fix | Delete

[291] Fix | Delete

LDAP_F( struct berval * )

[292] Fix | Delete

ldap_structurerule2bv LDAP_P((

[293] Fix | Delete

LDAPStructureRule * sr, struct berval *bv ));

[294] Fix | Delete

[295] Fix | Delete

LDAP_F( char * )

[296] Fix | Delete

ldap_nameform2str LDAP_P((

[297] Fix | Delete

LDAPNameForm * nf ));

[298] Fix | Delete

[299] Fix | Delete

LDAP_F( struct berval * )

[300] Fix | Delete

ldap_nameform2bv LDAP_P((

[301] Fix | Delete

LDAPNameForm * nf, struct berval *bv ));

[302] Fix | Delete

[303] Fix | Delete

LDAP_F( char * )

[304] Fix | Delete

ldap_contentrule2str LDAP_P((

[305] Fix | Delete

LDAPContentRule * cr ));

[306] Fix | Delete

[307] Fix | Delete

LDAP_F( struct berval * )

[308] Fix | Delete

ldap_contentrule2bv LDAP_P((

[309] Fix | Delete

LDAPContentRule * cr, struct berval *bv ));

[310] Fix | Delete

[311] Fix | Delete

LDAP_F( char * )

[312] Fix | Delete

ldap_objectclass2str LDAP_P((

[313] Fix | Delete

LDAPObjectClass * oc ));

[314] Fix | Delete

[315] Fix | Delete

LDAP_F( struct berval * )

[316] Fix | Delete

ldap_objectclass2bv LDAP_P((

[317] Fix | Delete

LDAPObjectClass * oc, struct berval *bv ));

[318] Fix | Delete

[319] Fix | Delete

LDAP_F( char * )

[320] Fix | Delete

ldap_attributetype2str LDAP_P((

[321] Fix | Delete

LDAPAttributeType * at ));

[322] Fix | Delete

[323] Fix | Delete

LDAP_F( struct berval * )

[324] Fix | Delete

ldap_attributetype2bv LDAP_P((

[325] Fix | Delete

LDAPAttributeType * at, struct berval *bv ));

[326] Fix | Delete

[327] Fix | Delete

LDAP_F( char * )

[328] Fix | Delete

ldap_syntax2str LDAP_P((

[329] Fix | Delete

LDAPSyntax * syn ));

[330] Fix | Delete

[331] Fix | Delete

LDAP_F( struct berval * )

[332] Fix | Delete

ldap_syntax2bv LDAP_P((

[333] Fix | Delete

LDAPSyntax * syn, struct berval *bv ));

[334] Fix | Delete

[335] Fix | Delete

LDAP_F( char * )

[336] Fix | Delete

ldap_matchingrule2str LDAP_P((

[337] Fix | Delete

LDAPMatchingRule * mr ));

[338] Fix | Delete

[339] Fix | Delete

LDAP_F( struct berval * )

[340] Fix | Delete

ldap_matchingrule2bv LDAP_P((

[341] Fix | Delete

LDAPMatchingRule * mr, struct berval *bv ));

[342] Fix | Delete

[343] Fix | Delete

LDAP_F( char * )

[344] Fix | Delete

ldap_matchingruleuse2str LDAP_P((

[345] Fix | Delete

LDAPMatchingRuleUse * mru ));

[346] Fix | Delete

[347] Fix | Delete

LDAP_F( struct berval * )

[348] Fix | Delete

ldap_matchingruleuse2bv LDAP_P((

[349] Fix | Delete

LDAPMatchingRuleUse * mru, struct berval *bv ));

[350] Fix | Delete

[351] Fix | Delete

LDAP_F( char * )

[352] Fix | Delete

ldap_scherr2str LDAP_P((

[353] Fix | Delete

int code )) LDAP_GCCATTR((const));

[354] Fix | Delete

[355] Fix | Delete

LDAP_END_DECL

[356] Fix | Delete

[357] Fix | Delete

#endif

[358] Fix | Delete

[359] Fix | Delete

[360] Fix | Delete