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.
27 #include <nt_status.h>
29 enum dcerpc_transport_t {
30 NCACN_NP, NCACN_IP_TCP, NCACN_IP_UDP, NCACN_VNS_IPC, NCACN_VNS_SPP,
31 NCACN_AT_DSP, NCADG_AT_DDP, NCALRPC, NCACN_UNIX_STREAM, NCADG_UNIX_DGRAM,
32 NCACN_HTTP, NCADG_IPX, NCACN_SPX };
35 this defines a generic security context for signed/sealed dcerpc pipes.
37 struct dcerpc_connection;
38 struct dcerpc_security {
39 struct dcerpc_auth *auth_info;
40 struct gensec_security *generic_state;
42 /* get the session key */
43 NTSTATUS (*session_key)(struct dcerpc_connection *, DATA_BLOB *);
47 this holds the information that is not specific to a particular rpc context_id
49 struct dcerpc_connection {
51 uint32_t srv_max_xmit_frag;
52 uint32_t srv_max_recv_frag;
54 struct dcerpc_security security_state;
55 const char *binding_string;
56 struct event_context *event_ctx;
58 struct dcerpc_transport {
59 enum dcerpc_transport_t transport;
62 NTSTATUS (*shutdown_pipe)(struct dcerpc_connection *);
64 const char *(*peer_name)(struct dcerpc_connection *);
66 /* send a request to the server */
67 NTSTATUS (*send_request)(struct dcerpc_connection *, DATA_BLOB *, BOOL trigger_read);
69 /* send a read request to the server */
70 NTSTATUS (*send_read)(struct dcerpc_connection *);
72 /* a callback to the dcerpc code when a full fragment
74 void (*recv_data)(struct dcerpc_connection *, DATA_BLOB *, NTSTATUS status);
77 /* Requests that have been sent, waiting for a reply */
78 struct rpc_request *pending;
80 /* Sync requests waiting to be shipped */
81 struct rpc_request *request_queue;
83 /* private pointer for pending binds */
86 /* private pointer for pending alter context requests */
89 /* the next context_id to be assigned */
90 uint32_t next_context_id;
94 this encapsulates a full dcerpc client side pipe
99 struct dcerpc_syntax_id syntax;
100 struct dcerpc_syntax_id transfer_syntax;
102 struct dcerpc_connection *conn;
104 /* the last fault code from a DCERPC fault */
105 uint32_t last_fault_code;
107 /* timeout for individual rpc requests, in seconds */
108 uint32_t request_timeout;
111 /* default timeout for all rpc requests, in seconds */
112 #define DCERPC_REQUEST_TIMEOUT 60
115 /* dcerpc pipe flags */
116 #define DCERPC_DEBUG_PRINT_IN (1<<0)
117 #define DCERPC_DEBUG_PRINT_OUT (1<<1)
118 #define DCERPC_DEBUG_PRINT_BOTH (DCERPC_DEBUG_PRINT_IN | DCERPC_DEBUG_PRINT_OUT)
120 #define DCERPC_DEBUG_VALIDATE_IN (1<<2)
121 #define DCERPC_DEBUG_VALIDATE_OUT (1<<3)
122 #define DCERPC_DEBUG_VALIDATE_BOTH (DCERPC_DEBUG_VALIDATE_IN | DCERPC_DEBUG_VALIDATE_OUT)
124 #define DCERPC_CONNECT (1<<4)
125 #define DCERPC_SIGN (1<<5)
126 #define DCERPC_SEAL (1<<6)
128 #define DCERPC_PUSH_BIGENDIAN (1<<7)
129 #define DCERPC_PULL_BIGENDIAN (1<<8)
131 #define DCERPC_SCHANNEL (1<<9)
133 /* use a 128 bit session key */
134 #define DCERPC_SCHANNEL_128 (1<<12)
136 /* check incoming pad bytes */
137 #define DCERPC_DEBUG_PAD_CHECK (1<<13)
139 /* set LIBNDR_FLAG_REF_ALLOC flag when decoding NDR */
140 #define DCERPC_NDR_REF_ALLOC (1<<14)
142 #define DCERPC_AUTH_OPTIONS (DCERPC_SEAL|DCERPC_SIGN|DCERPC_SCHANNEL|DCERPC_AUTH_SPNEGO|DCERPC_AUTH_KRB5)
144 /* enable spnego auth */
145 #define DCERPC_AUTH_SPNEGO (1<<15)
147 /* enable krb5 auth */
148 #define DCERPC_AUTH_KRB5 (1<<16)
150 #define DCERPC_SMB2 (1<<17)
153 this is used to find pointers to calls
155 struct dcerpc_interface_call {
158 ndr_push_flags_fn_t ndr_push;
159 ndr_pull_flags_fn_t ndr_pull;
160 ndr_print_function_t ndr_print;
164 struct dcerpc_endpoint_list {
166 const char * const *names;
169 struct dcerpc_authservice_list {
171 const char * const *names;
174 struct dcerpc_interface_table {
178 const char *helpstring;
180 const struct dcerpc_interface_call *calls;
181 const struct dcerpc_endpoint_list *endpoints;
182 const struct dcerpc_authservice_list *authservices;
185 struct dcerpc_interface_list {
186 struct dcerpc_interface_list *prev, *next;
187 const struct dcerpc_interface_table *table;
190 /* this describes a binding to a particular transport/pipe */
191 struct dcerpc_binding {
192 enum dcerpc_transport_t transport;
194 uint16_t object_version;
196 const char *endpoint;
197 const char **options;
202 struct dcerpc_pipe_connect {
203 struct dcerpc_pipe *pipe;
204 struct dcerpc_binding *binding;
205 const char *pipe_name;
206 const struct dcerpc_interface_table *interface;
207 struct cli_credentials *creds;
211 enum rpc_request_state {
217 handle for an async dcerpc request
220 struct rpc_request *next, *prev;
221 struct dcerpc_pipe *p;
224 enum rpc_request_state state;
229 const struct GUID *object;
231 DATA_BLOB request_data;
234 /* use by the ndr level async recv call */
236 const struct dcerpc_interface_table *table;
243 void (*callback)(struct rpc_request *);
248 #include "librpc/rpc/dcerpc_proto.h"
250 #endif /* __DCERPC_H__ */