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

   1 /* $OpenLDAP$ */
   2 /*
   3  * Copyright 1998-2002 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 struct ldaperror ldap_builtin_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 struct ldaperror *ldap_errlist = ldap_builtin_errlist;
  99
 100 void ldap_int_error_init( void ) {
 101 #ifdef LDAP_NLS
 102 #define LDAP_NLS_SDK_CAT "openldap_sdk"
 103 #define LDAP_NLS_LIBLDAP_SET (0)
 104
 105         int     i;
 106         nl_catd catd = catopen( LDAP_NLS_SDK_CAT, NL_CAT_LOCALE );
 107
 108         if( catd == -1 ) {
 109                 return;
 110         }
 111
 112         for ( i=0; ldap_errlist[i].e_reason != NULL; i++ ) {
 113                 char *msg = catgets( catd,
 114                         LDAP_NLS_LIBLDAP_SET,
 115                         ldap_errlist[i].e_code, NULL );
 116
 117                 if( msg != NULL ) {
 118                         msg = LDAP_STRDUP( msg );
 119
 120                         if( msg != NULL ) {
 121                                 ldap_errlist[i].e_reason = msg;
 122                         }
 123                 }
 124         }
 125
 126         catclose( catd );
 127 #endif
 128 }
 129
 130 static const struct ldaperror *
 131 ldap_int_error( int err )
 132 {
 133         int     i;
 134
 135         for ( i=0; ldap_errlist[i].e_reason != NULL; i++ ) {
 136                 if ( err == ldap_errlist[i].e_code ) {
 137                         return &ldap_errlist[i];
 138                 }
 139         }
 140
 141         return NULL;
 142 }
 143
 144 char *
 145 ldap_err2string( int err )
 146 {
 147         const struct ldaperror *e;
 148
 149 #ifdef NEW_LOGGING
 150         LDAP_LOG ( OPERATION, ENTRY, "ldap_err2string\n", 0,0,0 );
 151 #else
 152         Debug( LDAP_DEBUG_TRACE, "ldap_err2string\n", 0, 0, 0 );
 153 #endif
 154
 155         e = ldap_int_error( err );
 156
 157         return e ? e->e_reason : "Unknown error";
 158 }
 159
 160 /* deprecated */
 161 void
 162 ldap_perror( LDAP *ld, LDAP_CONST char *str )
 163 {
 164         const struct ldaperror *e;
 165 #ifdef NEW_LOGGING
 166         LDAP_LOG ( OPERATION, ENTRY, "ldap_perror\n", 0,0,0 );
 167 #else
 168         Debug( LDAP_DEBUG_TRACE, "ldap_perror\n", 0, 0, 0 );
 169 #endif
 170
 171         assert( ld != NULL );
 172         assert( LDAP_VALID( ld ) );
 173         assert( str );
 174
 175         e = ldap_int_error( ld->ld_errno );
 176
 177         fprintf( stderr, "%s: %s (%d)\n",
 178                 str ? str : "ldap_perror",
 179                 e ? e->e_reason : "unknown LDAP result code",
 180                 ld->ld_errno );
 181
 182         if ( ld->ld_matched != NULL && ld->ld_matched[0] != '\0' ) {
 183                 fprintf( stderr, "\tmatched DN: %s\n", ld->ld_matched );
 184         }
 185
 186         if ( ld->ld_error != NULL && ld->ld_error[0] != '\0' ) {
 187                 fprintf( stderr, "\tadditional info: %s\n", ld->ld_error );
 188         }
 189
 190         fflush( stderr );
 191 }
 192
 193 /* deprecated */
 194 int
 195 ldap_result2error( LDAP *ld, LDAPMessage *r, int freeit )
 196 {
 197         int rc, err;
 198
 199         rc = ldap_parse_result( ld, r, &err,
 200                 NULL, NULL, NULL, NULL, freeit );
 201
 202         return err != LDAP_SUCCESS ? err : rc;
 203 }
 204
 205 /*
 206  * Parse LDAPResult Messages:
 207  *
 208  *   LDAPResult ::= SEQUENCE {
 209  *     resultCode      ENUMERATED,
 210  *     matchedDN       LDAPDN,
 211  *     errorMessage    LDAPString,
 212  *     referral        [3] Referral OPTIONAL }
 213  *
 214  * including Bind results:
 215  *
 216  *   BindResponse ::= [APPLICATION 1] SEQUENCE {
 217  *     COMPONENTS OF LDAPResult,
 218  *     serverSaslCreds  [7] OCTET STRING OPTIONAL }
 219  *
 220  * and ExtendedOp results:
 221  *
 222  *   ExtendedResponse ::= [APPLICATION 24] SEQUENCE {
 223  *     COMPONENTS OF LDAPResult,
 224  *     responseName     [10] LDAPOID OPTIONAL,
 225  *     response         [11] OCTET STRING OPTIONAL }
 226  *
 227  */
 228 int
 229 ldap_parse_result(
 230         LDAP                    *ld,
 231         LDAPMessage             *r,
 232         int                             *errcodep,
 233         char                    **matcheddnp,
 234         char                    **errmsgp,
 235         char                    ***referralsp,
 236         LDAPControl             ***serverctrls,
 237         int                             freeit )
 238 {
 239         LDAPMessage     *lm;
 240         ber_int_t errcode = LDAP_SUCCESS;
 241
 242         ber_tag_t tag;
 243         BerElement      *ber;
 244
 245 #ifdef NEW_LOGGING
 246         LDAP_LOG ( OPERATION, ENTRY, "ldap_parse_result\n", 0,0,0 );
 247 #else
 248         Debug( LDAP_DEBUG_TRACE, "ldap_parse_result\n", 0, 0, 0 );
 249 #endif
 250
 251         assert( ld != NULL );
 252         assert( LDAP_VALID( ld ) );
 253         assert( r != NULL );
 254
 255         if(errcodep != NULL) *errcodep = LDAP_SUCCESS;
 256         if(matcheddnp != NULL) *matcheddnp = NULL;
 257         if(errmsgp != NULL) *errmsgp = NULL;
 258         if(referralsp != NULL) *referralsp = NULL;
 259         if(serverctrls != NULL) *serverctrls = NULL;
 260
 261         /* Find the next result... */
 262         for ( lm = r; lm != NULL; lm = lm->lm_chain ) {
 263                 /* skip over entries and references */
 264                 if( lm->lm_msgtype != LDAP_RES_SEARCH_ENTRY &&
 265                         lm->lm_msgtype != LDAP_RES_SEARCH_REFERENCE &&
 266                         lm->lm_msgtype != LDAP_RES_EXTENDED_PARTIAL )
 267                 {
 268                         break;
 269                 }
 270         }
 271
 272         if( lm == NULL ) {
 273                 ld->ld_errno = LDAP_NO_RESULTS_RETURNED;
 274                 return ld->ld_errno;
 275         }
 276
 277         if ( ld->ld_error ) {
 278                 LDAP_FREE( ld->ld_error );
 279                 ld->ld_error = NULL;
 280         }
 281         if ( ld->ld_matched ) {
 282                 LDAP_FREE( ld->ld_matched );
 283                 ld->ld_matched = NULL;
 284         }
 285
 286         /* parse results */
 287
 288         ber = ber_dup( lm->lm_ber );
 289
 290         if ( ld->ld_version < LDAP_VERSION2 ) {
 291                 tag = ber_scanf( ber, "{ia}",
 292                         &ld->ld_errno, &ld->ld_error );
 293         } else {
 294                 ber_len_t len;
 295                 tag = ber_scanf( ber, "{iaa" /*}*/,
 296                         &ld->ld_errno, &ld->ld_matched, &ld->ld_error );
 297
 298                 if( tag != LBER_ERROR ) {
 299                         /* peek for referrals */
 300                         if( ber_peek_tag(ber, &len) == LDAP_TAG_REFERRAL ) {
 301                                 if( referralsp != NULL ) {
 302                                         tag = ber_scanf( ber, "v", referralsp );
 303
 304                                 } else {
 305                                         /* no place to put them so skip 'em */
 306                                         tag = ber_scanf( ber, "x" );
 307                                 }
 308                         }
 309                 }
 310
 311                 /* need to clean out misc items */
 312                 if( tag != LBER_ERROR ) {
 313                         if( lm->lm_msgtype == LDAP_RES_BIND ) {
 314                                 /* look for sasl result creditials */
 315                                 if ( ber_peek_tag( ber, &len ) == LDAP_TAG_SASL_RES_CREDS ) {
 316                                         /* skip 'em */
 317                                         tag = ber_scanf( ber, "x" );
 318                                 }
 319
 320                         } else if( lm->lm_msgtype == LDAP_RES_EXTENDED ) {
 321                                 /* look for exop result oid or value */
 322                                 if ( ber_peek_tag( ber, &len ) == LDAP_TAG_EXOP_RES_OID ) {
 323                                         /* skip 'em */
 324                                         tag = ber_scanf( ber, "x" );
 325                                 }
 326
 327                                 if ( tag != LBER_ERROR &&
 328                                         ber_peek_tag( ber, &len ) == LDAP_TAG_EXOP_RES_VALUE )
 329                                 {
 330                                         /* skip 'em */
 331                                         tag = ber_scanf( ber, "x" );
 332                                 }
 333                         }
 334                 }
 335
 336                 if( tag != LBER_ERROR ) {
 337                         int rc = ldap_int_get_controls( ber, serverctrls );
 338
 339                         if( rc != LDAP_SUCCESS ) {
 340                                 tag = LBER_ERROR;
 341                         }
 342                 }
 343
 344                 if( tag != LBER_ERROR ) {
 345                         tag = ber_scanf( ber, /*{*/"}" );
 346                 }
 347         }
 348
 349         if ( tag == LBER_ERROR ) {
 350                 ld->ld_errno = errcode = LDAP_DECODING_ERROR;
 351         }
 352
 353         if( ber != NULL ) {
 354                 ber_free( ber, 0 );
 355         }
 356
 357         /* return */
 358         if( errcodep != NULL ) {
 359                 *errcodep = ld->ld_errno;
 360         }
 361         if ( errcode == LDAP_SUCCESS ) {
 362                 if( matcheddnp != NULL ) {
 363                         *matcheddnp = LDAP_STRDUP( ld->ld_matched );
 364                 }
 365                 if( errmsgp != NULL ) {
 366                         *errmsgp = LDAP_STRDUP( ld->ld_error );
 367                 }
 368
 369                 /* Find the next result... */
 370                 for ( lm = lm->lm_chain; lm != NULL; lm = lm->lm_chain ) {
 371                         /* skip over entries and references */
 372                         if( lm->lm_msgtype != LDAP_RES_SEARCH_ENTRY &&
 373                                 lm->lm_msgtype != LDAP_RES_SEARCH_REFERENCE &&
 374                                 lm->lm_msgtype != LDAP_RES_EXTENDED_PARTIAL )
 375                         {
 376                                 /* more results to return */
 377                                 errcode = LDAP_MORE_RESULTS_TO_RETURN;
 378                                 break;
 379                         }
 380                 }
 381         }
 382
 383         if ( freeit ) {
 384                 ldap_msgfree( r );
 385         }
 386
 387         return( errcode );
 388 }