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

   1 /* $OpenLDAP$ */
   2 /*
   3  * Copyright 1998-2003 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(er) 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                                                                         "Critical 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_PROXY_AUTHZ_FAILURE,              "Proxy Authorization Failure" },
  57         {LDAP_INAPPROPRIATE_AUTH,               "Inappropriate authentication" },
  58         {LDAP_INVALID_CREDENTIALS,              "Invalid credentials" },
  59         {LDAP_INSUFFICIENT_ACCESS,              "Insufficient access" },
  60         {LDAP_BUSY,                                     "Server is busy" },
  61         {LDAP_UNAVAILABLE,                              "Server is unavailable" },
  62         {LDAP_UNWILLING_TO_PERFORM,     "Server is unwilling to perform" },
  63         {LDAP_LOOP_DETECT,                              "Loop detected" },
  64
  65         {LDAP_NAMING_VIOLATION,                 "Naming violation" },
  66         {LDAP_OBJECT_CLASS_VIOLATION,   "Object class violation" },
  67         {LDAP_NOT_ALLOWED_ON_NONLEAF,   "Operation not allowed on non-leaf" },
  68         {LDAP_NOT_ALLOWED_ON_RDN,               "Operation not allowed on RDN" },
  69         {LDAP_ALREADY_EXISTS,                   "Already exists" },
  70         {LDAP_NO_OBJECT_CLASS_MODS,     "Cannot modify object class" },
  71         {LDAP_RESULTS_TOO_LARGE,                "Results too large" },
  72         {LDAP_AFFECTS_MULTIPLE_DSAS,    "Operation affects multiple DSAs" },
  73
  74         {LDAP_OTHER,                                    "Internal (implementation specific) error" },
  75
  76         /* API ResultCodes */
  77         {LDAP_SERVER_DOWN,                              "Can't contact LDAP server" },
  78         {LDAP_LOCAL_ERROR,                              "Local error" },
  79         {LDAP_ENCODING_ERROR,                   "Encoding error" },
  80         {LDAP_DECODING_ERROR,                   "Decoding error" },
  81         {LDAP_TIMEOUT,                                  "Timed out" },
  82         {LDAP_AUTH_UNKNOWN,                             "Unknown authentication method" },
  83         {LDAP_FILTER_ERROR,                             "Bad search filter" },
  84         {LDAP_USER_CANCELLED,                   "User cancelled operation" },
  85         {LDAP_PARAM_ERROR,                              "Bad parameter to an ldap routine" },
  86         {LDAP_NO_MEMORY,                                "Out of memory" },
  87
  88         {LDAP_CONNECT_ERROR,                    "Connect error" },
  89         {LDAP_NOT_SUPPORTED,                    "Not Supported" },
  90         {LDAP_CONTROL_NOT_FOUND,                "Control not found" },
  91         {LDAP_NO_RESULTS_RETURNED,              "No results returned" },
  92         {LDAP_MORE_RESULTS_TO_RETURN,   "More results to return" },
  93         {LDAP_CLIENT_LOOP,                              "Client Loop" },
  94         {LDAP_REFERRAL_LIMIT_EXCEEDED,  "Referral Limit Exceeded" },
  95 #ifdef LDAP_CLIENT_UPDATE
  96         {LDAP_CUP_RESOURCES_EXHAUSTED,  "LDAP Client Update Resource Exhausted" },
  97         {LDAP_CUP_SECURITY_VIOLATION,   "LDAP Client Update Security Violation" },
  98         {LDAP_CUP_INVALID_COOKIE,       "LDAP Client Update Invalid Cookie" },
  99         {LDAP_CUP_UNSUPPORTED_SCHEME,   "LDAP Client Update Unsupported Scheme" },
 100         {LDAP_CUP_CLIENT_DISCONNECT,    "LDAP Client Update Client Disconnect" },
 101         {LDAP_CUP_RELOAD_REQUIRED,      "LDAP Client Update Reload Required" },
 102 #endif
 103         {LDAP_CANCELLED,                "LDAP Cancelled" },
 104         {LDAP_NO_SUCH_OPERATION,        "LDAP No Operation to Cancel" },
 105         {LDAP_TOO_LATE,                 "LDAP Too Late to Cancel" },
 106         {LDAP_CANNOT_CANCEL,            "LDAP Cannot Cancel" },
 107
 108         {-1, NULL}
 109 };
 110
 111 static struct ldaperror *ldap_errlist = ldap_builtin_errlist;
 112
 113 void ldap_int_error_init( void ) {
 114 #ifdef LDAP_NLS
 115 #define LDAP_NLS_SDK_CAT "openldap_sdk"
 116 #define LDAP_NLS_LIBLDAP_SET (0)
 117
 118         int     i;
 119         nl_catd catd = catopen( LDAP_NLS_SDK_CAT, NL_CAT_LOCALE );
 120
 121         if( catd == -1 ) {
 122                 return;
 123         }
 124
 125         for ( i=0; ldap_errlist[i].e_reason != NULL; i++ ) {
 126                 char *msg = catgets( catd,
 127                         LDAP_NLS_LIBLDAP_SET,
 128                         ldap_errlist[i].e_code, NULL );
 129
 130                 if( msg != NULL ) {
 131                         msg = LDAP_STRDUP( msg );
 132
 133                         if( msg != NULL ) {
 134                                 ldap_errlist[i].e_reason = msg;
 135                         }
 136                 }
 137         }
 138
 139         catclose( catd );
 140 #endif
 141 }
 142
 143 static const struct ldaperror *
 144 ldap_int_error( int err )
 145 {
 146         int     i;
 147
 148         for ( i=0; ldap_errlist[i].e_reason != NULL; i++ ) {
 149                 if ( err == ldap_errlist[i].e_code ) {
 150                         return &ldap_errlist[i];
 151                 }
 152         }
 153
 154         return NULL;
 155 }
 156
 157 char *
 158 ldap_err2string( int err )
 159 {
 160         const struct ldaperror *e;
 161
 162 #ifdef NEW_LOGGING
 163         LDAP_LOG ( OPERATION, ENTRY, "ldap_err2string\n", 0,0,0 );
 164 #else
 165         Debug( LDAP_DEBUG_TRACE, "ldap_err2string\n", 0, 0, 0 );
 166 #endif
 167
 168         e = ldap_int_error( err );
 169
 170         return e ? e->e_reason : "Unknown error";
 171 }
 172
 173 /* deprecated */
 174 void
 175 ldap_perror( LDAP *ld, LDAP_CONST char *str )
 176 {
 177     int i;
 178         const struct ldaperror *e;
 179 #ifdef NEW_LOGGING
 180         LDAP_LOG ( OPERATION, ENTRY, "ldap_perror\n", 0,0,0 );
 181 #else
 182         Debug( LDAP_DEBUG_TRACE, "ldap_perror\n", 0, 0, 0 );
 183 #endif
 184
 185         assert( ld != NULL );
 186         assert( LDAP_VALID( ld ) );
 187         assert( str );
 188
 189         e = ldap_int_error( ld->ld_errno );
 190
 191         fprintf( stderr, "%s: %s (%d)\n",
 192                 str ? str : "ldap_perror",
 193                 e ? e->e_reason : "unknown LDAP result code",
 194                 ld->ld_errno );
 195
 196         if ( ld->ld_matched != NULL && ld->ld_matched[0] != '\0' ) {
 197                 fprintf( stderr, "\tmatched DN: %s\n", ld->ld_matched );
 198         }
 199
 200         if ( ld->ld_error != NULL && ld->ld_error[0] != '\0' ) {
 201                 fprintf( stderr, "\tadditional info: %s\n", ld->ld_error );
 202         }
 203
 204         if ( ld->ld_referrals != NULL && ld->ld_referrals[0] != NULL) {
 205                 fprintf( stderr, "\treferrals:\n" );
 206                 for (i=0; ld->ld_referrals[i]; i++) {
 207                         fprintf( stderr, "\t\t%s\n", ld->ld_referrals[i] );
 208                 }
 209         }
 210
 211         fflush( stderr );
 212 }
 213
 214 /* deprecated */
 215 int
 216 ldap_result2error( LDAP *ld, LDAPMessage *r, int freeit )
 217 {
 218         int rc, err;
 219
 220         rc = ldap_parse_result( ld, r, &err,
 221                 NULL, NULL, NULL, NULL, freeit );
 222
 223         return err != LDAP_SUCCESS ? err : rc;
 224 }
 225
 226 /*
 227  * Parse LDAPResult Messages:
 228  *
 229  *   LDAPResult ::= SEQUENCE {
 230  *     resultCode      ENUMERATED,
 231  *     matchedDN       LDAPDN,
 232  *     errorMessage    LDAPString,
 233  *     referral        [3] Referral OPTIONAL }
 234  *
 235  * including Bind results:
 236  *
 237  *   BindResponse ::= [APPLICATION 1] SEQUENCE {
 238  *     COMPONENTS OF LDAPResult,
 239  *     serverSaslCreds  [7] OCTET STRING OPTIONAL }
 240  *
 241  * and ExtendedOp results:
 242  *
 243  *   ExtendedResponse ::= [APPLICATION 24] SEQUENCE {
 244  *     COMPONENTS OF LDAPResult,
 245  *     responseName     [10] LDAPOID OPTIONAL,
 246  *     response         [11] OCTET STRING OPTIONAL }
 247  *
 248  */
 249 int
 250 ldap_parse_result(
 251         LDAP                    *ld,
 252         LDAPMessage             *r,
 253         int                             *errcodep,
 254         char                    **matcheddnp,
 255         char                    **errmsgp,
 256         char                    ***referralsp,
 257         LDAPControl             ***serverctrls,
 258         int                             freeit )
 259 {
 260         LDAPMessage     *lm;
 261         ber_int_t errcode = LDAP_SUCCESS;
 262
 263         ber_tag_t tag;
 264         BerElement      *ber;
 265
 266 #ifdef NEW_LOGGING
 267         LDAP_LOG ( OPERATION, ENTRY, "ldap_parse_result\n", 0,0,0 );
 268 #else
 269         Debug( LDAP_DEBUG_TRACE, "ldap_parse_result\n", 0, 0, 0 );
 270 #endif
 271
 272         assert( ld != NULL );
 273         assert( LDAP_VALID( ld ) );
 274         assert( r != NULL );
 275
 276         if(errcodep != NULL) *errcodep = LDAP_SUCCESS;
 277         if(matcheddnp != NULL) *matcheddnp = NULL;
 278         if(errmsgp != NULL) *errmsgp = NULL;
 279         if(referralsp != NULL) *referralsp = NULL;
 280         if(serverctrls != NULL) *serverctrls = NULL;
 281
 282         /* Find the next result... */
 283         for ( lm = r; lm != NULL; lm = lm->lm_chain ) {
 284                 /* skip over entries and references */
 285                 if( lm->lm_msgtype != LDAP_RES_SEARCH_ENTRY &&
 286                         lm->lm_msgtype != LDAP_RES_SEARCH_REFERENCE &&
 287                         lm->lm_msgtype != LDAP_RES_EXTENDED_PARTIAL )
 288                 {
 289                         break;
 290                 }
 291         }
 292
 293         if( lm == NULL ) {
 294                 ld->ld_errno = LDAP_NO_RESULTS_RETURNED;
 295                 return ld->ld_errno;
 296         }
 297
 298         if ( ld->ld_error ) {
 299                 LDAP_FREE( ld->ld_error );
 300                 ld->ld_error = NULL;
 301         }
 302         if ( ld->ld_matched ) {
 303                 LDAP_FREE( ld->ld_matched );
 304                 ld->ld_matched = NULL;
 305         }
 306         if ( ld->ld_referrals ) {
 307                 LDAP_VFREE( ld->ld_referrals );
 308                 ld->ld_referrals = NULL;
 309         }
 310
 311         /* parse results */
 312
 313         ber = ber_dup( lm->lm_ber );
 314
 315         if ( ld->ld_version < LDAP_VERSION2 ) {
 316                 tag = ber_scanf( ber, "{ia}",
 317                         &ld->ld_errno, &ld->ld_error );
 318         } else {
 319                 ber_len_t len;
 320                 tag = ber_scanf( ber, "{iaa" /*}*/,
 321                         &ld->ld_errno, &ld->ld_matched, &ld->ld_error );
 322
 323                 if( tag != LBER_ERROR ) {
 324                         /* peek for referrals */
 325                         if( ber_peek_tag(ber, &len) == LDAP_TAG_REFERRAL ) {
 326                                 tag = ber_scanf( ber, "v", &ld->ld_referrals );
 327                         }
 328                 }
 329
 330                 /* need to clean out misc items */
 331                 if( tag != LBER_ERROR ) {
 332                         if( lm->lm_msgtype == LDAP_RES_BIND ) {
 333                                 /* look for sasl result creditials */
 334                                 if ( ber_peek_tag( ber, &len ) == LDAP_TAG_SASL_RES_CREDS ) {
 335                                         /* skip 'em */
 336                                         tag = ber_scanf( ber, "x" );
 337                                 }
 338
 339                         } else if( lm->lm_msgtype == LDAP_RES_EXTENDED ) {
 340                                 /* look for exop result oid or value */
 341                                 if ( ber_peek_tag( ber, &len ) == LDAP_TAG_EXOP_RES_OID ) {
 342                                         /* skip 'em */
 343                                         tag = ber_scanf( ber, "x" );
 344                                 }
 345
 346                                 if ( tag != LBER_ERROR &&
 347                                         ber_peek_tag( ber, &len ) == LDAP_TAG_EXOP_RES_VALUE )
 348                                 {
 349                                         /* skip 'em */
 350                                         tag = ber_scanf( ber, "x" );
 351                                 }
 352                         }
 353                 }
 354
 355                 if( tag != LBER_ERROR ) {
 356                         int rc = ldap_int_get_controls( ber, serverctrls );
 357
 358                         if( rc != LDAP_SUCCESS ) {
 359                                 tag = LBER_ERROR;
 360                         }
 361                 }
 362
 363                 if( tag != LBER_ERROR ) {
 364                         tag = ber_scanf( ber, /*{*/"}" );
 365                 }
 366         }
 367
 368         if ( tag == LBER_ERROR ) {
 369                 ld->ld_errno = errcode = LDAP_DECODING_ERROR;
 370         }
 371
 372         if( ber != NULL ) {
 373                 ber_free( ber, 0 );
 374         }
 375
 376         /* return */
 377         if( errcodep != NULL ) {
 378                 *errcodep = ld->ld_errno;
 379         }
 380         if ( errcode == LDAP_SUCCESS ) {
 381                 if( matcheddnp != NULL ) {
 382                         *matcheddnp = LDAP_STRDUP( ld->ld_matched );
 383                 }
 384                 if( errmsgp != NULL ) {
 385                         *errmsgp = LDAP_STRDUP( ld->ld_error );
 386                 }
 387
 388                 if( referralsp != NULL) {
 389                         *referralsp = ldap_value_dup( ld->ld_referrals );
 390                 }
 391
 392                 /* Find the next result... */
 393                 for ( lm = lm->lm_chain; lm != NULL; lm = lm->lm_chain ) {
 394                         /* skip over entries and references */
 395                         if( lm->lm_msgtype != LDAP_RES_SEARCH_ENTRY &&
 396                                 lm->lm_msgtype != LDAP_RES_SEARCH_REFERENCE &&
 397                                 lm->lm_msgtype != LDAP_RES_EXTENDED_PARTIAL )
 398                         {
 399                                 /* more results to return */
 400                                 errcode = LDAP_MORE_RESULTS_TO_RETURN;
 401                                 break;
 402                         }
 403                 }
 404         }
 405
 406         if ( freeit ) {
 407                 ldap_msgfree( r );
 408         }
 409
 410         return( errcode );
 411 }