Rename dos_errstr() to win_errstr() for consistency with Samba 4.
[sfrench/samba-autobuild/.git] / 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 struct werror_code_struct {
25         const char *dos_errstr;
26         WERROR werror;
27 };
28
29 struct werror_str_struct {
30         WERROR werror;
31         const char *friendly_errstr;
32 };
33
34 const struct 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_FILE_EXISTS", WERR_FILE_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_GROUP_NOT_FOUND", WERR_GROUP_NOT_FOUND },
66         { "WERR_USER_NOT_FOUND", WERR_USER_NOT_FOUND },
67         { "WERR_NOT_LOCAL_DOMAIN", WERR_NOT_LOCAL_DOMAIN },
68         { "WERR_USER_EXISTS", WERR_USER_EXISTS },
69         { "WERR_REVISION_MISMATCH", WERR_REVISION_MISMATCH },
70         { "WERR_NO_LOGON_SERVERS", WERR_NO_LOGON_SERVERS },
71         { "WERR_NO_SUCH_LOGON_SESSION", WERR_NO_SUCH_LOGON_SESSION },
72         { "WERR_USER_ALREADY_EXISTS", WERR_USER_ALREADY_EXISTS },
73         { "WERR_NO_SUCH_USER", WERR_NO_SUCH_USER },
74         { "WERR_GROUP_EXISTS", WERR_GROUP_EXISTS },
75         { "WERR_MEMBER_IN_GROUP", WERR_MEMBER_IN_GROUP },
76         { "WERR_USER_NOT_IN_GROUP", WERR_USER_NOT_IN_GROUP },
77         { "WERR_PRINTER_DRIVER_IN_USE", WERR_PRINTER_DRIVER_IN_USE },
78         { "WERR_STATUS_MORE_ENTRIES  ", WERR_STATUS_MORE_ENTRIES },
79         { "WERR_DFS_NO_SUCH_VOL", WERR_DFS_NO_SUCH_VOL },
80         { "WERR_DFS_NO_SUCH_SHARE", WERR_DFS_NO_SUCH_SHARE },
81         { "WERR_DFS_NO_SUCH_SERVER", WERR_DFS_NO_SUCH_SERVER },
82         { "WERR_DFS_INTERNAL_ERROR", WERR_DFS_INTERNAL_ERROR },
83         { "WERR_DFS_CANT_CREATE_JUNCT", WERR_DFS_CANT_CREATE_JUNCT },
84         { "WERR_INVALID_COMPUTERNAME", WERR_INVALID_COMPUTERNAME },
85         { "WERR_INVALID_DOMAINNAME", WERR_INVALID_DOMAINNAME },
86         { "WERR_MACHINE_LOCKED", WERR_MACHINE_LOCKED },
87         { "WERR_DC_NOT_FOUND", WERR_DC_NOT_FOUND },
88         { "WERR_SETUP_NOT_JOINED", WERR_SETUP_NOT_JOINED },
89         { "WERR_SETUP_ALREADY_JOINED", WERR_SETUP_ALREADY_JOINED },
90         { "WERR_SETUP_DOMAIN_CONTROLLER", WERR_SETUP_DOMAIN_CONTROLLER },
91         { "WERR_DEFAULT_JOIN_REQUIRED", WERR_DEFAULT_JOIN_REQUIRED },
92         { "WERR_DEVICE_NOT_AVAILABLE", WERR_DEVICE_NOT_AVAILABLE },
93         { "WERR_LOGON_FAILURE", WERR_LOGON_FAILURE },
94         { "WERR_WRONG_PASSWORD", WERR_WRONG_PASSWORD },
95         { "WERR_PASSWORD_RESTRICTION", WERR_PASSWORD_RESTRICTION },
96         { "WERR_NO_SUCH_DOMAIN", WERR_NO_SUCH_DOMAIN },
97         { "WERR_NONE_MAPPED", WERR_NONE_MAPPED },
98         { "WERR_INVALID_SECURITY_DESCRIPTOR", WERR_INVALID_SECURITY_DESCRIPTOR },
99         { "WERR_INVALID_DOMAIN_STATE", WERR_INVALID_DOMAIN_STATE },
100         { "WERR_INVALID_DOMAIN_ROLE", WERR_INVALID_DOMAIN_ROLE },
101         { "WERR_SPECIAL_ACCOUNT", WERR_SPECIAL_ACCOUNT },
102         { "WERR_ALIAS_EXISTS", WERR_ALIAS_EXISTS },
103         { "WERR_NO_SUCH_ALIAS", WERR_NO_SUCH_ALIAS },
104         { "WERR_MEMBER_IN_ALIAS", WERR_MEMBER_IN_ALIAS },
105         { "WERR_TIME_SKEW", WERR_TIME_SKEW },
106         { "WERR_INVALID_OWNER", WERR_INVALID_OWNER },
107         { "WERR_SERVER_UNAVAILABLE", WERR_SERVER_UNAVAILABLE },
108         { "WERR_IO_PENDING", WERR_IO_PENDING },
109         { "WERR_INVALID_SERVICE_CONTROL", WERR_INVALID_SERVICE_CONTROL },
110         { "WERR_SERVICE_ALREADY_RUNNING", WERR_SERVICE_ALREADY_RUNNING },
111         { "WERR_NET_NAME_NOT_FOUND", WERR_NET_NAME_NOT_FOUND },
112         { "WERR_REG_CORRUPT", WERR_REG_CORRUPT },
113         { "WERR_REG_IO_FAILURE", WERR_REG_IO_FAILURE },
114         { "WERR_REG_FILE_INVALID", WERR_REG_FILE_INVALID },
115         { "WERR_NO_SUCH_SERVICE", WERR_NO_SUCH_SERVICE },
116         { "WERR_SERVICE_DISABLED", WERR_SERVICE_DISABLED },
117         { "WERR_SERVICE_NEVER_STARTED", WERR_SERVICE_NEVER_STARTED },
118         { "WERR_NOT_FOUND", WERR_NOT_FOUND },
119         { "WERR_CAN_NOT_COMPLETE", WERR_CAN_NOT_COMPLETE},
120         { "WERR_INVALID_FLAGS", WERR_INVALID_FLAGS},
121         { "WERR_PASSWORD_MUST_CHANGE", WERR_PASSWORD_MUST_CHANGE },
122         { "WERR_DOMAIN_CONTROLLER_NOT_FOUND", WERR_DOMAIN_CONTROLLER_NOT_FOUND },
123         { "WERR_ACCOUNT_LOCKED_OUT", WERR_ACCOUNT_LOCKED_OUT },
124         { "WERR_DS_DRA_BAD_DN", WERR_DS_DRA_BAD_DN },
125         { "WERR_DS_DRA_BAD_NC", WERR_DS_DRA_BAD_NC },
126         { NULL, W_ERROR(0) }
127 };
128
129 const struct werror_str_struct dos_err_strs[] = {
130         { WERR_OK, "Success" },
131         { WERR_ACCESS_DENIED, "Access is denied" },
132         { WERR_INVALID_PARAM, "Invalid parameter" },
133         { WERR_NOT_SUPPORTED, "Not supported" },
134         { WERR_BAD_PASSWORD, "A bad password was supplied" },
135         { WERR_NOMEM, "Out of memory" },
136         { WERR_NO_LOGON_SERVERS, "No logon servers found" },
137         { WERR_NO_SUCH_LOGON_SESSION, "No such logon session" },
138         { WERR_DOMAIN_CONTROLLER_NOT_FOUND, "A domain controller could not be found" },
139         { WERR_DC_NOT_FOUND, "A domain controller could not be found" },
140         { WERR_SETUP_NOT_JOINED, "Join failed" },
141         { WERR_SETUP_ALREADY_JOINED, "Machine is already joined" },
142         { WERR_SETUP_DOMAIN_CONTROLLER, "Machine is a Domain Controller" },
143         { WERR_LOGON_FAILURE, "Invalid logon credentials" },
144         { WERR_USER_EXISTS, "User account already exists" },
145         { WERR_PASSWORD_MUST_CHANGE, "The password must be changed" },
146         { WERR_ACCOUNT_LOCKED_OUT, "Account locked out" },
147         { WERR_TIME_SKEW, "Time difference between client and server" },
148         { WERR_USER_ALREADY_EXISTS, "User already exists" },
149         { WERR_PASSWORD_RESTRICTION, "Password does not meet restrictions" },
150         { WERR_NONE_MAPPED, "Could not map names to SIDs" },
151         { WERR_NO_SUCH_USER, "No such User" },
152         { WERR_GROUP_EXISTS, "Group already exists" },
153         { WERR_DS_DRA_BAD_DN, "An invalid distinguished name was specified for this replication" },
154         { WERR_DS_DRA_BAD_NC, "An invalid naming context was specified for this replication operation" },
155         { WERR_WRONG_PASSWORD, "The current password is incorrect" }
156 };
157
158 /*****************************************************************************
159  Returns a DOS error message.  not amazingly helpful, but better than a number.
160  *****************************************************************************/
161
162 const char *win_errstr(WERROR werror)
163 {
164         char *result;
165         int idx = 0;
166
167         while (dos_errs[idx].dos_errstr != NULL) {
168                 if (W_ERROR_V(dos_errs[idx].werror) ==
169                     W_ERROR_V(werror))
170                         return dos_errs[idx].dos_errstr;
171                 idx++;
172         }
173
174         result = talloc_asprintf(talloc_tos(), "DOS code 0x%08x",
175                                  W_ERROR_V(werror));
176         SMB_ASSERT(result != NULL);
177         return result;
178 }
179
180 /*****************************************************************************
181  Get friendly error string for WERRORs
182  *****************************************************************************/
183
184 const char *get_friendly_werror_msg(WERROR werror)
185 {
186         int i = 0;
187
188         for (i = 0; i < ARRAY_SIZE(dos_err_strs); i++) {
189                 if (W_ERROR_V(dos_err_strs[i].werror) ==
190                     W_ERROR_V(werror)) {
191                         return dos_err_strs[i].friendly_errstr;
192                 }
193         }
194
195         return win_errstr(werror);
196 }