git.sur5r.net Git - openldap/blob - libraries/libldap/error.c

   1 /* $OpenLDAP$ */
   2 /*
   3  * Copyright 1998-1999 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 const struct ldaperror ldap_errlist[] = {
  25         {LDAP_SUCCESS,                                  "Success" },
  26         {LDAP_OPERATIONS_ERROR,                 "Operations error" },
  27         {LDAP_PROTOCOL_ERROR,                   "Protocol error" },
  28         {LDAP_TIMELIMIT_EXCEEDED,               "Time limit exceeded" },
  29         {LDAP_SIZELIMIT_EXCEEDED,               "Size limit exceeded" },
  30         {LDAP_COMPARE_FALSE,                    "Compare false" },
  31         {LDAP_COMPARE_TRUE,                     "Compare true" },
  32         {LDAP_STRONG_AUTH_NOT_SUPPORTED, "Authentication method not supported" },
  33         {LDAP_STRONG_AUTH_REQUIRED,     "Strong authentication required" },
  34         {LDAP_PARTIAL_RESULTS,                  "Partial results and referral received" },
  35
  36         {LDAP_REFERRAL,                                 "Referral"},
  37         {LDAP_ADMINLIMIT_EXCEEDED,              "Administrative limit exceeded"},
  38         {LDAP_UNAVAILABLE_CRITICAL_EXTENSION,
  39                                                                         "Criticial extension is unavailable"},
  40         {LDAP_CONFIDENTIALITY_REQUIRED, "Confidentiality required"},
  41         {LDAP_SASL_BIND_IN_PROGRESS,    "SASL bind in progress"},
  42
  43         {LDAP_NO_SUCH_ATTRIBUTE,                "No such attribute" },
  44         {LDAP_UNDEFINED_TYPE,                   "Undefined attribute type" },
  45         {LDAP_INAPPROPRIATE_MATCHING,   "Inappropriate matching" },
  46         {LDAP_CONSTRAINT_VIOLATION,     "Constraint violation" },
  47         {LDAP_TYPE_OR_VALUE_EXISTS,     "Type or value exists" },
  48         {LDAP_INVALID_SYNTAX,                   "Invalid syntax" },
  49
  50         {LDAP_NO_SUCH_OBJECT,                   "No such object" },
  51         {LDAP_ALIAS_PROBLEM,                    "Alias problem" },
  52         {LDAP_INVALID_DN_SYNTAX,                "Invalid DN syntax" },
  53         {LDAP_IS_LEAF,                                  "Object is a leaf" },
  54         {LDAP_ALIAS_DEREF_PROBLEM,              "Alias dereferencing problem" },
  55
  56         {LDAP_INAPPROPRIATE_AUTH,               "Inappropriate authentication" },
  57         {LDAP_INVALID_CREDENTIALS,              "Invalid credentials" },
  58         {LDAP_INSUFFICIENT_ACCESS,              "Insufficient access" },
  59         {LDAP_BUSY,                                     "DSA is busy" },
  60         {LDAP_UNAVAILABLE,                              "DSA is unavailable" },
  61         {LDAP_UNWILLING_TO_PERFORM,     "DSA is unwilling to perform" },
  62         {LDAP_LOOP_DETECT,                              "Loop detected" },
  63
  64         {LDAP_NAMING_VIOLATION,                 "Naming violation" },
  65         {LDAP_OBJECT_CLASS_VIOLATION,   "Object class violation" },
  66         {LDAP_NOT_ALLOWED_ON_NONLEAF,   "Operation not allowed on nonleaf" },
  67         {LDAP_NOT_ALLOWED_ON_RDN,               "Operation not allowed on RDN" },
  68         {LDAP_ALREADY_EXISTS,                   "Already exists" },
  69         {LDAP_NO_OBJECT_CLASS_MODS,     "Cannot modify object class" },
  70         {LDAP_RESULTS_TOO_LARGE,                "Results too large" },
  71         {LDAP_AFFECTS_MULTIPLE_DSAS,    "Operation affects multiple DSAs" },
  72
  73         {LDAP_OTHER,                                    "Unknown error" },
  74         {LDAP_SERVER_DOWN,                              "Can't contact LDAP server" },
  75         {LDAP_LOCAL_ERROR,                              "Local error" },
  76         {LDAP_ENCODING_ERROR,                   "Encoding error" },
  77         {LDAP_DECODING_ERROR,                   "Decoding error" },
  78         {LDAP_TIMEOUT,                                  "Timed out" },
  79         {LDAP_AUTH_UNKNOWN,                             "Unknown authentication method" },
  80         {LDAP_FILTER_ERROR,                             "Bad search filter" },
  81         {LDAP_USER_CANCELLED,                   "User cancelled operation" },
  82         {LDAP_PARAM_ERROR,                              "Bad parameter to an ldap routine" },
  83         {LDAP_NO_MEMORY,                                "Out of memory" },
  84
  85         {LDAP_CONNECT_ERROR,                    "Connect error" },
  86         {LDAP_NOT_SUPPORTED,                    "Not Supported" },
  87         {LDAP_CONTROL_NOT_FOUND,                "Control not found" },
  88         {LDAP_NO_RESULTS_RETURNED,              "No results returned" },
  89         {LDAP_MORE_RESULTS_TO_RETURN,   "More results to return" },
  90         {LDAP_CLIENT_LOOP,                              "Client Loop" },
  91         {LDAP_REFERRAL_LIMIT_EXCEEDED,  "Referral Limit Exceeded" },
  92
  93         {-1, 0 }
  94 };
  95
  96 static const struct ldaperror *
  97 ldap_int_error( int err )
  98 {
  99         int     i;
 100
 101         for ( i = 0; ldap_errlist[i].e_code != -1; i++ ) {
 102                 if ( err == ldap_errlist[i].e_code )
 103                         return &ldap_errlist[i];
 104         }
 105
 106         return NULL;
 107 }
 108
 109 char *
 110 ldap_err2string( int err )
 111 {
 112         const struct ldaperror *e;
 113
 114         Debug( LDAP_DEBUG_TRACE, "ldap_err2string\n", 0, 0, 0 );
 115
 116         e = ldap_int_error( err );
 117
 118         return ( e != NULL ) ? e->e_reason : "Unknown error";
 119 }
 120
 121 /* deprecated */
 122 void
 123 ldap_perror( LDAP *ld, LDAP_CONST char *str )
 124 {
 125         const char *s;
 126         const struct ldaperror *e;
 127         Debug( LDAP_DEBUG_TRACE, "ldap_perror\n", 0, 0, 0 );
 128
 129         assert( ld != NULL );
 130         assert( LDAP_VALID( ld ) );
 131         assert( str );
 132
 133         s = ( str != NULL ) ? str : "ldap_perror";
 134
 135         if ( ld == NULL ) {
 136                 perror( s );
 137                 return;
 138         }
 139
 140         e = ldap_int_error( ld->ld_errno );
 141
 142         if ( e != NULL ) {
 143                 fprintf( stderr, "%s: %s\n",
 144                         s, e->e_reason );
 145         } else {
 146                 fprintf( stderr, "%s: unknown LDAP error number %d\n",
 147                         s, ld->ld_errno );
 148         }
 149
 150         if ( ld->ld_matched != NULL && ld->ld_matched[0] != '\0' ) {
 151                 fprintf( stderr, "\tmatched: \"%s\"\n",
 152                         ld->ld_matched );
 153         }
 154
 155         if ( ld->ld_error != NULL && ld->ld_error[0] != '\0' ) {
 156                 fprintf( stderr, "\tadditional info: %s\n",
 157                     ld->ld_error );
 158         }
 159
 160         fflush( stderr );
 161 }
 162
 163 int
 164 ldap_result2error( LDAP *ld, LDAPMessage *r, int freeit )
 165 {
 166         int rc, err;
 167
 168         rc = ldap_parse_result( ld, r, &err,
 169                 NULL, NULL, NULL, NULL, freeit );
 170
 171         return err != LDAP_SUCCESS ? err : rc;
 172 }
 173
 174 /*
 175  * Parse LDAPResult Messages:
 176  *
 177  *   LDAPResult ::= SEQUENCE {
 178  *     resultCode      ENUMERATED,
 179  *     matchedDN       LDAPDN,
 180  *     errorMessage    LDAPString,
 181  *     referral        [3] Referral OPTIONAL }
 182  *
 183  * including Bind results:
 184  *
 185  *   BindResponse ::= [APPLICATION 1] SEQUENCE {
 186  *     COMPONENTS OF LDAPResult,
 187  *     serverSaslCreds  [7] OCTET STRING OPTIONAL }
 188  *
 189  * and ExtendedOp results:
 190  *
 191  *   ExtendedResponse ::= [APPLICATION 24] SEQUENCE {
 192  *     COMPONENTS OF LDAPResult,
 193  *     responseName     [10] LDAPOID OPTIONAL,
 194  *     response         [11] OCTET STRING OPTIONAL }
 195  *
 196  */
 197 int
 198 ldap_parse_result(
 199         LDAP                    *ld,
 200         LDAPMessage             *r,
 201         int                             *errcodep,
 202         char                    **matcheddnp,
 203         char                    **errmsgp,
 204         char                    ***referralsp,
 205         LDAPControl             ***serverctrls,
 206         int                             freeit )
 207 {
 208         LDAPMessage     *lm;
 209         ber_int_t errcode = LDAP_SUCCESS;
 210
 211         int rc;
 212         ber_tag_t tag;
 213         BerElement      *ber;
 214
 215         Debug( LDAP_DEBUG_TRACE, "ldap_parse_result\n", 0, 0, 0 );
 216
 217         assert( ld != NULL );
 218         assert( LDAP_VALID( ld ) );
 219         assert( r != NULL );
 220
 221         if ( ld == NULL || r == NULL ) {
 222                 return LDAP_PARAM_ERROR;
 223         }
 224
 225         if(errcodep != NULL) *errcodep = LDAP_SUCCESS;
 226         if(matcheddnp != NULL) *matcheddnp = NULL;
 227         if(errmsgp != NULL) *errmsgp = NULL;
 228         if(referralsp != NULL) *referralsp = NULL;
 229         if(serverctrls != NULL) *serverctrls = NULL;
 230
 231         /* Find the next result... */
 232         for ( lm = r; lm->lm_chain != NULL; lm = lm->lm_chain ) {
 233                 /* skip over entries and references */
 234                 if( lm->lm_msgtype != LDAP_RES_SEARCH_ENTRY &&
 235                         lm->lm_msgtype != LDAP_RES_SEARCH_REFERENCE )
 236                 {
 237                         break;
 238                 }
 239         }
 240
 241         if( lm == NULL ) {
 242                 ld->ld_errno = LDAP_NO_RESULTS_RETURNED;
 243                 return ld->ld_errno;
 244         }
 245
 246         if ( ld->ld_error ) {
 247                 LDAP_FREE( ld->ld_error );
 248                 ld->ld_error = NULL;
 249         }
 250         if ( ld->ld_matched ) {
 251                 LDAP_FREE( ld->ld_matched );
 252                 ld->ld_matched = NULL;
 253         }
 254
 255         /* parse results */
 256
 257         ber = ber_dup( lm->lm_ber );
 258
 259         if ( ld->ld_version < LDAP_VERSION2 ) {
 260                 tag = ber_scanf( ber, "{ia}",
 261                         &ld->ld_errno, &ld->ld_error );
 262         } else {
 263                 ber_len_t len;
 264                 tag = ber_scanf( ber, "{iaa" /*}*/,
 265                         &ld->ld_errno, &ld->ld_matched, &ld->ld_error );
 266
 267                 if( tag != LBER_ERROR ) {
 268                         /* peek for referrals */
 269                         if( ber_peek_tag(ber, &len) == LDAP_TAG_REFERRAL ) {
 270                                 if( referralsp != NULL ) {
 271                                         tag = ber_scanf( ber, "v", referralsp );
 272
 273                                 } else {
 274                                         /* no place to put them so skip 'em */
 275                                         tag = ber_scanf( ber, "x" );
 276                                 }
 277                         }
 278                 }
 279
 280                 /* need to clean out misc items */
 281                 if( tag != LBER_ERROR ) {
 282                         if( lm->lm_msgtype == LDAP_RES_BIND ) {
 283                                 /* look for sasl result creditials */
 284                                 if ( ber_peek_tag( ber, &len ) == LDAP_TAG_SASL_RES_CREDS ) {
 285                                         /* skip 'em */
 286                                         tag = ber_scanf( ber, "x" );
 287                                 }
 288
 289                         } else if( lm->lm_msgtype == LDAP_RES_EXTENDED ) {
 290                                 /* look for exop result oid or value */
 291                                 if ( ber_peek_tag( ber, &len ) == LDAP_TAG_EXOP_RES_OID ) {
 292                                         /* skip 'em */
 293                                         tag = ber_scanf( ber, "x" );
 294                                 }
 295
 296                                 if ( tag != LBER_ERROR &&
 297                                         ber_peek_tag( ber, &len ) == LDAP_TAG_EXOP_RES_VALUE )
 298                                 {
 299                                         /* skip 'em */
 300                                         tag = ber_scanf( ber, "x" );
 301                                 }
 302                         }
 303                 }
 304
 305                 if( tag != LBER_ERROR ) {
 306                         rc = ldap_int_get_controls( ber, serverctrls );
 307
 308                         if( rc != LDAP_SUCCESS ) {
 309                                 tag = LBER_ERROR;
 310                         }
 311                 }
 312
 313                 if( tag != LBER_ERROR ) {
 314                         tag = ber_scanf( ber, /*{*/"}" );
 315                 }
 316         }
 317
 318         if ( tag == LBER_ERROR ) {
 319                 ld->ld_errno = errcode = LDAP_DECODING_ERROR;
 320         }
 321
 322         if( ber != NULL ) {
 323                 ber_free( ber, 0 );
 324         }
 325
 326         /* return */
 327         if ( errcode == LDAP_SUCCESS ) {
 328                 if( errcodep != NULL ) {
 329                         *errcodep = ld->ld_errno;
 330                 }
 331                 if( matcheddnp != NULL ) {
 332                         *matcheddnp = LDAP_STRDUP( ld->ld_matched );
 333                 }
 334                 if( errmsgp != NULL ) {
 335                         *errmsgp = LDAP_STRDUP( ld->ld_error );
 336                 }
 337
 338                 /* Find the next result... */
 339                 for ( lm = lm->lm_chain; lm != NULL; lm = lm->lm_chain ) {
 340                         /* skip over entries and references */
 341                         if( lm->lm_msgtype != LDAP_RES_SEARCH_ENTRY &&
 342                                 lm->lm_msgtype != LDAP_RES_SEARCH_REFERENCE )
 343                         {
 344                                 /* more results to return */
 345                                 errcode = LDAP_MORE_RESULTS_TO_RETURN;
 346                                 break;
 347                         }
 348                 }
 349         }
 350
 351         if ( freeit ) {
 352                 ldap_msgfree( r );
 353         }
 354
 355         return( errcode );
 356 }