r3315: converted the libcli/raw/ code to use the generic socket library. This
[jelmer/samba4-debian.git] / source / include / cli_context.h
index 6887160987b8fe63f9ff504ef8aa53bb76b7457c..bdf90018d5bd379084361270d91d2731e5bebc56 100644 (file)
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
 
-#ifndef _CLI_CONTEXT_H
-#define _CLI_CONTEXT_H
+#ifndef _SMBCLI_CONTEXT_H
+#define _SMBCLI_CONTEXT_H
 
-struct cli_tree;  /* forward declare */
-struct cli_request;  /* forward declare */
-struct cli_session;  /* forward declare */
-struct cli_transport;  /* forward declare */
+struct smbcli_tree;  /* forward declare */
+struct smbcli_request;  /* forward declare */
+struct smbcli_session;  /* forward declare */
+struct smbcli_transport;  /* forward declare */
 
 /* context that will be and has been negotiated between the client and server */
-struct cli_negotiate {
+struct smbcli_negotiate {
        /* 
         * negotiated maximum transmit size - this is given to us by the server
         */
@@ -48,17 +48,7 @@ struct cli_negotiate {
        DATA_BLOB secblob;      /* cryptkey or negTokenInit blob */
        uint32_t sesskey;
        
-       struct {
-               void (*sign_outgoing_message)(struct cli_request *req);
-               BOOL (*check_incoming_message)(struct cli_request *req);
-               void (*free_signing_context)(struct cli_transport *transport);
-               void *signing_context;
-               BOOL negotiated_smb_signing;
-               BOOL allow_smb_signing;
-               BOOL doing_signing;
-               BOOL mandatory_signing;
-               BOOL seen_valid; /* Have I ever seen a validly signed packet? */
-       } sign_info;
+       struct smb_signing_context sign_info;
 
        /* capabilities that the server reported */
        uint32_t capabilities;
@@ -68,16 +58,11 @@ struct cli_negotiate {
        uint_t readbraw_supported:1;
        uint_t writebraw_supported:1;
 
-       const char *server_domain;
+       char *server_domain;
 };
        
 /* this is the context for a SMB socket associated with the socket itself */
-struct cli_socket {
-       TALLOC_CTX *mem_ctx;    /* life of socket pool */
-
-       /* when the reference count reaches zero then the socket is destroyed */
-       int reference_count;
-
+struct smbcli_socket {
        struct in_addr dest_ip;
        /* dest hostname (which may or may not be a DNS name) */
        char *hostname;
@@ -85,8 +70,7 @@ struct cli_socket {
        /* the port used */
        int port;
        
-       /* the open file descriptor */
-       int fd;
+       struct socket_context *sock;
 
        /* a count of the number of packets we have received. We
         * actually only care about zero/non-zero at this stage */
@@ -103,31 +87,26 @@ struct cli_socket {
   this structure allows applications to control the behaviour of the
   client library
 */
-struct cli_options {
+struct smbcli_options {
        uint_t use_oplocks:1;
        uint_t use_level2_oplocks:1;
        uint_t use_spnego:1;
 };
 
 /* this is the context for the client transport layer */
-struct cli_transport {
-       TALLOC_CTX *mem_ctx;
-
-       /* when the reference count reaches zero then the transport is destroyed */
-       int reference_count;
-
+struct smbcli_transport {
        /* socket level info */
-       struct cli_socket *socket;
+       struct smbcli_socket *socket;
 
        /* the next mid to be allocated - needed for signing and
           request matching */
        uint16_t next_mid;
        
        /* negotiated protocol information */
-       struct cli_negotiate negotiate;
+       struct smbcli_negotiate negotiate;
 
        /* options to control the behaviour of the client code */
-       struct cli_options options;
+       struct smbcli_options options;
 
        /* is a readbraw pending? we need to handle that case
           specially on receiving packets */
@@ -137,7 +116,7 @@ struct cli_transport {
           called once every period seconds while we are waiting
           for a packet */
        struct {
-               void (*func)(struct cli_transport *, void *);
+               void (*func)(struct smbcli_transport *, void *);
                void *private;
                uint_t period;
        } idle;
@@ -162,17 +141,17 @@ struct cli_transport {
 
        struct {
                /* a oplock break request handler */
-               BOOL (*handler)(struct cli_transport *transport, 
+               BOOL (*handler)(struct smbcli_transport *transport, 
                                uint16_t tid, uint16_t fnum, uint8_t level, void *private);
                /* private data passed to the oplock handler */
                void *private;
        } oplock;
 
        /* a list of async requests that are pending for send on this connection */
-       struct cli_request *pending_send;
+       struct smbcli_request *pending_send;
 
        /* a list of async requests that are pending for receive on this connection */
-       struct cli_request *pending_recv;
+       struct smbcli_request *pending_recv;
 
        /* remember the called name - some sub-protocols require us to
           know the server name */
@@ -197,14 +176,9 @@ struct cli_transport {
 /* this is the context for the user */
 
 /* this is the context for the session layer */
-struct cli_session {   
-       TALLOC_CTX *mem_ctx;    /* life of session */
-
-       /* when the reference count reaches zero then the session is destroyed */
-       int reference_count;    
-       
+struct smbcli_session {        
        /* transport layer info */
-       struct cli_transport *transport;
+       struct smbcli_transport *transport;
        
        /* after a session setup the server provides us with
           a vuid identifying the security context */
@@ -220,17 +194,11 @@ struct cli_session {
 };
 
 /* 
-   cli_tree context: internal state for a tree connection. 
+   smbcli_tree context: internal state for a tree connection. 
  */
-struct cli_tree {
-       /* life of tree tree */
-       TALLOC_CTX *mem_ctx;
-
-       /* when the reference count reaches zero then the tree is destroyed */
-       int reference_count;    
-
+struct smbcli_tree {
        /* session layer info */
-       struct cli_session *session;
+       struct smbcli_session *session;
 
        uint16_t tid;                   /* tree id, aka cnum */
        char *device;
@@ -241,30 +209,27 @@ struct cli_tree {
 /*
   a client request moves between the following 4 states.
 */
-enum cli_request_state {CLI_REQUEST_INIT, /* we are creating the request */
-                       CLI_REQUEST_SEND, /* the request is in the outgoing socket Q */
-                       CLI_REQUEST_RECV, /* we are waiting for a matching reply */
-                       CLI_REQUEST_DONE, /* the request is finished */
-                       CLI_REQUEST_ERROR}; /* a packet or transport level error has occurred */
+enum smbcli_request_state {SMBCLI_REQUEST_INIT, /* we are creating the request */
+                       SMBCLI_REQUEST_SEND, /* the request is in the outgoing socket Q */
+                       SMBCLI_REQUEST_RECV, /* we are waiting for a matching reply */
+                       SMBCLI_REQUEST_DONE, /* the request is finished */
+                       SMBCLI_REQUEST_ERROR}; /* a packet or transport level error has occurred */
 
 /* the context for a single SMB request. This is passed to any request-context 
  * functions (similar to context.h, the server version).
  * This will allow requests to be multi-threaded. */
-struct cli_request {
+struct smbcli_request {
        /* allow a request to be part of a list of requests */
-       struct cli_request *next, *prev;
+       struct smbcli_request *next, *prev;
 
-       /* a talloc context for the lifetime of this request */
-       TALLOC_CTX *mem_ctx;
-       
        /* each request is in one of 4 possible states */
-       enum cli_request_state state;
+       enum smbcli_request_state state;
        
        /* a request always has a transport context, nearly always has
           a session context and usually has a tree context */
-       struct cli_transport *transport;
-       struct cli_session *session;
-       struct cli_tree *tree;
+       struct smbcli_transport *transport;
+       struct smbcli_session *session;
+       struct smbcli_tree *tree;
 
        /* the flags2 from the SMB request, in raw form (host byte
           order). Used to parse strings */
@@ -281,6 +246,10 @@ struct cli_request {
           expecting a reply from the server. */
        uint_t one_way_request:1;
 
+       /* set this when the request should only increment the signing
+          counter by one */
+       uint_t sign_single_increment:1;
+
        /* the mid of this packet - used to match replies */
        uint16_t mid;
 
@@ -295,34 +264,33 @@ struct cli_request {
           library (the application), not private to the library
        */
        struct {
-               void (*fn)(struct cli_request *);
+               void (*fn)(struct smbcli_request *);
                void *private;
        } async;
 };
 
 /* 
-   cli_state: internal state used in libcli library for single-threaded callers, 
+   smbcli_state: internal state used in libcli library for single-threaded callers, 
    i.e. a single session on a single socket. 
  */
-struct cli_state {
-       TALLOC_CTX *mem_ctx;    /* life of client pool */
-       struct cli_transport *transport;
-       struct cli_session *session;
-       struct cli_tree *tree;
+struct smbcli_state {
+       struct smbcli_transport *transport;
+       struct smbcli_session *session;
+       struct smbcli_tree *tree;
        struct substitute_context substitute;
 };
 
 /* useful way of catching wct errors with file and line number */
-#define CLI_CHECK_MIN_WCT(req, wcount) if ((req)->in.wct < (wcount)) { \
+#define SMBCLI_CHECK_MIN_WCT(req, wcount) if ((req)->in.wct < (wcount)) { \
       DEBUG(1,("Unexpected WCT %d at %s(%d) - expected min %d\n", (req)->in.wct, __FILE__, __LINE__, wcount)); \
       req->status = NT_STATUS_INVALID_PARAMETER; \
       goto failed; \
 }
 
-#define CLI_CHECK_WCT(req, wcount) if ((req)->in.wct != (wcount)) { \
+#define SMBCLI_CHECK_WCT(req, wcount) if ((req)->in.wct != (wcount)) { \
       DEBUG(1,("Unexpected WCT %d at %s(%d) - expected %d\n", (req)->in.wct, __FILE__, __LINE__, wcount)); \
       req->status = NT_STATUS_INVALID_PARAMETER; \
       goto failed; \
 }
 
-#endif /* _CLI_CONTEXT_H */
+#endif /* _SMBCLI_CONTEXT_H */