r12225: r11729@cabra: derrell | 2005-12-13 22:59:45 -0500
[samba.git] / source3 / libsmb / clientgen.c
index 560d391320f6dbf6558038aa082049fb9189e26a..2f980adcf8733f4a99005047f5aa0b1a7ec10626 100644 (file)
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
 
-#define NO_SYSLOG
-
 #include "includes.h"
 
-/*
- * Change the port number used to call on 
- */
+/****************************************************************************
+ Change the timeout (in milliseconds).
+****************************************************************************/
+
+unsigned int cli_set_timeout(struct cli_state *cli, unsigned int timeout)
+{
+       unsigned int old_timeout = cli->timeout;
+       cli->timeout = timeout;
+       return old_timeout;
+}
+
+/****************************************************************************
+ Change the port number used to call on.
+****************************************************************************/
+
 int cli_set_port(struct cli_state *cli, int port)
 {
        cli->port = port;
@@ -32,49 +42,49 @@ 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.
 The timeout is in milliseconds
-
 This is exactly the same as receive_smb except that it never returns
 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.
Read an smb from a fd ignoring all keepalive packets. Note that the buffer 
+ *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
+ 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)
 {
-  BOOL ret;
-
-  for(;;)
-  {
-    ret = receive_smb(fd, buffer, timeout);
-
-    if (!ret)
-    {
-      DEBUG(10,("client_receive_smb failed\n"));
-      show_msg(buffer);
-      return ret;
-    }
-
-    /* Ignore session keepalive packets. */
-    if(CVAL(buffer,0) != SMBkeepalive)
-      break;
-  }
-  show_msg(buffer);
-  return ret;
-}
+       BOOL ret;
 
+       for(;;) {
+               ret = receive_smb_raw(fd, buffer, timeout);
+
+               if (!ret) {
+                       DEBUG(10,("client_receive_smb failed\n"));
+                       show_msg(buffer);
+                       return ret;
+               }
+
+               /* Ignore session keepalive packets. */
+               if(CVAL(buffer,0) != SMBkeepalive)
+                       break;
+       }
+       show_msg(buffer);
+       return ret;
+}
 
 /****************************************************************************
-recv an smb
+ Recv an smb.
 ****************************************************************************/
+
 BOOL cli_receive_smb(struct cli_state *cli)
 {
+       extern int smb_read_error;
        BOOL ret;
 
        /* fd == -1 causes segfaults -- Tom (tom@ninja.nl) */
-       if (cli->fd == -1) return False; 
+       if (cli->fd == -1)
+               return False; 
 
  again:
        ret = client_receive_smb(cli->fd,cli->inbuf,cli->timeout);
@@ -96,14 +106,38 @@ BOOL cli_receive_smb(struct cli_state *cli)
                }
        }
 
-        /* If the server is not responding, note that now */
+       /* If the server is not responding, note that now */
 
-        if (!ret) {
-                close(cli->fd);
-                cli->fd = -1;
-        }
+       if (!ret) {
+               cli->smb_rw_error = smb_read_error;
+               close(cli->fd);
+               cli->fd = -1;
+               return ret;
+       }
 
-       return ret;
+       if (!cli_check_sign_mac(cli)) {
+               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;
+}
+
+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);
 }
 
 /****************************************************************************
@@ -120,7 +154,7 @@ BOOL cli_send_smb(struct cli_state *cli)
        if (cli->fd == -1)
                return False;
 
-       cli_caclulate_sign_mac(cli);
+       cli_calculate_sign_mac(cli);
 
        len = smb_len(cli->outbuf) + 4;
 
@@ -129,11 +163,17 @@ BOOL cli_send_smb(struct cli_state *cli)
                if (ret <= 0) {
                        close(cli->fd);
                        cli->fd = -1;
-                       DEBUG(0,("Error writing %d bytes to client. %d\n", (int)len,(int)ret));
+                       cli->smb_rw_error = WRITE_ERROR;
+                       DEBUG(0,("Error writing %d bytes to client. %d (%s)\n",
+                               (int)len,(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;
 }
 
@@ -149,55 +189,75 @@ void cli_setup_packet(struct cli_state *cli)
        SSVAL(cli->outbuf,smb_mid,cli->mid);
        if (cli->protocol > PROTOCOL_CORE) {
                uint16 flags2;
-               SCVAL(cli->outbuf,smb_flg,0x8);
+               if (cli->case_sensitive) {
+                       SCVAL(cli->outbuf,smb_flg,0x0);
+               } else {
+                       /* Default setting, case insensitive. */
+                       SCVAL(cli->outbuf,smb_flg,0x8);
+               }
                flags2 = FLAGS2_LONG_PATH_COMPONENTS;
-               if (cli->capabilities & CAP_UNICODE) {
+               if (cli->capabilities & CAP_UNICODE)
                        flags2 |= FLAGS2_UNICODE_STRINGS;
-               }
-               if (cli->capabilities & CAP_STATUS32) {
+               if (cli->capabilities & CAP_DFS)
+                       flags2 |= FLAGS2_DFS_PATHNAMES;
+               if (cli->capabilities & CAP_STATUS32)
                        flags2 |= FLAGS2_32_BIT_ERROR_CODES;
-               }
-               if (cli->use_spnego) {
+               if (cli->use_spnego)
                        flags2 |= FLAGS2_EXTENDED_SECURITY;
-               }
-               if (cli->sign_info.use_smb_signing 
-                   || cli->sign_info.temp_smb_signing)
-                       flags2 |= FLAGS2_SMB_SECURITY_SIGNATURES;
                SSVAL(cli->outbuf,smb_flg2, flags2);
        }
 }
 
 /****************************************************************************
-setup the bcc length of the packet from a pointer to the end of the data
+ Setup the bcc length of the packet from a pointer to the end of the data.
 ****************************************************************************/
+
 void cli_setup_bcc(struct cli_state *cli, void *p)
 {
        set_message_bcc(cli->outbuf, PTR_DIFF(p, smb_buf(cli->outbuf)));
 }
 
+/****************************************************************************
+ Initialise credentials of a client structure.
+****************************************************************************/
+
+void cli_init_creds(struct cli_state *cli, const char *username, const char *domain, const char *password)
+{
+       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));
+}
 
 /****************************************************************************
-initialise credentials of a client structure
+ Set the signing state (used from the command line).
 ****************************************************************************/
-void cli_init_creds(struct cli_state *cli, const struct ntuser_creds *usr)
+
+void cli_setup_signing_state(struct cli_state *cli, int signing_state)
 {
-        /* copy_nt_creds(&cli->usr, usr); */
-       safe_strcpy(cli->domain   , usr->domain   , sizeof(usr->domain   )-1);
-       safe_strcpy(cli->user_name, usr->user_name, sizeof(usr->user_name)-1);
-       memcpy(&cli->pwd, &usr->pwd, sizeof(usr->pwd));
-        cli->ntlmssp_flags = usr->ntlmssp_flags;
-        cli->ntlmssp_cli_flgs = usr != NULL ? usr->ntlmssp_flags : 0;
-
-        DEBUG(10,("cli_init_creds: user %s domain %s flgs: %x\nntlmssp_cli_flgs:%x\n",
-               cli->user_name, cli->domain,
-               cli->ntlmssp_flags,cli->ntlmssp_cli_flgs));
-}
+       if (signing_state == Undefined)
+               return;
+
+       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;
+
+       if (signing_state == Required) 
+               cli->sign_info.mandatory_signing = True;
+}
 
 /****************************************************************************
-initialise a client structure
+ Initialise a client structure.
 ****************************************************************************/
+
 struct cli_state *cli_initialise(struct cli_state *cli)
 {
         BOOL alloced_cli = False;
@@ -209,16 +269,15 @@ struct cli_state *cli_initialise(struct cli_state *cli)
        }
 
        if (!cli) {
-               cli = (struct cli_state *)malloc(sizeof(*cli));
+               cli = SMB_MALLOC_P(struct cli_state);
                if (!cli)
                        return NULL;
                ZERO_STRUCTP(cli);
                 alloced_cli = True;
        }
 
-       if (cli->initialised) {
-               cli_shutdown(cli);
-       }
+       if (cli->initialised)
+               cli_close_connection(cli);
 
        ZERO_STRUCTP(cli);
 
@@ -232,34 +291,46 @@ 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);
-       cli->inbuf = (char *)malloc(cli->bufsize);
+       cli->outbuf = (char *)SMB_MALLOC(cli->bufsize+SAFETY_MARGIN);
+       cli->inbuf = (char *)SMB_MALLOC(cli->bufsize+SAFETY_MARGIN);
        cli->oplock_handler = cli_oplock_ack;
-       if (lp_use_spnego()) {
-               cli->use_spnego = True;
-       }
+       cli->case_sensitive = False;
+       cli->smb_rw_error = 0;
+
+       cli->use_spnego = lp_client_use_spnego();
+
+       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")) {
+       if (getenv("CLI_FORCE_DOSERR"))
                cli->force_dos_errors = True;
-       }
 
-       /* A way to attempt to force SMB signing */
-       if (getenv("CLI_FORCE_SMB_SIGNING"))
-               cli->sign_info.negotiated_smb_signing = True;
+       if (lp_client_signing()) 
+               cli->sign_info.allow_smb_signing = True;
+
+       if (lp_client_signing() == Required) 
+               cli->sign_info.mandatory_signing = True;
                                    
        if (!cli->outbuf || !cli->inbuf)
                 goto error;
 
-       if ((cli->mem_ctx = talloc_init_named("cli based talloc")) == NULL)
+       if ((cli->mem_ctx = talloc_init("cli based talloc")) == NULL)
                 goto error;
 
        memset(cli->outbuf, 0, cli->bufsize);
        memset(cli->inbuf, 0, cli->bufsize);
 
-       cli->nt_pipe_fnum = 0;
+
+#if defined(DEVELOPER)
+       /* just because we over-allocate, doesn't mean it's right to use it */
+       clobber_region(FUNCTION_MACRO, __LINE__, cli->outbuf+cli->bufsize, SAFETY_MARGIN);
+       clobber_region(FUNCTION_MACRO, __LINE__, cli->inbuf+cli->bufsize, SAFETY_MARGIN);
+#endif
+
+       /* initialise signing */
+       cli_null_set_signing(cli);
 
        cli->initialised = 1;
        cli->allocated = alloced_cli;
@@ -280,43 +351,183 @@ struct cli_state *cli_initialise(struct cli_state *cli)
 }
 
 /****************************************************************************
-shutdown a client structure
+ External interface.
+ Close an open named pipe over SMB. Free any authentication data.
+ ****************************************************************************/
+
+void cli_rpc_pipe_close(struct rpc_pipe_client *cli)
+{
+       if (!cli_close(cli->cli, cli->fnum)) {
+               DEBUG(0,("cli_rpc_pipe_close: cli_close failed on pipe %s, "
+                         "fnum 0x%x "
+                         "to machine %s.  Error was %s\n",
+                         cli->pipe_name,
+                         (int) cli->fnum,
+                         cli->cli->desthost,
+                         cli_errstr(cli->cli)));
+       }
+
+       if (cli->auth.cli_auth_data_free_func) {
+               (*cli->auth.cli_auth_data_free_func)(&cli->auth);
+       }
+
+       DEBUG(10,("cli_rpc_pipe_close: closed pipe %s to machine %s\n",
+               cli->pipe_name, cli->cli->desthost ));
+
+       DLIST_REMOVE(cli->cli->pipe_list, cli);
+       talloc_destroy(cli->mem_ctx);
+}
+
+/****************************************************************************
+ Close all pipes open on this session.
 ****************************************************************************/
-void cli_shutdown(struct cli_state *cli)
+
+void cli_nt_pipes_close(struct cli_state *cli)
+{
+       struct rpc_pipe_client *cp, *next;
+
+       for (cp = cli->pipe_list; cp; cp = next) {
+               next = cp->next;
+               cli_rpc_pipe_close(cp);
+       }
+}
+
+/****************************************************************************
+ Close a client connection and free the memory without destroying cli itself.
+****************************************************************************/
+
+void cli_close_connection(struct cli_state *cli)
 {
-       BOOL allocated;
+       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 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 != DO_NOT_DO_TDIS ) ) {
+               cli_tdis(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->mem_ctx)
+       if (cli->mem_ctx) {
                talloc_destroy(cli->mem_ctx);
+               cli->mem_ctx = NULL;
+       }
 
-       if (cli->fd != -1) 
+       if (cli->fd != -1) {
                close(cli->fd);
-       allocated = cli->allocated;
+       }
+       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);
-       } 
+       }
 }
 
-
 /****************************************************************************
-set socket options on a open connection
+ Set socket options on a open connection.
 ****************************************************************************/
-void cli_sockopt(struct cli_state *cli, char *options)
+
+void cli_sockopt(struct cli_state *cli, const char *options)
 {
        set_socket_options(cli->fd, options);
 }
 
 /****************************************************************************
-set the PID to use for smb messages. Return the old pid.
+ Set the PID to use for smb messages. Return the old pid.
 ****************************************************************************/
+
 uint16 cli_setpid(struct cli_state *cli, uint16 pid)
 {
        uint16 ret = cli->pid;
        cli->pid = 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)
+{
+        if (cli->fd == -1) {
+                DEBUG(3, ("cli_send_keepalive: fd == -1\n"));
+                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 True;
+}
+
+/****************************************************************************
+ Send/receive a SMBecho command: ping the server
+****************************************************************************/
+
+BOOL cli_echo(struct cli_state *cli, unsigned char *data, size_t length)
+{
+       char *p;
+
+       SMB_ASSERT(length < 1024);
+
+       memset(cli->outbuf,'\0',smb_size);
+       set_message(cli->outbuf,1,length,True);
+       SCVAL(cli->outbuf,smb_com,SMBecho);
+       SSVAL(cli->outbuf,smb_tid,65535);
+       SSVAL(cli->outbuf,smb_vwv0,1);
+       cli_setup_packet(cli);
+       p = smb_buf(cli->outbuf);
+       memcpy(p, data, length);
+       p += length;
+
+       cli_setup_bcc(cli, p);
+
+       cli_send_smb(cli);
+       if (!cli_receive_smb(cli)) {
+               return False;
+       }
+
+       if (cli_is_error(cli)) {
+               return False;
+       }
+       return True;
+}