2 Unix SMB/CIFS implementation.
3 client error handling routines
4 Copyright (C) Andrew Tridgell 1994-1998
5 Copyright (C) Jelmer Vernooij 2003
6 Copyright (C) Jeremy Allison 2006
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
23 #include "libsmb/libsmb.h"
25 /*****************************************************
26 RAP error codes - a small start but will be extended.
28 XXX: Perhaps these should move into a common function because they're
29 duplicated in clirap2.c
31 *******************************************************/
37 {5, "RAP5: User has insufficient privilege" },
38 {50, "RAP50: Not supported by server" },
39 {65, "RAP65: Access denied" },
40 {86, "RAP86: The specified password is invalid" },
41 {2220, "RAP2220: Group does not exist" },
42 {2221, "RAP2221: User does not exist" },
43 {2226, "RAP2226: Operation only permitted on a Primary Domain Controller" },
44 {2237, "RAP2237: User is not in group" },
45 {2242, "RAP2242: The password of this user has expired." },
46 {2243, "RAP2243: The password of this user cannot change." },
47 {2244, "RAP2244: This password cannot be used now (password history conflict)." },
48 {2245, "RAP2245: The password is shorter than required." },
49 {2246, "RAP2246: The password of this user is too recent to change."},
51 /* these really shouldn't be here ... */
52 {0x80, "Not listening on called name"},
53 {0x81, "Not listening for calling name"},
54 {0x82, "Called name not present"},
55 {0x83, "Called name present, but insufficient resources"},
60 /****************************************************************************
61 Return a description of an SMB error.
62 ****************************************************************************/
64 static const char *cli_smb_errstr(struct cli_state *cli)
66 return smb_dos_errstr(cli->inbuf);
69 /****************************************************************************
70 Convert a socket error into an NTSTATUS.
71 ****************************************************************************/
73 static NTSTATUS cli_smb_rw_error_to_ntstatus(struct cli_state *cli)
75 switch(cli->smb_rw_error) {
76 case SMB_READ_TIMEOUT:
77 return NT_STATUS_IO_TIMEOUT;
79 return NT_STATUS_END_OF_FILE;
80 /* What we shoud really do for read/write errors is convert from errno. */
83 return NT_STATUS_INVALID_NETWORK_RESPONSE;
85 return NT_STATUS_UNEXPECTED_NETWORK_ERROR;
86 case SMB_READ_BAD_SIG:
87 return NT_STATUS_INVALID_PARAMETER;
89 return NT_STATUS_NO_MEMORY;
93 return NT_STATUS_UNSUCCESSFUL;
96 /***************************************************************************
97 Return an error message - either an NT error, SMB error or a RAP error.
98 Note some of the NT errors are actually warnings or "informational" errors
99 in which case they can be safely ignored.
100 ****************************************************************************/
102 const char *cli_errstr(struct cli_state *cli)
104 fstring cli_error_message;
105 uint32 flgs2 = SVAL(cli->inbuf,smb_flg2), errnum;
110 if (!cli->initialised) {
111 fstrcpy(cli_error_message, "[Programmer's error] cli_errstr called on unitialized cli_stat struct!\n");
115 /* Was it server socket error ? */
116 if (cli->fd == -1 && cli->smb_rw_error) {
117 switch(cli->smb_rw_error) {
118 case SMB_READ_TIMEOUT:
119 slprintf(cli_error_message, sizeof(cli_error_message) - 1,
120 "Call timed out: server did not respond after %d milliseconds",
124 slprintf(cli_error_message, sizeof(cli_error_message) - 1,
125 "Call returned zero bytes (EOF)" );
128 slprintf(cli_error_message, sizeof(cli_error_message) - 1,
129 "Read error: %s", strerror(errno) );
131 case SMB_WRITE_ERROR:
132 slprintf(cli_error_message, sizeof(cli_error_message) - 1,
133 "Write error: %s", strerror(errno) );
135 case SMB_READ_BAD_SIG:
136 slprintf(cli_error_message, sizeof(cli_error_message) - 1,
137 "Server packet had invalid SMB signature!");
140 slprintf(cli_error_message, sizeof(cli_error_message) - 1,
144 slprintf(cli_error_message, sizeof(cli_error_message) - 1,
145 "Unknown error code %d\n", cli->smb_rw_error );
151 /* Case #1: RAP error */
152 if (cli->rap_error) {
153 for (i = 0; rap_errmap[i].message != NULL; i++) {
154 if (rap_errmap[i].err == cli->rap_error) {
155 return rap_errmap[i].message;
159 slprintf(cli_error_message, sizeof(cli_error_message) - 1, "RAP code %d",
165 /* Case #2: 32-bit NT errors */
166 if (flgs2 & FLAGS2_32_BIT_ERROR_CODES) {
167 NTSTATUS status = NT_STATUS(IVAL(cli->inbuf,smb_rcls));
169 return nt_errstr(status);
172 cli_dos_error(cli, &errclass, &errnum);
174 /* Case #3: SMB error */
176 return cli_smb_errstr(cli);
179 result = talloc_strdup(talloc_tos(), cli_error_message);
185 /****************************************************************************
186 Return the 32-bit NT status code from the last packet.
187 ****************************************************************************/
189 NTSTATUS cli_nt_error(struct cli_state *cli)
191 int flgs2 = SVAL(cli->inbuf,smb_flg2);
193 /* Deal with socket errors first. */
194 if (cli->fd == -1 && cli->smb_rw_error) {
195 return cli_smb_rw_error_to_ntstatus(cli);
198 if (!(flgs2 & FLAGS2_32_BIT_ERROR_CODES)) {
199 int e_class = CVAL(cli->inbuf,smb_rcls);
200 int code = SVAL(cli->inbuf,smb_err);
201 return dos_to_ntstatus(e_class, code);
204 return NT_STATUS(IVAL(cli->inbuf,smb_rcls));
208 /****************************************************************************
209 Return the DOS error from the last packet - an error class and an error
211 ****************************************************************************/
213 void cli_dos_error(struct cli_state *cli, uint8 *eclass, uint32 *ecode)
217 if(!cli->initialised) {
221 /* Deal with socket errors first. */
222 if (cli->fd == -1 && cli->smb_rw_error) {
223 NTSTATUS status = cli_smb_rw_error_to_ntstatus(cli);
224 ntstatus_to_dos( status, eclass, ecode);
228 flgs2 = SVAL(cli->inbuf,smb_flg2);
230 if (flgs2 & FLAGS2_32_BIT_ERROR_CODES) {
231 NTSTATUS ntstatus = NT_STATUS(IVAL(cli->inbuf, smb_rcls));
232 ntstatus_to_dos(ntstatus, eclass, ecode);
236 *eclass = CVAL(cli->inbuf,smb_rcls);
237 *ecode = SVAL(cli->inbuf,smb_err);
241 /* Return a UNIX errno appropriate for the error received in the last
244 int cli_errno(struct cli_state *cli)
248 if (cli_is_nt_error(cli)) {
249 status = cli_nt_error(cli);
250 return map_errno_from_nt_status(status);
253 if (cli_is_dos_error(cli)) {
257 cli_dos_error(cli, &eclass, &ecode);
258 status = dos_to_ntstatus(eclass, ecode);
259 return map_errno_from_nt_status(status);
263 * Yuck! A special case for this Vista error. Since its high-order
264 * byte isn't 0xc0, it doesn't match cli_is_nt_error() above.
266 status = cli_nt_error(cli);
267 if (NT_STATUS_V(status) == NT_STATUS_V(NT_STATUS_INACCESSIBLE_SYSTEM_SHORTCUT)) {
271 /* for other cases */
275 /* Return true if the last packet was in error */
277 bool cli_is_error(struct cli_state *cli)
279 uint32 flgs2 = SVAL(cli->inbuf,smb_flg2), rcls = 0;
281 /* A socket error is always an error. */
282 if (cli->fd == -1 && cli->smb_rw_error != 0) {
286 if (flgs2 & FLAGS2_32_BIT_ERROR_CODES) {
287 /* Return error is error bits are set */
288 rcls = IVAL(cli->inbuf, smb_rcls);
289 return (rcls & 0xF0000000) == 0xC0000000;
292 /* Return error if error class in non-zero */
294 rcls = CVAL(cli->inbuf, smb_rcls);
298 /* Return true if the last error was an NT error */
300 bool cli_is_nt_error(struct cli_state *cli)
302 uint32 flgs2 = SVAL(cli->inbuf,smb_flg2);
304 /* A socket error is always an NT error. */
305 if (cli->fd == -1 && cli->smb_rw_error != 0) {
309 return cli_is_error(cli) && (flgs2 & FLAGS2_32_BIT_ERROR_CODES);
312 /* Return true if the last error was a DOS error */
314 bool cli_is_dos_error(struct cli_state *cli)
316 uint32 flgs2 = SVAL(cli->inbuf,smb_flg2);
318 /* A socket error is always a DOS error. */
319 if (cli->fd == -1 && cli->smb_rw_error != 0) {
323 return cli_is_error(cli) && !(flgs2 & FLAGS2_32_BIT_ERROR_CODES);
326 bool cli_state_is_connected(struct cli_state *cli)
332 if (!cli->initialised) {