]> git.sur5r.net Git - openldap/blobdiff - libraries/libldap/error.c
ITS#6703
[openldap] / libraries / libldap / error.c
index 26c8778047cf9a5ccaaff9e74de18020e554b864..b0d5d3cda1234163ecd8b5be3274274067dc78b2 100644 (file)
+/* $OpenLDAP$ */
+/* This work is part of OpenLDAP Software <http://www.openldap.org/>.
+ *
+ * Copyright 1998-2010 The OpenLDAP Foundation.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted only as authorized by the OpenLDAP
+ * Public License.
+ *
+ * A copy of this license is available in the file LICENSE in the
+ * top-level directory of the distribution or, alternatively, at
+ * <http://www.OpenLDAP.org/license.html>.
+ */
+
 #include "portable.h"
 
 #include <stdio.h>
-#include <stdlib.h>
+
+#include <ac/stdlib.h>
 
 #include <ac/socket.h>
 #include <ac/string.h>
 #include <ac/time.h>
 
-#include "lber.h"
-#include "ldap.h"
-
-struct ldaperror {
-       int     e_code;
-       char    *e_reason;
-};
-
-static struct ldaperror ldap_errlist[] = {
-       {LDAP_SUCCESS,                                  "Success" },
-       {LDAP_OPERATIONS_ERROR,                 "Operations error" },
-       {LDAP_PROTOCOL_ERROR,                   "Protocol error" },
-       {LDAP_TIMELIMIT_EXCEEDED,               "Timelimit exceeded" },
-       {LDAP_SIZELIMIT_EXCEEDED,               "Sizelimit exceeded" },
-       {LDAP_COMPARE_FALSE,                    "Compare false" },
-       {LDAP_COMPARE_TRUE,                     "Compare true" },
-       {LDAP_STRONG_AUTH_NOT_SUPPORTED, "Strong authentication not supported" },
-       {LDAP_STRONG_AUTH_REQUIRED,     "Strong authentication required" },
-       {LDAP_PARTIAL_RESULTS,                  "Partial results and referral received" },
-       {LDAP_NO_SUCH_ATTRIBUTE,                "No such attribute" },
-       {LDAP_UNDEFINED_TYPE,                   "Undefined attribute type" },
-       {LDAP_INAPPROPRIATE_MATCHING,   "Inappropriate matching" },
-       {LDAP_CONSTRAINT_VIOLATION,     "Constraint violation" },
-       {LDAP_TYPE_OR_VALUE_EXISTS,     "Type or value exists" },
-       {LDAP_INVALID_SYNTAX,                   "Invalid syntax" },
-       {LDAP_NO_SUCH_OBJECT,                   "No such object" },
-       {LDAP_ALIAS_PROBLEM,                    "Alias problem" },
-       {LDAP_INVALID_DN_SYNTAX,                "Invalid DN syntax" },
-       {LDAP_IS_LEAF,                                  "Object is a leaf" },
-       {LDAP_ALIAS_DEREF_PROBLEM,              "Alias dereferencing problem" },
-       {LDAP_INAPPROPRIATE_AUTH,               "Inappropriate authentication" },
-       {LDAP_INVALID_CREDENTIALS,              "Invalid credentials" },
-       {LDAP_INSUFFICIENT_ACCESS,              "Insufficient access" },
-       {LDAP_BUSY,                                     "DSA is busy" },
-       {LDAP_UNAVAILABLE,                              "DSA is unavailable" },
-       {LDAP_UNWILLING_TO_PERFORM,     "DSA is unwilling to perform" },
-       {LDAP_LOOP_DETECT,                              "Loop detected" },
-       {LDAP_NAMING_VIOLATION,                 "Naming violation" },
-       {LDAP_OBJECT_CLASS_VIOLATION,   "Object class violation" },
-       {LDAP_NOT_ALLOWED_ON_NONLEAF,   "Operation not allowed on nonleaf" },
-       {LDAP_NOT_ALLOWED_ON_RDN,               "Operation not allowed on RDN" },
-       {LDAP_ALREADY_EXISTS,                   "Already exists" },
-       {LDAP_NO_OBJECT_CLASS_MODS,     "Cannot modify object class" },
-       {LDAP_RESULTS_TOO_LARGE,                "Results too large" },
-       {LDAP_OTHER,                                    "Unknown error" },
-       {LDAP_SERVER_DOWN,                              "Can't contact LDAP server" },
-       {LDAP_LOCAL_ERROR,                              "Local error" },
-       {LDAP_ENCODING_ERROR,                   "Encoding error" },
-       {LDAP_DECODING_ERROR,                   "Decoding error" },
-       {LDAP_TIMEOUT,                                  "Timed out" },
-       {LDAP_AUTH_UNKNOWN,                             "Unknown authentication method" },
-       {LDAP_FILTER_ERROR,                             "Bad search filter" },
-       {LDAP_USER_CANCELLED,                   "User cancelled operation" },
-       {LDAP_PARAM_ERROR,                              "Bad parameter to an ldap routine" },
-       {LDAP_NO_MEMORY,                                "Out of memory" },
-       {-1, 0 }
-};
+#include "ldap-int.h"
+
+void ldap_int_error_init( void ) {
+}
 
 char *
 ldap_err2string( int err )
 {
-       int     i;
+       char *m;
 
        Debug( LDAP_DEBUG_TRACE, "ldap_err2string\n", 0, 0, 0 );
 
-       for ( i = 0; ldap_errlist[i].e_code != -1; i++ ) {
-               if ( err == ldap_errlist[i].e_code )
-                       return( ldap_errlist[i].e_reason );
+       switch ( err ) {
+#      define C(code, message) case code: m = message; break
+
+       /* LDAPv3 (RFC 4511) codes */
+       C(LDAP_SUCCESS,                                 N_("Success"));
+       C(LDAP_OPERATIONS_ERROR,                N_("Operations error"));
+       C(LDAP_PROTOCOL_ERROR,                  N_("Protocol error"));
+       C(LDAP_TIMELIMIT_EXCEEDED,              N_("Time limit exceeded"));
+       C(LDAP_SIZELIMIT_EXCEEDED,              N_("Size limit exceeded"));
+       C(LDAP_COMPARE_FALSE,                   N_("Compare False"));
+       C(LDAP_COMPARE_TRUE,                    N_("Compare True"));
+       C(LDAP_STRONG_AUTH_NOT_SUPPORTED,N_("Authentication method not supported"));
+       C(LDAP_STRONG_AUTH_REQUIRED,    N_("Strong(er) authentication required"));
+
+       C(LDAP_REFERRAL,                                N_("Referral"));
+       C(LDAP_ADMINLIMIT_EXCEEDED,             N_("Administrative limit exceeded"));
+       C(LDAP_UNAVAILABLE_CRITICAL_EXTENSION,
+                                                                       N_("Critical extension is unavailable"));
+       C(LDAP_CONFIDENTIALITY_REQUIRED,N_("Confidentiality required"));
+       C(LDAP_SASL_BIND_IN_PROGRESS,   N_("SASL bind in progress"));
+
+       C(LDAP_NO_SUCH_ATTRIBUTE,               N_("No such attribute"));
+       C(LDAP_UNDEFINED_TYPE,                  N_("Undefined attribute type"));
+       C(LDAP_INAPPROPRIATE_MATCHING,  N_("Inappropriate matching"));
+       C(LDAP_CONSTRAINT_VIOLATION,    N_("Constraint violation"));
+       C(LDAP_TYPE_OR_VALUE_EXISTS,    N_("Type or value exists"));
+       C(LDAP_INVALID_SYNTAX,                  N_("Invalid syntax"));
+
+       C(LDAP_NO_SUCH_OBJECT,                  N_("No such object"));
+       C(LDAP_ALIAS_PROBLEM,                   N_("Alias problem"));
+       C(LDAP_INVALID_DN_SYNTAX,               N_("Invalid DN syntax"));
+
+       C(LDAP_ALIAS_DEREF_PROBLEM,             N_("Alias dereferencing problem"));
+
+       C(LDAP_INAPPROPRIATE_AUTH,              N_("Inappropriate authentication"));
+       C(LDAP_INVALID_CREDENTIALS,     N_("Invalid credentials"));
+       C(LDAP_INSUFFICIENT_ACCESS,     N_("Insufficient access"));
+       C(LDAP_BUSY,                                    N_("Server is busy"));
+       C(LDAP_UNAVAILABLE,                     N_("Server is unavailable"));
+       C(LDAP_UNWILLING_TO_PERFORM,    N_("Server is unwilling to perform"));
+       C(LDAP_LOOP_DETECT,                     N_("Loop detected"));
+
+       C(LDAP_NAMING_VIOLATION,                N_("Naming violation"));
+       C(LDAP_OBJECT_CLASS_VIOLATION,  N_("Object class violation"));
+       C(LDAP_NOT_ALLOWED_ON_NONLEAF,  N_("Operation not allowed on non-leaf"));
+       C(LDAP_NOT_ALLOWED_ON_RDN,              N_("Operation not allowed on RDN"));
+       C(LDAP_ALREADY_EXISTS,                  N_("Already exists"));
+       C(LDAP_NO_OBJECT_CLASS_MODS,    N_("Cannot modify object class"));
+
+       C(LDAP_AFFECTS_MULTIPLE_DSAS,   N_("Operation affects multiple DSAs"));
+
+       /* Virtual List View draft */
+       C(LDAP_VLV_ERROR,                               N_("Virtual List View error"));
+
+       C(LDAP_OTHER, N_("Other (e.g., implementation specific) error"));
+
+       /* LDAPv2 (RFC 1777) codes */
+       C(LDAP_PARTIAL_RESULTS, N_("Partial results and referral received"));
+       C(LDAP_IS_LEAF,                                 N_("Entry is a leaf"));
+
+       /* Connection-less LDAP (CLDAP - RFC 1798) code */
+       C(LDAP_RESULTS_TOO_LARGE,               N_("Results too large"));
+
+       /* Cancel Operation (RFC 3909) codes */
+       C(LDAP_CANCELLED,                               N_("Cancelled"));
+       C(LDAP_NO_SUCH_OPERATION,               N_("No Operation to Cancel"));
+       C(LDAP_TOO_LATE,                                N_("Too Late to Cancel"));
+       C(LDAP_CANNOT_CANCEL,                   N_("Cannot Cancel"));
+
+       /* Assert Control (RFC 4528 and old internet-draft) codes */
+       C(LDAP_ASSERTION_FAILED,                N_("Assertion Failed"));
+       C(LDAP_X_ASSERTION_FAILED,              N_("Assertion Failed (X)"));
+
+       /* Proxied Authorization Control (RFC 4370 and I-D) codes */
+       C(LDAP_PROXIED_AUTHORIZATION_DENIED, N_("Proxied Authorization Denied"));
+       C(LDAP_X_PROXY_AUTHZ_FAILURE,   N_("Proxy Authorization Failure (X)"));
+
+       /* Content Sync Operation (RFC 4533 and I-D) codes */
+       C(LDAP_SYNC_REFRESH_REQUIRED,   N_("Content Sync Refresh Required"));
+       C(LDAP_X_SYNC_REFRESH_REQUIRED, N_("Content Sync Refresh Required (X)"));
+
+       /* No-Op Control (draft-zeilenga-ldap-noop) code */
+       C(LDAP_X_NO_OPERATION,                  N_("No Operation (X)"));
+
+       /* Client Update Protocol (RFC 3928) codes */
+       C(LDAP_CUP_RESOURCES_EXHAUSTED, N_("LCUP Resources Exhausted"));
+       C(LDAP_CUP_SECURITY_VIOLATION,  N_("LCUP Security Violation"));
+       C(LDAP_CUP_INVALID_DATA,                N_("LCUP Invalid Data"));
+       C(LDAP_CUP_UNSUPPORTED_SCHEME,  N_("LCUP Unsupported Scheme"));
+       C(LDAP_CUP_RELOAD_REQUIRED,             N_("LCUP Reload Required"));
+
+#ifdef LDAP_X_TXN
+       /* Codes related to LDAP Transactions (draft-zeilenga-ldap-txn) */
+       C(LDAP_X_TXN_SPECIFY_OKAY,              N_("TXN specify okay"));
+       C(LDAP_X_TXN_ID_INVALID,                N_("TXN ID is invalid"));
+#endif
+
+       /* API codes - renumbered since draft-ietf-ldapext-ldap-c-api */
+       C(LDAP_SERVER_DOWN,                             N_("Can't contact LDAP server"));
+       C(LDAP_LOCAL_ERROR,                             N_("Local error"));
+       C(LDAP_ENCODING_ERROR,                  N_("Encoding error"));
+       C(LDAP_DECODING_ERROR,                  N_("Decoding error"));
+       C(LDAP_TIMEOUT,                                 N_("Timed out"));
+       C(LDAP_AUTH_UNKNOWN,                    N_("Unknown authentication method"));
+       C(LDAP_FILTER_ERROR,                    N_("Bad search filter"));
+       C(LDAP_USER_CANCELLED,                  N_("User cancelled operation"));
+       C(LDAP_PARAM_ERROR,                             N_("Bad parameter to an ldap routine"));
+       C(LDAP_NO_MEMORY,                               N_("Out of memory"));
+       C(LDAP_CONNECT_ERROR,                   N_("Connect error"));
+       C(LDAP_NOT_SUPPORTED,                   N_("Not Supported"));
+       C(LDAP_CONTROL_NOT_FOUND,               N_("Control not found"));
+       C(LDAP_NO_RESULTS_RETURNED,             N_("No results returned"));
+       C(LDAP_MORE_RESULTS_TO_RETURN,  N_("More results to return"));
+       C(LDAP_CLIENT_LOOP,                             N_("Client Loop"));
+       C(LDAP_REFERRAL_LIMIT_EXCEEDED, N_("Referral Limit Exceeded"));
+#      undef C
+
+       default:
+               m = (LDAP_API_ERROR(err) ? N_("Unknown API error")
+                        : LDAP_E_ERROR(err) ? N_("Unknown (extension) error")
+                        : LDAP_X_ERROR(err) ? N_("Unknown (private extension) error")
+                        : N_("Unknown error"));
+               break;
        }
 
-       return( "Unknown error" );
+       return _(m);
 }
 
-#ifdef LDAP_LIBUI
+/* deprecated */
 void
-ldap_perror( LDAP *ld, char *s )
+ldap_perror( LDAP *ld, LDAP_CONST char *str )
 {
-       int     i;
+    int i;
+
+       assert( ld != NULL );
+       assert( LDAP_VALID( ld ) );
+       assert( str != NULL );
+
+       fprintf( stderr, "%s: %s (%d)\n",
+               str ? str : "ldap_perror",
+               ldap_err2string( ld->ld_errno ),
+               ld->ld_errno );
 
-       Debug( LDAP_DEBUG_TRACE, "ldap_perror\n", 0, 0, 0 );
+       if ( ld->ld_matched != NULL && ld->ld_matched[0] != '\0' ) {
+               fprintf( stderr, _("\tmatched DN: %s\n"), ld->ld_matched );
+       }
 
-       if ( ld == NULL ) {
-               perror( s );
-               return;
+       if ( ld->ld_error != NULL && ld->ld_error[0] != '\0' ) {
+               fprintf( stderr, _("\tadditional info: %s\n"), ld->ld_error );
        }
 
-       for ( i = 0; ldap_errlist[i].e_code != -1; i++ ) {
-               if ( ld->ld_errno == ldap_errlist[i].e_code ) {
-                       fprintf( stderr, "%s: %s\n", s,
-                           ldap_errlist[i].e_reason );
-                       if ( ld->ld_matched != NULL && *ld->ld_matched != '\0' )
-                               fprintf( stderr, "%s: matched: %s\n", s,
-                                   ld->ld_matched );
-                       if ( ld->ld_error != NULL && *ld->ld_error != '\0' )
-                               fprintf( stderr, "%s: additional info: %s\n",
-                                   s, ld->ld_error );
-                       fflush( stderr );
-                       return;
+       if ( ld->ld_referrals != NULL && ld->ld_referrals[0] != NULL) {
+               fprintf( stderr, _("\treferrals:\n") );
+               for (i=0; ld->ld_referrals[i]; i++) {
+                       fprintf( stderr, _("\t\t%s\n"), ld->ld_referrals[i] );
                }
        }
 
-       fprintf( stderr, "%s: Not an LDAP errno %d\n", s, ld->ld_errno );
        fflush( stderr );
 }
 
-#else
-
-void
-ldap_perror( LDAP *ld, char *s )
+/* deprecated */
+int
+ldap_result2error( LDAP *ld, LDAPMessage *r, int freeit )
 {
-}
+       int rc, err;
 
-#endif /* !LDAP_LIBUI */
+       rc = ldap_parse_result( ld, r, &err,
+               NULL, NULL, NULL, NULL, freeit );
 
+       return err != LDAP_SUCCESS ? err : rc;
+}
 
+/*
+ * Parse LDAPResult Messages:
+ *
+ *   LDAPResult ::= SEQUENCE {
+ *     resultCode      ENUMERATED,
+ *     matchedDN       LDAPDN,
+ *     errorMessage    LDAPString,
+ *     referral        [3] Referral OPTIONAL }
+ *
+ * including Bind results:
+ *
+ *   BindResponse ::= [APPLICATION 1] SEQUENCE {
+ *     COMPONENTS OF LDAPResult,
+ *     serverSaslCreds  [7] OCTET STRING OPTIONAL }
+ *
+ * and ExtendedOp results:
+ *
+ *   ExtendedResponse ::= [APPLICATION 24] SEQUENCE {
+ *     COMPONENTS OF LDAPResult,
+ *     responseName     [10] LDAPOID OPTIONAL,
+ *     response         [11] OCTET STRING OPTIONAL }
+ *
+ */
 int
-ldap_result2error( LDAP *ld, LDAPMessage *r, int freeit )
+ldap_parse_result(
+       LDAP                    *ld,
+       LDAPMessage             *r,
+       int                             *errcodep,
+       char                    **matcheddnp,
+       char                    **errmsgp,
+       char                    ***referralsp,
+       LDAPControl             ***serverctrls,
+       int                             freeit )
 {
        LDAPMessage     *lm;
-       BerElement      ber;
-       long            along;
-       int             rc;
+       ber_int_t errcode = LDAP_SUCCESS;
+
+       ber_tag_t tag;
+       BerElement      *ber;
 
-       Debug( LDAP_DEBUG_TRACE, "ldap_result2error\n", 0, 0, 0 );
+       Debug( LDAP_DEBUG_TRACE, "ldap_parse_result\n", 0, 0, 0 );
 
-       if ( r == NULLMSG )
-               return( LDAP_PARAM_ERROR );
+       assert( ld != NULL );
+       assert( LDAP_VALID( ld ) );
+       assert( r != NULL );
 
-       for ( lm = r; lm->lm_chain != NULL; lm = lm->lm_chain )
-               ;       /* NULL */
+       if(errcodep != NULL) *errcodep = LDAP_SUCCESS;
+       if(matcheddnp != NULL) *matcheddnp = NULL;
+       if(errmsgp != NULL) *errmsgp = NULL;
+       if(referralsp != NULL) *referralsp = NULL;
+       if(serverctrls != NULL) *serverctrls = NULL;
+
+#ifdef LDAP_R_COMPILE
+       ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
+#endif
+       /* Find the result, last msg in chain... */
+       lm = r->lm_chain_tail;
+       /* FIXME: either this is not possible (assert?)
+        * or it should be handled */
+       if ( lm != NULL ) {
+               switch ( lm->lm_msgtype ) {
+               case LDAP_RES_SEARCH_ENTRY:
+               case LDAP_RES_SEARCH_REFERENCE:
+               case LDAP_RES_INTERMEDIATE:
+                       lm = NULL;
+                       break;
+
+               default:
+                       break;
+               }
+       }
+
+       if( lm == NULL ) {
+               errcode = ld->ld_errno = LDAP_NO_RESULTS_RETURNED;
+#ifdef LDAP_R_COMPILE
+               ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
+#endif
+           goto done;
+       }
 
        if ( ld->ld_error ) {
-               free( ld->ld_error );
+               LDAP_FREE( ld->ld_error );
                ld->ld_error = NULL;
        }
        if ( ld->ld_matched ) {
-               free( ld->ld_matched );
+               LDAP_FREE( ld->ld_matched );
                ld->ld_matched = NULL;
        }
+       if ( ld->ld_referrals ) {
+               LDAP_VFREE( ld->ld_referrals );
+               ld->ld_referrals = NULL;
+       }
+
+       /* parse results */
+
+       ber = ber_dup( lm->lm_ber );
+
+       if ( ld->ld_version < LDAP_VERSION2 ) {
+               tag = ber_scanf( ber, "{iA}",
+                       &ld->ld_errno, &ld->ld_error );
 
-       ber = *(lm->lm_ber);
-       if ( ld->ld_version == LDAP_VERSION2 ) {
-               rc = ber_scanf( &ber, "{iaa}", &along, &ld->ld_matched,
-                   &ld->ld_error );
        } else {
-               rc = ber_scanf( &ber, "{ia}", &along, &ld->ld_error );
+               ber_len_t len;
+
+               tag = ber_scanf( ber, "{iAA" /*}*/,
+                       &ld->ld_errno, &ld->ld_matched, &ld->ld_error );
+
+               if( tag != LBER_ERROR ) {
+                       /* peek for referrals */
+                       if( ber_peek_tag(ber, &len) == LDAP_TAG_REFERRAL ) {
+                               tag = ber_scanf( ber, "v", &ld->ld_referrals );
+                       }
+               }
+
+               /* need to clean out misc items */
+               if( tag != LBER_ERROR ) {
+                       if( lm->lm_msgtype == LDAP_RES_BIND ) {
+                               /* look for sasl result creditials */
+                               if ( ber_peek_tag( ber, &len ) == LDAP_TAG_SASL_RES_CREDS ) {
+                                       /* skip 'em */
+                                       tag = ber_scanf( ber, "x" );
+                               }
+
+                       } else if( lm->lm_msgtype == LDAP_RES_EXTENDED ) {
+                               /* look for exop result oid or value */
+                               if ( ber_peek_tag( ber, &len ) == LDAP_TAG_EXOP_RES_OID ) {
+                                       /* skip 'em */
+                                       tag = ber_scanf( ber, "x" );
+                               }
+
+                               if ( tag != LBER_ERROR &&
+                                       ber_peek_tag( ber, &len ) == LDAP_TAG_EXOP_RES_VALUE )
+                               {
+                                       /* skip 'em */
+                                       tag = ber_scanf( ber, "x" );
+                               }
+                       }
+               }
+
+               if( tag != LBER_ERROR ) {
+                       int rc = ldap_pvt_get_controls( ber, serverctrls );
+
+                       if( rc != LDAP_SUCCESS ) {
+                               tag = LBER_ERROR;
+                       }
+               }
+
+               if( tag != LBER_ERROR ) {
+                       tag = ber_scanf( ber, /*{*/"}" );
+               }
        }
-       if ( rc == LBER_ERROR ) {
-               ld->ld_errno = LDAP_DECODING_ERROR;
-       } else {
-               ld->ld_errno = (int) along;
+
+       if ( tag == LBER_ERROR ) {
+               ld->ld_errno = errcode = LDAP_DECODING_ERROR;
+       }
+
+       if( ber != NULL ) {
+               ber_free( ber, 0 );
        }
 
-       if ( freeit )
+       /* return */
+       if( errcodep != NULL ) {
+               *errcodep = ld->ld_errno;
+       }
+       if ( errcode == LDAP_SUCCESS ) {
+               if( matcheddnp != NULL ) {
+                       if ( ld->ld_matched )
+                       {
+                               *matcheddnp = LDAP_STRDUP( ld->ld_matched );
+                       }
+               }
+               if( errmsgp != NULL ) {
+                       if ( ld->ld_error )
+                       {
+                               *errmsgp = LDAP_STRDUP( ld->ld_error );
+                       }
+               }
+
+               if( referralsp != NULL) {
+                       *referralsp = ldap_value_dup( ld->ld_referrals );
+               }
+       }
+
+#ifdef LDAP_R_COMPILE
+       ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
+#endif
+
+done:
+       if ( freeit ) {
                ldap_msgfree( r );
+       }
 
-       return( ld->ld_errno );
+       return errcode;
 }