2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2003 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_PROXY_AUTHZ_FAILURE, N_("Proxy Authorization Failure")},
69 {LDAP_INAPPROPRIATE_AUTH, N_("Inappropriate authentication")},
70 {LDAP_INVALID_CREDENTIALS, N_("Invalid credentials")},
71 {LDAP_INSUFFICIENT_ACCESS, N_("Insufficient access")},
72 {LDAP_BUSY, N_("Server is busy")},
73 {LDAP_UNAVAILABLE, N_("Server is unavailable")},
74 {LDAP_UNWILLING_TO_PERFORM, N_("Server is unwilling to perform")},
75 {LDAP_LOOP_DETECT, N_("Loop detected")},
77 {LDAP_NAMING_VIOLATION, N_("Naming violation")},
78 {LDAP_OBJECT_CLASS_VIOLATION, N_("Object class violation")},
79 {LDAP_NOT_ALLOWED_ON_NONLEAF, N_("Operation not allowed on non-leaf")},
80 {LDAP_NOT_ALLOWED_ON_RDN, N_("Operation not allowed on RDN")},
81 {LDAP_ALREADY_EXISTS, N_("Already exists")},
82 {LDAP_NO_OBJECT_CLASS_MODS, N_("Cannot modify object class")},
83 {LDAP_RESULTS_TOO_LARGE, N_("Results too large")},
84 {LDAP_AFFECTS_MULTIPLE_DSAS, N_("Operation affects multiple DSAs")},
86 {LDAP_OTHER, N_("Internal (implementation specific) error")},
89 {LDAP_SERVER_DOWN, N_("Can't contact LDAP server")},
90 {LDAP_LOCAL_ERROR, N_("Local error")},
91 {LDAP_ENCODING_ERROR, N_("Encoding error")},
92 {LDAP_DECODING_ERROR, N_("Decoding error")},
93 {LDAP_TIMEOUT, N_("Timed out")},
94 {LDAP_AUTH_UNKNOWN, N_("Unknown authentication method")},
95 {LDAP_FILTER_ERROR, N_("Bad search filter")},
96 {LDAP_USER_CANCELLED, N_("User cancelled operation")},
97 {LDAP_PARAM_ERROR, N_("Bad parameter to an ldap routine")},
98 {LDAP_NO_MEMORY, N_("Out of memory")},
100 {LDAP_CONNECT_ERROR, N_("Connect error")},
101 {LDAP_NOT_SUPPORTED, N_("Not Supported")},
102 {LDAP_CONTROL_NOT_FOUND, N_("Control not found")},
103 {LDAP_NO_RESULTS_RETURNED, N_("No results returned")},
104 {LDAP_MORE_RESULTS_TO_RETURN, N_("More results to return")},
105 {LDAP_CLIENT_LOOP, N_("Client Loop")},
106 {LDAP_REFERRAL_LIMIT_EXCEEDED, N_("Referral Limit Exceeded")},
108 {LDAP_ASSERTION_FAILED, N_("Assertion Failed")},
110 {LDAP_SYNC_RESOURCES_EXHAUSTED, N_("Content Sync Resource Exhausted")},
111 {LDAP_SYNC_SECURITY_VIOLATION, N_("Content Sync Security Violation")},
112 {LDAP_SYNC_INVALID_COOKIE, N_("Content Sync Invalid Cookie")},
113 {LDAP_SYNC_UNSUPPORTED_SCHEME, N_("Content Sync Unsupported Scheme")},
114 {LDAP_SYNC_CLIENT_DISCONNECT, N_("Content Sync Client Disconnect")},
115 {LDAP_SYNC_RELOAD_REQUIRED, N_("Content Sync Reload Required")},
117 #ifdef LDAP_EXOP_X_CANCEL
118 {LDAP_CANCELLED, N_("Cancelled")},
119 {LDAP_NO_SUCH_OPERATION, N_("No Operation to Cancel")},
120 {LDAP_TOO_LATE, N_("Too Late to Cancel")},
121 {LDAP_CANNOT_CANCEL, N_("Cannot Cancel")},
127 static struct ldaperror *ldap_errlist = ldap_builtin_errlist;
129 void ldap_int_error_init( void ) {
132 static const struct ldaperror *
133 ldap_int_error( int err )
137 /* XXYYZ: O(n) search instead of O(1) lookup */
138 for ( i=0; ldap_errlist[i].e_reason != NULL; i++ ) {
139 if ( err == ldap_errlist[i].e_code ) {
140 return &ldap_errlist[i];
148 ldap_err2string( int err )
150 const struct ldaperror *e;
153 LDAP_LOG ( OPERATION, ENTRY, "ldap_err2string\n", 0,0,0 );
155 Debug( LDAP_DEBUG_TRACE, "ldap_err2string\n", 0, 0, 0 );
158 e = ldap_int_error( err );
160 return e ? _(e->e_reason) : _("Unknown error");
165 ldap_perror( LDAP *ld, LDAP_CONST char *str )
168 const struct ldaperror *e;
170 LDAP_LOG ( OPERATION, ENTRY, "ldap_perror\n", 0,0,0 );
172 Debug( LDAP_DEBUG_TRACE, "ldap_perror\n", 0, 0, 0 );
175 assert( ld != NULL );
176 assert( LDAP_VALID( ld ) );
179 e = ldap_int_error( ld->ld_errno );
181 fprintf( stderr, "%s: %s (%d)\n",
182 str ? str : "ldap_perror",
183 e ? _(e->e_reason) : _("unknown LDAP result code"),
186 if ( ld->ld_matched != NULL && ld->ld_matched[0] != '\0' ) {
187 fprintf( stderr, _("\tmatched DN: %s\n"), ld->ld_matched );
190 if ( ld->ld_error != NULL && ld->ld_error[0] != '\0' ) {
191 fprintf( stderr, _("\tadditional info: %s\n"), ld->ld_error );
194 if ( ld->ld_referrals != NULL && ld->ld_referrals[0] != NULL) {
195 fprintf( stderr, _("\treferrals:\n") );
196 for (i=0; ld->ld_referrals[i]; i++) {
197 fprintf( stderr, _("\t\t%s\n"), ld->ld_referrals[i] );
206 ldap_result2error( LDAP *ld, LDAPMessage *r, int freeit )
210 rc = ldap_parse_result( ld, r, &err,
211 NULL, NULL, NULL, NULL, freeit );
213 return err != LDAP_SUCCESS ? err : rc;
217 * Parse LDAPResult Messages:
219 * LDAPResult ::= SEQUENCE {
220 * resultCode ENUMERATED,
222 * errorMessage LDAPString,
223 * referral [3] Referral OPTIONAL }
225 * including Bind results:
227 * BindResponse ::= [APPLICATION 1] SEQUENCE {
228 * COMPONENTS OF LDAPResult,
229 * serverSaslCreds [7] OCTET STRING OPTIONAL }
231 * and ExtendedOp results:
233 * ExtendedResponse ::= [APPLICATION 24] SEQUENCE {
234 * COMPONENTS OF LDAPResult,
235 * responseName [10] LDAPOID OPTIONAL,
236 * response [11] OCTET STRING OPTIONAL }
247 LDAPControl ***serverctrls,
251 ber_int_t errcode = LDAP_SUCCESS;
257 LDAP_LOG ( OPERATION, ENTRY, "ldap_parse_result\n", 0,0,0 );
259 Debug( LDAP_DEBUG_TRACE, "ldap_parse_result\n", 0, 0, 0 );
262 assert( ld != NULL );
263 assert( LDAP_VALID( ld ) );
266 if(errcodep != NULL) *errcodep = LDAP_SUCCESS;
267 if(matcheddnp != NULL) *matcheddnp = NULL;
268 if(errmsgp != NULL) *errmsgp = NULL;
269 if(referralsp != NULL) *referralsp = NULL;
270 if(serverctrls != NULL) *serverctrls = NULL;
272 #ifdef LDAP_R_COMPILE
273 ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
275 /* Find the next result... */
276 for ( lm = r; lm != NULL; lm = lm->lm_chain ) {
277 /* skip over entries and references */
278 if( lm->lm_msgtype != LDAP_RES_SEARCH_ENTRY &&
279 lm->lm_msgtype != LDAP_RES_SEARCH_REFERENCE &&
280 lm->lm_msgtype != LDAP_RES_INTERMEDIATE )
287 ld->ld_errno = LDAP_NO_RESULTS_RETURNED;
288 #ifdef LDAP_R_COMPILE
289 ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
294 if ( ld->ld_error ) {
295 LDAP_FREE( ld->ld_error );
298 if ( ld->ld_matched ) {
299 LDAP_FREE( ld->ld_matched );
300 ld->ld_matched = NULL;
302 if ( ld->ld_referrals ) {
303 LDAP_VFREE( ld->ld_referrals );
304 ld->ld_referrals = NULL;
309 ber = ber_dup( lm->lm_ber );
311 if ( ld->ld_version < LDAP_VERSION2 ) {
312 tag = ber_scanf( ber, "{ia}",
313 &ld->ld_errno, &ld->ld_error );
316 tag = ber_scanf( ber, "{iaa" /*}*/,
317 &ld->ld_errno, &ld->ld_matched, &ld->ld_error );
319 if( tag != LBER_ERROR ) {
320 /* peek for referrals */
321 if( ber_peek_tag(ber, &len) == LDAP_TAG_REFERRAL ) {
322 tag = ber_scanf( ber, "v", &ld->ld_referrals );
326 /* need to clean out misc items */
327 if( tag != LBER_ERROR ) {
328 if( lm->lm_msgtype == LDAP_RES_BIND ) {
329 /* look for sasl result creditials */
330 if ( ber_peek_tag( ber, &len ) == LDAP_TAG_SASL_RES_CREDS ) {
332 tag = ber_scanf( ber, "x" );
335 } else if( lm->lm_msgtype == LDAP_RES_EXTENDED ) {
336 /* look for exop result oid or value */
337 if ( ber_peek_tag( ber, &len ) == LDAP_TAG_EXOP_RES_OID ) {
339 tag = ber_scanf( ber, "x" );
342 if ( tag != LBER_ERROR &&
343 ber_peek_tag( ber, &len ) == LDAP_TAG_EXOP_RES_VALUE )
346 tag = ber_scanf( ber, "x" );
351 if( tag != LBER_ERROR ) {
352 int rc = ldap_pvt_get_controls( ber, serverctrls );
354 if( rc != LDAP_SUCCESS ) {
359 if( tag != LBER_ERROR ) {
360 tag = ber_scanf( ber, /*{*/"}" );
364 if ( tag == LBER_ERROR ) {
365 ld->ld_errno = errcode = LDAP_DECODING_ERROR;
373 if( errcodep != NULL ) {
374 *errcodep = ld->ld_errno;
376 if ( errcode == LDAP_SUCCESS ) {
377 if( matcheddnp != NULL ) {
378 *matcheddnp = LDAP_STRDUP( ld->ld_matched );
380 if( errmsgp != NULL ) {
381 *errmsgp = LDAP_STRDUP( ld->ld_error );
384 if( referralsp != NULL) {
385 *referralsp = ldap_value_dup( ld->ld_referrals );
388 /* Find the next result... */
389 for ( lm = lm->lm_chain; lm != NULL; lm = lm->lm_chain ) {
390 /* skip over entries and references */
391 if( lm->lm_msgtype != LDAP_RES_SEARCH_ENTRY &&
392 lm->lm_msgtype != LDAP_RES_SEARCH_REFERENCE &&
393 lm->lm_msgtype != LDAP_RES_INTERMEDIATE )
395 /* more results to return */
396 errcode = LDAP_MORE_RESULTS_TO_RETURN;
405 #ifdef LDAP_R_COMPILE
406 ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );