source3/libsmb/doserr.c

   1 /*
   2  *  Unix SMB/CIFS implementation.
   3  *  DOS error routines
   4  *  Copyright (C) Tim Potter 2002.
   5  *
   6  *  This program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation; either version 3 of the License, or
   9  *  (at your option) any later version.
  10  *
  11  *  This program 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
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program; if not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 /* DOS error codes.  please read doserr.h */
  21
  22 #include "includes.h"
  23
  24 typedef const struct {
  25         const char *dos_errstr;
  26         WERROR werror;
  27 } werror_code_struct;
  28
  29 typedef const struct {
  30         WERROR werror;
  31         const char *friendly_errstr;
  32 } werror_str_struct;
  33
  34 werror_code_struct dos_errs[] =
  35 {
  36         { "WERR_OK", WERR_OK },
  37         { "WERR_GENERAL_FAILURE", WERR_GENERAL_FAILURE },
  38         { "WERR_BADFILE", WERR_BADFILE },
  39         { "WERR_ACCESS_DENIED", WERR_ACCESS_DENIED },
  40         { "WERR_BADFID", WERR_BADFID },
  41         { "WERR_BADFUNC", WERR_BADFUNC },
  42         { "WERR_INSUFFICIENT_BUFFER", WERR_INSUFFICIENT_BUFFER },
  43         { "WERR_SEM_TIMEOUT", WERR_SEM_TIMEOUT },
  44         { "WERR_NO_SUCH_SHARE", WERR_NO_SUCH_SHARE },
  45         { "WERR_ALREADY_EXISTS", WERR_ALREADY_EXISTS },
  46         { "WERR_INVALID_PARAM", WERR_INVALID_PARAM },
  47         { "WERR_NOT_SUPPORTED", WERR_NOT_SUPPORTED },
  48         { "WERR_BAD_PASSWORD", WERR_BAD_PASSWORD },
  49         { "WERR_NOMEM", WERR_NOMEM },
  50         { "WERR_INVALID_NAME", WERR_INVALID_NAME },
  51         { "WERR_UNKNOWN_LEVEL", WERR_UNKNOWN_LEVEL },
  52         { "WERR_OBJECT_PATH_INVALID", WERR_OBJECT_PATH_INVALID },
  53         { "WERR_NO_MORE_ITEMS", WERR_NO_MORE_ITEMS },
  54         { "WERR_MORE_DATA", WERR_MORE_DATA },
  55         { "WERR_UNKNOWN_PRINTER_DRIVER", WERR_UNKNOWN_PRINTER_DRIVER },
  56         { "WERR_INVALID_PRINTER_NAME", WERR_INVALID_PRINTER_NAME },
  57         { "WERR_PRINTER_ALREADY_EXISTS", WERR_PRINTER_ALREADY_EXISTS },
  58         { "WERR_INVALID_DATATYPE", WERR_INVALID_DATATYPE },
  59         { "WERR_INVALID_ENVIRONMENT", WERR_INVALID_ENVIRONMENT },
  60         { "WERR_INVALID_FORM_NAME", WERR_INVALID_FORM_NAME },
  61         { "WERR_INVALID_FORM_SIZE", WERR_INVALID_FORM_SIZE },
  62         { "WERR_BUF_TOO_SMALL", WERR_BUF_TOO_SMALL },
  63         { "WERR_JOB_NOT_FOUND", WERR_JOB_NOT_FOUND },
  64         { "WERR_DEST_NOT_FOUND", WERR_DEST_NOT_FOUND },
  65         { "WERR_NOT_LOCAL_DOMAIN", WERR_NOT_LOCAL_DOMAIN },
  66         { "WERR_USER_EXISTS", WERR_USER_EXISTS },
  67         { "WERR_NO_LOGON_SERVERS", WERR_NO_LOGON_SERVERS },
  68         { "WERR_NO_SUCH_LOGON_SESSION", WERR_NO_SUCH_LOGON_SESSION },
  69         { "WERR_PRINTER_DRIVER_IN_USE", WERR_PRINTER_DRIVER_IN_USE },
  70         { "WERR_STATUS_MORE_ENTRIES  ", WERR_STATUS_MORE_ENTRIES },
  71         { "WERR_DFS_NO_SUCH_VOL", WERR_DFS_NO_SUCH_VOL },
  72         { "WERR_DFS_NO_SUCH_SHARE", WERR_DFS_NO_SUCH_SHARE },
  73         { "WERR_DFS_NO_SUCH_SERVER", WERR_DFS_NO_SUCH_SERVER },
  74         { "WERR_DFS_INTERNAL_ERROR", WERR_DFS_INTERNAL_ERROR },
  75         { "WERR_DFS_CANT_CREATE_JUNCT", WERR_DFS_CANT_CREATE_JUNCT },
  76         { "WERR_MACHINE_LOCKED", WERR_MACHINE_LOCKED },
  77         { "WERR_DC_NOT_FOUND", WERR_DC_NOT_FOUND },
  78         { "WERR_SETUP_NOT_JOINED", WERR_SETUP_NOT_JOINED },
  79         { "WERR_SETUP_ALREADY_JOINED", WERR_SETUP_ALREADY_JOINED },
  80         { "WERR_SETUP_DOMAIN_CONTROLLER", WERR_SETUP_DOMAIN_CONTROLLER },
  81         { "WERR_DEFAULT_JOIN_REQUIRED", WERR_DEFAULT_JOIN_REQUIRED },
  82         { "WERR_DEVICE_NOT_AVAILABLE", WERR_DEVICE_NOT_AVAILABLE },
  83         { "WERR_LOGON_FAILURE", WERR_LOGON_FAILURE },
  84         { "WERR_NO_SUCH_DOMAIN", WERR_NO_SUCH_DOMAIN },
  85         { "WERR_INVALID_SECURITY_DESCRIPTOR", WERR_INVALID_SECURITY_DESCRIPTOR },
  86         { "WERR_INVALID_OWNER", WERR_INVALID_OWNER },
  87         { "WERR_SERVER_UNAVAILABLE", WERR_SERVER_UNAVAILABLE },
  88         { "WERR_IO_PENDING", WERR_IO_PENDING },
  89         { "WERR_INVALID_SERVICE_CONTROL", WERR_INVALID_SERVICE_CONTROL },
  90         { "WERR_SERVICE_ALREADY_RUNNING", WERR_SERVICE_ALREADY_RUNNING },
  91         { "WERR_NET_NAME_NOT_FOUND", WERR_NET_NAME_NOT_FOUND },
  92         { "WERR_REG_CORRUPT", WERR_REG_CORRUPT },
  93         { "WERR_REG_IO_FAILURE", WERR_REG_IO_FAILURE },
  94         { "WERR_REG_FILE_INVALID", WERR_REG_FILE_INVALID },
  95         { "WERR_NO_SUCH_SERVICE", WERR_NO_SUCH_SERVICE },
  96         { "WERR_SERVICE_DISABLED", WERR_SERVICE_DISABLED },
  97         { "WERR_CAN_NOT_COMPLETE", WERR_CAN_NOT_COMPLETE},
  98         { "WERR_INVALID_FLAGS", WERR_INVALID_FLAGS},
  99         { "WERR_PASSWORD_MUST_CHANGE", WERR_PASSWORD_MUST_CHANGE },
 100         { "WERR_DOMAIN_CONTROLLER_NOT_FOUND", WERR_DOMAIN_CONTROLLER_NOT_FOUND },
 101         { "WERR_ACCOUNT_LOCKED_OUT", WERR_ACCOUNT_LOCKED_OUT },
 102         { NULL, W_ERROR(0) }
 103 };
 104
 105 werror_str_struct dos_err_strs[] = {
 106         { WERR_OK, "Success" },
 107         { WERR_ACCESS_DENIED, "Access is denied" },
 108         { WERR_INVALID_PARAM, "Invalid parameter" },
 109         { WERR_NOT_SUPPORTED, "Not supported" },
 110         { WERR_BAD_PASSWORD, "A bad password was supplied" },
 111         { WERR_NOMEM, "Out of memory" },
 112         { WERR_NO_LOGON_SERVERS, "No logon servers found" },
 113         { WERR_NO_SUCH_LOGON_SESSION, "No such logon session" },
 114         { WERR_DOMAIN_CONTROLLER_NOT_FOUND, "A domain controller could not be found" },
 115         { WERR_DC_NOT_FOUND, "A domain controller could not be found" },
 116         { WERR_SETUP_NOT_JOINED, "Join failed" },
 117         { WERR_SETUP_ALREADY_JOINED, "Machine is already joined" },
 118         { WERR_SETUP_DOMAIN_CONTROLLER, "Machine is a Domain Controller" },
 119         { WERR_LOGON_FAILURE, "Invalid logon credentials" },
 120         { WERR_USER_EXISTS, "User account already exists" },
 121         { WERR_PASSWORD_MUST_CHANGE, "The password must be changed" },
 122         { WERR_ACCOUNT_LOCKED_OUT, "Account locked out" },
 123 };
 124
 125 /*****************************************************************************
 126  Returns a DOS error message.  not amazingly helpful, but better than a number.
 127  *****************************************************************************/
 128
 129 const char *dos_errstr(WERROR werror)
 130 {
 131         char *result;
 132         int idx = 0;
 133
 134         while (dos_errs[idx].dos_errstr != NULL) {
 135                 if (W_ERROR_V(dos_errs[idx].werror) ==
 136                     W_ERROR_V(werror))
 137                         return dos_errs[idx].dos_errstr;
 138                 idx++;
 139         }
 140
 141         result = talloc_asprintf(talloc_tos(), "DOS code 0x%08x",
 142                                  W_ERROR_V(werror));
 143         SMB_ASSERT(result != NULL);
 144         return result;
 145 }
 146
 147 /*****************************************************************************
 148  Get friendly error string for WERRORs
 149  *****************************************************************************/
 150
 151 const char *get_friendly_werror_msg(WERROR werror)
 152 {
 153         int i = 0;
 154
 155         for (i = 0; i < ARRAY_SIZE(dos_err_strs); i++) {
 156                 if (W_ERROR_V(dos_err_strs[i].werror) ==
 157                     W_ERROR_V(werror)) {
 158                         return dos_err_strs[i].friendly_errstr;
 159                 }
 160         }
 161
 162         return dos_errstr(werror);
 163 }
 164
 165 /* compat function for samba4 */
 166 const char *win_errstr(WERROR werror)
 167 {
 168         return dos_errstr(werror);
 169 }