source/libsmb/clierror.c

   1 /*
   2    Unix SMB/Netbios implementation.
   3    Version 3.0
   4    client error handling routines
   5    Copyright (C) Andrew Tridgell 1994-1998
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program; if not, write to the Free Software
  19    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 */
  21
  22 #define NO_SYSLOG
  23
  24 #include "includes.h"
  25
  26 /*****************************************************
  27  RAP error codes - a small start but will be extended.
  28 *******************************************************/
  29
  30 static const struct
  31 {
  32         int err;
  33         char *message;
  34 } rap_errmap[] = {
  35         {5,    "RAP5: User has insufficient privilege" },
  36         {50,   "RAP50: Not supported by server" },
  37         {65,   "RAP65: Access denied" },
  38         {86,   "RAP86: The specified password is invalid" },
  39         {2220, "RAP2220: Group does not exist" },
  40         {2221, "RAP2221: User does not exist" },
  41         {2226, "RAP2226: Operation only permitted on a Primary Domain Controller"  },
  42         {2237, "RAP2237: User is not in group" },
  43         {2242, "RAP2242: The password of this user has expired." },
  44         {2243, "RAP2243: The password of this user cannot change." },
  45         {2244, "RAP2244: This password cannot be used now (password history conflict)." },
  46         {2245, "RAP2245: The password is shorter than required." },
  47         {2246, "RAP2246: The password of this user is too recent to change."},
  48
  49         /* these really shouldn't be here ... */
  50         {0x80, "Not listening on called name"},
  51         {0x81, "Not listening for calling name"},
  52         {0x82, "Called name not present"},
  53         {0x83, "Called name present, but insufficient resources"},
  54
  55         {0, NULL}
  56 };
  57
  58 /****************************************************************************
  59   return a description of an SMB error
  60 ****************************************************************************/
  61 static char *cli_smb_errstr(struct cli_state *cli)
  62 {
  63         return smb_dos_errstr(cli->inbuf);
  64 }
  65
  66 /***************************************************************************
  67  Return an error message - either an NT error, SMB error or a RAP error.
  68  Note some of the NT errors are actually warnings or "informational" errors
  69  in which case they can be safely ignored.
  70 ****************************************************************************/
  71
  72 char *cli_errstr(struct cli_state *cli)
  73 {
  74         static fstring cli_error_message;
  75         uint32 flgs2 = SVAL(cli->inbuf,smb_flg2), errnum;
  76         uint8 errclass;
  77         int i;
  78
  79         if (!cli->initialised) {
  80                 fstrcpy(cli_error_message, "[Programmer's error] cli_errstr called on unitialized cli_stat struct!\n");
  81                 return cli_error_message;
  82         }
  83
  84         /* Was it server socket error ? */
  85         if (cli->fd == -1 && cli->smb_rw_error) {
  86                 switch(cli->smb_rw_error) {
  87                         case READ_TIMEOUT:
  88                                 slprintf(cli_error_message, sizeof(cli_error_message) - 1,
  89                                         "Call timed out: server did not respond after %d milliseconds",
  90                                         cli->timeout);
  91                                 break;
  92                         case READ_EOF:
  93                                 slprintf(cli_error_message, sizeof(cli_error_message) - 1,
  94                                         "Call returned zero bytes (EOF)\n" );
  95                                 break;
  96                         case READ_ERROR:
  97                                 slprintf(cli_error_message, sizeof(cli_error_message) - 1,
  98                                         "Read error: %s\n", strerror(errno) );
  99                                 break;
 100                         case WRITE_ERROR:
 101                                 slprintf(cli_error_message, sizeof(cli_error_message) - 1,
 102                                         "Write error: %s\n", strerror(errno) );
 103                                 break;
 104                         default:
 105                                 slprintf(cli_error_message, sizeof(cli_error_message) - 1,
 106                                         "Unknown error code %d\n", cli->smb_rw_error );
 107                                 break;
 108                 }
 109                 return cli_error_message;
 110         }
 111
 112         /* Case #1: RAP error */
 113         if (cli->rap_error) {
 114                 for (i = 0; rap_errmap[i].message != NULL; i++) {
 115                         if (rap_errmap[i].err == cli->rap_error) {
 116                                 return rap_errmap[i].message;
 117                         }
 118                 }
 119
 120                 slprintf(cli_error_message, sizeof(cli_error_message) - 1, "RAP code %d",
 121                         cli->rap_error);
 122
 123                 return cli_error_message;
 124         }
 125
 126         /* Case #2: 32-bit NT errors */
 127         if (flgs2 & FLAGS2_32_BIT_ERROR_CODES) {
 128                 NTSTATUS status = NT_STATUS(IVAL(cli->inbuf,smb_rcls));
 129
 130                 return get_nt_error_msg(status);
 131         }
 132
 133         cli_dos_error(cli, &errclass, &errnum);
 134
 135         /* Case #3: SMB error */
 136
 137         return cli_smb_errstr(cli);
 138 }
 139
 140
 141 /* Return the 32-bit NT status code from the last packet */
 142 NTSTATUS cli_nt_error(struct cli_state *cli)
 143 {
 144         int flgs2 = SVAL(cli->inbuf,smb_flg2);
 145
 146         if (!(flgs2 & FLAGS2_32_BIT_ERROR_CODES)) {
 147                 int class  = CVAL(cli->inbuf,smb_rcls);
 148                 int code  = SVAL(cli->inbuf,smb_err);
 149                 return dos_to_ntstatus(class, code);
 150         }
 151
 152         return NT_STATUS(IVAL(cli->inbuf,smb_rcls));
 153 }
 154
 155
 156 /* Return the DOS error from the last packet - an error class and an error
 157    code. */
 158 void cli_dos_error(struct cli_state *cli, uint8 *eclass, uint32 *ecode)
 159 {
 160         int  flgs2;
 161         char rcls;
 162         int code;
 163
 164         if(!cli->initialised) return;
 165
 166         flgs2 = SVAL(cli->inbuf,smb_flg2);
 167
 168         if (flgs2 & FLAGS2_32_BIT_ERROR_CODES) {
 169                 NTSTATUS ntstatus = NT_STATUS(IVAL(cli->inbuf, smb_rcls));
 170                 ntstatus_to_dos(ntstatus, eclass, ecode);
 171                 return;
 172         }
 173
 174         rcls  = CVAL(cli->inbuf,smb_rcls);
 175         code  = SVAL(cli->inbuf,smb_err);
 176
 177         if (eclass) *eclass = rcls;
 178         if (ecode) *ecode    = code;
 179 }
 180
 181 /* Return a UNIX errno from a dos error class, error number tuple */
 182
 183 int cli_errno_from_dos(uint8 eclass, uint32 num)
 184 {
 185         if (eclass == ERRDOS) {
 186                 switch (num) {
 187                 case ERRbadfile: return ENOENT;
 188                 case ERRbadpath: return ENOTDIR;
 189                 case ERRnoaccess: return EACCES;
 190                 case ERRfilexists: return EEXIST;
 191                 case ERRrename: return EEXIST;
 192                 case ERRbadshare: return EBUSY;
 193                 case ERRlock: return EBUSY;
 194                 case ERRinvalidname: return ENOENT;
 195                 case ERRnosuchshare: return ENODEV;
 196                 }
 197         }
 198
 199         if (eclass == ERRSRV) {
 200                 switch (num) {
 201                 case ERRbadpw: return EPERM;
 202                 case ERRaccess: return EACCES;
 203                 case ERRnoresource: return ENOMEM;
 204                 case ERRinvdevice: return ENODEV;
 205                 case ERRinvnetname: return ENODEV;
 206                 }
 207         }
 208
 209         /* for other cases */
 210         return EINVAL;
 211 }
 212
 213 /* Return a UNIX errno from a NT status code */
 214 static struct {
 215         NTSTATUS status;
 216         int error;
 217 } nt_errno_map[] = {
 218         {NT_STATUS_ACCESS_VIOLATION, EACCES},
 219         {NT_STATUS_NO_SUCH_FILE, ENOENT},
 220         {NT_STATUS_NO_SUCH_DEVICE, ENODEV},
 221         {NT_STATUS_INVALID_HANDLE, EBADF},
 222         {NT_STATUS_NO_MEMORY, ENOMEM},
 223         {NT_STATUS_ACCESS_DENIED, EACCES},
 224         {NT_STATUS_OBJECT_NAME_NOT_FOUND, ENOENT},
 225         {NT_STATUS_SHARING_VIOLATION, EBUSY},
 226         {NT_STATUS_OBJECT_PATH_INVALID, ENOTDIR},
 227         {NT_STATUS_OBJECT_NAME_COLLISION, EEXIST},
 228         {NT_STATUS_PATH_NOT_COVERED, ENOENT},
 229         {NT_STATUS(0), 0}
 230 };
 231
 232 int cli_errno_from_nt(NTSTATUS status)
 233 {
 234         int i;
 235         DEBUG(10,("cli_errno_from_nt: 32 bit codes: code=%08x\n", NT_STATUS_V(status)));
 236
 237         /* Status codes without this bit set are not errors */
 238
 239         if (!(NT_STATUS_V(status) & 0xc0000000))
 240                 return 0;
 241
 242         for (i=0;nt_errno_map[i].error;i++) {
 243                 if (NT_STATUS_V(nt_errno_map[i].status) ==
 244                     NT_STATUS_V(status)) return nt_errno_map[i].error;
 245         }
 246
 247         /* for all other cases - a default code */
 248         return EINVAL;
 249 }
 250
 251 /* Return a UNIX errno appropriate for the error received in the last
 252    packet. */
 253
 254 int cli_errno(struct cli_state *cli)
 255 {
 256         NTSTATUS status;
 257
 258         if (cli_is_dos_error(cli)) {
 259                 uint8 eclass;
 260                 uint32 ecode;
 261
 262                 cli_dos_error(cli, &eclass, &ecode);
 263                 return cli_errno_from_dos(eclass, ecode);
 264         }
 265
 266         status = cli_nt_error(cli);
 267
 268         return cli_errno_from_nt(status);
 269 }
 270
 271 /* Return true if the last packet was in error */
 272
 273 BOOL cli_is_error(struct cli_state *cli)
 274 {
 275         uint32 flgs2 = SVAL(cli->inbuf,smb_flg2), rcls = 0;
 276
 277         if (flgs2 & FLAGS2_32_BIT_ERROR_CODES) {
 278                 /* Return error is error bits are set */
 279                 rcls = IVAL(cli->inbuf, smb_rcls);
 280                 return (rcls & 0xF0000000) == 0xC0000000;
 281         }
 282
 283         /* Return error if error class in non-zero */
 284
 285         rcls = CVAL(cli->inbuf, smb_rcls);
 286         return rcls != 0;
 287 }
 288
 289 /* Return true if the last error was an NT error */
 290
 291 BOOL cli_is_nt_error(struct cli_state *cli)
 292 {
 293         uint32 flgs2 = SVAL(cli->inbuf,smb_flg2);
 294
 295         return cli_is_error(cli) && (flgs2 & FLAGS2_32_BIT_ERROR_CODES);
 296 }
 297
 298 /* Return true if the last error was a DOS error */
 299
 300 BOOL cli_is_dos_error(struct cli_state *cli)
 301 {
 302         uint32 flgs2 = SVAL(cli->inbuf,smb_flg2);
 303
 304         return cli_is_error(cli) && !(flgs2 & FLAGS2_32_BIT_ERROR_CODES);
 305 }