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

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