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

   1 /* $OpenLDAP$ */
   2 /*
   3  * Copyright 1998-2000 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,                                  "Entry 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
  75         /* API ResultCodes */
  76         {LDAP_SERVER_DOWN,                              "Can't contact LDAP server" },
  77         {LDAP_LOCAL_ERROR,                              "Local error" },
  78         {LDAP_ENCODING_ERROR,                   "Encoding error" },
  79         {LDAP_DECODING_ERROR,                   "Decoding error" },
  80         {LDAP_TIMEOUT,                                  "Timed out" },
  81         {LDAP_AUTH_UNKNOWN,                             "Unknown authentication method" },
  82         {LDAP_FILTER_ERROR,                             "Bad search filter" },
  83         {LDAP_USER_CANCELLED,                   "User cancelled operation" },
  84         {LDAP_PARAM_ERROR,                              "Bad parameter to an ldap routine" },
  85         {LDAP_NO_MEMORY,                                "Out of memory" },
  86
  87         {LDAP_CONNECT_ERROR,                    "Connect error" },
  88         {LDAP_NOT_SUPPORTED,                    "Not Supported" },
  89         {LDAP_CONTROL_NOT_FOUND,                "Control not found" },
  90         {LDAP_NO_RESULTS_RETURNED,              "No results returned" },
  91         {LDAP_MORE_RESULTS_TO_RETURN,   "More results to return" },
  92         {LDAP_CLIENT_LOOP,                              "Client Loop" },
  93         {LDAP_REFERRAL_LIMIT_EXCEEDED,  "Referral Limit Exceeded" },
  94
  95         {-1, NULL }
  96 };
  97
  98 static const struct ldaperror *
  99 ldap_int_error( int err )
 100 {
 101         int     i;
 102
 103         for ( i = 0; ldap_errlist[i].e_code != -1; i++ ) {
 104                 if ( err == ldap_errlist[i].e_code ) {
 105                         return &ldap_errlist[i];
 106                 }
 107         }
 108
 109         return NULL;
 110 }
 111
 112 char *
 113 ldap_err2string( int err )
 114 {
 115         const struct ldaperror *e;
 116
 117         Debug( LDAP_DEBUG_TRACE, "ldap_err2string\n", 0, 0, 0 );
 118
 119         e = ldap_int_error( err );
 120
 121         return e ? e->e_reason : "Unknown error";
 122 }
 123
 124 /* deprecated */
 125 void
 126 ldap_perror( LDAP *ld, LDAP_CONST char *str )
 127 {
 128         const struct ldaperror *e;
 129         Debug( LDAP_DEBUG_TRACE, "ldap_perror\n", 0, 0, 0 );
 130
 131         assert( ld != NULL );
 132         assert( LDAP_VALID( ld ) );
 133         assert( str );
 134
 135         if ( ld == NULL ) {
 136                 fprintf( stderr, "ldap_perror: invalid session handle\n" );
 137                 return;
 138         }
 139
 140         e = ldap_int_error( ld->ld_errno );
 141
 142         fprintf( stderr, "%s: %s (%d)\n",
 143                 str ? str : "ldap_perror",
 144                 e ? e->e_reason : "unknown LDAP result code",
 145                 ld->ld_errno );
 146
 147         if ( ld->ld_matched != NULL && ld->ld_matched[0] != '\0' ) {
 148                 fprintf( stderr, "\tmatched DN: %s\n", ld->ld_matched );
 149         }
 150
 151         if ( ld->ld_error != NULL && ld->ld_error[0] != '\0' ) {
 152                 fprintf( stderr, "\tadditional info: %s\n", ld->ld_error );
 153         }
 154
 155         fflush( stderr );
 156 }
 157
 158 /* deprecated */
 159 int
 160 ldap_result2error( LDAP *ld, LDAPMessage *r, int freeit )
 161 {
 162         int rc, err;
 163
 164         rc = ldap_parse_result( ld, r, &err,
 165                 NULL, NULL, NULL, NULL, freeit );
 166
 167         return err != LDAP_SUCCESS ? err : rc;
 168 }
 169
 170 /*
 171  * Parse LDAPResult Messages:
 172  *
 173  *   LDAPResult ::= SEQUENCE {
 174  *     resultCode      ENUMERATED,
 175  *     matchedDN       LDAPDN,
 176  *     errorMessage    LDAPString,
 177  *     referral        [3] Referral OPTIONAL }
 178  *
 179  * including Bind results:
 180  *
 181  *   BindResponse ::= [APPLICATION 1] SEQUENCE {
 182  *     COMPONENTS OF LDAPResult,
 183  *     serverSaslCreds  [7] OCTET STRING OPTIONAL }
 184  *
 185  * and ExtendedOp results:
 186  *
 187  *   ExtendedResponse ::= [APPLICATION 24] SEQUENCE {
 188  *     COMPONENTS OF LDAPResult,
 189  *     responseName     [10] LDAPOID OPTIONAL,
 190  *     response         [11] OCTET STRING OPTIONAL }
 191  *
 192  */
 193 int
 194 ldap_parse_result(
 195         LDAP                    *ld,
 196         LDAPMessage             *r,
 197         int                             *errcodep,
 198         char                    **matcheddnp,
 199         char                    **errmsgp,
 200         char                    ***referralsp,
 201         LDAPControl             ***serverctrls,
 202         int                             freeit )
 203 {
 204         LDAPMessage     *lm;
 205         ber_int_t errcode = LDAP_SUCCESS;
 206
 207         ber_tag_t tag;
 208         BerElement      *ber;
 209
 210         Debug( LDAP_DEBUG_TRACE, "ldap_parse_result\n", 0, 0, 0 );
 211
 212         assert( ld != NULL );
 213         assert( LDAP_VALID( ld ) );
 214         assert( r != NULL );
 215
 216         if ( ld == NULL || r == NULL ) {
 217                 return LDAP_PARAM_ERROR;
 218         }
 219
 220         if(errcodep != NULL) *errcodep = LDAP_SUCCESS;
 221         if(matcheddnp != NULL) *matcheddnp = NULL;
 222         if(errmsgp != NULL) *errmsgp = NULL;
 223         if(referralsp != NULL) *referralsp = NULL;
 224         if(serverctrls != NULL) *serverctrls = NULL;
 225
 226         /* Find the next result... */
 227         for ( lm = r; lm != NULL; lm = lm->lm_chain ) {
 228                 /* skip over entries and references */
 229                 if( lm->lm_msgtype != LDAP_RES_SEARCH_ENTRY &&
 230                         lm->lm_msgtype != LDAP_RES_SEARCH_REFERENCE &&
 231                         lm->lm_msgtype != LDAP_RES_EXTENDED_PARTIAL )
 232                 {
 233                         break;
 234                 }
 235         }
 236
 237         if( lm == NULL ) {
 238                 ld->ld_errno = LDAP_NO_RESULTS_RETURNED;
 239                 return ld->ld_errno;
 240         }
 241
 242         if ( ld->ld_error ) {
 243                 LDAP_FREE( ld->ld_error );
 244                 ld->ld_error = NULL;
 245         }
 246         if ( ld->ld_matched ) {
 247                 LDAP_FREE( ld->ld_matched );
 248                 ld->ld_matched = NULL;
 249         }
 250
 251         /* parse results */
 252
 253         ber = ber_dup( lm->lm_ber );
 254
 255         if ( ld->ld_version < LDAP_VERSION2 ) {
 256                 tag = ber_scanf( ber, "{ia}",
 257                         &ld->ld_errno, &ld->ld_error );
 258         } else {
 259                 ber_len_t len;
 260                 tag = ber_scanf( ber, "{iaa" /*}*/,
 261                         &ld->ld_errno, &ld->ld_matched, &ld->ld_error );
 262
 263                 if( tag != LBER_ERROR ) {
 264                         /* peek for referrals */
 265                         if( ber_peek_tag(ber, &len) == LDAP_TAG_REFERRAL ) {
 266                                 if( referralsp != NULL ) {
 267                                         tag = ber_scanf( ber, "v", referralsp );
 268
 269                                 } else {
 270                                         /* no place to put them so skip 'em */
 271                                         tag = ber_scanf( ber, "x" );
 272                                 }
 273                         }
 274                 }
 275
 276                 /* need to clean out misc items */
 277                 if( tag != LBER_ERROR ) {
 278                         if( lm->lm_msgtype == LDAP_RES_BIND ) {
 279                                 /* look for sasl result creditials */
 280                                 if ( ber_peek_tag( ber, &len ) == LDAP_TAG_SASL_RES_CREDS ) {
 281                                         /* skip 'em */
 282                                         tag = ber_scanf( ber, "x" );
 283                                 }
 284
 285                         } else if( lm->lm_msgtype == LDAP_RES_EXTENDED ) {
 286                                 /* look for exop result oid or value */
 287                                 if ( ber_peek_tag( ber, &len ) == LDAP_TAG_EXOP_RES_OID ) {
 288                                         /* skip 'em */
 289                                         tag = ber_scanf( ber, "x" );
 290                                 }
 291
 292                                 if ( tag != LBER_ERROR &&
 293                                         ber_peek_tag( ber, &len ) == LDAP_TAG_EXOP_RES_VALUE )
 294                                 {
 295                                         /* skip 'em */
 296                                         tag = ber_scanf( ber, "x" );
 297                                 }
 298                         }
 299                 }
 300
 301                 if( tag != LBER_ERROR ) {
 302                         int rc = ldap_int_get_controls( ber, serverctrls );
 303
 304                         if( rc != LDAP_SUCCESS ) {
 305                                 tag = LBER_ERROR;
 306                         }
 307                 }
 308
 309                 if( tag != LBER_ERROR ) {
 310                         tag = ber_scanf( ber, /*{*/"}" );
 311                 }
 312         }
 313
 314         if ( tag == LBER_ERROR ) {
 315                 ld->ld_errno = errcode = LDAP_DECODING_ERROR;
 316         }
 317
 318         if( ber != NULL ) {
 319                 ber_free( ber, 0 );
 320         }
 321
 322         /* return */
 323         if( errcodep != NULL ) {
 324                 *errcodep = ld->ld_errno;
 325         }
 326         if ( errcode == LDAP_SUCCESS ) {
 327                 if( matcheddnp != NULL ) {
 328                         *matcheddnp = LDAP_STRDUP( ld->ld_matched );
 329                 }
 330                 if( errmsgp != NULL ) {
 331                         *errmsgp = LDAP_STRDUP( ld->ld_error );
 332                 }
 333
 334                 /* Find the next result... */
 335                 for ( lm = lm->lm_chain; lm != NULL; lm = lm->lm_chain ) {
 336                         /* skip over entries and references */
 337                         if( lm->lm_msgtype != LDAP_RES_SEARCH_ENTRY &&
 338                                 lm->lm_msgtype != LDAP_RES_SEARCH_REFERENCE &&
 339                                 lm->lm_msgtype != LDAP_RES_EXTENDED_PARTIAL )
 340                         {
 341                                 /* more results to return */
 342                                 errcode = LDAP_MORE_RESULTS_TO_RETURN;
 343                                 break;
 344                         }
 345                 }
 346         }
 347
 348         if ( freeit ) {
 349                 ldap_msgfree( r );
 350         }
 351
 352         return( errcode );
 353 }