s3:smbd: Fix converity warning with _smb_setlen_large()
[metze/samba/wip.git] / source3 / smbd / error.c
index 92a7c11b153c073074a000464d7148dcd5d8392c..3f9ecaa2c5cc818b254e9e68f80f7c11a44062f6 100644 (file)
    Unix SMB/CIFS implementation.
    error packet handling
    Copyright (C) Andrew Tridgell 1992-1998
-   
+
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
-   the Free Software Foundation; either version 2 of the License, or
+   the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.
-   
+
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
-   
+
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #include "includes.h"
+#include "smbd/smbd.h"
+#include "smbd/globals.h"
 
-/* these can be set by some functions to override the error codes */
-int unix_ERR_class=SMB_SUCCESS;
-int unix_ERR_code=0;
-
-/* From lib/error.c */
-extern struct unix_error_map unix_dos_nt_errmap[];
-
-/****************************************************************************
- Create an error packet from a cached error.
-****************************************************************************/
-int cached_error_packet(char *outbuf,files_struct *fsp,int line,const char *file)
+bool use_nt_status(void)
 {
-       write_bmpx_struct *wbmpx = fsp->wbmpx_ptr;
-       int32 eclass = wbmpx->wr_errclass;
-       int32 err = wbmpx->wr_error;
-       /* We can now delete the auxiliary struct */
-       free((char *)wbmpx);
-       fsp->wbmpx_ptr = NULL;
-       return error_packet(outbuf,NT_STATUS_OK,eclass,err,line,file);
+       return lp_nt_status_support() && (global_client_caps & CAP_STATUS32);
 }
 
 /****************************************************************************
- Create an error packet from errno.
-****************************************************************************/
+ Create an error packet. Normally called using the ERROR() macro.
 
-int unix_error_packet(char *outbuf,int def_class,uint32 def_code,
-                     int line, const char *file)
-{
-       int eclass=def_class;
-       int ecode=def_code;
-       NTSTATUS ntstatus = NT_STATUS_OK;
-       int i=0;
-
-       if (unix_ERR_class != SMB_SUCCESS) {
-               eclass = unix_ERR_class;
-               ecode = unix_ERR_code;
-               unix_ERR_class = SMB_SUCCESS;
-               unix_ERR_code = 0;
-       } else {
-               while (unix_dos_nt_errmap[i].dos_class != 0) {
-                       if (unix_dos_nt_errmap[i].unix_error == errno) {
-                               eclass = unix_dos_nt_errmap[i].dos_class;
-                               ecode = unix_dos_nt_errmap[i].dos_code;
-                               ntstatus = unix_dos_nt_errmap[i].nt_error;
-                               break;
-                       }
-                       i++;
-               }
-       }
+ Setting eclass and ecode to zero and status to a valid NT error will
+ reply with an NT error if the client supports CAP_STATUS32, otherwise
+ it maps to and returns a DOS error if the client doesn't support CAP_STATUS32.
+ This is the normal mode of calling this function via reply_nterror(req, status).
 
-       return error_packet(outbuf,ntstatus,eclass,ecode,line,file);
-}
+ Setting eclass and ecode to non-zero and status to NT_STATUS_OK (0) will map
+ from a DOS error to an NT error and reply with an NT error if the client
+ supports CAP_STATUS32, otherwise it replies with the given DOS error.
+ This mode is currently not used in the server.
 
+ Setting both eclass, ecode and status to non-zero values allows a non-default
+ mapping from NT error codes to DOS error codes, and will return one or the
+ other depending on the client supporting CAP_STATUS32 or not. This is the
+ path taken by calling reply_botherror(req, eclass, ecode, status);
 
-/****************************************************************************
- Create an error packet. Normally called using the ERROR() macro.
+ Setting status to NT_STATUS_DOS(eclass, ecode) forces DOS errors even if the
+ client supports CAP_STATUS32. This is the path taken to force a DOS error
+ reply by calling reply_force_doserror(req, eclass, ecode).
+
+ Setting status only and eclass to -1 forces NT errors even if the client
+ doesn't support CAP_STATUS32. This mode is currently never used in the
+ server.
 ****************************************************************************/
 
-int error_packet(char *outbuf,NTSTATUS ntstatus,
-                uint8 eclass,uint32 ecode,int line, const char *file)
+void error_packet_set(char *outbuf, uint8_t eclass, uint32_t ecode, NTSTATUS ntstatus, int line, const char *file)
 {
-       int outsize = set_message(outbuf,0,0,True);
-       extern uint32 global_client_caps;
-
-       if (errno != 0)
-               DEBUG(3,("error string = %s\n",strerror(errno)));
-  
-       /*
-        * We can explicitly force 32 bit error codes even when the
-        * parameter "nt status" is set to no by pre-setting the
-        * FLAGS2_32_BIT_ERROR_CODES bit in the smb_flg2 outbuf.
-        * This is to allow work arounds for client bugs that are needed
-        * when talking with clients that normally expect nt status codes. JRA.
-        */
-
-       if ((lp_nt_status_support() || (SVAL(outbuf,smb_flg2) & FLAGS2_32_BIT_ERROR_CODES)) && (global_client_caps & CAP_STATUS32)) {
-               if (NT_STATUS_V(ntstatus) == 0 && eclass)
+       bool force_nt_status = False;
+       bool force_dos_status = False;
+
+       if (eclass == (uint8_t)-1) {
+               force_nt_status = True;
+       } else if (NT_STATUS_IS_DOS(ntstatus)) {
+               force_dos_status = True;
+       }
+
+       if (force_nt_status || (!force_dos_status && lp_nt_status_support() && (global_client_caps & CAP_STATUS32))) {
+               /* We're returning an NT error. */
+               if (NT_STATUS_V(ntstatus) == 0 && eclass) {
                        ntstatus = dos_to_ntstatus(eclass, ecode);
+               }
                SIVAL(outbuf,smb_rcls,NT_STATUS_V(ntstatus));
                SSVAL(outbuf,smb_flg2, SVAL(outbuf,smb_flg2)|FLAGS2_32_BIT_ERROR_CODES);
-               DEBUG(3,("error packet at %s(%d) cmd=%d (%s) %s\n",
+               /* This must not start with the word 'error', as this
+                * is reserved in the subunit stream protocol, causing
+                * false errors to show up when debugging is turned
+                * on */
+               DEBUG(3,("NT error packet at %s(%d) cmd=%d (%s) %s\n",
                         file, line,
                         (int)CVAL(outbuf,smb_com),
                         smb_fn_name(CVAL(outbuf,smb_com)),
-                        get_nt_error_msg(ntstatus)));
-               return outsize;
-       } 
+                        nt_errstr(ntstatus)));
+       } else {
+               /* We're returning a DOS error only,
+                * nt_status_to_dos() pulls DOS error codes out of the
+                * NTSTATUS */
+               if (NT_STATUS_IS_DOS(ntstatus) || (eclass == 0 && NT_STATUS_V(ntstatus))) {
+                       ntstatus_to_dos(ntstatus, &eclass, &ecode);
+               }
 
-       if (eclass == 0 && NT_STATUS_V(ntstatus))
-               ntstatus_to_dos(ntstatus, &eclass, &ecode);
+               SSVAL(outbuf,smb_flg2, SVAL(outbuf,smb_flg2)&~FLAGS2_32_BIT_ERROR_CODES);
+               SSVAL(outbuf,smb_rcls,eclass);
+               SSVAL(outbuf,smb_err,ecode);  
+
+               /* This must not start with the word 'error', as this
+                * is reserved in the subunit stream protocol, causing
+                * false errors to show up when debugging is turned
+                * on */
+               DEBUG(3,("DOS error packet at %s(%d) cmd=%d (%s) eclass=%d ecode=%d\n",
+                         file, line,
+                         (int)CVAL(outbuf,smb_com),
+                         smb_fn_name(CVAL(outbuf,smb_com)),
+                         eclass,
+                         ecode));
+       }
+}
 
-       SSVAL(outbuf,smb_flg2, SVAL(outbuf,smb_flg2)&~FLAGS2_32_BIT_ERROR_CODES);
-       SSVAL(outbuf,smb_rcls,eclass);
-       SSVAL(outbuf,smb_err,ecode);  
+size_t error_packet(char *outbuf, uint8_t eclass, uint32_t ecode, NTSTATUS ntstatus, int line, const char *file)
+{
+       size_t outsize = srv_set_message(outbuf,0,0,True);
+       error_packet_set(outbuf, eclass, ecode, ntstatus, line, file);
+       return outsize;
+}
 
-       DEBUG(3,("error packet at %s(%d) cmd=%d (%s) eclass=%d ecode=%d\n",
-                 file, line,
-                 (int)CVAL(outbuf,smb_com),
-                 smb_fn_name(CVAL(outbuf,smb_com)),
-                 eclass,
-                 ecode));
+void reply_nt_error(struct smb_request *req, NTSTATUS ntstatus,
+                   int line, const char *file)
+{
+       TALLOC_FREE(req->outbuf);
+       reply_outbuf(req, 0, 0);
+       error_packet_set((char *)req->outbuf, 0, 0, ntstatus, line, file);
+}
 
-       return outsize;
+/****************************************************************************
+ Forces a DOS error on the wire.
+****************************************************************************/
+
+void reply_force_dos_error(struct smb_request *req, uint8_t eclass, uint32_t ecode,
+                   int line, const char *file)
+{
+       TALLOC_FREE(req->outbuf);
+       reply_outbuf(req, 0, 0);
+       error_packet_set((char *)req->outbuf,
+                       eclass, ecode,
+                       NT_STATUS_DOS(eclass, ecode),
+                       line,
+                       file);
+}
+
+void reply_both_error(struct smb_request *req, uint8_t eclass, uint32_t ecode,
+                     NTSTATUS status, int line, const char *file)
+{
+       TALLOC_FREE(req->outbuf);
+       reply_outbuf(req, 0, 0);
+       error_packet_set((char *)req->outbuf, eclass, ecode, status,
+                        line, file);
+}
+
+void reply_openerror(struct smb_request *req, NTSTATUS status)
+{
+       if (NT_STATUS_EQUAL(status, NT_STATUS_OBJECT_NAME_COLLISION)) {
+               /*
+                * We hit an existing file, and if we're returning DOS
+                * error codes OBJECT_NAME_COLLISION would map to
+                * ERRDOS/183, we need to return ERRDOS/80, see bug
+                * 4852.
+                */
+               reply_botherror(req, NT_STATUS_OBJECT_NAME_COLLISION,
+                       ERRDOS, ERRfilexists);
+       } else if (NT_STATUS_EQUAL(status, NT_STATUS_TOO_MANY_OPENED_FILES)) {
+               /* EMFILE always seems to be returned as a DOS error.
+                * See bug 6837. NOTE this forces a DOS error on the wire
+                * even though it's calling reply_nterror(). */
+               reply_force_doserror(req, ERRDOS, ERRnofids);
+       } else {
+               reply_nterror(req, status);
+       }
 }