r23784: use the GPLv3 boilerplate as recommended by the FSF and the license text
[ira/wip.git] / source3 / libsmb / clientgen.c
index 8342df0f1d14e35bd54e9bc7d3cc4ca13552a9f2..29d4d9c33419b9ee270bbb305dc1abab16784c96 100644 (file)
@@ -2,10 +2,11 @@
    Unix SMB/CIFS implementation.
    SMB client generic functions
    Copyright (C) Andrew Tridgell 1994-1998
+   Copyright (C) Jeremy Allison 2007.
    
    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,
    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"
 
+extern int smb_read_error;
+
 /****************************************************************************
  Change the timeout (in milliseconds).
 ****************************************************************************/
@@ -46,50 +48,71 @@ int cli_set_port(struct cli_state *cli, int port)
  *MUST* be of size BUFFER_SIZE+SAFETY_MARGIN.
  The timeout is in milliseconds
 
- This is exactly the same as receive_smb except that it never returns
+ This is exactly the same as receive_smb except that it can be set to never return
  a session keepalive packet (just as receive_smb used to do).
  receive_smb was changed to return keepalives as the oplock processing means this call
  should never go into a blocking read.
 ****************************************************************************/
 
-static BOOL client_receive_smb(int fd,char *buffer, unsigned int timeout)
+static ssize_t client_receive_smb(struct cli_state *cli, BOOL eat_keepalives, size_t maxlen)
 {
-       BOOL ret;
+       ssize_t len;
+       int fd = cli->fd;
+       char *buffer = cli->inbuf;
+       unsigned int timeout = cli->timeout;
 
        for(;;) {
-               ret = receive_smb_raw(fd, buffer, timeout);
+               len = receive_smb_raw(fd, buffer, timeout, maxlen);
 
-               if (!ret) {
+               if (len < 0) {
                        DEBUG(10,("client_receive_smb failed\n"));
                        show_msg(buffer);
-                       return ret;
+                       return len;
                }
 
                /* Ignore session keepalive packets. */
-               if(CVAL(buffer,0) != SMBkeepalive)
-                       break;
+               if (eat_keepalives && (CVAL(buffer,0) == SMBkeepalive)) {
+                       continue;
+               }
+               break;
+       }
+
+       if (cli_encryption_on(cli)) {
+               NTSTATUS status = cli_decrypt_message(cli);
+               if (!NT_STATUS_IS_OK(status)) {
+                       DEBUG(0, ("SMB decryption failed on incoming packet! Error %s\n",
+                               nt_errstr(status)));
+                       cli->smb_rw_error = READ_BAD_DECRYPT;
+                       close(cli->fd);
+                       cli->fd = -1;
+                       return -1;
+               }
        }
        show_msg(buffer);
-       return ret;
+       return len;
 }
 
 /****************************************************************************
  Recv an smb.
 ****************************************************************************/
 
-BOOL cli_receive_smb(struct cli_state *cli)
+BOOL cli_receive_smb_internal(struct cli_state *cli, BOOL eat_keepalives)
 {
-       extern int smb_read_error;
-       BOOL ret;
+       ssize_t len;
 
        /* fd == -1 causes segfaults -- Tom (tom@ninja.nl) */
        if (cli->fd == -1)
                return False; 
 
  again:
-       ret = client_receive_smb(cli->fd,cli->inbuf,cli->timeout);
+       len = client_receive_smb(cli, eat_keepalives, 0);
+
+       if (len >= 0 && !eat_keepalives && (CVAL(cli->inbuf,0) == SMBkeepalive)) {
+               /* Give back the keepalive. */
+               return True;
+       }
        
-       if (ret) {
+       if (len > 0) {
                /* it might be an oplock break request */
                if (!(CVAL(cli->inbuf, smb_flg) & FLAG_REPLY) &&
                    CVAL(cli->inbuf,smb_com) == SMBlockingX &&
@@ -98,7 +121,9 @@ BOOL cli_receive_smb(struct cli_state *cli)
                        if (cli->oplock_handler) {
                                int fnum = SVAL(cli->inbuf,smb_vwv2);
                                unsigned char level = CVAL(cli->inbuf,smb_vwv3+1);
-                               if (!cli->oplock_handler(cli, fnum, level)) return False;
+                               if (!cli->oplock_handler(cli, fnum, level)) {
+                                       return False;
+                               }
                        }
                        /* try to prevent loops */
                        SCVAL(cli->inbuf,smb_com,0xFF);
@@ -107,31 +132,171 @@ BOOL cli_receive_smb(struct cli_state *cli)
        }
 
        /* If the server is not responding, note that now */
-
-       if (!ret) {
+       if (len < 0) {
+                DEBUG(0, ("Receiving SMB: Server stopped responding\n"));
                cli->smb_rw_error = smb_read_error;
                close(cli->fd);
                cli->fd = -1;
-               return ret;
+               return False;
        }
 
        if (!cli_check_sign_mac(cli)) {
+               /*
+                * If we get a signature failure in sessionsetup, then
+                * the server sometimes just reflects the sent signature
+                * back to us. Detect this and allow the upper layer to
+                * retrieve the correct Windows error message.
+                */
+               if (CVAL(cli->outbuf,smb_com) == SMBsesssetupX &&
+                       (smb_len(cli->inbuf) > (smb_ss_field + 8 - 4)) &&
+                       (SVAL(cli->inbuf,smb_flg2) & FLAGS2_SMB_SECURITY_SIGNATURES) &&
+                       memcmp(&cli->outbuf[smb_ss_field],&cli->inbuf[smb_ss_field],8) == 0 &&
+                       cli_is_error(cli)) {
+
+                       /*
+                        * Reflected signature on login error. 
+                        * Set bad sig but don't close fd.
+                        */
+                       cli->smb_rw_error = READ_BAD_SIG;
+                       return True;
+               }
+
                DEBUG(0, ("SMB Signature verification failed on incoming packet!\n"));
                cli->smb_rw_error = READ_BAD_SIG;
                close(cli->fd);
                cli->fd = -1;
                return False;
-       };
+       }
+
        return True;
 }
 
+/****************************************************************************
+ Recv an smb - eat keepalives.
+****************************************************************************/
+
+BOOL cli_receive_smb(struct cli_state *cli)
+{
+       return cli_receive_smb_internal(cli, True);
+}
+
+/****************************************************************************
+ Recv an smb - return keepalives.
+****************************************************************************/
+
+BOOL cli_receive_smb_return_keepalive(struct cli_state *cli)
+{
+       return cli_receive_smb_internal(cli, False);
+}
+
+/****************************************************************************
+ Read the data portion of a readX smb.
+ The timeout is in milliseconds
+****************************************************************************/
+
+ssize_t cli_receive_smb_data(struct cli_state *cli, char *buffer, size_t len)
+{
+       if (cli->timeout > 0) {
+               return read_socket_with_timeout(cli->fd, buffer, len, len, cli->timeout);
+       } else {
+               return read_data(cli->fd, buffer, len);
+       }
+}
+
+/****************************************************************************
+ Read a smb readX header.
+ We can only use this if encryption and signing are off.
+****************************************************************************/
+
+BOOL cli_receive_smb_readX_header(struct cli_state *cli)
+{
+       ssize_t len, offset;
+
+       if (cli->fd == -1)
+               return False; 
+
+ again:
+
+       /* Read up to the size of a readX header reply. */
+       len = client_receive_smb(cli, True, (smb_size - 4) + 24);
+       
+       if (len > 0) {
+               /* it might be an oplock break request */
+               if (!(CVAL(cli->inbuf, smb_flg) & FLAG_REPLY) &&
+                   CVAL(cli->inbuf,smb_com) == SMBlockingX &&
+                   SVAL(cli->inbuf,smb_vwv6) == 0 &&
+                   SVAL(cli->inbuf,smb_vwv7) == 0) {
+                       ssize_t total_len = smb_len(cli->inbuf);
+
+                       if (total_len > CLI_SAMBA_MAX_LARGE_READX_SIZE+SAFETY_MARGIN) {
+                               goto read_err;
+                       }
+
+                       /* Read the rest of the data. */
+                       if ((total_len - len > 0) &&
+                           !cli_receive_smb_data(cli,cli->inbuf+len,total_len - len)) {
+                               goto read_err;
+                       }
+
+                       if (cli->oplock_handler) {
+                               int fnum = SVAL(cli->inbuf,smb_vwv2);
+                               unsigned char level = CVAL(cli->inbuf,smb_vwv3+1);
+                               if (!cli->oplock_handler(cli, fnum, level)) return False;
+                       }
+                       /* try to prevent loops */
+                       SCVAL(cli->inbuf,smb_com,0xFF);
+                       goto again;
+               }
+       }
+
+       /* If it's not the above size it probably was an error packet. */
+
+       if ((len == (smb_size - 4) + 24) && !cli_is_error(cli)) {
+               /* Check it's a non-chained readX reply. */
+               if (!(CVAL(cli->inbuf, smb_flg) & FLAG_REPLY) ||
+                       (CVAL(cli->inbuf,smb_vwv0) != 0xFF) ||
+                       (CVAL(cli->inbuf,smb_com) != SMBreadX)) {
+                       /* 
+                        * We're not coping here with asnyc replies to
+                        * other calls. Punt here - we need async client
+                        * libs for this.
+                        */
+                       goto read_err;
+               }
+
+               /* 
+                * We know it's a readX reply - ensure we've read the
+                * padding bytes also.
+                */
+
+               offset = SVAL(cli->inbuf,smb_vwv6);
+               if (offset > len) {
+                       ssize_t ret;
+                       size_t padbytes = offset - len;
+                       ret = cli_receive_smb_data(cli,smb_buf(cli->inbuf),padbytes);
+                       if (ret != padbytes) {
+                               goto read_err;
+                       }
+               }
+       }
+
+       return True;
+
+  read_err:
+
+       cli->smb_rw_error = smb_read_error = READ_ERROR;
+       close(cli->fd);
+       cli->fd = -1;
+       return False;
+}
+
 static ssize_t write_socket(int fd, const char *buf, size_t len)
 {
         ssize_t ret=0;
                                                                                                                                             
         DEBUG(6,("write_socket(%d,%d)\n",fd,(int)len));
         ret = write_data(fd,buf,len);
-                                                                                                                                            
+
         DEBUG(6,("write_socket(%d,%d) wrote %d\n",fd,(int)len,(int)ret));
         if(ret <= 0)
                 DEBUG(0,("write_socket: Error writing %d bytes to socket %d: ERRNO = %s\n",
@@ -149,18 +314,36 @@ BOOL cli_send_smb(struct cli_state *cli)
        size_t len;
        size_t nwritten=0;
        ssize_t ret;
+       char *buf_out = cli->outbuf;
+       BOOL enc_on = cli_encryption_on(cli);
 
        /* fd == -1 causes segfaults -- Tom (tom@ninja.nl) */
-       if (cli->fd == -1)
+       if (cli->fd == -1) {
                return False;
+       }
 
        cli_calculate_sign_mac(cli);
 
-       len = smb_len(cli->outbuf) + 4;
+       if (enc_on) {
+               NTSTATUS status = cli_encrypt_message(cli, &buf_out);
+               if (!NT_STATUS_IS_OK(status)) {
+                       close(cli->fd);
+                       cli->fd = -1;
+                       cli->smb_rw_error = WRITE_ERROR;
+                       DEBUG(0,("Error in encrypting client message. Error %s\n",
+                               nt_errstr(status) ));
+                       return False;
+               }
+       }
+
+       len = smb_len(buf_out) + 4;
 
        while (nwritten < len) {
-               ret = write_socket(cli->fd,cli->outbuf+nwritten,len - nwritten);
+               ret = write_socket(cli->fd,buf_out+nwritten,len - nwritten);
                if (ret <= 0) {
+                       if (enc_on) {
+                               cli_free_enc_buffer(cli, buf_out);
+                       }
                        close(cli->fd);
                        cli->fd = -1;
                        cli->smb_rw_error = WRITE_ERROR;
@@ -170,10 +353,14 @@ BOOL cli_send_smb(struct cli_state *cli)
                }
                nwritten += ret;
        }
+
+       cli_free_enc_buffer(cli, buf_out);
+
        /* Increment the mid so we can tell between responses. */
        cli->mid++;
-       if (!cli->mid)
+       if (!cli->mid) {
                cli->mid++;
+       }
        return True;
 }
 
@@ -214,7 +401,7 @@ void cli_setup_packet(struct cli_state *cli)
 
 void cli_setup_bcc(struct cli_state *cli, void *p)
 {
-       set_message_bcc(cli->outbuf, PTR_DIFF(p, smb_buf(cli->outbuf)));
+       set_message_bcc(NULL,cli->outbuf, PTR_DIFF(p, smb_buf(cli->outbuf)));
 }
 
 /****************************************************************************
@@ -255,12 +442,12 @@ void cli_setup_signing_state(struct cli_state *cli, int signing_state)
 }
 
 /****************************************************************************
- Initialise a client structure.
+ Initialise a client structure. Always returns a malloc'ed struct.
 ****************************************************************************/
 
-struct cli_state *cli_initialise(struct cli_state *cli)
+struct cli_state *cli_initialise(void)
 {
-        BOOL alloced_cli = False;
+       struct cli_state *cli = NULL;
 
        /* Check the effective uid - make sure we are not setuid */
        if (is_setuid_root()) {
@@ -268,17 +455,11 @@ struct cli_state *cli_initialise(struct cli_state *cli)
                return NULL;
        }
 
+       cli = SMB_MALLOC_P(struct cli_state);
        if (!cli) {
-               cli = SMB_MALLOC_P(struct cli_state);
-               if (!cli)
-                       return NULL;
-               ZERO_STRUCTP(cli);
-                alloced_cli = True;
+               return NULL;
        }
 
-       if (cli->initialised)
-               cli_close_connection(cli);
-
        ZERO_STRUCTP(cli);
 
        cli->port = 0;
@@ -333,7 +514,6 @@ struct cli_state *cli_initialise(struct cli_state *cli)
        cli_null_set_signing(cli);
 
        cli->initialised = 1;
-       cli->allocated = alloced_cli;
 
        return cli;
 
@@ -343,10 +523,7 @@ struct cli_state *cli_initialise(struct cli_state *cli)
 
         SAFE_FREE(cli->inbuf);
         SAFE_FREE(cli->outbuf);
-
-        if (alloced_cli)
-                SAFE_FREE(cli);
-
+       SAFE_FREE(cli);
         return NULL;
 }
 
@@ -403,10 +580,10 @@ void cli_nt_pipes_close(struct cli_state *cli)
 }
 
 /****************************************************************************
Close a client connection and free the memory without destroying cli itself.
Shutdown a client structure.
 ****************************************************************************/
 
-void cli_close_connection(struct cli_state *cli)
+void cli_shutdown(struct cli_state *cli)
 {
        cli_nt_pipes_close(cli);
 
@@ -430,6 +607,8 @@ void cli_close_connection(struct cli_state *cli)
        SAFE_FREE(cli->inbuf);
 
        cli_free_signing_context(cli);
+       cli_free_encryption_context(cli);
+
        data_blob_free(&cli->secblob);
        data_blob_free(&cli->user_session_key);
 
@@ -443,20 +622,8 @@ void cli_close_connection(struct cli_state *cli)
        }
        cli->fd = -1;
        cli->smb_rw_error = 0;
-}
-
-/****************************************************************************
- Shutdown a client structure.
-****************************************************************************/
 
-void cli_shutdown(struct cli_state *cli)
-{
-       BOOL allocated = cli->allocated;
-       cli_close_connection(cli);
-       ZERO_STRUCTP(cli);
-       if (allocated) {
-               free(cli);
-       }
+       SAFE_FREE(cli);
 }
 
 /****************************************************************************
@@ -520,7 +687,7 @@ BOOL cli_echo(struct cli_state *cli, unsigned char *data, size_t length)
        SMB_ASSERT(length < 1024);
 
        memset(cli->outbuf,'\0',smb_size);
-       set_message(cli->outbuf,1,length,True);
+       set_message(NULL,cli->outbuf,1,length,True);
        SCVAL(cli->outbuf,smb_com,SMBecho);
        SSVAL(cli->outbuf,smb_tid,65535);
        SSVAL(cli->outbuf,smb_vwv0,1);