xref: /illumos-gate/usr/src/lib/libldap5/include/ldap/ldaprot.h (revision 8b80e8cb6855118d46f605e91b5ed4ce83417395)
1 /*
2  * Copyright (c) 2001 by Sun Microsystems, Inc.
3  * All rights reserved.
4  */
5 
6 #pragma ident	"%Z%%M%	%I%	%E% SMI"
7 
8 /*
9  * The contents of this file are subject to the Netscape Public
10  * License Version 1.1 (the "License"); you may not use this file
11  * except in compliance with the License. You may obtain a copy of
12  * the License at http://www.mozilla.org/NPL/
13  *
14  * Software distributed under the License is distributed on an "AS
15  * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
16  * implied. See the License for the specific language governing
17  * rights and limitations under the License.
18  *
19  * The Original Code is Mozilla Communicator client code, released
20  * March 31, 1998.
21  *
22  * The Initial Developer of the Original Code is Netscape
23  * Communications Corporation. Portions created by Netscape are
24  * Copyright (C) 1998-1999 Netscape Communications Corporation. All
25  * Rights Reserved.
26  *
27  * Contributor(s):
28  */
29 
30 #ifndef _LDAPROT_H
31 #define _LDAPROT_H
32 
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36 
37 #define LDAP_VERSION1	1
38 #define LDAP_VERSION2	2
39 #define LDAP_VERSION3	3
40 #define LDAP_VERSION	LDAP_VERSION2
41 
42 #define COMPAT20
43 #define COMPAT30
44 #if defined(COMPAT20) || defined(COMPAT30)
45 #define COMPAT
46 #endif
47 
48 #define LDAP_URL_PREFIX		"ldap://"
49 #define LDAP_URL_PREFIX_LEN	7
50 #define LDAPS_URL_PREFIX	"ldaps://"
51 #define LDAPS_URL_PREFIX_LEN	8
52 #define LDAP_REF_STR		"Referral:\n"
53 #define LDAP_REF_STR_LEN	10
54 
55 /*
56  * specific LDAP instantiations of BER types we know about
57  */
58 
59 #ifdef _SOLARIS_SDK
60 #define LDAP_TAG_LDAPDN         0x04   /* OCTET STRING */
61 #define OLD_LDAP_TAG_MESSAGE    0x10   /* forgot the constructed bit  */
62 #define LDAP_TAG_MRA_OID        0x81   /* context specific + primitive + 1 */
63 #define LDAP_TAG_MRA_TYPE       0x82   /* context specific + primitive + 2 */
64 #define LDAP_TAG_MRA_VALUE      0x83   /* context specific + primitive + 3 */
65 #define LDAP_TAG_MRA_DNATTRS    0x84   /* context specific + primitive + 4 */
66 #define LDAP_TAG_EXOP_REQ_OID   0x80   /* context specific + primitive + 0 */
67 #define LDAP_TAG_EXOP_REQ_VALUE 0x81   /* context specific + primitive + 1 */
68 #define LDAP_TAG_EXOP_RES_OID   0x8a   /* context specific + primitive + 10 */
69 #define LDAP_TAG_EXOP_RES_VALUE 0x8b   /* context specific + primitive + 11 */
70 #endif /* ifdef _SOLARIS_SDK */
71 
72 #ifndef _SOLARIS_SDK
73 
74 /* general stuff */
75 #define LDAP_TAG_MESSAGE	0x30L	/* tag is 16 + constructed bit */
76 #define LDAP_TAG_MSGID		0x02L   /* INTEGER */
77 #define LDAP_TAG_CONTROLS	0xa0L	/* context specific + constructed + 0 */
78 #define LDAP_TAG_REFERRAL	0xa3L	/* context specific + constructed + 3 */
79 #define LDAP_TAG_NEWSUPERIOR	0x80L	/* context specific + primitive + 0 */
80 #define LDAP_TAG_SASL_RES_CREDS	0x87L	/* context specific + primitive + 7 */
81 #define LDAP_TAG_VLV_BY_INDEX	0xa0L	/* context specific + constructed + 0 */
82 #define LDAP_TAG_VLV_BY_VALUE	0x81L	/* context specific + primitive + 1 */
83 
84 
85 #define LDAP_TAG_LDAPDN		0x04L	/* OCTET STRING */
86 #define OLD_LDAP_TAG_MESSAGE	0x10L	/* forgot the constructed bit  */
87 #define LDAP_TAG_MRA_OID	0x81L	/* context specific + primitive + 1 */
88 #define LDAP_TAG_MRA_TYPE	0x82L	/* context specific + primitive + 2 */
89 #define LDAP_TAG_MRA_VALUE	0x83L	/* context specific + primitive + 3 */
90 #define LDAP_TAG_MRA_DNATTRS	0x84L	/* context specific + primitive + 4 */
91 #define LDAP_TAG_EXOP_REQ_OID	0x80L	/* context specific + primitive + 0 */
92 #define LDAP_TAG_EXOP_REQ_VALUE	0x81L	/* context specific + primitive + 1 */
93 #define LDAP_TAG_EXOP_RES_OID	0x8aL	/* context specific + primitive + 10 */
94 #define LDAP_TAG_EXOP_RES_VALUE	0x8bL	/* context specific + primitive + 11 */
95 #define LDAP_TAG_SK_MATCHRULE   0x80L   /* context specific + primitive + 0 */
96 #define LDAP_TAG_SK_REVERSE 	0x81L	/* context specific + primitive + 1 */
97 #define LDAP_TAG_SR_ATTRTYPE    0x80L   /* context specific + primitive + 0 */
98 
99 /* possible operations a client can invoke */
100 #define LDAP_REQ_BIND		0x60L	/* application + constructed + 0 */
101 #define LDAP_REQ_UNBIND		0x42L	/* application + primitive   + 2 */
102 #define LDAP_REQ_SEARCH		0x63L	/* application + constructed + 3 */
103 #define LDAP_REQ_MODIFY		0x66L	/* application + constructed + 6 */
104 #define LDAP_REQ_ADD		0x68L	/* application + constructed + 8 */
105 #define LDAP_REQ_DELETE		0x4aL	/* application + primitive   + 10 */
106 #define LDAP_REQ_MODRDN		0x6cL	/* application + constructed + 12 */
107 #define LDAP_REQ_MODDN		0x6cL	/* application + constructed + 12 */
108 #define LDAP_REQ_RENAME		0x6cL	/* application + constructed + 12 */
109 #define LDAP_REQ_COMPARE	0x6eL	/* application + constructed + 14 */
110 #define LDAP_REQ_ABANDON	0x50L	/* application + primitive   + 16 */
111 #define LDAP_REQ_EXTENDED	0x77L	/* application + constructed + 23 */
112 
113 /* U-M LDAP release 3.0 compatibility stuff */
114 #define LDAP_REQ_UNBIND_30	0x62L
115 #define LDAP_REQ_DELETE_30	0x6aL
116 #define LDAP_REQ_ABANDON_30	0x70L
117 
118 /* U-M LDAP 3.0 compatibility auth methods */
119 #define LDAP_AUTH_SIMPLE_30	0xa0L	/* context specific + constructed */
120 #define LDAP_AUTH_KRBV41_30	0xa1L	/* context specific + constructed */
121 #define LDAP_AUTH_KRBV42_30	0xa2L	/* context specific + constructed */
122 
123 /*
124  * old broken stuff for backwards compatibility - forgot application tag
125  * and constructed/primitive bit
126  */
127 #define OLD_LDAP_REQ_BIND	0x00L
128 #define OLD_LDAP_REQ_UNBIND	0x02L
129 #define OLD_LDAP_REQ_SEARCH	0x03L
130 #define OLD_LDAP_REQ_MODIFY	0x06L
131 #define OLD_LDAP_REQ_ADD	0x08L
132 #define OLD_LDAP_REQ_DELETE	0x0aL
133 #define OLD_LDAP_REQ_MODRDN	0x0cL
134 #define OLD_LDAP_REQ_MODDN	0x0cL
135 #define OLD_LDAP_REQ_COMPARE	0x0eL
136 #define OLD_LDAP_REQ_ABANDON	0x10L
137 
138 /* old broken stuff for backwards compatibility */
139 #define OLD_LDAP_RES_BIND		0x01L
140 #define OLD_LDAP_RES_SEARCH_ENTRY	0x04L
141 #define OLD_LDAP_RES_SEARCH_RESULT	0x05L
142 #define OLD_LDAP_RES_MODIFY		0x07L
143 #define OLD_LDAP_RES_ADD		0x09L
144 #define OLD_LDAP_RES_DELETE		0x0bL
145 #define OLD_LDAP_RES_MODRDN		0x0dL
146 #define OLD_LDAP_RES_MODDN		0x0dL
147 #define OLD_LDAP_RES_COMPARE		0x0fL
148 
149 /* U-M LDAP 3.0 compatibility auth methods */
150 #define LDAP_AUTH_SIMPLE_30	0xa0L	/* context specific + constructed */
151 #define LDAP_AUTH_KRBV41_30	0xa1L	/* context specific + constructed */
152 #define LDAP_AUTH_KRBV42_30	0xa2L	/* context specific + constructed */
153 
154 /* old broken stuff */
155 #define OLD_LDAP_AUTH_SIMPLE	0x00L
156 #define OLD_LDAP_AUTH_KRBV4	0x01L
157 #define OLD_LDAP_AUTH_KRBV42	0x02L
158 
159 /* U-M LDAP 3.0 compatibility filter types */
160 #define LDAP_FILTER_PRESENT_30	0xa7L	/* context specific + constructed */
161 
162 /* filter types */
163 #define LDAP_FILTER_AND		0xa0L	/* context specific + constructed + 0 */
164 #define LDAP_FILTER_OR		0xa1L	/* context specific + constructed + 1 */
165 #define LDAP_FILTER_NOT		0xa2L	/* context specific + constructed + 2 */
166 #define LDAP_FILTER_EQUALITY	0xa3L	/* context specific + constructed + 3 */
167 #define LDAP_FILTER_SUBSTRINGS	0xa4L	/* context specific + constructed + 4 */
168 #define LDAP_FILTER_GE		0xa5L	/* context specific + constructed + 5 */
169 #define LDAP_FILTER_LE		0xa6L	/* context specific + constructed + 6 */
170 #define LDAP_FILTER_PRESENT	0x87L	/* context specific + primitive   + 7 */
171 #define LDAP_FILTER_APPROX	0xa8L	/* context specific + constructed + 8 */
172 #define LDAP_FILTER_EXTENDED	0xa9L	/* context specific + constructed + 0 */
173 
174 /* old broken stuff */
175 #define OLD_LDAP_FILTER_AND		0x00L
176 #define OLD_LDAP_FILTER_OR		0x01L
177 #define OLD_LDAP_FILTER_NOT		0x02L
178 #define OLD_LDAP_FILTER_EQUALITY	0x03L
179 #define OLD_LDAP_FILTER_SUBSTRINGS	0x04L
180 #define OLD_LDAP_FILTER_GE		0x05L
181 #define OLD_LDAP_FILTER_LE		0x06L
182 #define OLD_LDAP_FILTER_PRESENT		0x07L
183 #define OLD_LDAP_FILTER_APPROX		0x08L
184 
185 /* substring filter component types */
186 #define LDAP_SUBSTRING_INITIAL	0x80L	/* context specific + primitive + 0 */
187 #define LDAP_SUBSTRING_ANY	0x81L	/* context specific + primitive + 1 */
188 #define LDAP_SUBSTRING_FINAL	0x82L	/* context specific + primitive + 2 */
189 
190 /* extended filter component types */
191 #define LDAP_FILTER_EXTENDED_OID	0x81L	/* context spec. + prim. + 1 */
192 #define LDAP_FILTER_EXTENDED_TYPE	0x82L	/* context spec. + prim. + 2 */
193 #define LDAP_FILTER_EXTENDED_VALUE	0x83L	/* context spec. + prim. + 3 */
194 #define LDAP_FILTER_EXTENDED_DNATTRS	0x84L	/* context spec. + prim. + 4 */
195 
196 /* U-M LDAP 3.0 compatibility substring filter component types */
197 #define LDAP_SUBSTRING_INITIAL_30	0xa0L	/* context specific */
198 #define LDAP_SUBSTRING_ANY_30		0xa1L	/* context specific */
199 #define LDAP_SUBSTRING_FINAL_30		0xa2L	/* context specific */
200 
201 /* old broken stuff */
202 #define OLD_LDAP_SUBSTRING_INITIAL	0x00L
203 #define OLD_LDAP_SUBSTRING_ANY		0x01L
204 #define OLD_LDAP_SUBSTRING_FINAL	0x02L
205 
206 #endif /* _SOLARIS_SDK */
207 
208 #ifdef __cplusplus
209 }
210 #endif
211 #endif /* _LDAPROT_H */
212