source3/smbd/error.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    error packet handling
   4    Copyright (C) Andrew Tridgell 1992-1998
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 2 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program; if not, write to the Free Software
  18    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19 */
  20
  21 #include "includes.h"
  22
  23 /* From lib/error.c */
  24 extern struct unix_error_map unix_dos_nt_errmap[];
  25
  26 extern uint32 global_client_caps;
  27 /* these can be set by some functions to override the error codes */
  28 static int override_ERR_class;
  29 static int override_ERR_code;
  30 static NTSTATUS override_ERR_ntstatus;
  31
  32 /****************************************************************************
  33  Setting eclass and ecode only and status to NT_STATUS_INVALID forces DOS errors.
  34  Setting status only and eclass and ecode to -1 forces NT errors.
  35 ****************************************************************************/
  36
  37 void set_saved_error_triple(int eclass, int ecode, NTSTATUS status)
  38 {
  39         override_ERR_class = eclass;
  40         override_ERR_code = ecode;
  41         override_ERR_ntstatus = status;
  42 }
  43
  44 /****************************************************************************
  45  Return the current settings of the error triple. Return True if any are set.
  46 ****************************************************************************/
  47
  48 BOOL get_saved_error_triple(int *peclass, int *pecode, NTSTATUS *pstatus)
  49 {
  50         if (peclass) {
  51                 *peclass = override_ERR_class;
  52         }
  53         if (pecode) {
  54                 *pecode = override_ERR_code;
  55         }
  56         if (pstatus) {
  57                 *pstatus = override_ERR_ntstatus;
  58         }
  59
  60         return (override_ERR_class || !NT_STATUS_IS_OK(override_ERR_ntstatus));
  61 }
  62
  63 /****************************************************************************
  64  Create an error packet from a cached error.
  65 ****************************************************************************/
  66
  67 int cached_error_packet(char *outbuf,files_struct *fsp,int line,const char *file)
  68 {
  69         write_bmpx_struct *wbmpx = fsp->wbmpx_ptr;
  70         int32 eclass = wbmpx->wr_errclass;
  71         int32 err = wbmpx->wr_error;
  72         NTSTATUS ntstatus = wbmpx->wr_status;
  73
  74         /* We can now delete the auxiliary struct */
  75         SAFE_FREE(fsp->wbmpx_ptr);
  76         return error_packet(outbuf,eclass,err,ntstatus,line,file);
  77 }
  78
  79 /****************************************************************************
  80  Create an error packet from errno.
  81 ****************************************************************************/
  82
  83 int unix_error_packet(char *outbuf,int def_class,uint32 def_code, NTSTATUS def_status, int line, const char *file)
  84 {
  85         int eclass=def_class;
  86         int ecode=def_code;
  87         NTSTATUS ntstatus = def_status;
  88         int i=0;
  89
  90         if (errno != 0) {
  91                 DEBUG(3,("unix_error_packet: error string = %s\n",strerror(errno)));
  92
  93                 while (unix_dos_nt_errmap[i].dos_class != 0) {
  94                         if (unix_dos_nt_errmap[i].unix_error == errno) {
  95                                 eclass = unix_dos_nt_errmap[i].dos_class;
  96                                 ecode = unix_dos_nt_errmap[i].dos_code;
  97                                 ntstatus = unix_dos_nt_errmap[i].nt_error;
  98                                 break;
  99                         }
 100                         i++;
 101                 }
 102         }
 103
 104         return error_packet(outbuf,eclass,ecode,ntstatus,line,file);
 105 }
 106
 107
 108 /****************************************************************************
 109  Create an error packet. Normally called using the ERROR() macro.
 110  Setting eclass and ecode only and status to NT_STATUS_OK forces DOS errors.
 111  Setting status only and eclass and ecode to zero forces NT errors.
 112  If the override errors are set they take precedence over any passed in values.
 113 ****************************************************************************/
 114
 115 int error_packet(char *outbuf, uint8 eclass, uint32 ecode, NTSTATUS ntstatus, int line, const char *file)
 116 {
 117         int outsize = set_message(outbuf,0,0,True);
 118         BOOL force_nt_status = False;
 119         BOOL force_dos_status = False;
 120
 121         if (override_ERR_class != SMB_SUCCESS || !NT_STATUS_IS_OK(override_ERR_ntstatus)) {
 122                 eclass = override_ERR_class;
 123                 ecode = override_ERR_code;
 124                 ntstatus = override_ERR_ntstatus;
 125                 override_ERR_class = SMB_SUCCESS;
 126                 override_ERR_code = 0;
 127                 override_ERR_ntstatus = NT_STATUS_OK;
 128         }
 129
 130         if (eclass == (uint8)-1) {
 131                 force_nt_status = True;
 132         } else if (NT_STATUS_IS_INVALID(ntstatus)) {
 133                 force_dos_status = True;
 134         }
 135
 136         if (force_nt_status || (!force_dos_status && lp_nt_status_support() && (global_client_caps & CAP_STATUS32))) {
 137                 /* We're returning an NT error. */
 138                 if (NT_STATUS_V(ntstatus) == 0 && eclass) {
 139                         ntstatus = dos_to_ntstatus(eclass, ecode);
 140                 }
 141                 SIVAL(outbuf,smb_rcls,NT_STATUS_V(ntstatus));
 142                 SSVAL(outbuf,smb_flg2, SVAL(outbuf,smb_flg2)|FLAGS2_32_BIT_ERROR_CODES);
 143                 DEBUG(3,("error packet at %s(%d) cmd=%d (%s) %s\n",
 144                          file, line,
 145                          (int)CVAL(outbuf,smb_com),
 146                          smb_fn_name(CVAL(outbuf,smb_com)),
 147                          nt_errstr(ntstatus)));
 148         } else {
 149                 /* We're returning a DOS error only. */
 150                 if (eclass == 0 && NT_STATUS_V(ntstatus)) {
 151                         ntstatus_to_dos(ntstatus, &eclass, &ecode);
 152                 }
 153
 154                 SSVAL(outbuf,smb_flg2, SVAL(outbuf,smb_flg2)&~FLAGS2_32_BIT_ERROR_CODES);
 155                 SSVAL(outbuf,smb_rcls,eclass);
 156                 SSVAL(outbuf,smb_err,ecode);
 157
 158                 DEBUG(3,("error packet at %s(%d) cmd=%d (%s) eclass=%d ecode=%d\n",
 159                           file, line,
 160                           (int)CVAL(outbuf,smb_com),
 161                           smb_fn_name(CVAL(outbuf,smb_com)),
 162                           eclass,
 163                           ecode));
 164         }
 165
 166         return outsize;
 167 }