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