source3/libsmb/clierror.c

   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 3 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, see <http://www.gnu.org/licenses/>.
  20 */
  21
  22 #include "includes.h"
  23 #include "libsmb/libsmb.h"
  24 #include "../libcli/smb/smbXcli_base.h"
  25
  26 /****************************************************************************
  27  Return the 32-bit NT status code from the last packet.
  28 ****************************************************************************/
  29
  30 NTSTATUS cli_nt_error(struct cli_state *cli)
  31 {
  32         /* Deal with socket errors first. */
  33         if (!cli_state_is_connected(cli)) {
  34                 return NT_STATUS_CONNECTION_DISCONNECTED;
  35         }
  36
  37         if (NT_STATUS_IS_DOS(cli->raw_status)) {
  38                 int e_class = NT_STATUS_DOS_CLASS(cli->raw_status);
  39                 int code = NT_STATUS_DOS_CODE(cli->raw_status);
  40                 return dos_to_ntstatus(e_class, code);
  41         }
  42
  43         return cli->raw_status;
  44 }
  45
  46
  47 /****************************************************************************
  48  Return the DOS error from the last packet - an error class and an error
  49  code.
  50 ****************************************************************************/
  51
  52 void cli_dos_error(struct cli_state *cli, uint8_t *eclass, uint32_t *ecode)
  53 {
  54         if (!cli_state_is_connected(cli)) {
  55                 *eclass = ERRDOS;
  56                 *ecode = ERRnotconnected;
  57                 return;
  58         }
  59
  60         if (!NT_STATUS_IS_DOS(cli->raw_status)) {
  61                 ntstatus_to_dos(cli->raw_status, eclass, ecode);
  62                 return;
  63         }
  64
  65         *eclass = NT_STATUS_DOS_CLASS(cli->raw_status);
  66         *ecode = NT_STATUS_DOS_CODE(cli->raw_status);
  67 }
  68
  69
  70 /* Return a UNIX errno appropriate for the error received in the last
  71    packet. */
  72
  73 int cli_errno(struct cli_state *cli)
  74 {
  75         NTSTATUS status;
  76
  77         if (cli_is_nt_error(cli)) {
  78                 status = cli_nt_error(cli);
  79                 return map_errno_from_nt_status(status);
  80         }
  81
  82         if (cli_is_dos_error(cli)) {
  83                 uint8_t eclass;
  84                 uint32_t ecode;
  85
  86                 cli_dos_error(cli, &eclass, &ecode);
  87                 status = dos_to_ntstatus(eclass, ecode);
  88                 return map_errno_from_nt_status(status);
  89         }
  90
  91         /*
  92          * Yuck!  A special case for this Vista error.  Since its high-order
  93          * byte isn't 0xc0, it doesn't match cli_is_nt_error() above.
  94          */
  95         status = cli_nt_error(cli);
  96         if (NT_STATUS_V(status) == NT_STATUS_V(NT_STATUS_INACCESSIBLE_SYSTEM_SHORTCUT)) {
  97             return EACCES;
  98         }
  99
 100         /* for other cases */
 101         return EINVAL;
 102 }
 103
 104 /* Return true if the last packet was in error */
 105
 106 bool cli_is_error(struct cli_state *cli)
 107 {
 108         /* A socket error is always an error. */
 109         if (!cli_state_is_connected(cli)) {
 110                 return true;
 111         }
 112
 113         if (NT_STATUS_IS_DOS(cli->raw_status)) {
 114                 /* Return error if error class in non-zero */
 115                 uint8_t rcls = NT_STATUS_DOS_CLASS(cli->raw_status);
 116                 return rcls != 0;
 117         }
 118
 119         return NT_STATUS_IS_ERR(cli->raw_status);
 120 }
 121
 122 /* Return true if the last error was an NT error */
 123
 124 bool cli_is_nt_error(struct cli_state *cli)
 125 {
 126         /* A socket error is always an NT error. */
 127         if (!cli_state_is_connected(cli)) {
 128                 return true;
 129         }
 130
 131         return cli_is_error(cli) && !NT_STATUS_IS_DOS(cli->raw_status);
 132 }
 133
 134 /* Return true if the last error was a DOS error */
 135
 136 bool cli_is_dos_error(struct cli_state *cli)
 137 {
 138         /* A socket error is always a DOS error. */
 139         if (!cli_state_is_connected(cli)) {
 140                 return true;
 141         }
 142
 143         return cli_is_error(cli) && NT_STATUS_IS_DOS(cli->raw_status);
 144 }
 145
 146 bool cli_state_is_connected(struct cli_state *cli)
 147 {
 148         if (cli == NULL) {
 149                 return false;
 150         }
 151
 152         if (!cli->initialised) {
 153                 return false;
 154         }
 155
 156         return smbXcli_conn_is_connected(cli->conn);
 157 }