dlls/wldap32/error.c

   1 /*
   2  * WLDAP32 - LDAP support for Wine
   3  *
   4  * Copyright 2005 Hans Leidekker
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  */
  20
  21 #include "config.h"
  22
  23 #include "wine/port.h"
  24 #include "wine/debug.h"
  25
  26 #include <stdarg.h>
  27
  28 #include "windef.h"
  29 #include "winbase.h"
  30 #include "winuser.h"
  31 #include "winnls.h"
  32
  33 #ifdef HAVE_LDAP_H
  34 #include <ldap.h>
  35 #endif
  36
  37 #include "winldap_private.h"
  38 #include "wldap32.h"
  39
  40 WINE_DEFAULT_DEBUG_CHANNEL(wldap32);
  41
  42 ULONG map_error( int error )
  43 {
  44     switch (error)
  45     {
  46 #ifdef HAVE_LDAP_H
  47     case LDAP_SERVER_DOWN:              return WLDAP32_LDAP_SERVER_DOWN;
  48     case LDAP_LOCAL_ERROR:              return WLDAP32_LDAP_LOCAL_ERROR;
  49     case LDAP_DECODING_ERROR:           return WLDAP32_LDAP_DECODING_ERROR;
  50     case LDAP_TIMEOUT:                  return WLDAP32_LDAP_TIMEOUT;
  51     case LDAP_AUTH_UNKNOWN:             return WLDAP32_LDAP_AUTH_UNKNOWN;
  52     case LDAP_FILTER_ERROR:             return WLDAP32_LDAP_FILTER_ERROR;
  53     case LDAP_USER_CANCELLED:           return WLDAP32_LDAP_USER_CANCELLED;
  54     case LDAP_PARAM_ERROR:              return WLDAP32_LDAP_PARAM_ERROR;
  55     case LDAP_NO_MEMORY:                return WLDAP32_LDAP_NO_MEMORY;
  56     case LDAP_CONNECT_ERROR:            return WLDAP32_LDAP_CONNECT_ERROR;
  57     case LDAP_NOT_SUPPORTED:            return WLDAP32_LDAP_NOT_SUPPORTED;
  58     case LDAP_CONTROL_NOT_FOUND:        return WLDAP32_LDAP_CONTROL_NOT_FOUND;
  59     case LDAP_NO_RESULTS_RETURNED:      return WLDAP32_LDAP_NO_RESULTS_RETURNED;
  60     case LDAP_MORE_RESULTS_TO_RETURN:   return WLDAP32_LDAP_MORE_RESULTS_TO_RETURN;
  61     case LDAP_CLIENT_LOOP:              return WLDAP32_LDAP_CLIENT_LOOP;
  62     case LDAP_REFERRAL_LIMIT_EXCEEDED:  return WLDAP32_LDAP_REFERRAL_LIMIT_EXCEEDED;
  63 #endif
  64     default: return error;
  65     }
  66 }
  67
  68 /***********************************************************************
  69  *      ldap_err2stringA     (WLDAP32.@)
  70  *
  71  * See ldap_err2stringW.
  72  */
  73 PCHAR CDECL ldap_err2stringA( ULONG err )
  74 {
  75     static char buf[256] = "";
  76
  77     TRACE( "(0x%08x)\n", err );
  78
  79     if (err <= WLDAP32_LDAP_REFERRAL_LIMIT_EXCEEDED)
  80         LoadStringA( hwldap32, err, buf, 256 );
  81     else
  82         LoadStringA( hwldap32, WLDAP32_LDAP_LOCAL_ERROR, buf, 256 );
  83
  84     return buf;
  85 }
  86
  87 /***********************************************************************
  88  *      ldap_err2stringW     (WLDAP32.@)
  89  *
  90  * Convert an error code into a string describing the error.
  91  *
  92  * PARAMS
  93  *  err  [I] Error code to convert.
  94  *
  95  * RETURNS
  96  *  Success: Pointer to a string containing the error description.
  97  *  Failure: NULL
  98  *
  99  * NOTES
 100  *  The returned string is statically allocated, you must not
 101  *  free this string.
 102  */
 103 PWCHAR CDECL ldap_err2stringW( ULONG err )
 104 {
 105     static WCHAR buf[256] = { 0 };
 106
 107     TRACE( "(0x%08x)\n", err );
 108
 109     if (err <= WLDAP32_LDAP_REFERRAL_LIMIT_EXCEEDED)
 110         LoadStringW( hwldap32, err, buf, 256 );
 111     else
 112         LoadStringW( hwldap32, WLDAP32_LDAP_LOCAL_ERROR, buf, 256 );
 113
 114     return buf;
 115 }
 116
 117 /***********************************************************************
 118  *      ldap_perror     (WLDAP32.@)
 119  *
 120  * Print a given error string.
 121  *
 122  * PARAMS
 123  *  ld   [I] Pointer to an LDAP context.
 124  *  msg  [I] Error string.
 125  *
 126  * RETURNS
 127  *  Nothing.
 128  *
 129  * NOTES
 130  *  Like native, this function does nothing.
 131  */
 132 void CDECL WLDAP32_ldap_perror( WLDAP32_LDAP *ld, const PCHAR msg )
 133 {
 134     TRACE( "(%p, %s)\n", ld, debugstr_a(msg) );
 135 }
 136
 137 /***********************************************************************
 138  *      ldap_result2error     (WLDAP32.@)
 139  *
 140  * Parse an LDAP message and return the error obtained from it.
 141  *
 142  * PARAMS
 143  *  ld    [I] Pointer to an LDAP context.
 144  *  res   [I] Pointer to an LDAPMessage structure.
 145  *  free  [I] Ask for the LDAPMessage structure to be freed.
 146  *
 147  * RETURNS
 148  *  Success: LDAP_SUCCESS
 149  *  Failure: An LDAP error code.
 150  *
 151  * NOTES
 152  *  If not asked for, use ldap_msgfree to free the LDAPMessage.
 153  */
 154 ULONG CDECL WLDAP32_ldap_result2error( WLDAP32_LDAP *ld, WLDAP32_LDAPMessage *res, ULONG free )
 155 {
 156     ULONG ret = WLDAP32_LDAP_NOT_SUPPORTED;
 157 #ifdef HAVE_LDAP
 158     int error;
 159
 160     TRACE( "(%p, %p, 0x%08x)\n", ld, res, free );
 161
 162     if (!ld || !res) return ~0u;
 163
 164     ret = ldap_parse_result( ld, res, &error, NULL, NULL, NULL, NULL, free );
 165
 166     if (ret == LDAP_SUCCESS)
 167         ret = error;
 168     else
 169         ret = ~0u;
 170
 171 #endif
 172     return ret;
 173 }
 174
 175 /***********************************************************************
 176  *      LdapGetLastError     (WLDAP32.@)
 177  *
 178  * Return the last error set by an LDAP function call.
 179  *
 180  * PARAMS
 181  *  None.
 182  *
 183  * RETURNS
 184  *  An LDAP error code.
 185  */
 186 ULONG CDECL LdapGetLastError( void )
 187 {
 188     TRACE( "\n" );
 189     return GetLastError();
 190 }
 191
 192 static const ULONG WLDAP32_errormap[] = {
 193     /* LDAP_SUCCESS */                      ERROR_SUCCESS,
 194     /* LDAP_OPERATIONS_ERROR */             ERROR_OPEN_FAILED,
 195     /* LDAP_PROTOCOL_ERROR */               ERROR_INVALID_LEVEL,
 196     /* LDAP_TIMELIMIT_EXCEEDED */           ERROR_TIMEOUT,
 197     /* LDAP_SIZELIMIT_EXCEEDED */           ERROR_MORE_DATA,
 198     /* LDAP_COMPARE_FALSE */                ERROR_DS_GENERIC_ERROR,
 199     /* LDAP_COMPARE_TRUE */                 ERROR_DS_GENERIC_ERROR,
 200     /* LDAP_AUTH_METHOD_NOT_SUPPORTED */    ERROR_ACCESS_DENIED,
 201     /* LDAP_STRONG_AUTH_REQUIRED */         ERROR_ACCESS_DENIED,
 202     /* LDAP_REFERRAL_V2 */                  ERROR_MORE_DATA,
 203     /* LDAP_REFERRAL */                     ERROR_MORE_DATA,
 204     /* LDAP_ADMIN_LIMIT_EXCEEDED */         ERROR_NOT_ENOUGH_QUOTA,
 205     /* LDAP_UNAVAILABLE_CRIT_EXTENSION */   ERROR_CAN_NOT_COMPLETE,
 206     /* LDAP_CONFIDENTIALITY_REQUIRED */     ERROR_DS_GENERIC_ERROR,
 207     /* LDAP_SASL_BIND_IN_PROGRESS */        ERROR_DS_GENERIC_ERROR,
 208     /* 0x0f */                              ERROR_DS_GENERIC_ERROR,
 209     /* LDAP_NO_SUCH_ATTRIBUTE */            ERROR_INVALID_PARAMETER,
 210     /* LDAP_UNDEFINED_TYPE */               ERROR_DS_GENERIC_ERROR,
 211     /* LDAP_INAPPROPRIATE_MATCHING */       ERROR_INVALID_PARAMETER,
 212     /* LDAP_CONSTRAINT_VIOLATION */         ERROR_INVALID_PARAMETER,
 213     /* LDAP_ATTRIBUTE_OR_VALUE_EXISTS */    ERROR_ALREADY_EXISTS,
 214     /* LDAP_INVALID_SYNTAX */               ERROR_INVALID_NAME,
 215     /* 0x16 */                              ERROR_DS_GENERIC_ERROR,
 216     /* 0x17 */                              ERROR_DS_GENERIC_ERROR,
 217     /* 0x18 */                              ERROR_DS_GENERIC_ERROR,
 218     /* 0x19 */                              ERROR_DS_GENERIC_ERROR,
 219     /* 0x1a */                              ERROR_DS_GENERIC_ERROR,
 220     /* 0x1b */                              ERROR_DS_GENERIC_ERROR,
 221     /* 0x1c */                              ERROR_DS_GENERIC_ERROR,
 222     /* 0x1d */                              ERROR_DS_GENERIC_ERROR,
 223     /* 0x1e */                              ERROR_DS_GENERIC_ERROR,
 224     /* 0x1f */                              ERROR_DS_GENERIC_ERROR,
 225     /* LDAP_NO_SUCH_OBJECT */               ERROR_FILE_NOT_FOUND,
 226     /* LDAP_ALIAS_PROBLEM */                ERROR_DS_GENERIC_ERROR,
 227     /* LDAP_INVALID_DN_SYNTAX */            ERROR_INVALID_PARAMETER,
 228     /* LDAP_IS_LEAF */                      ERROR_DS_GENERIC_ERROR,
 229     /* LDAP_ALIAS_DEREF_PROBLEM */          ERROR_DS_GENERIC_ERROR,
 230     /* 0x25 */                              ERROR_DS_GENERIC_ERROR,
 231     /* 0x26 */                              ERROR_DS_GENERIC_ERROR,
 232     /* 0x27 */                              ERROR_DS_GENERIC_ERROR,
 233     /* 0x28 */                              ERROR_DS_GENERIC_ERROR,
 234     /* 0x29 */                              ERROR_DS_GENERIC_ERROR,
 235     /* 0x2a */                              ERROR_DS_GENERIC_ERROR,
 236     /* 0x2b */                              ERROR_DS_GENERIC_ERROR,
 237     /* 0x2c */                              ERROR_DS_GENERIC_ERROR,
 238     /* 0x2d */                              ERROR_DS_GENERIC_ERROR,
 239     /* 0x2e */                              ERROR_DS_GENERIC_ERROR,
 240     /* 0x2f */                              ERROR_DS_GENERIC_ERROR,
 241     /* LDAP_INAPPROPRIATE_AUTH */           ERROR_ACCESS_DENIED,
 242     /* LDAP_INVALID_CREDENTIALS */          ERROR_WRONG_PASSWORD,
 243     /* LDAP_INSUFFICIENT_RIGHTS */          ERROR_ACCESS_DENIED,
 244     /* LDAP_BUSY */                         ERROR_BUSY,
 245     /* LDAP_UNAVAILABLE */                  ERROR_DEV_NOT_EXIST,
 246     /* LDAP_UNWILLING_TO_PERFORM */         ERROR_CAN_NOT_COMPLETE,
 247     /* LDAP_LOOP_DETECT */                  ERROR_DS_GENERIC_ERROR,
 248     /* 0x37 */                              ERROR_DS_GENERIC_ERROR,
 249     /* 0x38 */                              ERROR_DS_GENERIC_ERROR,
 250     /* 0x39 */                              ERROR_DS_GENERIC_ERROR,
 251     /* 0x3a */                              ERROR_DS_GENERIC_ERROR,
 252     /* 0x3b */                              ERROR_DS_GENERIC_ERROR,
 253     /* LDAP_SORT_CONTROL_MISSING */         8261,
 254     /* LDAP_OFFSET_RANGE_ERROR */           8262,
 255     /* 0x3e */                              ERROR_DS_GENERIC_ERROR,
 256     /* 0x3f */                              ERROR_DS_GENERIC_ERROR,
 257     /* LDAP_NAMING_VIOLATION */             ERROR_INVALID_PARAMETER,
 258     /* LDAP_OBJECT_CLASS_VIOLATION */       ERROR_INVALID_PARAMETER,
 259     /* LDAP_NOT_ALLOWED_ON_NONLEAF */       ERROR_CAN_NOT_COMPLETE,
 260     /* LDAP_NOT_ALLOWED_ON_RDN */           ERROR_ACCESS_DENIED,
 261     /* LDAP_ALREADY_EXISTS */               ERROR_ALREADY_EXISTS,
 262     /* LDAP_NO_OBJECT_CLASS_MODS */         ERROR_ACCESS_DENIED,
 263     /* LDAP_RESULTS_TOO_LARGE */            ERROR_INSUFFICIENT_BUFFER,
 264     /* LDAP_AFFECTS_MULTIPLE_DSAS */        ERROR_CAN_NOT_COMPLETE,
 265     /* 0x48 */                              ERROR_DS_GENERIC_ERROR,
 266     /* 0x49 */                              ERROR_DS_GENERIC_ERROR,
 267     /* 0x4a */                              ERROR_DS_GENERIC_ERROR,
 268     /* 0x4b */                              ERROR_DS_GENERIC_ERROR,
 269     /* LDAP_VIRTUAL_LIST_VIEW_ERROR */      ERROR_DS_GENERIC_ERROR,
 270     /* 0x4d */                              ERROR_DS_GENERIC_ERROR,
 271     /* 0x4e */                              ERROR_DS_GENERIC_ERROR,
 272     /* 0x4f */                              ERROR_DS_GENERIC_ERROR,
 273     /* LDAP_OTHER */                        ERROR_DS_GENERIC_ERROR,
 274     /* LDAP_SERVER_DOWN */                  ERROR_BAD_NET_RESP,
 275     /* LDAP_LOCAL_ERROR */                  ERROR_DS_GENERIC_ERROR,
 276     /* LDAP_ENCODING_ERROR */               ERROR_UNEXP_NET_ERR,
 277     /* LDAP_DECODING_ERROR */               ERROR_UNEXP_NET_ERR,
 278     /* LDAP_TIMEOUT */                      ERROR_SERVICE_REQUEST_TIMEOUT,
 279     /* LDAP_AUTH_UNKNOWN */                 ERROR_WRONG_PASSWORD,
 280     /* LDAP_FILTER_ERROR */                 ERROR_INVALID_PARAMETER,
 281     /* LDAP_USER_CANCELLED */               ERROR_CANCELLED,
 282     /* LDAP_PARAM_ERROR */                  ERROR_INVALID_PARAMETER,
 283     /* LDAP_NO_MEMORY */                    ERROR_NOT_ENOUGH_MEMORY,
 284     /* LDAP_CONNECT_ERROR */                ERROR_CONNECTION_REFUSED,
 285     /* LDAP_NOT_SUPPORTED */                ERROR_CAN_NOT_COMPLETE,
 286     /* LDAP_CONTROL_NOT_FOUND */            ERROR_NOT_FOUND,
 287     /* LDAP_NO_RESULTS_RETURNED */          ERROR_MORE_DATA,
 288     /* LDAP_MORE_RESULTS_TO_RETURN */       ERROR_MORE_DATA,
 289     /* LDAP_CLIENT_LOOP */                  ERROR_DS_GENERIC_ERROR,
 290     /* LDAP_REFERRAL_LIMIT_EXCEEDED */      ERROR_DS_GENERIC_ERROR
 291 };
 292
 293 /***********************************************************************
 294  *      LdapMapErrorToWin32     (WLDAP32.@)
 295  *
 296  * Map an LDAP error code to a Win32 error code.
 297  *
 298  * PARAMS
 299  *  err  [I] An LDAP error code.
 300  *
 301  * RETURNS
 302  *  A Win32 error code.
 303  */
 304 ULONG CDECL LdapMapErrorToWin32( ULONG err )
 305 {
 306     TRACE( "(0x%08x)\n", err );
 307
 308     if (err >= sizeof(WLDAP32_errormap)/sizeof(WLDAP32_errormap[0]))
 309         return ERROR_DS_GENERIC_ERROR;
 310     return WLDAP32_errormap[err];
 311 }