Add tldap paged searches, together with two helper routines
[ira/wip.git] / source3 / include / tldap.h
1 /*
2    Unix SMB/CIFS implementation.
3    Infrastructure for async ldap client requests
4    Copyright (C) Volker Lendecke 2009
5
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 3 of the License, or
9    (at your option) any later version.
10
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    You should have received a copy of the GNU General Public License
17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 */
19
20 #ifndef __TLDAP_H__
21 #define __TLDAP_H__
22
23 #include <talloc.h>
24 #include <tevent.h>
25
26 struct tldap_context;
27 struct tldap_message;
28
29 struct tldap_control {
30         const char *oid;
31         DATA_BLOB value;
32         bool critical;
33 };
34
35 struct tldap_attribute {
36         char *name;
37         int num_values;
38         DATA_BLOB *values;
39 };
40
41 struct tldap_mod {
42         int mod_op;
43         char *attribute;
44         int num_values;
45         DATA_BLOB *values;
46 };
47
48 bool tevent_req_is_ldap_error(struct tevent_req *req, int *perr);
49
50 struct tldap_context *tldap_context_create(TALLOC_CTX *mem_ctx, int fd);
51 bool tldap_context_setattr(struct tldap_context *ld,
52                            const char *name, const void *pptr);
53 void *tldap_context_getattr(struct tldap_context *ld, const char *name);
54
55 struct tevent_req *tldap_sasl_bind_send(TALLOC_CTX *mem_ctx,
56                                         struct tevent_context *ev,
57                                         struct tldap_context *ld,
58                                         const char *dn,
59                                         const char *mechanism,
60                                         DATA_BLOB *creds,
61                                         struct tldap_control *sctrls,
62                                         int num_sctrls,
63                                         struct tldap_control *cctrls,
64                                         int num_cctrls);
65 int tldap_sasl_bind_recv(struct tevent_req *req);
66 int tldap_sasl_bind(struct tldap_context *ldap,
67                     const char *dn,
68                     const char *mechanism,
69                     DATA_BLOB *creds,
70                     struct tldap_control *sctrls,
71                     int num_sctrls,
72                     struct tldap_control *cctrls,
73                     int num_ctrls);
74
75 struct tevent_req *tldap_simple_bind_send(TALLOC_CTX *mem_ctx,
76                                           struct tevent_context *ev,
77                                           struct tldap_context *ldap,
78                                           const char *dn,
79                                           const char *passwd);
80 int tldap_simple_bind_recv(struct tevent_req *req);
81 int tldap_simple_bind(struct tldap_context *ldap, const char *dn,
82                       const char *passwd);
83
84 struct tevent_req *tldap_search_send(TALLOC_CTX *mem_ctx,
85                                      struct tevent_context *ev,
86                                      struct tldap_context *ld,
87                                      const char *base, int scope,
88                                      const char *filter,
89                                      const char **attrs,
90                                      int num_attrs,
91                                      int attrsonly,
92                                      struct tldap_control *sctrls,
93                                      int num_sctrls,
94                                      struct tldap_control *cctrls,
95                                      int num_cctrls,
96                                      int timelimit,
97                                      int sizelimit,
98                                      int deref);
99 int tldap_search_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
100                       struct tldap_message **pmsg);
101 int tldap_search(struct tldap_context *ld,
102                  const char *base, int scope, const char *filter,
103                  const char **attrs, int num_attrs, int attrsonly,
104                  struct tldap_control *sctrls, int num_sctrls,
105                  struct tldap_control *cctrls, int num_cctrls,
106                  int timelimit, int sizelimit, int deref,
107                  TALLOC_CTX *mem_ctx, struct tldap_message ***entries,
108                  struct tldap_message ***refs);
109 bool tldap_entry_dn(struct tldap_message *msg, char **dn);
110 bool tldap_entry_attributes(struct tldap_message *msg, int *num_attributes,
111                             struct tldap_attribute **attributes);
112
113 struct tevent_req *tldap_add_send(TALLOC_CTX *mem_ctx,
114                                   struct tevent_context *ev,
115                                   struct tldap_context *ld,
116                                   const char *dn,
117                                   struct tldap_mod *attributes,
118                                   int num_attributes,
119                                   struct tldap_control *sctrls,
120                                   int num_sctrls,
121                                   struct tldap_control *cctrls,
122                                   int num_cctrls);
123 int tldap_add_recv(struct tevent_req *req);
124 int tldap_add(struct tldap_context *ld, const char *dn,
125               int num_attributes, struct tldap_mod *attributes,
126               struct tldap_control *sctrls, int num_sctrls,
127               struct tldap_control *cctrls, int num_cctrls);
128
129 struct tevent_req *tldap_modify_send(TALLOC_CTX *mem_ctx,
130                                      struct tevent_context *ev,
131                                      struct tldap_context *ld,
132                                      const char *dn,
133                                      int num_mods, struct tldap_mod *mods,
134                                      struct tldap_control *sctrls,
135                                      int num_sctrls,
136                                      struct tldap_control *cctrls,
137                                      int num_cctrls);
138 int tldap_modify_recv(struct tevent_req *req);
139 int tldap_modify(struct tldap_context *ld, const char *dn,
140                  int num_mods, struct tldap_mod *mods,
141                  struct tldap_control *sctrls, int num_sctrls,
142                  struct tldap_control *cctrls, int num_cctrls);
143
144 struct tevent_req *tldap_delete_send(TALLOC_CTX *mem_ctx,
145                                      struct tevent_context *ev,
146                                      struct tldap_context *ld,
147                                      const char *dn,
148                                      struct tldap_control *sctrls,
149                                      int num_sctrls,
150                                      struct tldap_control *cctrls,
151                                      int num_cctrls);
152 int tldap_delete_recv(struct tevent_req *req);
153 int tldap_delete(struct tldap_context *ld, const char *dn,
154                  struct tldap_control *sctrls, int num_sctrls,
155                  struct tldap_control *cctrls, int num_cctrls);
156
157 int tldap_msg_id(const struct tldap_message *msg);
158 int tldap_msg_type(const struct tldap_message *msg);
159 const char *tldap_msg_matcheddn(struct tldap_message *msg);
160 const char *tldap_msg_diagnosticmessage(struct tldap_message *msg);
161 const char *tldap_msg_referral(struct tldap_message *msg);
162 void tldap_msg_sctrls(struct tldap_message *msg, int *num_sctrls,
163                       struct tldap_control **sctrls);
164 struct tldap_message *tldap_ctx_lastmsg(struct tldap_context *ld);
165 const char *tldap_err2string(int rc);
166
167 /* DEBUG */
168 enum tldap_debug_level {
169         TLDAP_DEBUG_FATAL,
170         TLDAP_DEBUG_ERROR,
171         TLDAP_DEBUG_WARNING,
172         TLDAP_DEBUG_TRACE
173 };
174
175 void tldap_set_debug(struct tldap_context *ld,
176                      void (*log_fn)(void *log_private,
177                                     enum tldap_debug_level level,
178                                     const char *fmt,
179                                     va_list ap) PRINTF_ATTRIBUTE(3,0),
180                      void *log_private);
181
182 /*
183  * "+ 0x60" is from ASN1_APPLICATION
184  */
185 #define TLDAP_REQ_BIND (0 + 0x60)
186 #define TLDAP_RES_BIND (1 + 0x60)
187 #define TLDAP_REQ_UNBIND (2 + 0x60)
188 #define TLDAP_REQ_SEARCH (3 + 0x60)
189 #define TLDAP_RES_SEARCH_ENTRY (4 + 0x60)
190 #define TLDAP_RES_SEARCH_RESULT (5 + 0x60)
191 #define TLDAP_REQ_MODIFY (6 + 0x60)
192 #define TLDAP_RES_MODIFY (7 + 0x60)
193 #define TLDAP_REQ_ADD (8 + 0x60)
194 #define TLDAP_RES_ADD (9 + 0x60)
195 /* ASN1_APPLICATION_SIMPLE instead of ASN1_APPLICATION */
196 #define TLDAP_REQ_DELETE (10 + 0x40)
197 #define TLDAP_RES_DELETE (11 + 0x60)
198 #define TLDAP_REQ_MODDN (12 + 0x60)
199 #define TLDAP_RES_MODDN (13 + 0x60)
200 #define TLDAP_REQ_COMPARE (14 + 0x60)
201 #define TLDAP_RES_COMPARE (15 + 0x60)
202 /* ASN1_APPLICATION_SIMPLE instead of ASN1_APPLICATION */
203 #define TLDAP_REQ_ABANDON (16 + 0x40)
204 #define TLDAP_RES_SEARCH_REFERENCE (19 + 0x60)
205 #define TLDAP_REQ_EXTENDED (23 + 0x60)
206 #define TLDAP_RES_EXTENDED (24 + 0x60)
207 #define TLDAP_RES_INTERMEDIATE (25 + 0x60)
208
209 #define TLDAP_SUCCESS (0x00)
210 #define TLDAP_OPERATIONS_ERROR (0x01)
211 #define TLDAP_PROTOCOL_ERROR (0x02)
212 #define TLDAP_TIMELIMIT_EXCEEDED (0x03)
213 #define TLDAP_SIZELIMIT_EXCEEDED (0x04)
214 #define TLDAP_COMPARE_FALSE (0x05)
215 #define TLDAP_COMPARE_TRUE (0x06)
216 #define TLDAP_STRONG_AUTH_NOT_SUPPORTED (0x07)
217 #define TLDAP_STRONG_AUTH_REQUIRED (0x08)
218 #define TLDAP_REFERRAL (0x0a)
219 #define TLDAP_ADMINLIMIT_EXCEEDED (0x0b)
220 #define TLDAP_UNAVAILABLE_CRITICAL_EXTENSION (0x0c)
221 #define TLDAP_CONFIDENTIALITY_REQUIRED (0x0d)
222 #define TLDAP_SASL_BIND_IN_PROGRESS (0x0e)
223 #define TLDAP_NO_SUCH_ATTRIBUTE (0x10)
224 #define TLDAP_UNDEFINED_TYPE (0x11)
225 #define TLDAP_INAPPROPRIATE_MATCHING (0x12)
226 #define TLDAP_CONSTRAINT_VIOLATION (0x13)
227 #define TLDAP_TYPE_OR_VALUE_EXISTS (0x14)
228 #define TLDAP_INVALID_SYNTAX (0x15)
229 #define TLDAP_NO_SUCH_OBJECT (0x20)
230 #define TLDAP_ALIAS_PROBLEM (0x21)
231 #define TLDAP_INVALID_DN_SYNTAX (0x22)
232 #define TLDAP_IS_LEAF (0x23)
233 #define TLDAP_ALIAS_DEREF_PROBLEM (0x24)
234 #define TLDAP_INAPPROPRIATE_AUTH (0x30)
235 #define TLDAP_INVALID_CREDENTIALS (0x31)
236 #define TLDAP_INSUFFICIENT_ACCESS (0x32)
237 #define TLDAP_BUSY (0x33)
238 #define TLDAP_UNAVAILABLE (0x34)
239 #define TLDAP_UNWILLING_TO_PERFORM (0x35)
240 #define TLDAP_LOOP_DETECT (0x36)
241 #define TLDAP_NAMING_VIOLATION (0x40)
242 #define TLDAP_OBJECT_CLASS_VIOLATION (0x41)
243 #define TLDAP_NOT_ALLOWED_ON_NONLEAF (0x42)
244 #define TLDAP_NOT_ALLOWED_ON_RDN (0x43)
245 #define TLDAP_ALREADY_EXISTS (0x44)
246 #define TLDAP_NO_OBJECT_CLASS_MODS (0x45)
247 #define TLDAP_RESULTS_TOO_LARGE (0x46)
248 #define TLDAP_AFFECTS_MULTIPLE_DSAS (0x47)
249 #define TLDAP_OTHER (0x50)
250 #define TLDAP_SERVER_DOWN (0x51)
251 #define TLDAP_LOCAL_ERROR (0x52)
252 #define TLDAP_ENCODING_ERROR (0x53)
253 #define TLDAP_DECODING_ERROR (0x54)
254 #define TLDAP_TIMEOUT (0x55)
255 #define TLDAP_AUTH_UNKNOWN (0x56)
256 #define TLDAP_FILTER_ERROR (0x57)
257 #define TLDAP_USER_CANCELLED (0x58)
258 #define TLDAP_PARAM_ERROR (0x59)
259 #define TLDAP_NO_MEMORY (0x5a)
260 #define TLDAP_CONNECT_ERROR (0x5b)
261 #define TLDAP_NOT_SUPPORTED (0x5c)
262 #define TLDAP_CONTROL_NOT_FOUND (0x5d)
263 #define TLDAP_NO_RESULTS_RETURNED (0x5e)
264 #define TLDAP_MORE_RESULTS_TO_RETURN (0x5f)
265 #define TLDAP_CLIENT_LOOP (0x60)
266 #define TLDAP_REFERRAL_LIMIT_EXCEEDED (0x61)
267
268 #define TLDAP_MOD_ADD (0)
269 #define TLDAP_MOD_DELETE (1)
270 #define TLDAP_MOD_REPLACE (2)
271
272 #define TLDAP_SCOPE_BASE (0)
273 #define TLDAP_SCOPE_ONE (1)
274 #define TLDAP_SCOPE_SUB (2)
275
276 #define TLDAP_CONTROL_PAGEDRESULTS "1.2.840.113556.1.4.319"
277
278 #endif