2 Unix SMB/CIFS implementation.
4 DCERPC client side interface structures
6 Copyright (C) Tim Potter 2003
7 Copyright (C) Andrew Tridgell 2003-2005
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 enum dcerpc_transport_t {
25 NCACN_NP, NCACN_IP_TCP, NCACN_IP_UDP, NCACN_VNS_IPC, NCACN_VNS_SPP,
26 NCACN_AT_DSP, NCADG_AT_DDP, NCALRPC, NCACN_UNIX_STREAM, NCADG_UNIX_DGRAM,
27 NCACN_HTTP, NCADG_IPX, NCACN_SPX };
30 this defines a generic security context for signed/sealed dcerpc pipes.
32 struct dcerpc_connection;
33 struct dcerpc_security {
34 struct dcerpc_auth *auth_info;
35 struct gensec_security *generic_state;
37 /* get the session key */
38 NTSTATUS (*session_key)(struct dcerpc_connection *, DATA_BLOB *);
42 this holds the information that is not specific to a particular rpc context_id
44 struct dcerpc_connection {
46 uint32_t srv_max_xmit_frag;
47 uint32_t srv_max_recv_frag;
49 struct dcerpc_security security_state;
50 const char *binding_string;
52 struct dcerpc_transport {
53 enum dcerpc_transport_t transport;
56 NTSTATUS (*shutdown_pipe)(struct dcerpc_connection *);
58 const char *(*peer_name)(struct dcerpc_connection *);
60 /* send a request to the server */
61 NTSTATUS (*send_request)(struct dcerpc_connection *, DATA_BLOB *, BOOL trigger_read);
63 /* send a read request to the server */
64 NTSTATUS (*send_read)(struct dcerpc_connection *);
66 /* get an event context for the connection */
67 struct event_context *(*event_context)(struct dcerpc_connection *);
69 /* a callback to the dcerpc code when a full fragment
71 void (*recv_data)(struct dcerpc_connection *, DATA_BLOB *, NTSTATUS status);
74 /* pending requests */
75 struct rpc_request *pending;
77 /* private pointer for pending full requests */
78 void *full_request_private;
80 /* the next context_id to be assigned */
81 uint32_t next_context_id;
85 this encapsulates a full dcerpc client side pipe
90 struct dcerpc_syntax_id syntax;
91 struct dcerpc_syntax_id transfer_syntax;
93 struct dcerpc_connection *conn;
95 /* the last fault code from a DCERPC fault */
96 uint32_t last_fault_code;
100 /* dcerpc pipe flags */
101 #define DCERPC_DEBUG_PRINT_IN (1<<0)
102 #define DCERPC_DEBUG_PRINT_OUT (1<<1)
103 #define DCERPC_DEBUG_PRINT_BOTH (DCERPC_DEBUG_PRINT_IN | DCERPC_DEBUG_PRINT_OUT)
105 #define DCERPC_DEBUG_VALIDATE_IN (1<<2)
106 #define DCERPC_DEBUG_VALIDATE_OUT (1<<3)
107 #define DCERPC_DEBUG_VALIDATE_BOTH (DCERPC_DEBUG_VALIDATE_IN | DCERPC_DEBUG_VALIDATE_OUT)
109 #define DCERPC_CONNECT (1<<4)
110 #define DCERPC_SIGN (1<<5)
111 #define DCERPC_SEAL (1<<6)
113 #define DCERPC_PUSH_BIGENDIAN (1<<7)
114 #define DCERPC_PULL_BIGENDIAN (1<<8)
116 #define DCERPC_SCHANNEL_BDC (1<<9)
117 #define DCERPC_SCHANNEL_WORKSTATION (1<<10)
118 #define DCERPC_SCHANNEL_DOMAIN (1<<11)
119 #define DCERPC_SCHANNEL_ANY (DCERPC_SCHANNEL_BDC| \
120 DCERPC_SCHANNEL_DOMAIN| \
121 DCERPC_SCHANNEL_WORKSTATION)
123 /* use a 128 bit session key */
124 #define DCERPC_SCHANNEL_128 (1<<12)
126 /* check incoming pad bytes */
127 #define DCERPC_DEBUG_PAD_CHECK (1<<13)
129 /* set LIBNDR_FLAG_REF_ALLOC flag when decoding NDR */
130 #define DCERPC_NDR_REF_ALLOC (1<<14)
132 #define DCERPC_AUTH_OPTIONS (DCERPC_SEAL|DCERPC_SIGN|DCERPC_SCHANNEL_ANY|DCERPC_AUTH_SPNEGO|DCERPC_AUTH_KRB5)
134 /* enable spnego auth */
135 #define DCERPC_AUTH_SPNEGO (1<<15)
137 /* enable krb5 auth */
138 #define DCERPC_AUTH_KRB5 (1<<16)
141 this is used to find pointers to calls
143 struct dcerpc_interface_call {
146 NTSTATUS (*ndr_push)(struct ndr_push *, int , void *);
147 NTSTATUS (*ndr_pull)(struct ndr_pull *, int , void *);
148 void (*ndr_print)(struct ndr_print *, const char *, int, void *);
151 struct dcerpc_endpoint_list {
153 const char * const *names;
156 struct dcerpc_authservice_list {
158 const char * const *names;
161 struct dcerpc_interface_table {
165 const char *helpstring;
167 const struct dcerpc_interface_call *calls;
168 const struct dcerpc_endpoint_list *endpoints;
169 const struct dcerpc_authservice_list *authservices;
172 struct dcerpc_interface_list {
173 struct dcerpc_interface_list *prev, *next;
174 const struct dcerpc_interface_table *table;
177 /* this describes a binding to a particular transport/pipe */
178 struct dcerpc_binding {
179 enum dcerpc_transport_t transport;
181 uint16_t object_version;
183 const char *endpoint;
184 const char *authservice;
185 const char **options;
190 enum rpc_request_state {
196 handle for an async dcerpc request
199 struct rpc_request *next, *prev;
200 struct dcerpc_pipe *p;
203 enum rpc_request_state state;
208 /* use by the ndr level async recv call */
210 const struct dcerpc_interface_table *table;
217 void (*callback)(struct rpc_request *);