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

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