]> git.sur5r.net Git - openldap/blob - libraries/libldap/error.c
LCUP primitive routines removed
[openldap] / libraries / libldap / error.c
1 /* $OpenLDAP$ */
2 /*
3  * Copyright 1998-2003 The OpenLDAP Foundation, All Rights Reserved.
4  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
5  */
6
7 #include "portable.h"
8
9 #include <stdio.h>
10
11 #include <ac/stdlib.h>
12
13 #include <ac/socket.h>
14 #include <ac/string.h>
15 #include <ac/time.h>
16
17 #include "ldap-int.h"
18
19 struct ldaperror {
20         int     e_code;
21         char *e_reason;
22 };
23
24 static struct ldaperror ldap_builtin_errlist[] = {
25         {LDAP_SUCCESS,                                  N_("Success")},
26         {LDAP_OPERATIONS_ERROR,                 N_("Operations error")},
27         {LDAP_PROTOCOL_ERROR,                   N_("Protocol error")},
28         {LDAP_TIMELIMIT_EXCEEDED,               N_("Time limit exceeded")},
29         {LDAP_SIZELIMIT_EXCEEDED,               N_("Size limit exceeded")},
30         {LDAP_COMPARE_FALSE,                    N_("Compare False")},
31         {LDAP_COMPARE_TRUE,                     N_("Compare True")},
32         {LDAP_STRONG_AUTH_NOT_SUPPORTED, N_("Authentication method not supported")},
33         {LDAP_STRONG_AUTH_REQUIRED,     N_("Strong(er) authentication required")},
34         {LDAP_PARTIAL_RESULTS,                  N_("Partial results and referral received")},
35
36         {LDAP_REFERRAL,                                 N_("Referral")},
37         {LDAP_ADMINLIMIT_EXCEEDED,              N_("Administrative limit exceeded")},
38         {LDAP_UNAVAILABLE_CRITICAL_EXTENSION,
39                                                                         N_("Critical extension is unavailable")},
40         {LDAP_CONFIDENTIALITY_REQUIRED, N_("Confidentiality required")},
41         {LDAP_SASL_BIND_IN_PROGRESS,    N_("SASL bind in progress")},
42
43         {LDAP_NO_SUCH_ATTRIBUTE,                N_("No such attribute")},
44         {LDAP_UNDEFINED_TYPE,                   N_("Undefined attribute type")},
45         {LDAP_INAPPROPRIATE_MATCHING,   N_("Inappropriate matching")},
46         {LDAP_CONSTRAINT_VIOLATION,     N_("Constraint violation")},
47         {LDAP_TYPE_OR_VALUE_EXISTS,     N_("Type or value exists")},
48         {LDAP_INVALID_SYNTAX,                   N_("Invalid syntax")},
49
50         {LDAP_NO_SUCH_OBJECT,                   N_("No such object")},
51         {LDAP_ALIAS_PROBLEM,                    N_("Alias problem")},
52         {LDAP_INVALID_DN_SYNTAX,                N_("Invalid DN syntax")},
53         {LDAP_IS_LEAF,                                  N_("Entry is a leaf")},
54         {LDAP_ALIAS_DEREF_PROBLEM,              N_("Alias dereferencing problem")},
55
56         {LDAP_PROXY_AUTHZ_FAILURE,              N_("Proxy Authorization Failure")},
57         {LDAP_INAPPROPRIATE_AUTH,               N_("Inappropriate authentication")},
58         {LDAP_INVALID_CREDENTIALS,              N_("Invalid credentials")},
59         {LDAP_INSUFFICIENT_ACCESS,              N_("Insufficient access")},
60         {LDAP_BUSY,                                     N_("Server is busy")},
61         {LDAP_UNAVAILABLE,                              N_("Server is unavailable")},
62         {LDAP_UNWILLING_TO_PERFORM,     N_("Server is unwilling to perform")},
63         {LDAP_LOOP_DETECT,                              N_("Loop detected")},
64
65         {LDAP_NAMING_VIOLATION,                 N_("Naming violation")},
66         {LDAP_OBJECT_CLASS_VIOLATION,   N_("Object class violation")},
67         {LDAP_NOT_ALLOWED_ON_NONLEAF,   N_("Operation not allowed on non-leaf")},
68         {LDAP_NOT_ALLOWED_ON_RDN,               N_("Operation not allowed on RDN")},
69         {LDAP_ALREADY_EXISTS,                   N_("Already exists")},
70         {LDAP_NO_OBJECT_CLASS_MODS,     N_("Cannot modify object class")},
71         {LDAP_RESULTS_TOO_LARGE,                N_("Results too large")},
72         {LDAP_AFFECTS_MULTIPLE_DSAS,    N_("Operation affects multiple DSAs")},
73
74         {LDAP_OTHER,                                    N_("Internal (implementation specific) error")},
75
76         /* API ResultCodes */
77         {LDAP_SERVER_DOWN,                              N_("Can't contact LDAP server")},
78         {LDAP_LOCAL_ERROR,                              N_("Local error")},
79         {LDAP_ENCODING_ERROR,                   N_("Encoding error")},
80         {LDAP_DECODING_ERROR,                   N_("Decoding error")},
81         {LDAP_TIMEOUT,                                  N_("Timed out")},
82         {LDAP_AUTH_UNKNOWN,                             N_("Unknown authentication method")},
83         {LDAP_FILTER_ERROR,                             N_("Bad search filter")},
84         {LDAP_USER_CANCELLED,                   N_("User cancelled operation")},
85         {LDAP_PARAM_ERROR,                              N_("Bad parameter to an ldap routine")},
86         {LDAP_NO_MEMORY,                                N_("Out of memory")},
87
88         {LDAP_CONNECT_ERROR,                    N_("Connect error")},
89         {LDAP_NOT_SUPPORTED,                    N_("Not Supported")},
90         {LDAP_CONTROL_NOT_FOUND,                N_("Control not found")},
91         {LDAP_NO_RESULTS_RETURNED,              N_("No results returned")},
92         {LDAP_MORE_RESULTS_TO_RETURN,   N_("More results to return")},
93         {LDAP_CLIENT_LOOP,                              N_("Client Loop")},
94         {LDAP_REFERRAL_LIMIT_EXCEEDED,  N_("Referral Limit Exceeded")},
95
96         {LDAP_ASSERTION_FAILED,                 N_("Assertion Failed")},
97
98 #ifdef LDAP_SYNC
99         {LDAP_SYNC_RESOURCES_EXHAUSTED, N_("Content Sync Resource Exhausted")},
100         {LDAP_SYNC_SECURITY_VIOLATION,  N_("Content Sync Security Violation")},
101         {LDAP_SYNC_INVALID_COOKIE,              N_("Content Sync Invalid Cookie")},
102         {LDAP_SYNC_UNSUPPORTED_SCHEME,  N_("Content Sync Unsupported Scheme")},
103         {LDAP_SYNC_CLIENT_DISCONNECT,   N_("Content Sync Client Disconnect")},
104         {LDAP_SYNC_RELOAD_REQUIRED,             N_("Content Sync Reload Required")},
105 #endif
106
107 #ifdef LDAP_EXOP_X_CANCEL
108         {LDAP_CANCELLED,                                N_("Cancelled")},
109         {LDAP_NO_SUCH_OPERATION,                N_("No Operation to Cancel")},
110         {LDAP_TOO_LATE,                                 N_("Too Late to Cancel")},
111         {LDAP_CANNOT_CANCEL,                    N_("Cannot Cancel")},
112 #endif
113
114         {-1, NULL}
115 };
116
117 static struct ldaperror *ldap_errlist = ldap_builtin_errlist; 
118
119 void ldap_int_error_init( void ) {
120 }
121
122 static const struct ldaperror *
123 ldap_int_error( int err )
124 {
125         int     i;
126
127         /* XXYYZ: O(n) search instead of O(1) lookup */
128         for ( i=0; ldap_errlist[i].e_reason != NULL; i++ ) {
129                 if ( err == ldap_errlist[i].e_code ) {
130                         return &ldap_errlist[i];
131                 }
132         }
133
134         return NULL;
135 }
136
137 char *
138 ldap_err2string( int err )
139 {
140         const struct ldaperror *e;
141         
142 #ifdef NEW_LOGGING
143         LDAP_LOG ( OPERATION, ENTRY, "ldap_err2string\n", 0,0,0 );
144 #else
145         Debug( LDAP_DEBUG_TRACE, "ldap_err2string\n", 0, 0, 0 );
146 #endif
147
148         e = ldap_int_error( err );
149
150         return e ? _(e->e_reason) : _("Unknown error");
151 }
152
153 /* deprecated */
154 void
155 ldap_perror( LDAP *ld, LDAP_CONST char *str )
156 {
157     int i;
158         const struct ldaperror *e;
159 #ifdef NEW_LOGGING
160         LDAP_LOG ( OPERATION, ENTRY, "ldap_perror\n", 0,0,0 );
161 #else
162         Debug( LDAP_DEBUG_TRACE, "ldap_perror\n", 0, 0, 0 );
163 #endif
164
165         assert( ld != NULL );
166         assert( LDAP_VALID( ld ) );
167         assert( str );
168
169         e = ldap_int_error( ld->ld_errno );
170
171         fprintf( stderr, "%s: %s (%d)\n",
172                 str ? str : "ldap_perror",
173                 e ? _(e->e_reason) : _("unknown LDAP result code"),
174                 ld->ld_errno );
175
176         if ( ld->ld_matched != NULL && ld->ld_matched[0] != '\0' ) {
177                 fprintf( stderr, _("\tmatched DN: %s\n"), ld->ld_matched );
178         }
179
180         if ( ld->ld_error != NULL && ld->ld_error[0] != '\0' ) {
181                 fprintf( stderr, _("\tadditional info: %s\n"), ld->ld_error );
182         }
183
184         if ( ld->ld_referrals != NULL && ld->ld_referrals[0] != NULL) {
185                 fprintf( stderr, _("\treferrals:\n") );
186                 for (i=0; ld->ld_referrals[i]; i++) {
187                         fprintf( stderr, _("\t\t%s\n"), ld->ld_referrals[i] );
188                 }
189         }
190
191         fflush( stderr );
192 }
193
194 /* deprecated */
195 int
196 ldap_result2error( LDAP *ld, LDAPMessage *r, int freeit )
197 {
198         int rc, err;
199
200         rc = ldap_parse_result( ld, r, &err,
201                 NULL, NULL, NULL, NULL, freeit );
202
203         return err != LDAP_SUCCESS ? err : rc;
204 }
205
206 /*
207  * Parse LDAPResult Messages:
208  *
209  *   LDAPResult ::= SEQUENCE {
210  *     resultCode      ENUMERATED,
211  *     matchedDN       LDAPDN,
212  *     errorMessage    LDAPString,
213  *     referral        [3] Referral OPTIONAL }
214  *
215  * including Bind results:
216  *
217  *   BindResponse ::= [APPLICATION 1] SEQUENCE {
218  *     COMPONENTS OF LDAPResult,
219  *     serverSaslCreds  [7] OCTET STRING OPTIONAL }
220  * 
221  * and ExtendedOp results:
222  *
223  *   ExtendedResponse ::= [APPLICATION 24] SEQUENCE {
224  *     COMPONENTS OF LDAPResult,
225  *     responseName     [10] LDAPOID OPTIONAL,
226  *     response         [11] OCTET STRING OPTIONAL }
227  *
228  */
229 int
230 ldap_parse_result(
231         LDAP                    *ld,
232         LDAPMessage             *r,
233         int                             *errcodep,
234         char                    **matcheddnp,
235         char                    **errmsgp,
236         char                    ***referralsp,
237         LDAPControl             ***serverctrls,
238         int                             freeit )
239 {
240         LDAPMessage     *lm;
241         ber_int_t errcode = LDAP_SUCCESS;
242
243         ber_tag_t tag;
244         BerElement      *ber;
245
246 #ifdef NEW_LOGGING
247         LDAP_LOG ( OPERATION, ENTRY, "ldap_parse_result\n", 0,0,0 );
248 #else
249         Debug( LDAP_DEBUG_TRACE, "ldap_parse_result\n", 0, 0, 0 );
250 #endif
251
252         assert( ld != NULL );
253         assert( LDAP_VALID( ld ) );
254         assert( r != NULL );
255
256         if(errcodep != NULL) *errcodep = LDAP_SUCCESS;
257         if(matcheddnp != NULL) *matcheddnp = NULL;
258         if(errmsgp != NULL) *errmsgp = NULL;
259         if(referralsp != NULL) *referralsp = NULL;
260         if(serverctrls != NULL) *serverctrls = NULL;
261
262 #ifdef LDAP_R_COMPILE
263         ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
264 #endif
265         /* Find the next result... */
266         for ( lm = r; lm != NULL; lm = lm->lm_chain ) {
267                 /* skip over entries and references */
268                 if( lm->lm_msgtype != LDAP_RES_SEARCH_ENTRY &&
269                         lm->lm_msgtype != LDAP_RES_SEARCH_REFERENCE &&
270                         lm->lm_msgtype != LDAP_RES_INTERMEDIATE )
271                 {
272                         break;
273                 }
274         }
275
276         if( lm == NULL ) {
277                 ld->ld_errno = LDAP_NO_RESULTS_RETURNED;
278 #ifdef LDAP_R_COMPILE
279                 ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
280 #endif
281                 return ld->ld_errno;
282         }
283
284         if ( ld->ld_error ) {
285                 LDAP_FREE( ld->ld_error );
286                 ld->ld_error = NULL;
287         }
288         if ( ld->ld_matched ) {
289                 LDAP_FREE( ld->ld_matched );
290                 ld->ld_matched = NULL;
291         }
292         if ( ld->ld_referrals ) {
293                 LDAP_VFREE( ld->ld_referrals );
294                 ld->ld_referrals = NULL;
295         }
296
297         /* parse results */
298
299         ber = ber_dup( lm->lm_ber );
300
301         if ( ld->ld_version < LDAP_VERSION2 ) {
302                 tag = ber_scanf( ber, "{ia}",
303                         &ld->ld_errno, &ld->ld_error );
304         } else {
305                 ber_len_t len;
306                 tag = ber_scanf( ber, "{iaa" /*}*/,
307                         &ld->ld_errno, &ld->ld_matched, &ld->ld_error );
308
309                 if( tag != LBER_ERROR ) {
310                         /* peek for referrals */
311                         if( ber_peek_tag(ber, &len) == LDAP_TAG_REFERRAL ) {
312                                 tag = ber_scanf( ber, "v", &ld->ld_referrals );
313                         }
314                 }
315
316                 /* need to clean out misc items */
317                 if( tag != LBER_ERROR ) {
318                         if( lm->lm_msgtype == LDAP_RES_BIND ) {
319                                 /* look for sasl result creditials */
320                                 if ( ber_peek_tag( ber, &len ) == LDAP_TAG_SASL_RES_CREDS ) {
321                                         /* skip 'em */
322                                         tag = ber_scanf( ber, "x" );
323                                 }
324
325                         } else if( lm->lm_msgtype == LDAP_RES_EXTENDED ) {
326                                 /* look for exop result oid or value */
327                                 if ( ber_peek_tag( ber, &len ) == LDAP_TAG_EXOP_RES_OID ) {
328                                         /* skip 'em */
329                                         tag = ber_scanf( ber, "x" );
330                                 }
331
332                                 if ( tag != LBER_ERROR &&
333                                         ber_peek_tag( ber, &len ) == LDAP_TAG_EXOP_RES_VALUE )
334                                 {
335                                         /* skip 'em */
336                                         tag = ber_scanf( ber, "x" );
337                                 }
338                         }
339                 }
340
341                 if( tag != LBER_ERROR ) {
342                         int rc = ldap_int_get_controls( ber, serverctrls );
343
344                         if( rc != LDAP_SUCCESS ) {
345                                 tag = LBER_ERROR;
346                         }
347                 }
348
349                 if( tag != LBER_ERROR ) {
350                         tag = ber_scanf( ber, /*{*/"}" );
351                 }
352         }
353
354         if ( tag == LBER_ERROR ) {
355                 ld->ld_errno = errcode = LDAP_DECODING_ERROR;
356         }
357
358         if( ber != NULL ) {
359                 ber_free( ber, 0 );
360         }
361
362         /* return */
363         if( errcodep != NULL ) {
364                 *errcodep = ld->ld_errno;
365         }
366         if ( errcode == LDAP_SUCCESS ) {
367                 if( matcheddnp != NULL ) {
368                         *matcheddnp = LDAP_STRDUP( ld->ld_matched );
369                 }
370                 if( errmsgp != NULL ) {
371                         *errmsgp = LDAP_STRDUP( ld->ld_error );
372                 }
373
374                 if( referralsp != NULL) {
375                         *referralsp = ldap_value_dup( ld->ld_referrals );
376                 }
377
378                 /* Find the next result... */
379                 for ( lm = lm->lm_chain; lm != NULL; lm = lm->lm_chain ) {
380                         /* skip over entries and references */
381                         if( lm->lm_msgtype != LDAP_RES_SEARCH_ENTRY &&
382                                 lm->lm_msgtype != LDAP_RES_SEARCH_REFERENCE &&
383                                 lm->lm_msgtype != LDAP_RES_INTERMEDIATE )
384                         {
385                                 /* more results to return */
386                                 errcode = LDAP_MORE_RESULTS_TO_RETURN;
387                                 break;
388                         }
389                 }
390         }
391
392         if ( freeit ) {
393                 ldap_msgfree( r );
394         }
395 #ifdef LDAP_R_COMPILE
396         ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
397 #endif
398
399         return( errcode );
400 }