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  * Portions Copyright (C) The Internet Society (1997)
   8  * ASN.1 fragments are from RFC 2251; see RFC for full legal notices.
   9  */
  10
  11 #include "portable.h"
  12
  13 #include <stdio.h>
  14
  15 #include <ac/stdlib.h>
  16
  17 #include <ac/socket.h>
  18 #include <ac/string.h>
  19 #include <ac/time.h>
  20
  21 #include "ldap-int.h"
  22
  23 struct ldaperror {
  24         int     e_code;
  25         char *e_reason;
  26 };
  27
  28 static struct ldaperror ldap_builtin_errlist[] = {
  29         {LDAP_SUCCESS,                                  N_("Success")},
  30         {LDAP_OPERATIONS_ERROR,                 N_("Operations error")},
  31         {LDAP_PROTOCOL_ERROR,                   N_("Protocol error")},
  32         {LDAP_TIMELIMIT_EXCEEDED,               N_("Time limit exceeded")},
  33         {LDAP_SIZELIMIT_EXCEEDED,               N_("Size limit exceeded")},
  34         {LDAP_COMPARE_FALSE,                    N_("Compare False")},
  35         {LDAP_COMPARE_TRUE,                     N_("Compare True")},
  36         {LDAP_STRONG_AUTH_NOT_SUPPORTED, N_("Authentication method not supported")},
  37         {LDAP_STRONG_AUTH_REQUIRED,     N_("Strong(er) authentication required")},
  38         {LDAP_PARTIAL_RESULTS,                  N_("Partial results and referral received")},
  39
  40         {LDAP_REFERRAL,                                 N_("Referral")},
  41         {LDAP_ADMINLIMIT_EXCEEDED,              N_("Administrative limit exceeded")},
  42         {LDAP_UNAVAILABLE_CRITICAL_EXTENSION,
  43                                                                         N_("Critical extension is unavailable")},
  44         {LDAP_CONFIDENTIALITY_REQUIRED, N_("Confidentiality required")},
  45         {LDAP_SASL_BIND_IN_PROGRESS,    N_("SASL bind in progress")},
  46
  47         {LDAP_NO_SUCH_ATTRIBUTE,                N_("No such attribute")},
  48         {LDAP_UNDEFINED_TYPE,                   N_("Undefined attribute type")},
  49         {LDAP_INAPPROPRIATE_MATCHING,   N_("Inappropriate matching")},
  50         {LDAP_CONSTRAINT_VIOLATION,     N_("Constraint violation")},
  51         {LDAP_TYPE_OR_VALUE_EXISTS,     N_("Type or value exists")},
  52         {LDAP_INVALID_SYNTAX,                   N_("Invalid syntax")},
  53
  54         {LDAP_NO_SUCH_OBJECT,                   N_("No such object")},
  55         {LDAP_ALIAS_PROBLEM,                    N_("Alias problem")},
  56         {LDAP_INVALID_DN_SYNTAX,                N_("Invalid DN syntax")},
  57         {LDAP_IS_LEAF,                                  N_("Entry is a leaf")},
  58         {LDAP_ALIAS_DEREF_PROBLEM,              N_("Alias dereferencing problem")},
  59
  60         {LDAP_PROXY_AUTHZ_FAILURE,              N_("Proxy Authorization Failure")},
  61         {LDAP_INAPPROPRIATE_AUTH,               N_("Inappropriate authentication")},
  62         {LDAP_INVALID_CREDENTIALS,              N_("Invalid credentials")},
  63         {LDAP_INSUFFICIENT_ACCESS,              N_("Insufficient access")},
  64         {LDAP_BUSY,                                     N_("Server is busy")},
  65         {LDAP_UNAVAILABLE,                              N_("Server is unavailable")},
  66         {LDAP_UNWILLING_TO_PERFORM,     N_("Server is unwilling to perform")},
  67         {LDAP_LOOP_DETECT,                              N_("Loop detected")},
  68
  69         {LDAP_NAMING_VIOLATION,                 N_("Naming violation")},
  70         {LDAP_OBJECT_CLASS_VIOLATION,   N_("Object class violation")},
  71         {LDAP_NOT_ALLOWED_ON_NONLEAF,   N_("Operation not allowed on non-leaf")},
  72         {LDAP_NOT_ALLOWED_ON_RDN,               N_("Operation not allowed on RDN")},
  73         {LDAP_ALREADY_EXISTS,                   N_("Already exists")},
  74         {LDAP_NO_OBJECT_CLASS_MODS,     N_("Cannot modify object class")},
  75         {LDAP_RESULTS_TOO_LARGE,                N_("Results too large")},
  76         {LDAP_AFFECTS_MULTIPLE_DSAS,    N_("Operation affects multiple DSAs")},
  77
  78         {LDAP_OTHER,                                    N_("Internal (implementation specific) error")},
  79
  80         /* API ResultCodes */
  81         {LDAP_SERVER_DOWN,                              N_("Can't contact LDAP server")},
  82         {LDAP_LOCAL_ERROR,                              N_("Local error")},
  83         {LDAP_ENCODING_ERROR,                   N_("Encoding error")},
  84         {LDAP_DECODING_ERROR,                   N_("Decoding error")},
  85         {LDAP_TIMEOUT,                                  N_("Timed out")},
  86         {LDAP_AUTH_UNKNOWN,                             N_("Unknown authentication method")},
  87         {LDAP_FILTER_ERROR,                             N_("Bad search filter")},
  88         {LDAP_USER_CANCELLED,                   N_("User cancelled operation")},
  89         {LDAP_PARAM_ERROR,                              N_("Bad parameter to an ldap routine")},
  90         {LDAP_NO_MEMORY,                                N_("Out of memory")},
  91
  92         {LDAP_CONNECT_ERROR,                    N_("Connect error")},
  93         {LDAP_NOT_SUPPORTED,                    N_("Not Supported")},
  94         {LDAP_CONTROL_NOT_FOUND,                N_("Control not found")},
  95         {LDAP_NO_RESULTS_RETURNED,              N_("No results returned")},
  96         {LDAP_MORE_RESULTS_TO_RETURN,   N_("More results to return")},
  97         {LDAP_CLIENT_LOOP,                              N_("Client Loop")},
  98         {LDAP_REFERRAL_LIMIT_EXCEEDED,  N_("Referral Limit Exceeded")},
  99
 100         {LDAP_ASSERTION_FAILED,                 N_("Assertion Failed")},
 101
 102         {LDAP_SYNC_RESOURCES_EXHAUSTED, N_("Content Sync Resource Exhausted")},
 103         {LDAP_SYNC_SECURITY_VIOLATION,  N_("Content Sync Security Violation")},
 104         {LDAP_SYNC_INVALID_COOKIE,              N_("Content Sync Invalid Cookie")},
 105         {LDAP_SYNC_UNSUPPORTED_SCHEME,  N_("Content Sync Unsupported Scheme")},
 106         {LDAP_SYNC_CLIENT_DISCONNECT,   N_("Content Sync Client Disconnect")},
 107         {LDAP_SYNC_RELOAD_REQUIRED,             N_("Content Sync Reload Required")},
 108
 109 #ifdef LDAP_EXOP_X_CANCEL
 110         {LDAP_CANCELLED,                                N_("Cancelled")},
 111         {LDAP_NO_SUCH_OPERATION,                N_("No Operation to Cancel")},
 112         {LDAP_TOO_LATE,                                 N_("Too Late to Cancel")},
 113         {LDAP_CANNOT_CANCEL,                    N_("Cannot Cancel")},
 114 #endif
 115
 116         {-1, NULL}
 117 };
 118
 119 static struct ldaperror *ldap_errlist = ldap_builtin_errlist;
 120
 121 void ldap_int_error_init( void ) {
 122 }
 123
 124 static const struct ldaperror *
 125 ldap_int_error( int err )
 126 {
 127         int     i;
 128
 129         /* XXYYZ: O(n) search instead of O(1) lookup */
 130         for ( i=0; ldap_errlist[i].e_reason != NULL; i++ ) {
 131                 if ( err == ldap_errlist[i].e_code ) {
 132                         return &ldap_errlist[i];
 133                 }
 134         }
 135
 136         return NULL;
 137 }
 138
 139 char *
 140 ldap_err2string( int err )
 141 {
 142         const struct ldaperror *e;
 143
 144 #ifdef NEW_LOGGING
 145         LDAP_LOG ( OPERATION, ENTRY, "ldap_err2string\n", 0,0,0 );
 146 #else
 147         Debug( LDAP_DEBUG_TRACE, "ldap_err2string\n", 0, 0, 0 );
 148 #endif
 149
 150         e = ldap_int_error( err );
 151
 152         return e ? _(e->e_reason) : _("Unknown error");
 153 }
 154
 155 /* deprecated */
 156 void
 157 ldap_perror( LDAP *ld, LDAP_CONST char *str )
 158 {
 159     int i;
 160         const struct ldaperror *e;
 161 #ifdef NEW_LOGGING
 162         LDAP_LOG ( OPERATION, ENTRY, "ldap_perror\n", 0,0,0 );
 163 #else
 164         Debug( LDAP_DEBUG_TRACE, "ldap_perror\n", 0, 0, 0 );
 165 #endif
 166
 167         assert( ld != NULL );
 168         assert( LDAP_VALID( ld ) );
 169         assert( str );
 170
 171         e = ldap_int_error( ld->ld_errno );
 172
 173         fprintf( stderr, "%s: %s (%d)\n",
 174                 str ? str : "ldap_perror",
 175                 e ? _(e->e_reason) : _("unknown LDAP result code"),
 176                 ld->ld_errno );
 177
 178         if ( ld->ld_matched != NULL && ld->ld_matched[0] != '\0' ) {
 179                 fprintf( stderr, _("\tmatched DN: %s\n"), ld->ld_matched );
 180         }
 181
 182         if ( ld->ld_error != NULL && ld->ld_error[0] != '\0' ) {
 183                 fprintf( stderr, _("\tadditional info: %s\n"), ld->ld_error );
 184         }
 185
 186         if ( ld->ld_referrals != NULL && ld->ld_referrals[0] != NULL) {
 187                 fprintf( stderr, _("\treferrals:\n") );
 188                 for (i=0; ld->ld_referrals[i]; i++) {
 189                         fprintf( stderr, _("\t\t%s\n"), ld->ld_referrals[i] );
 190                 }
 191         }
 192
 193         fflush( stderr );
 194 }
 195
 196 /* deprecated */
 197 int
 198 ldap_result2error( LDAP *ld, LDAPMessage *r, int freeit )
 199 {
 200         int rc, err;
 201
 202         rc = ldap_parse_result( ld, r, &err,
 203                 NULL, NULL, NULL, NULL, freeit );
 204
 205         return err != LDAP_SUCCESS ? err : rc;
 206 }
 207
 208 /*
 209  * Parse LDAPResult Messages:
 210  *
 211  *   LDAPResult ::= SEQUENCE {
 212  *     resultCode      ENUMERATED,
 213  *     matchedDN       LDAPDN,
 214  *     errorMessage    LDAPString,
 215  *     referral        [3] Referral OPTIONAL }
 216  *
 217  * including Bind results:
 218  *
 219  *   BindResponse ::= [APPLICATION 1] SEQUENCE {
 220  *     COMPONENTS OF LDAPResult,
 221  *     serverSaslCreds  [7] OCTET STRING OPTIONAL }
 222  *
 223  * and ExtendedOp results:
 224  *
 225  *   ExtendedResponse ::= [APPLICATION 24] SEQUENCE {
 226  *     COMPONENTS OF LDAPResult,
 227  *     responseName     [10] LDAPOID OPTIONAL,
 228  *     response         [11] OCTET STRING OPTIONAL }
 229  *
 230  */
 231 int
 232 ldap_parse_result(
 233         LDAP                    *ld,
 234         LDAPMessage             *r,
 235         int                             *errcodep,
 236         char                    **matcheddnp,
 237         char                    **errmsgp,
 238         char                    ***referralsp,
 239         LDAPControl             ***serverctrls,
 240         int                             freeit )
 241 {
 242         LDAPMessage     *lm;
 243         ber_int_t errcode = LDAP_SUCCESS;
 244
 245         ber_tag_t tag;
 246         BerElement      *ber;
 247
 248 #ifdef NEW_LOGGING
 249         LDAP_LOG ( OPERATION, ENTRY, "ldap_parse_result\n", 0,0,0 );
 250 #else
 251         Debug( LDAP_DEBUG_TRACE, "ldap_parse_result\n", 0, 0, 0 );
 252 #endif
 253
 254         assert( ld != NULL );
 255         assert( LDAP_VALID( ld ) );
 256         assert( r != NULL );
 257
 258         if(errcodep != NULL) *errcodep = LDAP_SUCCESS;
 259         if(matcheddnp != NULL) *matcheddnp = NULL;
 260         if(errmsgp != NULL) *errmsgp = NULL;
 261         if(referralsp != NULL) *referralsp = NULL;
 262         if(serverctrls != NULL) *serverctrls = NULL;
 263
 264 #ifdef LDAP_R_COMPILE
 265         ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
 266 #endif
 267         /* Find the next result... */
 268         for ( lm = r; lm != NULL; lm = lm->lm_chain ) {
 269                 /* skip over entries and references */
 270                 if( lm->lm_msgtype != LDAP_RES_SEARCH_ENTRY &&
 271                         lm->lm_msgtype != LDAP_RES_SEARCH_REFERENCE &&
 272                         lm->lm_msgtype != LDAP_RES_INTERMEDIATE )
 273                 {
 274                         break;
 275                 }
 276         }
 277
 278         if( lm == NULL ) {
 279                 ld->ld_errno = LDAP_NO_RESULTS_RETURNED;
 280 #ifdef LDAP_R_COMPILE
 281                 ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
 282 #endif
 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_INTERMEDIATE )
 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 #ifdef LDAP_R_COMPILE
 398         ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
 399 #endif
 400
 401         return( errcode );
 402 }