s3-rpc_client: add and use rpc_client/rpc_client.h.
[samba.git] / source3 / include / ntdomain.h
1 /* 
2    Unix SMB/CIFS implementation.
3    SMB parameters and setup
4    Copyright (C) Andrew Tridgell 1992-1997
5    Copyright (C) Luke Kenneth Casson Leighton 1996-1997
6    Copyright (C) Paul Ashton 1997
7    Copyright (C) Jeremy Allison 2000-2004
8
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 3 of the License, or
12    (at your option) any later version.
13
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.
18
19    You should have received a copy of the GNU General Public License
20    along with this program.  If not, see <http://www.gnu.org/licenses/>.
21 */
22
23 #ifndef _NT_DOMAIN_H /* _NT_DOMAIN_H */
24 #define _NT_DOMAIN_H 
25
26 #include "librpc/rpc/dcerpc.h"
27
28 /*
29  * A bunch of stuff that was put into smb.h
30  * in the NTDOM branch - it didn't belong there.
31  */
32
33 typedef struct _output_data {
34         /*
35          * Raw RPC output data. This does not include RPC headers or footers.
36          */
37         DATA_BLOB rdata;
38
39         /* The amount of data sent from the current rdata struct. */
40         uint32 data_sent_length;
41
42         /*
43          * The current fragment being returned. This inclues
44          * headers, data and authentication footer.
45          */
46         DATA_BLOB frag;
47
48         /* The amount of data sent from the current PDU. */
49         uint32 current_pdu_sent;
50 } output_data;
51
52 typedef struct _input_data {
53         /*
54          * This is the current incoming pdu. The data here
55          * is collected via multiple writes until a complete
56          * pdu is seen, then the data is copied into the in_data
57          * structure. The maximum size of this is 0x1630 (RPC_MAX_PDU_FRAG_LEN).
58          * If length is zero, then we are at the start of a new
59          * pdu.
60          */
61         DATA_BLOB pdu;
62
63         /*
64          * The amount of data needed to complete the in_pdu.
65          * If this is zero, then we are at the start of a new
66          * pdu.
67          */
68         uint32 pdu_needed_len;
69
70         /*
71          * This is the collection of input data with all
72          * the rpc headers and auth footers removed.
73          * The maximum length of this (1Mb) is strictly enforced.
74          */
75         DATA_BLOB data;
76
77 } input_data;
78
79 struct handle_list;
80
81 typedef struct pipe_rpc_fns {
82
83         struct pipe_rpc_fns *next, *prev;
84
85         /* RPC function table associated with the current rpc_bind (associated by context) */
86
87         const struct api_struct *cmds;
88         int n_cmds;
89         uint32 context_id;
90
91 } PIPE_RPC_FNS;
92
93 /*
94  * Different auth types we support.
95  * Can't keep in sync with wire values as spnego wraps different auth methods.
96  */
97
98 struct gse_context;
99
100 /* auth state for all bind types. */
101
102 struct pipe_auth_data {
103         enum dcerpc_AuthType auth_type;
104         enum dcerpc_AuthLevel auth_level;
105
106         void *auth_ctx;
107
108         /* Only the client code uses these 3 for now */
109         char *domain;
110         char *user_name;
111         DATA_BLOB user_session_key;
112 };
113
114 struct dcesrv_ep_entry_list;
115
116 /*
117  * DCE/RPC-specific samba-internal-specific handling of data on
118  * NamedPipes.
119  */
120
121 struct pipes_struct {
122         struct pipes_struct *next, *prev;
123
124         struct client_address *client_id;
125         struct client_address *server_id;
126
127         enum dcerpc_transport_t transport;
128
129         struct auth_serversupplied_info *session_info;
130         struct messaging_context *msg_ctx;
131
132         struct ndr_syntax_id syntax;
133         struct dcesrv_ep_entry_list *ep_entries;
134
135         /* linked list of rpc dispatch tables associated 
136            with the open rpc contexts */
137
138         PIPE_RPC_FNS *contexts;
139
140         struct pipe_auth_data auth;
141
142         bool ncalrpc_as_system;
143
144         /*
145          * Set to true when an RPC bind has been done on this pipe.
146          */
147
148         bool pipe_bound;
149
150         /*
151          * Set to true when we should return fault PDU's for everything.
152          */
153
154         bool fault_state;
155
156         /*
157          * Set to true when we should return fault PDU's for a bad handle.
158          */
159
160         bool bad_handle_fault_state;
161
162         /*
163          * Set to true when the backend does not support a call.
164          */
165
166         bool rng_fault_state;
167
168         /*
169          * Set to RPC_BIG_ENDIAN when dealing with big-endian PDU's
170          */
171
172         bool endian;
173
174         /*
175          * Struct to deal with multiple pdu inputs.
176          */
177
178         input_data in_data;
179
180         /*
181          * Struct to deal with multiple pdu outputs.
182          */
183
184         output_data out_data;
185
186         /* This context is used for PDU data and is freed between each pdu.
187                 Don't use for pipe state storage. */
188         TALLOC_CTX *mem_ctx;
189
190         /* handle database to use on this pipe. */
191         struct handle_list *pipe_handles;
192
193         /* call id retrieved from the pdu header */
194         uint32_t call_id;
195
196         /* operation number retrieved from the rpc header */
197         uint16_t opnum;
198
199         /* private data for the interface implementation */
200         void *private_data;
201
202 };
203
204 struct api_struct {  
205         const char *name;
206         uint8 opnum;
207         bool (*fn) (struct pipes_struct *);
208 };
209
210 #endif /* _NT_DOMAIN_H */