Simplify async programming a bit with helper routines
[kai/samba.git] / source3 / libsmb / clientgen.c
index 0a134f715dcbd6e4276468441e0877d4b2f7fbc9..d94427809cecd7d479d1fb7d45f19d335b89fb6a 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/>.
 */
 
-#define NO_SYSLOG
-
 #include "includes.h"
 
+/*******************************************************************
+ Setup the word count and byte count for a client smb message.
+********************************************************************/
+
+int cli_set_message(char *buf,int num_words,int num_bytes,bool zero)
+{
+       if (zero && (num_words || num_bytes)) {
+               memset(buf + smb_size,'\0',num_words*2 + num_bytes);
+       }
+       SCVAL(buf,smb_wct,num_words);
+       SSVAL(buf,smb_vwv + num_words*SIZEOFWORD,num_bytes);
+       smb_setlen(buf,smb_size + num_words*2 + num_bytes - 4);
+       return (smb_size + num_words*2 + num_bytes);
+}
+
 /****************************************************************************
  Change the timeout (in milliseconds).
 ****************************************************************************/
@@ -44,8 +57,7 @@ int cli_set_port(struct cli_state *cli, int port)
 }
 
 /****************************************************************************
- Read an smb from a fd ignoring all keepalive packets. Note that the buffer 
- *MUST* be of size BUFFER_SIZE+SAFETY_MARGIN.
+ Read an smb from a fd ignoring all keepalive packets.
  The timeout is in milliseconds
 
  This is exactly the same as receive_smb except that it never returns
@@ -54,44 +66,82 @@ int cli_set_port(struct cli_state *cli, int port)
  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, size_t maxlen)
 {
-       BOOL ret;
+       size_t len;
 
        for(;;) {
-               ret = receive_smb(fd, buffer, timeout);
+               NTSTATUS status;
+
+               set_smb_read_error(&cli->smb_rw_error, SMB_READ_OK);
 
-               if (!ret) {
+               status = receive_smb_raw(cli->fd, cli->inbuf, cli->bufsize,
+                                       cli->timeout, maxlen, &len);
+               if (!NT_STATUS_IS_OK(status)) {
                        DEBUG(10,("client_receive_smb failed\n"));
-                       show_msg(buffer);
-                       return ret;
+                       show_msg(cli->inbuf);
+
+                       if (NT_STATUS_EQUAL(status, NT_STATUS_END_OF_FILE)) {
+                               set_smb_read_error(&cli->smb_rw_error,
+                                                  SMB_READ_EOF);
+                               return -1;
+                       }
+
+                       if (NT_STATUS_EQUAL(status, NT_STATUS_IO_TIMEOUT)) {
+                               set_smb_read_error(&cli->smb_rw_error,
+                                                  SMB_READ_TIMEOUT);
+                               return -1;
+                       }
+
+                       set_smb_read_error(&cli->smb_rw_error, SMB_READ_ERROR);
+                       return -1;
+               }
+
+               /*
+                * I don't believe len can be < 0 with NT_STATUS_OK
+                * returned above, but this check doesn't hurt. JRA.
+                */
+
+               if ((ssize_t)len < 0) {
+                       return len;
                }
 
                /* Ignore session keepalive packets. */
-               if(CVAL(buffer,0) != SMBkeepalive)
+               if(CVAL(cli->inbuf,0) != SMBkeepalive) {
                        break;
+               }
        }
-       show_msg(buffer);
-       return ret;
+
+       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 = SMB_READ_BAD_DECRYPT;
+                       return -1;
+               }
+       }
+
+       show_msg(cli->inbuf);
+       return len;
 }
 
 /****************************************************************************
  Recv an smb.
 ****************************************************************************/
 
-BOOL cli_receive_smb(struct cli_state *cli)
+bool cli_receive_smb(struct cli_state *cli)
 {
-       extern int smb_read_error;
-       BOOL ret;
+       ssize_t len;
 
        /* fd == -1 causes segfaults -- Tom (tom@ninja.nl) */
        if (cli->fd == -1)
-               return False; 
+               return false; 
 
  again:
-       ret = client_receive_smb(cli->fd,cli->inbuf,cli->timeout);
+       len = client_receive_smb(cli, 0);
        
-       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 &&
@@ -100,7 +150,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);
@@ -109,83 +161,247 @@ BOOL cli_receive_smb(struct cli_state *cli)
        }
 
        /* If the server is not responding, note that now */
-
-       if (!ret) {
-               cli->smb_rw_error = smb_read_error;
+       if (len < 0) {
+                DEBUG(0, ("Receiving SMB: Server stopped responding\n"));
                close(cli->fd);
                cli->fd = -1;
-               return ret;
+               return false;
        }
 
-       if (!cli_check_sign_mac(cli)) {
+       if (!cli_check_sign_mac(cli, cli->inbuf)) {
+               /*
+                * 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 = SMB_READ_BAD_SIG;
+                       return true;
+               }
+
                DEBUG(0, ("SMB Signature verification failed on incoming packet!\n"));
-               cli->smb_rw_error = READ_BAD_SIG;
+               cli->smb_rw_error = SMB_READ_BAD_SIG;
                close(cli->fd);
                cli->fd = -1;
-               return False;
+               return false;
        };
-       return True;
+       return true;
+}
+
+/****************************************************************************
+ 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)
+{
+       NTSTATUS status;
+
+       set_smb_read_error(&cli->smb_rw_error, SMB_READ_OK);
+
+       status = read_socket_with_timeout(
+               cli->fd, buffer, len, len, cli->timeout, NULL);
+       if (NT_STATUS_IS_OK(status)) {
+               return len;
+       }
+
+       if (NT_STATUS_EQUAL(status, NT_STATUS_END_OF_FILE)) {
+               set_smb_read_error(&cli->smb_rw_error, SMB_READ_EOF);
+               return -1;
+       }
+
+       if (NT_STATUS_EQUAL(status, NT_STATUS_IO_TIMEOUT)) {
+               set_smb_read_error(&cli->smb_rw_error, SMB_READ_TIMEOUT);
+               return -1;
+       }
+
+       set_smb_read_error(&cli->smb_rw_error, SMB_READ_ERROR);
+       return -1;
+}
+
+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",
+                        (int)len, fd, strerror(errno) ));
+
+        return(ret);
 }
 
 /****************************************************************************
  Send an smb to a fd.
 ****************************************************************************/
 
-BOOL cli_send_smb(struct cli_state *cli)
+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)
-               return False;
+               return false;
 
-       cli_calculate_sign_mac(cli);
+       cli_calculate_sign_mac(cli, cli->outbuf);
 
-       len = smb_len(cli->outbuf) + 4;
+       if (enc_on) {
+               NTSTATUS status = cli_encrypt_message(cli, cli->outbuf,
+                                                     &buf_out);
+               if (!NT_STATUS_IS_OK(status)) {
+                       close(cli->fd);
+                       cli->fd = -1;
+                       cli->smb_rw_error = SMB_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,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 = SMB_WRITE_ERROR;
+                       DEBUG(0,("Error writing %d bytes to client. %d (%s)\n",
+                               (int)len,(int)ret, strerror(errno) ));
+                       return false;
+               }
+               nwritten += ret;
+       }
+
+       if (enc_on) {
+               cli_free_enc_buffer(cli, buf_out);
+       }
+
+       /* Increment the mid so we can tell between responses. */
+       cli->mid++;
+       if (!cli->mid)
+               cli->mid++;
+       return true;
+}
+
+/****************************************************************************
+ Send a "direct" writeX smb to a fd.
+****************************************************************************/
+
+bool cli_send_smb_direct_writeX(struct cli_state *cli,
+                               const char *p,
+                               size_t extradata)
+{
+       /* First length to send is the offset to the data. */
+       size_t len = SVAL(cli->outbuf,smb_vwv11) + 4;
+       size_t nwritten=0;
+       ssize_t ret;
+
+       /* fd == -1 causes segfaults -- Tom (tom@ninja.nl) */
+       if (cli->fd == -1) {
+               return false;
+       }
+
+       if (client_is_signing_on(cli)) {
+               DEBUG(0,("cli_send_smb_large: cannot send signed packet.\n"));
+               return false;
+       }
 
        while (nwritten < len) {
                ret = write_socket(cli->fd,cli->outbuf+nwritten,len - nwritten);
                if (ret <= 0) {
                        close(cli->fd);
                        cli->fd = -1;
-                       cli->smb_rw_error = WRITE_ERROR;
+                       cli->smb_rw_error = SMB_WRITE_ERROR;
                        DEBUG(0,("Error writing %d bytes to client. %d (%s)\n",
                                (int)len,(int)ret, strerror(errno) ));
-                       return False;
+                       return false;
                }
                nwritten += ret;
        }
+
+       /* Now write the extra data. */
+       nwritten=0;
+       while (nwritten < extradata) {
+               ret = write_socket(cli->fd,p+nwritten,extradata - nwritten);
+               if (ret <= 0) {
+                       close(cli->fd);
+                       cli->fd = -1;
+                       cli->smb_rw_error = SMB_WRITE_ERROR;
+                       DEBUG(0,("Error writing %d extradata "
+                               "bytes to client. %d (%s)\n",
+                               (int)extradata,(int)ret, strerror(errno) ));
+                       return false;
+               }
+               nwritten += ret;
+       }
+
        /* Increment the mid so we can tell between responses. */
        cli->mid++;
        if (!cli->mid)
                cli->mid++;
-       return True;
+       return true;
 }
 
 /****************************************************************************
  Setup basics in a outgoing packet.
 ****************************************************************************/
 
-void cli_setup_packet(struct cli_state *cli)
+void cli_setup_packet_buf(struct cli_state *cli, char *buf)
 {
+       uint16 flags2;
        cli->rap_error = 0;
-       SSVAL(cli->outbuf,smb_pid,cli->pid);
-       SSVAL(cli->outbuf,smb_uid,cli->vuid);
-       SSVAL(cli->outbuf,smb_mid,cli->mid);
-       if (cli->protocol > PROTOCOL_CORE) {
-               uint16 flags2;
-               SCVAL(cli->outbuf,smb_flg,0x8);
-               flags2 = FLAGS2_LONG_PATH_COMPONENTS;
-               if (cli->capabilities & CAP_UNICODE)
-                       flags2 |= FLAGS2_UNICODE_STRINGS;
-               if (cli->capabilities & CAP_STATUS32)
-                       flags2 |= FLAGS2_32_BIT_ERROR_CODES;
-               if (cli->use_spnego)
-                       flags2 |= FLAGS2_EXTENDED_SECURITY;
-               SSVAL(cli->outbuf,smb_flg2, flags2);
+       SIVAL(buf,smb_rcls,0);
+       SSVAL(buf,smb_pid,cli->pid);
+       memset(buf+smb_pidhigh, 0, 12);
+       SSVAL(buf,smb_uid,cli->vuid);
+       SSVAL(buf,smb_mid,cli->mid);
+
+       if (cli->protocol <= PROTOCOL_CORE) {
+               return;
        }
+
+       if (cli->case_sensitive) {
+               SCVAL(buf,smb_flg,0x0);
+       } else {
+               /* Default setting, case insensitive. */
+               SCVAL(buf,smb_flg,0x8);
+       }
+       flags2 = FLAGS2_LONG_PATH_COMPONENTS;
+       if (cli->capabilities & CAP_UNICODE)
+               flags2 |= FLAGS2_UNICODE_STRINGS;
+       if ((cli->capabilities & CAP_DFS) && cli->dfsroot)
+               flags2 |= FLAGS2_DFS_PATHNAMES;
+       if (cli->capabilities & CAP_STATUS32)
+               flags2 |= FLAGS2_32_BIT_ERROR_CODES;
+       if (cli->use_spnego)
+               flags2 |= FLAGS2_EXTENDED_SECURITY;
+       SSVAL(buf,smb_flg2, flags2);
+}
+
+void cli_setup_packet(struct cli_state *cli)
+{
+       cli_setup_packet_buf(cli, cli->outbuf);
 }
 
 /****************************************************************************
@@ -201,15 +417,16 @@ void cli_setup_bcc(struct cli_state *cli, void *p)
  Initialise credentials of a client structure.
 ****************************************************************************/
 
-void cli_init_creds(struct cli_state *cli, const struct ntuser_creds *usr)
+void cli_init_creds(struct cli_state *cli, const char *username, const char *domain, const char *password)
 {
-        /* copy_nt_creds(&cli->usr, usr); */
-       fstrcpy(cli->domain   , usr->domain);
-       fstrcpy(cli->user_name, usr->user_name);
-       memcpy(&cli->pwd, &usr->pwd, sizeof(usr->pwd));
+       fstrcpy(cli->domain, domain);
+       fstrcpy(cli->user_name, username);
+       pwd_set_cleartext(&cli->pwd, password);
+       if (!*username) {
+               cli->pwd.null_pwd = true;
+       }
 
-        DEBUG(10,("cli_init_creds: user %s domain %s\n",
-               cli->user_name, cli->domain));
+        DEBUG(10,("cli_init_creds: user %s domain %s\n", cli->user_name, cli->domain));
 }
 
 /****************************************************************************
@@ -221,25 +438,25 @@ void cli_setup_signing_state(struct cli_state *cli, int signing_state)
        if (signing_state == Undefined)
                return;
 
-       if (signing_state == False) {
-               cli->sign_info.allow_smb_signing = False;
-               cli->sign_info.mandatory_signing = False;
+       if (signing_state == false) {
+               cli->sign_info.allow_smb_signing = false;
+               cli->sign_info.mandatory_signing = false;
                return;
        }
 
-       cli->sign_info.allow_smb_signing = True;
+       cli->sign_info.allow_smb_signing = true;
 
        if (signing_state == Required) 
-               cli->sign_info.mandatory_signing = True;
+               cli->sign_info.mandatory_signing = true;
 }
 
 /****************************************************************************
- 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()) {
@@ -247,19 +464,11 @@ struct cli_state *cli_initialise(struct cli_state *cli)
                return NULL;
        }
 
+       cli = TALLOC_ZERO_P(NULL, struct cli_state);
        if (!cli) {
-               cli = (struct cli_state *)malloc(sizeof(*cli));
-               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;
        cli->fd = -1;
        cli->cnum = -1;
@@ -270,32 +479,31 @@ struct cli_state *cli_initialise(struct cli_state *cli)
        cli->timeout = 20000; /* Timeout is in milliseconds. */
        cli->bufsize = CLI_BUFFER_SIZE+4;
        cli->max_xmit = cli->bufsize;
-       cli->outbuf = (char *)malloc(cli->bufsize+SAFETY_MARGIN);
-       cli->inbuf = (char *)malloc(cli->bufsize+SAFETY_MARGIN);
+       cli->outbuf = (char *)SMB_MALLOC(cli->bufsize+SAFETY_MARGIN);
+       cli->inbuf = (char *)SMB_MALLOC(cli->bufsize+SAFETY_MARGIN);
        cli->oplock_handler = cli_oplock_ack;
+       cli->case_sensitive = false;
+       cli->smb_rw_error = SMB_READ_OK;
 
        cli->use_spnego = lp_client_use_spnego();
 
-       cli->capabilities = CAP_UNICODE | CAP_STATUS32;
+       cli->capabilities = CAP_UNICODE | CAP_STATUS32 | CAP_DFS;
 
        /* Set the CLI_FORCE_DOSERR environment variable to test
           client routines using DOS errors instead of STATUS32
           ones.  This intended only as a temporary hack. */    
        if (getenv("CLI_FORCE_DOSERR"))
-               cli->force_dos_errors = True;
+               cli->force_dos_errors = true;
 
        if (lp_client_signing()) 
-               cli->sign_info.allow_smb_signing = True;
+               cli->sign_info.allow_smb_signing = true;
 
        if (lp_client_signing() == Required) 
-               cli->sign_info.mandatory_signing = True;
+               cli->sign_info.mandatory_signing = true;
                                    
        if (!cli->outbuf || !cli->inbuf)
                 goto error;
 
-       if ((cli->mem_ctx = talloc_init("cli based talloc")) == NULL)
-                goto error;
-
        memset(cli->outbuf, 0, cli->bufsize);
        memset(cli->inbuf, 0, cli->bufsize);
 
@@ -309,13 +517,7 @@ struct cli_state *cli_initialise(struct cli_state *cli)
        /* initialise signing */
        cli_null_set_signing(cli);
 
-       cli->nt_pipe_fnum = 0;
-       cli->saved_netlogon_pipe_fnum = 0;
-
        cli->initialised = 1;
-       cli->allocated = alloced_cli;
-
-       cli->pipe_idx = -1;
 
        return cli;
 
@@ -325,83 +527,62 @@ 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;
 }
 
 /****************************************************************************
-close the session
+ Close all pipes open on this session.
 ****************************************************************************/
 
-void cli_nt_session_close(struct cli_state *cli)
+void cli_nt_pipes_close(struct cli_state *cli)
 {
-       if (cli->ntlmssp_pipe_state) {
-               ntlmssp_client_end(&cli->ntlmssp_pipe_state);
+       while (cli->pipe_list != NULL) {
+               /*
+                * No TALLOC_FREE here!
+                */
+               talloc_free(cli->pipe_list);
        }
-
-       if (cli->nt_pipe_fnum != 0)
-               cli_close(cli, cli->nt_pipe_fnum);
-
-       cli->nt_pipe_fnum = 0;
-       cli->pipe_idx = -1;
 }
 
 /****************************************************************************
-close the NETLOGON session holding the session key for NETSEC
+ Shutdown a client structure.
 ****************************************************************************/
 
-void cli_nt_netlogon_netsec_session_close(struct cli_state *cli)
+void cli_shutdown(struct cli_state *cli)
 {
-       if (cli->saved_netlogon_pipe_fnum != 0) {
-               cli_close(cli, cli->saved_netlogon_pipe_fnum);
-               cli->saved_netlogon_pipe_fnum = 0;
+       cli_nt_pipes_close(cli);
+
+       /*
+        * tell our peer to free his resources.  Wihtout this, when an
+        * application attempts to do a graceful shutdown and calls
+        * smbc_free_context() to clean up all connections, some connections
+        * can remain active on the peer end, until some (long) timeout period
+        * later.  This tree disconnect forces the peer to clean up, since the
+        * connection will be going away.
+        *
+        * Also, do not do tree disconnect when cli->smb_rw_error is SMB_DO_NOT_DO_TDIS
+        * the only user for this so far is smbmount which passes opened connection
+        * down to kernel's smbfs module.
+        */
+       if ( (cli->cnum != (uint16)-1) && (cli->smb_rw_error != SMB_DO_NOT_DO_TDIS ) ) {
+               cli_tdis(cli);
        }
-}
-
-/****************************************************************************
- Close a client connection and free the memory without destroying cli itself.
-****************************************************************************/
-
-void cli_close_connection(struct cli_state *cli)
-{
-       cli_nt_session_close(cli);
-       cli_nt_netlogon_netsec_session_close(cli);
-
+        
        SAFE_FREE(cli->outbuf);
        SAFE_FREE(cli->inbuf);
 
        cli_free_signing_context(cli);
        data_blob_free(&cli->secblob);
+       data_blob_free(&cli->user_session_key);
 
-       if (cli->ntlmssp_pipe_state) 
-               ntlmssp_client_end(&cli->ntlmssp_pipe_state);
-
-       if (cli->mem_ctx) {
-               talloc_destroy(cli->mem_ctx);
-               cli->mem_ctx = NULL;
-       }
-
-       if (cli->fd != -1) 
+       if (cli->fd != -1) {
                close(cli->fd);
+       }
        cli->fd = -1;
-       cli->smb_rw_error = 0;
+       cli->smb_rw_error = SMB_READ_OK;
 
-}
-
-/****************************************************************************
- 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);
+       TALLOC_FREE(cli);
 }
 
 /****************************************************************************
@@ -424,20 +605,178 @@ uint16 cli_setpid(struct cli_state *cli, uint16 pid)
        return ret;
 }
 
+/****************************************************************************
+ Set the case sensitivity flag on the packets. Returns old state.
+****************************************************************************/
+
+bool cli_set_case_sensitive(struct cli_state *cli, bool case_sensitive)
+{
+       bool ret = cli->case_sensitive;
+       cli->case_sensitive = case_sensitive;
+       return ret;
+}
+
 /****************************************************************************
 Send a keepalive packet to the server
 ****************************************************************************/
-BOOL cli_send_keepalive(struct cli_state *cli)
+
+bool cli_send_keepalive(struct cli_state *cli)
 {
         if (cli->fd == -1) {
                 DEBUG(3, ("cli_send_keepalive: fd == -1\n"));
-                return False;
+                return false;
         }
         if (!send_keepalive(cli->fd)) {
                 close(cli->fd);
                 cli->fd = -1;
                 DEBUG(0,("Error sending keepalive packet to client.\n"));
-                return False;
+                return false;
         }
-        return True;
+        return true;
+}
+
+/**
+ * @brief: Collect a echo reply
+ * @param[in] req      The corresponding async request
+ *
+ * There might be more than one echo reply. This helper pulls the reply out of
+ * the data stream. If all expected replies have arrived, declare the
+ * async_req done.
+ */
+
+static void cli_echo_recv_helper(struct async_req *req)
+{
+       struct cli_request *cli_req;
+       uint8_t wct;
+       uint16_t *vwv;
+       uint16_t num_bytes;
+       uint8_t *bytes;
+       NTSTATUS status;
+
+       status = cli_pull_reply(req, &wct, &vwv, &num_bytes, &bytes);
+       if (!NT_STATUS_IS_OK(status)) {
+               async_req_error(req, status);
+               return;
+       }
+
+       cli_req = talloc_get_type_abort(req->private_data, struct cli_request);
+
+       if ((num_bytes != cli_req->data.echo.data.length)
+           || (memcmp(cli_req->data.echo.data.data, bytes,
+                      num_bytes) != 0)) {
+               async_req_error(req, NT_STATUS_INVALID_NETWORK_RESPONSE);
+               return;
+       }
+
+       cli_req->data.echo.num_echos -= 1;
+
+       if (cli_req->data.echo.num_echos == 0) {
+               client_set_trans_sign_state_off(cli_req->cli, cli_req->mid);
+               async_req_done(req);
+               return;
+       }
+
+       return;
+}
+
+/**
+ * @brief Send SMBEcho requests
+ * @param[in] mem_ctx  The memory context to put the async_req on
+ * @param[in] ev       The event context that will call us back
+ * @param[in] cli      The connection to send the echo to
+ * @param[in] num_echos        How many times do we want to get the reply?
+ * @param[in] data     The data we want to get back
+ * @retval The async request
+ */
+
+struct async_req *cli_echo_send(TALLOC_CTX *mem_ctx, struct event_context *ev,
+                               struct cli_state *cli, uint16_t num_echos,
+                               DATA_BLOB data)
+{
+       uint16_t vwv[1];
+       uint8_t *data_copy;
+       struct async_req *result;
+       struct cli_request *req;
+
+       SSVAL(vwv, 0, num_echos);
+
+       data_copy = (uint8_t *)talloc_memdup(mem_ctx, data.data, data.length);
+       if (data_copy == NULL) {
+               return NULL;
+       }
+
+       result = cli_request_send(mem_ctx, ev, cli, SMBecho, 0, 1, vwv,
+                                 data.length, data.data);
+       if (result == NULL) {
+               TALLOC_FREE(data_copy);
+               return NULL;
+       }
+       req = talloc_get_type_abort(result->private_data, struct cli_request);
+
+       client_set_trans_sign_state_on(cli, req->mid);
+
+       req->data.echo.num_echos = num_echos;
+       req->data.echo.data.data = talloc_move(req, &data_copy);
+       req->data.echo.data.length = data.length;
+
+       req->recv_helper.fn = cli_echo_recv_helper;
+
+       return result;
+}
+
+/**
+ * Get the result out from an echo request
+ * @param[in] req      The async_req from cli_echo_send
+ * @retval Did the server reply correctly?
+ */
+
+NTSTATUS cli_echo_recv(struct async_req *req)
+{
+       return async_req_simple_recv(req);
+}
+
+/**
+ * @brief Send/Receive SMBEcho requests
+ * @param[in] mem_ctx  The memory context to put the async_req on
+ * @param[in] ev       The event context that will call us back
+ * @param[in] cli      The connection to send the echo to
+ * @param[in] num_echos        How many times do we want to get the reply?
+ * @param[in] data     The data we want to get back
+ * @retval Did the server reply correctly?
+ */
+
+NTSTATUS cli_echo(struct cli_state *cli, uint16_t num_echos, DATA_BLOB data)
+{
+       TALLOC_CTX *frame = talloc_stackframe();
+       struct event_context *ev;
+       struct async_req *req;
+       NTSTATUS status = NT_STATUS_NO_MEMORY;
+
+       if (cli->fd_event != NULL) {
+               /*
+                * Can't use sync call while an async call is in flight
+                */
+               cli_set_error(cli, NT_STATUS_INVALID_PARAMETER);
+               goto fail;
+       }
+
+       ev = event_context_init(frame);
+       if (ev == NULL) {
+               goto fail;
+       }
+
+       req = cli_echo_send(frame, ev, cli, num_echos, data);
+       if (req == NULL) {
+               goto fail;
+       }
+
+       while (req->state < ASYNC_REQ_DONE) {
+               event_loop_once(ev);
+       }
+
+       status = cli_echo_recv(req);
+
+ fail:
+       TALLOC_FREE(frame);
+       return status;
 }