~vcs-imports/samba/main

« back to all changes in this revision

Viewing changes to source/libsmb/clierror.c

  • Committer: jerry
  • Date: 2006-07-14 21:48:39 UTC
  • Revision ID: vcs-imports@canonical.com-20060714214839-586d8c489a8fcead
gutting trunk to move to svn:externals

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
 
33
 
static 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
 
 
64
 
static 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
 
 
73
 
static 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
 
 
100
 
const 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
 
 
177
 
NTSTATUS 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
 
 
201
 
void cli_dos_error(struct cli_state *cli, uint8 *eclass, uint32 *ecode)
202
 
{
203
 
        int  flgs2;
204
 
        char rcls;
205
 
        int code;
206
 
 
207
 
        if(!cli->initialised) {
208
 
                return;
209
 
        }
210
 
 
211
 
        /* Deal with socket errors first. */
212
 
        if (cli->fd == -1 && cli->smb_rw_error) {
213
 
                NTSTATUS status = cli_smb_rw_error_to_ntstatus(cli);
214
 
                ntstatus_to_dos( status, eclass, ecode);
215
 
                return;
216
 
        }
217
 
 
218
 
        flgs2 = SVAL(cli->inbuf,smb_flg2);
219
 
 
220
 
        if (flgs2 & FLAGS2_32_BIT_ERROR_CODES) {
221
 
                NTSTATUS ntstatus = NT_STATUS(IVAL(cli->inbuf, smb_rcls));
222
 
                ntstatus_to_dos(ntstatus, eclass, ecode);
223
 
                return;
224
 
        }
225
 
 
226
 
        rcls  = CVAL(cli->inbuf,smb_rcls);
227
 
        code  = SVAL(cli->inbuf,smb_err);
228
 
 
229
 
        if (eclass) *eclass = rcls;
230
 
        if (ecode) *ecode    = code;
231
 
}
232
 
 
233
 
/* Return a UNIX errno from a NT status code */
234
 
static struct {
235
 
        NTSTATUS status;
236
 
        int error;
237
 
} nt_errno_map[] = {
238
 
        {NT_STATUS_ACCESS_VIOLATION, EACCES},
239
 
        {NT_STATUS_INVALID_HANDLE, EBADF},
240
 
        {NT_STATUS_ACCESS_DENIED, EACCES},
241
 
        {NT_STATUS_OBJECT_NAME_NOT_FOUND, ENOENT},
242
 
        {NT_STATUS_SHARING_VIOLATION, EBUSY},
243
 
        {NT_STATUS_OBJECT_PATH_INVALID, ENOTDIR},
244
 
        {NT_STATUS_OBJECT_NAME_COLLISION, EEXIST},
245
 
        {NT_STATUS_PATH_NOT_COVERED, ENOENT},
246
 
        {NT_STATUS_UNSUCCESSFUL, EINVAL},
247
 
        {NT_STATUS_NOT_IMPLEMENTED, ENOSYS},
248
 
        {NT_STATUS_IN_PAGE_ERROR, EFAULT}, 
249
 
        {NT_STATUS_BAD_NETWORK_NAME, ENOENT},
250
 
#ifdef EDQUOT
251
 
        {NT_STATUS_PAGEFILE_QUOTA, EDQUOT},
252
 
        {NT_STATUS_QUOTA_EXCEEDED, EDQUOT},
253
 
        {NT_STATUS_REGISTRY_QUOTA_LIMIT, EDQUOT},
254
 
        {NT_STATUS_LICENSE_QUOTA_EXCEEDED, EDQUOT},
255
 
#endif
256
 
#ifdef ETIME
257
 
        {NT_STATUS_TIMER_NOT_CANCELED, ETIME},
258
 
#endif
259
 
        {NT_STATUS_INVALID_PARAMETER, EINVAL},
260
 
        {NT_STATUS_NO_SUCH_DEVICE, ENODEV},
261
 
        {NT_STATUS_NO_SUCH_FILE, ENOENT},
262
 
#ifdef ENODATA
263
 
        {NT_STATUS_END_OF_FILE, ENODATA}, 
264
 
#endif
265
 
#ifdef ENOMEDIUM
266
 
        {NT_STATUS_NO_MEDIA_IN_DEVICE, ENOMEDIUM}, 
267
 
        {NT_STATUS_NO_MEDIA, ENOMEDIUM},
268
 
#endif
269
 
        {NT_STATUS_NONEXISTENT_SECTOR, ESPIPE}, 
270
 
        {NT_STATUS_NO_MEMORY, ENOMEM},
271
 
        {NT_STATUS_CONFLICTING_ADDRESSES, EADDRINUSE},
272
 
        {NT_STATUS_NOT_MAPPED_VIEW, EINVAL},
273
 
        {NT_STATUS_UNABLE_TO_FREE_VM, EADDRINUSE},
274
 
        {NT_STATUS_ACCESS_DENIED, EACCES}, 
275
 
        {NT_STATUS_BUFFER_TOO_SMALL, ENOBUFS},
276
 
        {NT_STATUS_WRONG_PASSWORD, EACCES},
277
 
        {NT_STATUS_LOGON_FAILURE, EACCES},
278
 
        {NT_STATUS_INVALID_WORKSTATION, EACCES},
279
 
        {NT_STATUS_INVALID_LOGON_HOURS, EACCES},
280
 
        {NT_STATUS_PASSWORD_EXPIRED, EACCES},
281
 
        {NT_STATUS_ACCOUNT_DISABLED, EACCES},
282
 
        {NT_STATUS_DISK_FULL, ENOSPC},
283
 
        {NT_STATUS_INVALID_PIPE_STATE, EPIPE},
284
 
        {NT_STATUS_PIPE_BUSY, EPIPE},
285
 
        {NT_STATUS_PIPE_DISCONNECTED, EPIPE},
286
 
        {NT_STATUS_PIPE_NOT_AVAILABLE, ENOSYS},
287
 
        {NT_STATUS_FILE_IS_A_DIRECTORY, EISDIR},
288
 
        {NT_STATUS_NOT_SUPPORTED, ENOSYS},
289
 
        {NT_STATUS_NOT_A_DIRECTORY, ENOTDIR},
290
 
        {NT_STATUS_DIRECTORY_NOT_EMPTY, ENOTEMPTY},
291
 
        {NT_STATUS_NETWORK_UNREACHABLE, ENETUNREACH},
292
 
        {NT_STATUS_HOST_UNREACHABLE, EHOSTUNREACH},
293
 
        {NT_STATUS_CONNECTION_ABORTED, ECONNABORTED},
294
 
        {NT_STATUS_CONNECTION_REFUSED, ECONNREFUSED},
295
 
        {NT_STATUS_TOO_MANY_LINKS, EMLINK},
296
 
        {NT_STATUS_NETWORK_BUSY, EBUSY},
297
 
        {NT_STATUS_DEVICE_DOES_NOT_EXIST, ENODEV},
298
 
#ifdef ELIBACC
299
 
        {NT_STATUS_DLL_NOT_FOUND, ELIBACC},
300
 
#endif
301
 
        {NT_STATUS_PIPE_BROKEN, EPIPE},
302
 
        {NT_STATUS_REMOTE_NOT_LISTENING, ECONNREFUSED},
303
 
        {NT_STATUS_NETWORK_ACCESS_DENIED, EACCES},
304
 
        {NT_STATUS_TOO_MANY_OPENED_FILES, EMFILE},
305
 
#ifdef EPROTO
306
 
        {NT_STATUS_DEVICE_PROTOCOL_ERROR, EPROTO},
307
 
#endif
308
 
        {NT_STATUS_FLOAT_OVERFLOW, ERANGE},
309
 
        {NT_STATUS_FLOAT_UNDERFLOW, ERANGE},
310
 
        {NT_STATUS_INTEGER_OVERFLOW, ERANGE},
311
 
        {NT_STATUS_MEDIA_WRITE_PROTECTED, EROFS},
312
 
        {NT_STATUS_PIPE_CONNECTED, EISCONN},
313
 
        {NT_STATUS_MEMORY_NOT_ALLOCATED, EFAULT},
314
 
        {NT_STATUS_FLOAT_INEXACT_RESULT, ERANGE},
315
 
        {NT_STATUS_ILL_FORMED_PASSWORD, EACCES},
316
 
        {NT_STATUS_PASSWORD_RESTRICTION, EACCES},
317
 
        {NT_STATUS_ACCOUNT_RESTRICTION, EACCES},
318
 
        {NT_STATUS_PORT_CONNECTION_REFUSED, ECONNREFUSED},
319
 
        {NT_STATUS_NAME_TOO_LONG, ENAMETOOLONG},
320
 
        {NT_STATUS_REMOTE_DISCONNECT, ESHUTDOWN},
321
 
        {NT_STATUS_CONNECTION_DISCONNECTED, ECONNABORTED},
322
 
        {NT_STATUS_CONNECTION_RESET, ENETRESET},
323
 
#ifdef ENOTUNIQ
324
 
        {NT_STATUS_IP_ADDRESS_CONFLICT1, ENOTUNIQ},
325
 
        {NT_STATUS_IP_ADDRESS_CONFLICT2, ENOTUNIQ},
326
 
#endif
327
 
        {NT_STATUS_PORT_MESSAGE_TOO_LONG, EMSGSIZE},
328
 
        {NT_STATUS_PROTOCOL_UNREACHABLE, ENOPROTOOPT},
329
 
        {NT_STATUS_ADDRESS_ALREADY_EXISTS, EADDRINUSE},
330
 
        {NT_STATUS_PORT_UNREACHABLE, EHOSTUNREACH},
331
 
        {NT_STATUS_IO_TIMEOUT, ETIMEDOUT},
332
 
        {NT_STATUS_RETRY, EAGAIN},
333
 
#ifdef ENOTUNIQ
334
 
        {NT_STATUS_DUPLICATE_NAME, ENOTUNIQ},
335
 
#endif
336
 
#ifdef ECOMM
337
 
        {NT_STATUS_NET_WRITE_FAULT, ECOMM},
338
 
#endif
339
 
 
340
 
        {NT_STATUS(0), 0}
341
 
};
342
 
 
343
 
/****************************************************************************
344
 
 The following mappings need tidying up and moving into libsmb/errormap.c...
345
 
****************************************************************************/
346
 
 
347
 
static int cli_errno_from_nt(NTSTATUS status)
348
 
{
349
 
        int i;
350
 
        DEBUG(10,("cli_errno_from_nt: 32 bit codes: code=%08x\n", NT_STATUS_V(status)));
351
 
 
352
 
        /* Status codes without this bit set are not errors */
353
 
 
354
 
        if (!(NT_STATUS_V(status) & 0xc0000000)) {
355
 
                return 0;
356
 
        }
357
 
 
358
 
        for (i=0;nt_errno_map[i].error;i++) {
359
 
                if (NT_STATUS_V(nt_errno_map[i].status) ==
360
 
                    NT_STATUS_V(status)) return nt_errno_map[i].error;
361
 
        }
362
 
 
363
 
        /* for all other cases - a default code */
364
 
        return EINVAL;
365
 
}
366
 
 
367
 
/* Return a UNIX errno appropriate for the error received in the last
368
 
   packet. */
369
 
 
370
 
int cli_errno(struct cli_state *cli)
371
 
{
372
 
        NTSTATUS status;
373
 
 
374
 
        if (cli_is_nt_error(cli)) {
375
 
                status = cli_nt_error(cli);
376
 
                return cli_errno_from_nt(status);
377
 
        }
378
 
 
379
 
        if (cli_is_dos_error(cli)) {
380
 
                uint8 eclass;
381
 
                uint32 ecode;
382
 
 
383
 
                cli_dos_error(cli, &eclass, &ecode);
384
 
                status = dos_to_ntstatus(eclass, ecode);
385
 
                return cli_errno_from_nt(status);
386
 
        }
387
 
 
388
 
        /* for other cases */
389
 
        return EINVAL;
390
 
}
391
 
 
392
 
/* Return true if the last packet was in error */
393
 
 
394
 
BOOL cli_is_error(struct cli_state *cli)
395
 
{
396
 
        uint32 flgs2 = SVAL(cli->inbuf,smb_flg2), rcls = 0;
397
 
 
398
 
        /* A socket error is always an error. */
399
 
        if (cli->fd == -1 && cli->smb_rw_error != 0) {
400
 
                return True;
401
 
        }
402
 
 
403
 
        if (flgs2 & FLAGS2_32_BIT_ERROR_CODES) {
404
 
                /* Return error is error bits are set */
405
 
                rcls = IVAL(cli->inbuf, smb_rcls);
406
 
                return (rcls & 0xF0000000) == 0xC0000000;
407
 
        }
408
 
                
409
 
        /* Return error if error class in non-zero */
410
 
 
411
 
        rcls = CVAL(cli->inbuf, smb_rcls);
412
 
        return rcls != 0;
413
 
}
414
 
 
415
 
/* Return true if the last error was an NT error */
416
 
 
417
 
BOOL cli_is_nt_error(struct cli_state *cli)
418
 
{
419
 
        uint32 flgs2 = SVAL(cli->inbuf,smb_flg2);
420
 
 
421
 
        /* A socket error is always an NT error. */
422
 
        if (cli->fd == -1 && cli->smb_rw_error != 0) {
423
 
                return True;
424
 
        }
425
 
 
426
 
        return cli_is_error(cli) && (flgs2 & FLAGS2_32_BIT_ERROR_CODES);
427
 
}
428
 
 
429
 
/* Return true if the last error was a DOS error */
430
 
 
431
 
BOOL cli_is_dos_error(struct cli_state *cli)
432
 
{
433
 
        uint32 flgs2 = SVAL(cli->inbuf,smb_flg2);
434
 
 
435
 
        /* A socket error is always a DOS error. */
436
 
        if (cli->fd == -1 && cli->smb_rw_error != 0) {
437
 
                return True;
438
 
        }
439
 
 
440
 
        return cli_is_error(cli) && !(flgs2 & FLAGS2_32_BIT_ERROR_CODES);
441
 
}
442
 
 
443
 
/* Return the last error always as an NTSTATUS. */
444
 
 
445
 
NTSTATUS cli_get_nt_error(struct cli_state *cli)
446
 
{
447
 
        if (cli_is_nt_error(cli)) {
448
 
                return cli_nt_error(cli);
449
 
        } else if (cli_is_dos_error(cli)) {
450
 
                uint32 ecode;
451
 
                uint8 eclass;
452
 
                cli_dos_error(cli, &eclass, &ecode);
453
 
                return dos_to_ntstatus(eclass, ecode);
454
 
        } else {
455
 
                /* Something went wrong, we don't know what. */
456
 
                return NT_STATUS_UNSUCCESSFUL;
457
 
        }
458
 
}