2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2006 The OpenLDAP Foundation.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted only as authorized by the OpenLDAP
11 * A copy of this license is available in the file LICENSE in the
12 * top-level directory of the distribution or, alternatively, at
13 * <http://www.OpenLDAP.org/license.html>.
15 /* Portions Copyright (C) The Internet Society (1997)
16 * ASN.1 fragments are from RFC 2251; see RFC for full legal notices.
23 #include <ac/stdlib.h>
25 #include <ac/socket.h>
26 #include <ac/string.h>
36 static struct ldaperror ldap_builtin_errlist[] = {
37 {LDAP_SUCCESS, N_("Success")},
38 {LDAP_OPERATIONS_ERROR, N_("Operations error")},
39 {LDAP_PROTOCOL_ERROR, N_("Protocol error")},
40 {LDAP_TIMELIMIT_EXCEEDED, N_("Time limit exceeded")},
41 {LDAP_SIZELIMIT_EXCEEDED, N_("Size limit exceeded")},
42 {LDAP_COMPARE_FALSE, N_("Compare False")},
43 {LDAP_COMPARE_TRUE, N_("Compare True")},
44 {LDAP_STRONG_AUTH_NOT_SUPPORTED, N_("Authentication method not supported")},
45 {LDAP_STRONG_AUTH_REQUIRED, N_("Strong(er) authentication required")},
46 {LDAP_PARTIAL_RESULTS, N_("Partial results and referral received")},
48 {LDAP_REFERRAL, N_("Referral")},
49 {LDAP_ADMINLIMIT_EXCEEDED, N_("Administrative limit exceeded")},
50 {LDAP_UNAVAILABLE_CRITICAL_EXTENSION,
51 N_("Critical extension is unavailable")},
52 {LDAP_CONFIDENTIALITY_REQUIRED, N_("Confidentiality required")},
53 {LDAP_SASL_BIND_IN_PROGRESS, N_("SASL bind in progress")},
55 {LDAP_NO_SUCH_ATTRIBUTE, N_("No such attribute")},
56 {LDAP_UNDEFINED_TYPE, N_("Undefined attribute type")},
57 {LDAP_INAPPROPRIATE_MATCHING, N_("Inappropriate matching")},
58 {LDAP_CONSTRAINT_VIOLATION, N_("Constraint violation")},
59 {LDAP_TYPE_OR_VALUE_EXISTS, N_("Type or value exists")},
60 {LDAP_INVALID_SYNTAX, N_("Invalid syntax")},
62 {LDAP_NO_SUCH_OBJECT, N_("No such object")},
63 {LDAP_ALIAS_PROBLEM, N_("Alias problem")},
64 {LDAP_INVALID_DN_SYNTAX, N_("Invalid DN syntax")},
65 {LDAP_IS_LEAF, N_("Entry is a leaf")},
66 {LDAP_ALIAS_DEREF_PROBLEM, N_("Alias dereferencing problem")},
68 {LDAP_INAPPROPRIATE_AUTH, N_("Inappropriate authentication")},
69 {LDAP_INVALID_CREDENTIALS, N_("Invalid credentials")},
70 {LDAP_INSUFFICIENT_ACCESS, N_("Insufficient access")},
71 {LDAP_BUSY, N_("Server is busy")},
72 {LDAP_UNAVAILABLE, N_("Server is unavailable")},
73 {LDAP_UNWILLING_TO_PERFORM, N_("Server is unwilling to perform")},
74 {LDAP_LOOP_DETECT, N_("Loop detected")},
76 {LDAP_NAMING_VIOLATION, N_("Naming violation")},
77 {LDAP_OBJECT_CLASS_VIOLATION, N_("Object class violation")},
78 {LDAP_NOT_ALLOWED_ON_NONLEAF, N_("Operation not allowed on non-leaf")},
79 {LDAP_NOT_ALLOWED_ON_RDN, N_("Operation not allowed on RDN")},
80 {LDAP_ALREADY_EXISTS, N_("Already exists")},
81 {LDAP_NO_OBJECT_CLASS_MODS, N_("Cannot modify object class")},
82 {LDAP_RESULTS_TOO_LARGE, N_("Results too large")},
83 {LDAP_AFFECTS_MULTIPLE_DSAS, N_("Operation affects multiple DSAs")},
85 {LDAP_OTHER, N_("Other (e.g., implementation specific) error")},
87 {LDAP_CANCELLED, N_("Cancelled")},
88 {LDAP_NO_SUCH_OPERATION, N_("No Operation to Cancel")},
89 {LDAP_TOO_LATE, N_("Too Late to Cancel")},
90 {LDAP_CANNOT_CANCEL, N_("Cannot Cancel")},
92 {LDAP_ASSERTION_FAILED, N_("Assertion Failed")},
93 {LDAP_X_ASSERTION_FAILED, N_("Assertion Failed (X)")},
95 {LDAP_PROXIED_AUTHORIZATION_DENIED, N_("Proxied Authorization Denied")},
96 {LDAP_X_PROXY_AUTHZ_FAILURE, N_("Proxy Authorization Failure (X)")},
98 {LDAP_SYNC_REFRESH_REQUIRED, N_("Content Sync Refresh Required")},
99 {LDAP_X_SYNC_REFRESH_REQUIRED, N_("Content Sync Refresh Required (X)")},
101 {LDAP_X_NO_OPERATION, N_("No Operation (X)")},
103 {LDAP_CUP_RESOURCES_EXHAUSTED, N_("LCUP Resources Exhausted")},
104 {LDAP_CUP_SECURITY_VIOLATION, N_("LCUP Security Violation")},
105 {LDAP_CUP_INVALID_DATA, N_("LCUP Invalid Data")},
106 {LDAP_CUP_UNSUPPORTED_SCHEME, N_("LCUP Unsupported Scheme")},
107 {LDAP_CUP_RELOAD_REQUIRED, N_("LCUP Reload Required")},
110 {LDAP_X_TXN_SPECIFY_OKAY, N_("TXN specify okay")},
111 {LDAP_X_TXN_ID_INVALID, N_("TXN ID is invalid")},
114 /* API ResultCodes */
115 {LDAP_SERVER_DOWN, N_("Can't contact LDAP server")},
116 {LDAP_LOCAL_ERROR, N_("Local error")},
117 {LDAP_ENCODING_ERROR, N_("Encoding error")},
118 {LDAP_DECODING_ERROR, N_("Decoding error")},
119 {LDAP_TIMEOUT, N_("Timed out")},
120 {LDAP_AUTH_UNKNOWN, N_("Unknown authentication method")},
121 {LDAP_FILTER_ERROR, N_("Bad search filter")},
122 {LDAP_USER_CANCELLED, N_("User cancelled operation")},
123 {LDAP_PARAM_ERROR, N_("Bad parameter to an ldap routine")},
124 {LDAP_NO_MEMORY, N_("Out of memory")},
126 {LDAP_CONNECT_ERROR, N_("Connect error")},
127 {LDAP_NOT_SUPPORTED, N_("Not Supported")},
128 {LDAP_CONTROL_NOT_FOUND, N_("Control not found")},
129 {LDAP_NO_RESULTS_RETURNED, N_("No results returned")},
130 {LDAP_MORE_RESULTS_TO_RETURN, N_("More results to return")},
131 {LDAP_CLIENT_LOOP, N_("Client Loop")},
132 {LDAP_REFERRAL_LIMIT_EXCEEDED, N_("Referral Limit Exceeded")},
137 static struct ldaperror *ldap_errlist = ldap_builtin_errlist;
139 void ldap_int_error_init( void ) {
142 static const struct ldaperror *
143 ldap_int_error( int err )
147 /* XXYYZ: O(n) search instead of O(1) lookup */
148 for ( i=0; ldap_errlist[i].e_reason != NULL; i++ ) {
149 if ( err == ldap_errlist[i].e_code ) {
150 return &ldap_errlist[i];
158 ldap_err2string( int err )
160 const struct ldaperror *e;
162 Debug( LDAP_DEBUG_TRACE, "ldap_err2string\n", 0, 0, 0 );
164 e = ldap_int_error( err );
169 } else if ( LDAP_API_ERROR(err) ) {
170 return _("Unknown API error");
172 } else if ( LDAP_E_ERROR(err) ) {
173 return _("Unknown (extension) error");
175 } else if ( LDAP_X_ERROR(err) ) {
176 return _("Unknown (private extension) error");
179 return _("Unknown error");
184 ldap_perror( LDAP *ld, LDAP_CONST char *str )
187 const struct ldaperror *e;
188 Debug( LDAP_DEBUG_TRACE, "ldap_perror\n", 0, 0, 0 );
190 assert( ld != NULL );
191 assert( LDAP_VALID( ld ) );
192 assert( str != NULL );
194 e = ldap_int_error( ld->ld_errno );
196 fprintf( stderr, "%s: %s (%d)\n",
197 str ? str : "ldap_perror",
198 e ? _(e->e_reason) : _("unknown result code"),
201 if ( ld->ld_matched != NULL && ld->ld_matched[0] != '\0' ) {
202 fprintf( stderr, _("\tmatched DN: %s\n"), ld->ld_matched );
205 if ( ld->ld_error != NULL && ld->ld_error[0] != '\0' ) {
206 fprintf( stderr, _("\tadditional info: %s\n"), ld->ld_error );
209 if ( ld->ld_referrals != NULL && ld->ld_referrals[0] != NULL) {
210 fprintf( stderr, _("\treferrals:\n") );
211 for (i=0; ld->ld_referrals[i]; i++) {
212 fprintf( stderr, _("\t\t%s\n"), ld->ld_referrals[i] );
221 ldap_result2error( LDAP *ld, LDAPMessage *r, int freeit )
225 rc = ldap_parse_result( ld, r, &err,
226 NULL, NULL, NULL, NULL, freeit );
228 return err != LDAP_SUCCESS ? err : rc;
232 * Parse LDAPResult Messages:
234 * LDAPResult ::= SEQUENCE {
235 * resultCode ENUMERATED,
237 * errorMessage LDAPString,
238 * referral [3] Referral OPTIONAL }
240 * including Bind results:
242 * BindResponse ::= [APPLICATION 1] SEQUENCE {
243 * COMPONENTS OF LDAPResult,
244 * serverSaslCreds [7] OCTET STRING OPTIONAL }
246 * and ExtendedOp results:
248 * ExtendedResponse ::= [APPLICATION 24] SEQUENCE {
249 * COMPONENTS OF LDAPResult,
250 * responseName [10] LDAPOID OPTIONAL,
251 * response [11] OCTET STRING OPTIONAL }
262 LDAPControl ***serverctrls,
266 ber_int_t errcode = LDAP_SUCCESS;
271 Debug( LDAP_DEBUG_TRACE, "ldap_parse_result\n", 0, 0, 0 );
273 assert( ld != NULL );
274 assert( LDAP_VALID( ld ) );
277 if(errcodep != NULL) *errcodep = LDAP_SUCCESS;
278 if(matcheddnp != NULL) *matcheddnp = NULL;
279 if(errmsgp != NULL) *errmsgp = NULL;
280 if(referralsp != NULL) *referralsp = NULL;
281 if(serverctrls != NULL) *serverctrls = NULL;
283 #ifdef LDAP_R_COMPILE
284 ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
286 /* Find the result, last msg in chain... */
287 lm = r->lm_chain_tail;
288 /* FIXME: either this is not possible (assert?)
289 * or it should be handled */
291 switch ( lm->lm_msgtype ) {
292 case LDAP_RES_SEARCH_ENTRY:
293 case LDAP_RES_SEARCH_REFERENCE:
294 case LDAP_RES_INTERMEDIATE:
304 ld->ld_errno = LDAP_NO_RESULTS_RETURNED;
305 #ifdef LDAP_R_COMPILE
306 ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
311 if ( ld->ld_error ) {
312 LDAP_FREE( ld->ld_error );
315 if ( ld->ld_matched ) {
316 LDAP_FREE( ld->ld_matched );
317 ld->ld_matched = NULL;
319 if ( ld->ld_referrals ) {
320 LDAP_VFREE( ld->ld_referrals );
321 ld->ld_referrals = NULL;
326 ber = ber_dup( lm->lm_ber );
328 if ( ld->ld_version < LDAP_VERSION2 ) {
329 tag = ber_scanf( ber, "{iA}",
330 &ld->ld_errno, &ld->ld_error );
335 tag = ber_scanf( ber, "{iAA" /*}*/,
336 &ld->ld_errno, &ld->ld_matched, &ld->ld_error );
338 if( tag != LBER_ERROR ) {
339 /* peek for referrals */
340 if( ber_peek_tag(ber, &len) == LDAP_TAG_REFERRAL ) {
341 tag = ber_scanf( ber, "v", &ld->ld_referrals );
345 /* need to clean out misc items */
346 if( tag != LBER_ERROR ) {
347 if( lm->lm_msgtype == LDAP_RES_BIND ) {
348 /* look for sasl result creditials */
349 if ( ber_peek_tag( ber, &len ) == LDAP_TAG_SASL_RES_CREDS ) {
351 tag = ber_scanf( ber, "x" );
354 } else if( lm->lm_msgtype == LDAP_RES_EXTENDED ) {
355 /* look for exop result oid or value */
356 if ( ber_peek_tag( ber, &len ) == LDAP_TAG_EXOP_RES_OID ) {
358 tag = ber_scanf( ber, "x" );
361 if ( tag != LBER_ERROR &&
362 ber_peek_tag( ber, &len ) == LDAP_TAG_EXOP_RES_VALUE )
365 tag = ber_scanf( ber, "x" );
370 if( tag != LBER_ERROR ) {
371 int rc = ldap_pvt_get_controls( ber, serverctrls );
373 if( rc != LDAP_SUCCESS ) {
378 if( tag != LBER_ERROR ) {
379 tag = ber_scanf( ber, /*{*/"}" );
383 if ( tag == LBER_ERROR ) {
384 ld->ld_errno = errcode = LDAP_DECODING_ERROR;
392 if( errcodep != NULL ) {
393 *errcodep = ld->ld_errno;
395 if ( errcode == LDAP_SUCCESS ) {
396 if( matcheddnp != NULL ) {
397 if ( ld->ld_matched )
399 *matcheddnp = LDAP_STRDUP( ld->ld_matched );
402 if( errmsgp != NULL ) {
405 *errmsgp = LDAP_STRDUP( ld->ld_error );
409 if( referralsp != NULL) {
410 *referralsp = ldap_value_dup( ld->ld_referrals );
417 #ifdef LDAP_R_COMPILE
418 ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );