Update docs-status
[Samba/gebeck_regimport.git] / source / include / ntdomain.h
blobb6ab4fd0c50ede3795c95a623edc4499c5d7c24a
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
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 #ifndef _NT_DOMAIN_H /* _NT_DOMAIN_H */
24 #define _NT_DOMAIN_H
26 /* dce/rpc support */
27 #include "rpc_dce.h"
29 /* miscellaneous structures / defines */
30 #include "rpc_misc.h"
32 #include "rpc_creds.h"
34 #include "talloc.h"
37 * A bunch of stuff that was put into smb.h
38 * in the NTDOM branch - it didn't belong there.
41 typedef struct _prs_struct
43 BOOL io; /* parsing in or out of data stream */
44 /*
45 * If the (incoming) data is big-endian. On output we are
46 * always little-endian.
47 */
48 BOOL bigendian_data;
49 uint8 align; /* data alignment */
50 BOOL is_dynamic; /* Do we own this memory or not ? */
51 uint32 data_offset; /* Current working offset into data. */
52 uint32 buffer_size; /* Current allocated size of the buffer. */
53 uint32 grow_size; /* size requested via prs_grow() calls */
54 char *data_p; /* The buffer itself. */
55 TALLOC_CTX *mem_ctx; /* When unmarshalling, use this.... */
56 } prs_struct;
59 * Defines for io member of prs_struct.
62 #define MARSHALL 0
63 #define UNMARSHALL 1
65 #define MARSHALLING(ps) (!(ps)->io)
66 #define UNMARSHALLING(ps) ((ps)->io)
68 #define RPC_BIG_ENDIAN 1
69 #define RPC_LITTLE_ENDIAN 0
71 #define RPC_PARSE_ALIGN 4
73 typedef struct _output_data {
75 * Raw RPC output data. This does not include RPC headers or footers.
77 prs_struct rdata;
79 /* The amount of data sent from the current rdata struct. */
80 uint32 data_sent_length;
83 * The current PDU being returned. This inclues
84 * headers, data and authentication footer.
86 unsigned char current_pdu[MAX_PDU_FRAG_LEN];
88 /* The amount of data in the current_pdu buffer. */
89 uint32 current_pdu_len;
91 /* The amount of data sent from the current PDU. */
92 uint32 current_pdu_sent;
93 } output_data;
95 typedef struct _input_data {
97 * This is the current incoming pdu. The data here
98 * is collected via multiple writes until a complete
99 * pdu is seen, then the data is copied into the in_data
100 * structure. The maximum size of this is 0x1630 (MAX_PDU_FRAG_LEN).
102 unsigned char current_in_pdu[MAX_PDU_FRAG_LEN];
105 * The amount of data needed to complete the in_pdu.
106 * If this is zero, then we are at the start of a new
107 * pdu.
109 uint32 pdu_needed_len;
112 * The amount of data received so far in the in_pdu.
113 * If this is zero, then we are at the start of a new
114 * pdu.
116 uint32 pdu_received_len;
119 * This is the collection of input data with all
120 * the rpc headers and auth footers removed.
121 * The maximum length of this (1Mb) is strictly enforced.
123 prs_struct data;
124 } input_data;
127 * Handle database - stored per pipe.
130 struct policy
132 struct policy *next, *prev;
134 POLICY_HND pol_hnd;
136 void *data_ptr;
137 void (*free_fn)(void *);
141 struct handle_list {
142 struct policy *Policy; /* List of policies. */
143 size_t count; /* Current number of handles. */
144 size_t pipe_ref_count; /* Number of pipe handles referring to this list. */
147 /* Domain controller authentication protocol info */
148 struct dcinfo
150 DOM_CHAL clnt_chal; /* Initial challenge received from client */
151 DOM_CHAL srv_chal; /* Initial server challenge */
152 DOM_CRED clnt_cred; /* Last client credential */
153 DOM_CRED srv_cred; /* Last server credential */
155 uchar sess_key[8]; /* Session key */
156 uchar md4pw[16]; /* md4(machine password) */
158 fstring mach_acct; /* Machine name we've authenticated. */
160 fstring remote_machine; /* Machine name we've authenticated. */
162 BOOL challenge_sent;
163 BOOL got_session_key;
164 BOOL authenticated;
169 * DCE/RPC-specific samba-internal-specific handling of data on
170 * NamedPipes.
174 typedef struct pipes_struct
176 struct pipes_struct *next, *prev;
178 connection_struct *conn;
179 uint16 vuid; /* points to the unauthenticated user that opened this pipe. */
181 fstring name;
182 fstring pipe_srv_name;
184 RPC_HDR hdr; /* Incoming RPC header. */
185 RPC_HDR_REQ hdr_req; /* Incoming request header. */
187 uint32 ntlmssp_chal_flags; /* Client challenge flags. */
188 BOOL ntlmssp_auth_requested; /* If the client wanted authenticated rpc. */
189 BOOL ntlmssp_auth_validated; /* If the client *got* authenticated rpc. */
190 unsigned char challenge[8];
191 unsigned char ntlmssp_hash[258];
192 uint32 ntlmssp_seq_num;
193 struct dcinfo dc; /* Keeps the creds data. */
195 /* Hmm. In my understanding the authentication happens
196 implicitly later, so there are no two stages for
197 schannel. */
199 BOOL netsec_auth_validated;
200 struct netsec_auth_struct netsec_auth;
203 * Windows user info.
205 fstring user_name;
206 fstring domain;
207 fstring wks;
210 * Unix user name and credentials.
213 fstring pipe_user_name;
214 struct current_user pipe_user;
216 uint8 session_key[16];
219 * Set to true when an RPC bind has been done on this pipe.
222 BOOL pipe_bound;
225 * Set to true when we should return fault PDU's for everything.
228 BOOL fault_state;
231 * Set to true when we should return fault PDU's for a bad handle.
234 BOOL bad_handle_fault_state;
237 * Set to RPC_BIG_ENDIAN when dealing with big-endian PDU's
240 BOOL endian;
243 * Struct to deal with multiple pdu inputs.
246 input_data in_data;
249 * Struct to deal with multiple pdu outputs.
252 output_data out_data;
254 /* talloc context to use when allocating memory on this pipe. */
255 TALLOC_CTX *mem_ctx;
257 /* handle database to use on this pipe. */
258 struct handle_list *pipe_handles;
260 } pipes_struct;
262 typedef struct smb_np_struct
264 struct smb_np_struct *next, *prev;
265 int pnum;
266 connection_struct *conn;
267 uint16 vuid; /* points to the unauthenticated user that opened this pipe. */
268 BOOL open; /* open connection */
269 uint16 device_state;
270 uint16 priority;
271 fstring name;
273 /* When replying to an SMBtrans, this is the maximum amount of
274 data that can be sent in the initial reply. */
275 int max_trans_reply;
278 * NamedPipe state information.
280 * (e.g. typecast a np_struct, above).
282 void *np_state;
285 * NamedPipe functions, to be called to perform
286 * Named Pipe transactions on request from an
287 * SMB client.
290 /* call to create a named pipe connection.
291 * returns: state information representing the connection.
292 * is stored in np_state, above.
294 void * (*namedpipe_create)(char *pipe_name,
295 connection_struct *conn, uint16 vuid);
297 /* call to perform a write / read namedpipe transaction.
298 * TransactNamedPipe is weird: it returns whether there
299 * is more data outstanding to be read, and the
300 * caller is expected to take note and follow up with
301 * read requests.
303 ssize_t (*namedpipe_transact)(void *np_state,
304 char *data, int len,
305 char *rdata, int rlen,
306 BOOL *pipe_outstanding);
308 /* call to perform a write namedpipe operation
310 ssize_t (*namedpipe_write)(void * np_state,
311 char *data, size_t n);
313 /* call to perform a read namedpipe operation.
315 * NOTE: the only reason that the pipe_outstanding
316 * argument is here is because samba does not use
317 * the namedpipe_transact function yet: instead,
318 * it performs the same as what namedpipe_transact
319 * does - a write, followed by a read.
321 * when samba is modified to use namedpipe_transact,
322 * the pipe_outstanding argument may be removed.
324 ssize_t (*namedpipe_read)(void * np_state,
325 char *data, size_t max_len,
326 BOOL *pipe_outstanding);
328 /* call to close a namedpipe.
329 * function is expected to perform all cleanups
330 * necessary, free all memory etc.
332 * returns True if cleanup was successful (not that
333 * we particularly care).
335 BOOL (*namedpipe_close)(void * np_state);
337 } smb_np_struct;
339 struct api_struct
341 const char *name;
342 uint8 opnum;
343 BOOL (*fn) (pipes_struct *);
346 typedef struct
348 uint32 rid;
349 const char *name;
351 } rid_name;
353 struct acct_info
355 fstring acct_name; /* account name */
356 fstring acct_desc; /* account name */
357 uint32 rid; /* domain-relative RID */
361 * higher order functions for use with msrpc client code
364 #define PRINT_INFO_FN(fn)\
365 void (*fn)(const char*, uint32, uint32, void *const *const)
366 #define JOB_INFO_FN(fn)\
367 void (*fn)(const char*, const char*, uint32, uint32, void *const *const)
369 /* end higher order functions */
372 /* security descriptor structures */
373 #include "rpc_secdes.h"
375 /* pac */
376 #include "authdata.h"
378 /* different dce/rpc pipes */
379 #include "rpc_lsa.h"
380 #include "rpc_netlogon.h"
381 #include "rpc_reg.h"
382 #include "rpc_samr.h"
383 #include "rpc_srvsvc.h"
384 #include "rpc_wkssvc.h"
385 #include "rpc_spoolss.h"
386 #include "rpc_dfs.h"
387 #include "rpc_ds.h"
388 #include "rpc_echo.h"
390 #endif /* _NT_DOMAIN_H */