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