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