]> git.sur5r.net Git - openldap/blobdiff - libraries/libldap/error.c
prepare for ldap_bv2dn()
[openldap] / libraries / libldap / error.c
index 4c282dced0a61be64b8135eeb76a5288297f6eb9..3540828821567c841de4bc8b620e9cdfeef51ff0 100644 (file)
@@ -1,12 +1,14 @@
+/* $OpenLDAP$ */
 /*
- * Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
+ * Copyright 1998-2002 The OpenLDAP Foundation, All Rights Reserved.
  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
  */
 
 #include "portable.h"
 
 #include <stdio.h>
-#include <stdlib.h>
+
+#include <ac/stdlib.h>
 
 #include <ac/socket.h>
 #include <ac/string.h>
 
 struct ldaperror {
        int     e_code;
-       char    *e_reason;
+       char *e_reason;
 };
 
-static const struct ldaperror ldap_errlist[] = {
+static struct ldaperror ldap_builtin_errlist[] = {
        {LDAP_SUCCESS,                                  "Success" },
        {LDAP_OPERATIONS_ERROR,                 "Operations error" },
        {LDAP_PROTOCOL_ERROR,                   "Protocol error" },
        {LDAP_TIMELIMIT_EXCEEDED,               "Time limit exceeded" },
        {LDAP_SIZELIMIT_EXCEEDED,               "Size limit exceeded" },
-       {LDAP_COMPARE_FALSE,                    "Compare false" },
-       {LDAP_COMPARE_TRUE,                     "Compare true" },
-       {LDAP_STRONG_AUTH_NOT_SUPPORTED, "Strong authentication not supported" },
+       {LDAP_COMPARE_FALSE,                    "Compare False" },
+       {LDAP_COMPARE_TRUE,                     "Compare True" },
+       {LDAP_STRONG_AUTH_NOT_SUPPORTED, "Authentication method not supported" },
        {LDAP_STRONG_AUTH_REQUIRED,     "Strong authentication required" },
        {LDAP_PARTIAL_RESULTS,                  "Partial results and referral received" },
 
        {LDAP_REFERRAL,                                 "Referral"},
        {LDAP_ADMINLIMIT_EXCEEDED,              "Administrative limit exceeded"},
-       {LDAP_UNAVAILABLE_CRITICIAL_EXTENSION,
+       {LDAP_UNAVAILABLE_CRITICAL_EXTENSION,
                                                                        "Criticial extension is unavailable"},
        {LDAP_CONFIDENTIALITY_REQUIRED, "Confidentiality required"},
        {LDAP_SASL_BIND_IN_PROGRESS,    "SASL bind in progress"},
@@ -48,7 +50,7 @@ static const struct ldaperror ldap_errlist[] = {
        {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_IS_LEAF,                                  "Entry is a leaf" },
        {LDAP_ALIAS_DEREF_PROBLEM,              "Alias dereferencing problem" },
 
        {LDAP_INAPPROPRIATE_AUTH,               "Inappropriate authentication" },
@@ -69,6 +71,8 @@ static const struct ldaperror ldap_errlist[] = {
        {LDAP_AFFECTS_MULTIPLE_DSAS,    "Operation affects multiple DSAs" },
 
        {LDAP_OTHER,                                    "Unknown error" },
+
+       /* API ResultCodes */
        {LDAP_SERVER_DOWN,                              "Can't contact LDAP server" },
        {LDAP_LOCAL_ERROR,                              "Local error" },
        {LDAP_ENCODING_ERROR,                   "Encoding error" },
@@ -88,16 +92,50 @@ static const struct ldaperror ldap_errlist[] = {
        {LDAP_CLIENT_LOOP,                              "Client Loop" },
        {LDAP_REFERRAL_LIMIT_EXCEEDED,  "Referral Limit Exceeded" },
 
-       {-1, }
+       {-1, NULL}
 };
 
-static struct ldaperror *ldap_int_error( int err )
+static struct ldaperror *ldap_errlist = ldap_builtin_errlist; 
+
+void ldap_int_error_init( void ) {
+#ifdef LDAP_NLS
+#define LDAP_NLS_SDK_CAT "openldap_sdk"
+#define LDAP_NLS_LIBLDAP_SET (0)
+
+       int     i;
+       nl_catd catd = catopen( LDAP_NLS_SDK_CAT, NL_CAT_LOCALE );
+
+       if( catd == -1 ) {
+               return;
+       }
+
+       for ( i=0; ldap_errlist[i].e_reason != NULL; i++ ) {
+               char *msg = catgets( catd,
+                       LDAP_NLS_LIBLDAP_SET,
+                       ldap_errlist[i].e_code, NULL );
+
+               if( msg != NULL ) {
+                       msg = LDAP_STRDUP( msg );
+
+                       if( msg != NULL ) {
+                               ldap_errlist[i].e_reason = msg;
+                       }
+               }
+       }
+
+       catclose( catd );
+#endif
+}
+
+static const struct ldaperror *
+ldap_int_error( int err )
 {
        int     i;
 
-       for ( i = 0; ldap_errlist[i].e_code != -1; i++ ) {
-               if ( err == ldap_errlist[i].e_code )
-                       return (struct ldaperror *) &ldap_errlist[i];
+       for ( i=0; ldap_errlist[i].e_reason != NULL; i++ ) {
+               if ( err == ldap_errlist[i].e_code ) {
+                       return &ldap_errlist[i];
+               }
        }
 
        return NULL;
@@ -106,76 +144,132 @@ static struct ldaperror *ldap_int_error( int err )
 char *
 ldap_err2string( int err )
 {
-       struct ldaperror *e;
+       const struct ldaperror *e;
        
        Debug( LDAP_DEBUG_TRACE, "ldap_err2string\n", 0, 0, 0 );
 
        e = ldap_int_error( err );
 
-       return ( e != NULL ) ? e->e_reason : "Unknown error";
+       return e ? e->e_reason : "Unknown error";
 }
 
 /* deprecated */
 void
 ldap_perror( LDAP *ld, LDAP_CONST char *str )
 {
-       char *s;
-       struct ldaperror *e;
+       const struct ldaperror *e;
        Debug( LDAP_DEBUG_TRACE, "ldap_perror\n", 0, 0, 0 );
 
        assert( ld != NULL );
        assert( LDAP_VALID( ld ) );
-       assert( s );
-
-       s = ( str != NULL ) ? (char *) str : "ldap_perror";
+       assert( str );
 
        if ( ld == NULL ) {
-               perror( s );
+               fprintf( stderr, "ldap_perror: invalid session handle\n" );
                return;
        }
 
        e = ldap_int_error( ld->ld_errno );
 
-       if ( e != NULL ) {
-               fprintf( stderr, "%s: %s\n",
-                       s, e->e_reason );
-       } else {
-               fprintf( stderr, "%s: unknown LDAP error number %d\n",
-                       s, ld->ld_errno );
-       }
+       fprintf( stderr, "%s: %s (%d)\n",
+               str ? str : "ldap_perror",
+               e ? e->e_reason : "unknown LDAP result code",
+               ld->ld_errno );
 
-       if ( ld->ld_matched != NULL ) {
-               fprintf( stderr, "\tmatched: \"%s\"\n",
-                       ld->ld_matched );
+       if ( ld->ld_matched != NULL && ld->ld_matched[0] != '\0' ) {
+               fprintf( stderr, "\tmatched DN: %s\n", ld->ld_matched );
        }
 
-       if ( ld->ld_error != NULL ) {
-               fprintf( stderr, "\tadditional info: %s\n",
-                   ld->ld_error );
+       if ( ld->ld_error != NULL && ld->ld_error[0] != '\0' ) {
+               fprintf( stderr, "\tadditional info: %s\n", ld->ld_error );
        }
 
        fflush( stderr );
 }
 
+/* deprecated */
 int
 ldap_result2error( LDAP *ld, LDAPMessage *r, int freeit )
+{
+       int rc, err;
+
+       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_parse_result(
+       LDAP                    *ld,
+       LDAPMessage             *r,
+       int                             *errcodep,
+       char                    **matcheddnp,
+       char                    **errmsgp,
+       char                    ***referralsp,
+       LDAPControl             ***serverctrls,
+       int                             freeit )
 {
        LDAPMessage     *lm;
-       BerElement      ber;
-       long            along;
-       unsigned long   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 );
 
        assert( ld != NULL );
        assert( LDAP_VALID( ld ) );
        assert( r != NULL );
 
-       if ( ld == NULL || r == NULLMSG )
-               return( LDAP_PARAM_ERROR );
+       if ( ld == NULL || r == NULL ) {
+               return LDAP_PARAM_ERROR;
+       }
+
+       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;
+
+       /* Find the next result... */
+       for ( lm = r; lm != NULL; lm = lm->lm_chain ) {
+               /* skip over entries and references */
+               if( lm->lm_msgtype != LDAP_RES_SEARCH_ENTRY &&
+                       lm->lm_msgtype != LDAP_RES_SEARCH_REFERENCE &&
+                       lm->lm_msgtype != LDAP_RES_EXTENDED_PARTIAL )
+               {
+                       break;
+               }
+       }
 
-       for ( lm = r; lm->lm_chain != NULL; lm = lm->lm_chain )
-               ;       /* NULL */
+       if( lm == NULL ) {
+               ld->ld_errno = LDAP_NO_RESULTS_RETURNED;
+               return ld->ld_errno;
+       }
 
        if ( ld->ld_error ) {
                LDAP_FREE( ld->ld_error );
@@ -186,23 +280,106 @@ ldap_result2error( LDAP *ld, LDAPMessage *r, int freeit )
                ld->ld_matched = NULL;
        }
 
-       ber = *(lm->lm_ber);
+       /* parse results */
+
+       ber = ber_dup( lm->lm_ber );
 
        if ( ld->ld_version < LDAP_VERSION2 ) {
-               rc = ber_scanf( &ber, "{ia}", &along, &ld->ld_error );
+               tag = ber_scanf( ber, "{ia}",
+                       &ld->ld_errno, &ld->ld_error );
        } else {
-               rc = ber_scanf( &ber, "{iaa}", &along, &ld->ld_matched,
-                   &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 ) {
+                               if( referralsp != NULL ) {
+                                       tag = ber_scanf( ber, "v", referralsp );
+
+                               } else {
+                                       /* no place to put them so skip 'em */
+                                       tag = ber_scanf( ber, "x" );
+                               }
+                       }
+               }
+
+               /* 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_int_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 ) {
+                       *matcheddnp = LDAP_STRDUP( ld->ld_matched );
+               }
+               if( errmsgp != NULL ) {
+                       *errmsgp = LDAP_STRDUP( ld->ld_error );
+               }
+
+               /* Find the next result... */
+               for ( lm = lm->lm_chain; lm != NULL; lm = lm->lm_chain ) {
+                       /* skip over entries and references */
+                       if( lm->lm_msgtype != LDAP_RES_SEARCH_ENTRY &&
+                               lm->lm_msgtype != LDAP_RES_SEARCH_REFERENCE &&
+                               lm->lm_msgtype != LDAP_RES_EXTENDED_PARTIAL )
+                       {
+                               /* more results to return */
+                               errcode = LDAP_MORE_RESULTS_TO_RETURN;
+                               break;
+                       }
+               }
+       }
+
+       if ( freeit ) {
                ldap_msgfree( r );
+       }
 
-       return( ld->ld_errno );
+       return( errcode );
 }