source: branches/samba-3.0/source/libsmb/clierror.c

Last change on this file was 140, checked in by Paul Smedley, 17 years ago

Update branch to 3.0.31 release
File size: 14.9 KB
Line 
1/*
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
7
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 2 of the License, or
11 (at your option) any later version.
12
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.
17
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21*/
22
23#include "includes.h"
24
25/*****************************************************
26 RAP error codes - a small start but will be extended.
27
28 XXX: Perhaps these should move into a common function because they're
29 duplicated in clirap2.c
30
31*******************************************************/
32
33static const struct {
34 int err;
35 const char *message;
36} rap_errmap[] = {
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."},
50
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"},
56
57 {0, NULL}
58};
59
60/****************************************************************************
61 Return a description of an SMB error.
62****************************************************************************/
63
64static const char *cli_smb_errstr(struct cli_state *cli)
65{
66 return smb_dos_errstr(cli->inbuf);
67}
68
69/****************************************************************************
70 Convert a socket error into an NTSTATUS.
71****************************************************************************/
72
73static NTSTATUS cli_smb_rw_error_to_ntstatus(struct cli_state *cli)
74{
75 switch(cli->smb_rw_error) {
76 case READ_TIMEOUT:
77 return NT_STATUS_IO_TIMEOUT;
78 case READ_EOF:
79 return NT_STATUS_END_OF_FILE;
80 /* What we shoud really do for read/write errors is convert from errno. */
81 /* FIXME. JRA. */
82 case READ_ERROR:
83 return NT_STATUS_INVALID_NETWORK_RESPONSE;
84 case WRITE_ERROR:
85 return NT_STATUS_UNEXPECTED_NETWORK_ERROR;
86 case READ_BAD_SIG:
87 return NT_STATUS_INVALID_PARAMETER;
88 default:
89 break;
90 }
91 return NT_STATUS_UNSUCCESSFUL;
92}
93
94/***************************************************************************
95 Return an error message - either an NT error, SMB error or a RAP error.
96 Note some of the NT errors are actually warnings or "informational" errors
97 in which case they can be safely ignored.
98****************************************************************************/
99
100const char *cli_errstr(struct cli_state *cli)
101{
102 static fstring cli_error_message;
103 uint32 flgs2 = SVAL(cli->inbuf,smb_flg2), errnum;
104 uint8 errclass;
105 int i;
106
107 if (!cli->initialised) {
108 fstrcpy(cli_error_message, "[Programmer's error] cli_errstr called on unitialized cli_stat struct!\n");
109 return cli_error_message;
110 }
111
112 /* Was it server socket error ? */
113 if (cli->fd == -1 && cli->smb_rw_error) {
114 switch(cli->smb_rw_error) {
115 case READ_TIMEOUT:
116 slprintf(cli_error_message, sizeof(cli_error_message) - 1,
117 "Call timed out: server did not respond after %d milliseconds",
118 cli->timeout);
119 break;
120 case READ_EOF:
121 slprintf(cli_error_message, sizeof(cli_error_message) - 1,
122 "Call returned zero bytes (EOF)" );
123 break;
124 case READ_ERROR:
125 slprintf(cli_error_message, sizeof(cli_error_message) - 1,
126 "Read error: %s", strerror(errno) );
127 break;
128 case WRITE_ERROR:
129 slprintf(cli_error_message, sizeof(cli_error_message) - 1,
130 "Write error: %s", strerror(errno) );
131 break;
132 case READ_BAD_SIG:
133 slprintf(cli_error_message, sizeof(cli_error_message) - 1,
134 "Server packet had invalid SMB signature!");
135 break;
136 default:
137 slprintf(cli_error_message, sizeof(cli_error_message) - 1,
138 "Unknown error code %d\n", cli->smb_rw_error );
139 break;
140 }
141 return cli_error_message;
142 }
143
144 /* Case #1: RAP error */
145 if (cli->rap_error) {
146 for (i = 0; rap_errmap[i].message != NULL; i++) {
147 if (rap_errmap[i].err == cli->rap_error) {
148 return rap_errmap[i].message;
149 }
150 }
151
152 slprintf(cli_error_message, sizeof(cli_error_message) - 1, "RAP code %d",
153 cli->rap_error);
154
155 return cli_error_message;
156 }
157
158 /* Case #2: 32-bit NT errors */
159 if (flgs2 & FLAGS2_32_BIT_ERROR_CODES) {
160 NTSTATUS status = NT_STATUS(IVAL(cli->inbuf,smb_rcls));
161
162 return nt_errstr(status);
163 }
164
165 cli_dos_error(cli, &errclass, &errnum);
166
167 /* Case #3: SMB error */
168
169 return cli_smb_errstr(cli);
170}
171
172
173/****************************************************************************
174 Return the 32-bit NT status code from the last packet.
175****************************************************************************/
176
177NTSTATUS cli_nt_error(struct cli_state *cli)
178{
179 int flgs2 = SVAL(cli->inbuf,smb_flg2);
180
181 /* Deal with socket errors first. */
182 if (cli->fd == -1 && cli->smb_rw_error) {
183 return cli_smb_rw_error_to_ntstatus(cli);
184 }
185
186 if (!(flgs2 & FLAGS2_32_BIT_ERROR_CODES)) {
187 int e_class = CVAL(cli->inbuf,smb_rcls);
188 int code = SVAL(cli->inbuf,smb_err);
189 return dos_to_ntstatus(e_class, code);
190 }
191
192 return NT_STATUS(IVAL(cli->inbuf,smb_rcls));
193}
194
195
196/****************************************************************************
197 Return the DOS error from the last packet - an error class and an error
198 code.
199****************************************************************************/
200
201void cli_dos_error(struct cli_state *cli, uint8 *eclass, uint32 *ecode)
202{
203 int flgs2;
204
205 if(!cli->initialised) {
206 return;
207 }
208
209 /* Deal with socket errors first. */
210 if (cli->fd == -1 && cli->smb_rw_error) {
211 NTSTATUS status = cli_smb_rw_error_to_ntstatus(cli);
212 ntstatus_to_dos( status, eclass, ecode);
213 return;
214 }
215
216 flgs2 = SVAL(cli->inbuf,smb_flg2);
217
218 if (flgs2 & FLAGS2_32_BIT_ERROR_CODES) {
219 NTSTATUS ntstatus = NT_STATUS(IVAL(cli->inbuf, smb_rcls));
220 ntstatus_to_dos(ntstatus, eclass, ecode);
221 return;
222 }
223
224 *eclass = CVAL(cli->inbuf,smb_rcls);
225 *ecode = SVAL(cli->inbuf,smb_err);
226}
227
228/* Return a UNIX errno from a NT status code */
229static const struct {
230 NTSTATUS status;
231 int error;
232} nt_errno_map[] = {
233 {NT_STATUS_ACCESS_VIOLATION, EACCES},
234 {NT_STATUS_INVALID_HANDLE, EBADF},
235 {NT_STATUS_ACCESS_DENIED, EACCES},
236 {NT_STATUS_OBJECT_NAME_NOT_FOUND, ENOENT},
237 {NT_STATUS_OBJECT_PATH_NOT_FOUND, ENOENT},
238 {NT_STATUS_SHARING_VIOLATION, EBUSY},
239 {NT_STATUS_OBJECT_PATH_INVALID, ENOTDIR},
240 {NT_STATUS_OBJECT_NAME_COLLISION, EEXIST},
241 {NT_STATUS_PATH_NOT_COVERED, ENOENT},
242 {NT_STATUS_UNSUCCESSFUL, EINVAL},
243 {NT_STATUS_NOT_IMPLEMENTED, ENOSYS},
244 {NT_STATUS_IN_PAGE_ERROR, EFAULT},
245 {NT_STATUS_BAD_NETWORK_NAME, ENOENT},
246#ifdef EDQUOT
247 {NT_STATUS_PAGEFILE_QUOTA, EDQUOT},
248 {NT_STATUS_QUOTA_EXCEEDED, EDQUOT},
249 {NT_STATUS_REGISTRY_QUOTA_LIMIT, EDQUOT},
250 {NT_STATUS_LICENSE_QUOTA_EXCEEDED, EDQUOT},
251#endif
252#ifdef ETIME
253 {NT_STATUS_TIMER_NOT_CANCELED, ETIME},
254#endif
255 {NT_STATUS_INVALID_PARAMETER, EINVAL},
256 {NT_STATUS_NO_SUCH_DEVICE, ENODEV},
257 {NT_STATUS_NO_SUCH_FILE, ENOENT},
258#ifdef ENODATA
259 {NT_STATUS_END_OF_FILE, ENODATA},
260#endif
261#ifdef ENOMEDIUM
262 {NT_STATUS_NO_MEDIA_IN_DEVICE, ENOMEDIUM},
263 {NT_STATUS_NO_MEDIA, ENOMEDIUM},
264#endif
265 {NT_STATUS_NONEXISTENT_SECTOR, ESPIPE},
266 {NT_STATUS_NO_MEMORY, ENOMEM},
267 {NT_STATUS_CONFLICTING_ADDRESSES, EADDRINUSE},
268 {NT_STATUS_NOT_MAPPED_VIEW, EINVAL},
269 {NT_STATUS_UNABLE_TO_FREE_VM, EADDRINUSE},
270 {NT_STATUS_ACCESS_DENIED, EACCES},
271 {NT_STATUS_BUFFER_TOO_SMALL, ENOBUFS},
272 {NT_STATUS_WRONG_PASSWORD, EACCES},
273 {NT_STATUS_LOGON_FAILURE, EACCES},
274 {NT_STATUS_INVALID_WORKSTATION, EACCES},
275 {NT_STATUS_INVALID_LOGON_HOURS, EACCES},
276 {NT_STATUS_PASSWORD_EXPIRED, EACCES},
277 {NT_STATUS_ACCOUNT_DISABLED, EACCES},
278 {NT_STATUS_DISK_FULL, ENOSPC},
279 {NT_STATUS_INVALID_PIPE_STATE, EPIPE},
280 {NT_STATUS_PIPE_BUSY, EPIPE},
281 {NT_STATUS_PIPE_DISCONNECTED, EPIPE},
282 {NT_STATUS_PIPE_NOT_AVAILABLE, ENOSYS},
283 {NT_STATUS_FILE_IS_A_DIRECTORY, EISDIR},
284 {NT_STATUS_NOT_SUPPORTED, ENOSYS},
285 {NT_STATUS_NOT_A_DIRECTORY, ENOTDIR},
286 {NT_STATUS_DIRECTORY_NOT_EMPTY, ENOTEMPTY},
287 {NT_STATUS_NETWORK_UNREACHABLE, ENETUNREACH},
288 {NT_STATUS_HOST_UNREACHABLE, EHOSTUNREACH},
289 {NT_STATUS_CONNECTION_ABORTED, ECONNABORTED},
290 {NT_STATUS_CONNECTION_REFUSED, ECONNREFUSED},
291 {NT_STATUS_TOO_MANY_LINKS, EMLINK},
292 {NT_STATUS_NETWORK_BUSY, EBUSY},
293 {NT_STATUS_DEVICE_DOES_NOT_EXIST, ENODEV},
294#ifdef ELIBACC
295 {NT_STATUS_DLL_NOT_FOUND, ELIBACC},
296#endif
297 {NT_STATUS_PIPE_BROKEN, EPIPE},
298 {NT_STATUS_REMOTE_NOT_LISTENING, ECONNREFUSED},
299 {NT_STATUS_NETWORK_ACCESS_DENIED, EACCES},
300 {NT_STATUS_TOO_MANY_OPENED_FILES, EMFILE},
301#ifdef EPROTO
302 {NT_STATUS_DEVICE_PROTOCOL_ERROR, EPROTO},
303#endif
304 {NT_STATUS_FLOAT_OVERFLOW, ERANGE},
305 {NT_STATUS_FLOAT_UNDERFLOW, ERANGE},
306 {NT_STATUS_INTEGER_OVERFLOW, ERANGE},
307 {NT_STATUS_MEDIA_WRITE_PROTECTED, EROFS},
308 {NT_STATUS_PIPE_CONNECTED, EISCONN},
309 {NT_STATUS_MEMORY_NOT_ALLOCATED, EFAULT},
310 {NT_STATUS_FLOAT_INEXACT_RESULT, ERANGE},
311 {NT_STATUS_ILL_FORMED_PASSWORD, EACCES},
312 {NT_STATUS_PASSWORD_RESTRICTION, EACCES},
313 {NT_STATUS_ACCOUNT_RESTRICTION, EACCES},
314 {NT_STATUS_PORT_CONNECTION_REFUSED, ECONNREFUSED},
315 {NT_STATUS_NAME_TOO_LONG, ENAMETOOLONG},
316 {NT_STATUS_REMOTE_DISCONNECT, ESHUTDOWN},
317 {NT_STATUS_CONNECTION_DISCONNECTED, ECONNABORTED},
318 {NT_STATUS_CONNECTION_RESET, ENETRESET},
319#ifdef ENOTUNIQ
320 {NT_STATUS_IP_ADDRESS_CONFLICT1, ENOTUNIQ},
321 {NT_STATUS_IP_ADDRESS_CONFLICT2, ENOTUNIQ},
322#endif
323 {NT_STATUS_PORT_MESSAGE_TOO_LONG, EMSGSIZE},
324 {NT_STATUS_PROTOCOL_UNREACHABLE, ENOPROTOOPT},
325 {NT_STATUS_ADDRESS_ALREADY_EXISTS, EADDRINUSE},
326 {NT_STATUS_PORT_UNREACHABLE, EHOSTUNREACH},
327 {NT_STATUS_IO_TIMEOUT, ETIMEDOUT},
328 {NT_STATUS_RETRY, EAGAIN},
329#ifdef ENOTUNIQ
330 {NT_STATUS_DUPLICATE_NAME, ENOTUNIQ},
331#endif
332#ifdef ECOMM
333 {NT_STATUS_NET_WRITE_FAULT, ECOMM},
334#endif
335
336 {NT_STATUS(0), 0}
337};
338
339/****************************************************************************
340 The following mappings need tidying up and moving into libsmb/errormap.c...
341****************************************************************************/
342
343static int cli_errno_from_nt(NTSTATUS status)
344{
345 int i;
346 DEBUG(10,("cli_errno_from_nt: 32 bit codes: code=%08x\n", NT_STATUS_V(status)));
347
348 /* Status codes without this bit set are not errors */
349
350 if (!(NT_STATUS_V(status) & 0xc0000000)) {
351 return 0;
352 }
353
354 for (i=0;nt_errno_map[i].error;i++) {
355 if (NT_STATUS_V(nt_errno_map[i].status) ==
356 NT_STATUS_V(status)) return nt_errno_map[i].error;
357 }
358
359 /* for all other cases - a default code */
360 return EINVAL;
361}
362
363/* Return a UNIX errno appropriate for the error received in the last
364 packet. */
365
366int cli_errno(struct cli_state *cli)
367{
368 NTSTATUS status;
369
370 if (cli_is_nt_error(cli)) {
371 status = cli_nt_error(cli);
372 return cli_errno_from_nt(status);
373 }
374
375 if (cli_is_dos_error(cli)) {
376 uint8 eclass;
377 uint32 ecode;
378
379 cli_dos_error(cli, &eclass, &ecode);
380 status = dos_to_ntstatus(eclass, ecode);
381 return cli_errno_from_nt(status);
382 }
383
384 /*
385 * Yuck! A special case for this Vista error. Since its high-order
386 * byte isn't 0xc0, it doesn't match cli_is_nt_error() above.
387 */
388 status = cli_nt_error(cli);
389 if (NT_STATUS_V(status) == NT_STATUS_V(STATUS_INACCESSIBLE_SYSTEM_SHORTCUT)) {
390 return EACCES;
391 }
392
393 /* for other cases */
394 return EINVAL;
395}
396
397/* Return true if the last packet was in error */
398
399BOOL cli_is_error(struct cli_state *cli)
400{
401 uint32 flgs2 = SVAL(cli->inbuf,smb_flg2), rcls = 0;
402
403 /* A socket error is always an error. */
404 if (cli->fd == -1 && cli->smb_rw_error != 0) {
405 return True;
406 }
407
408 if (flgs2 & FLAGS2_32_BIT_ERROR_CODES) {
409 /* Return error is error bits are set */
410 rcls = IVAL(cli->inbuf, smb_rcls);
411 return (rcls & 0xF0000000) == 0xC0000000;
412 }
413
414 /* Return error if error class in non-zero */
415
416 rcls = CVAL(cli->inbuf, smb_rcls);
417 return rcls != 0;
418}
419
420/* Return true if the last error was an NT error */
421
422BOOL cli_is_nt_error(struct cli_state *cli)
423{
424 uint32 flgs2 = SVAL(cli->inbuf,smb_flg2);
425
426 /* A socket error is always an NT error. */
427 if (cli->fd == -1 && cli->smb_rw_error != 0) {
428 return True;
429 }
430
431 return cli_is_error(cli) && (flgs2 & FLAGS2_32_BIT_ERROR_CODES);
432}
433
434/* Return true if the last error was a DOS error */
435
436BOOL cli_is_dos_error(struct cli_state *cli)
437{
438 uint32 flgs2 = SVAL(cli->inbuf,smb_flg2);
439
440 /* A socket error is always a DOS error. */
441 if (cli->fd == -1 && cli->smb_rw_error != 0) {
442 return True;
443 }
444
445 return cli_is_error(cli) && !(flgs2 & FLAGS2_32_BIT_ERROR_CODES);
446}
447
448/* Return the last error always as an NTSTATUS. */
449
450NTSTATUS cli_get_nt_error(struct cli_state *cli)
451{
452 if (cli_is_nt_error(cli)) {
453 return cli_nt_error(cli);
454 } else if (cli_is_dos_error(cli)) {
455 uint32 ecode;
456 uint8 eclass;
457 cli_dos_error(cli, &eclass, &ecode);
458 return dos_to_ntstatus(eclass, ecode);
459 } else {
460 /* Something went wrong, we don't know what. */
461 return NT_STATUS_UNSUCCESSFUL;
462 }
463}
464
465/* Push an error code into the inbuf to be returned on the next
466 * query. */
467
468void cli_set_nt_error(struct cli_state *cli, NTSTATUS status)
469{
470 SSVAL(cli->inbuf,smb_flg2, SVAL(cli->inbuf,smb_flg2)|FLAGS2_32_BIT_ERROR_CODES);
471 SIVAL(cli->inbuf, smb_rcls, NT_STATUS_V(status));
472}
473
474/* Reset an error. */
475
476void cli_reset_error(struct cli_state *cli)
477{
478 if (SVAL(cli->inbuf,smb_flg2) & FLAGS2_32_BIT_ERROR_CODES) {
479 SIVAL(cli->inbuf, smb_rcls, NT_STATUS_V(NT_STATUS_OK));
480 } else {
481 SCVAL(cli->inbuf,smb_rcls,0);
482 SSVAL(cli->inbuf,smb_err,0);
483 }
484}
Note: See TracBrowser for help on using the repository browser.