s3/docs: Fix typo.
[Samba/gebeck_regimport.git] / source3 / include / ntdomain.h
blob141f63581c4b19ffcd8e84e6cca949c659436bda
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
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.
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, see <http://www.gnu.org/licenses/>.
23 #ifndef _NT_DOMAIN_H /* _NT_DOMAIN_H */
24 #define _NT_DOMAIN_H
27 * A bunch of stuff that was put into smb.h
28 * in the NTDOM branch - it didn't belong there.
31 typedef struct _prs_struct {
32 bool io; /* parsing in or out of data stream */
33 /*
34 * If the (incoming) data is big-endian. On output we are
35 * always little-endian.
36 */
37 bool bigendian_data;
38 uint8 align; /* data alignment */
39 bool is_dynamic; /* Do we own this memory or not ? */
40 uint32 data_offset; /* Current working offset into data. */
41 uint32 buffer_size; /* Current allocated size of the buffer. */
42 uint32 grow_size; /* size requested via prs_grow() calls */
43 char *data_p; /* The buffer itself. */
44 TALLOC_CTX *mem_ctx; /* When unmarshalling, use this.... */
45 const char *sess_key; /* If we have to do encrypt/decrypt on the fly. */
46 } prs_struct;
49 * Defines for io member of prs_struct.
52 #define MARSHALL 0
53 #define UNMARSHALL 1
55 #define MARSHALLING(ps) (!(ps)->io)
56 #define UNMARSHALLING(ps) ((ps)->io)
58 #define RPC_BIG_ENDIAN 1
59 #define RPC_LITTLE_ENDIAN 0
61 #define RPC_PARSE_ALIGN 4
63 typedef struct _output_data {
65 * Raw RPC output data. This does not include RPC headers or footers.
67 prs_struct rdata;
69 /* The amount of data sent from the current rdata struct. */
70 uint32 data_sent_length;
73 * The current fragment being returned. This inclues
74 * headers, data and authentication footer.
76 prs_struct frag;
78 /* The amount of data sent from the current PDU. */
79 uint32 current_pdu_sent;
80 } output_data;
82 typedef struct _input_data {
84 * This is the current incoming pdu. The data here
85 * is collected via multiple writes until a complete
86 * pdu is seen, then the data is copied into the in_data
87 * structure. The maximum size of this is 0x1630 (RPC_MAX_PDU_FRAG_LEN).
89 uint8_t *current_in_pdu;
92 * The amount of data needed to complete the in_pdu.
93 * If this is zero, then we are at the start of a new
94 * pdu.
96 uint32 pdu_needed_len;
99 * The amount of data received so far in the in_pdu.
100 * If this is zero, then we are at the start of a new
101 * pdu.
103 uint32 pdu_received_len;
106 * This is the collection of input data with all
107 * the rpc headers and auth footers removed.
108 * The maximum length of this (1Mb) is strictly enforced.
110 prs_struct data;
111 } input_data;
113 struct handle_list;
115 /* Domain controller authentication protocol info */
116 struct dcinfo {
117 uint32 sequence; /* "timestamp" from client. */
118 struct netr_Credential seed_chal;
119 struct netr_Credential clnt_chal; /* Client credential */
120 struct netr_Credential srv_chal; /* Server credential */
122 unsigned char sess_key[16]; /* Session key */
123 unsigned char mach_pw[16]; /* md4(machine password) */
125 fstring mach_acct; /* Machine name we've authenticated. */
127 fstring remote_machine; /* Machine name we've authenticated. */
128 fstring domain;
130 bool challenge_sent;
131 bool authenticated;
134 typedef struct pipe_rpc_fns {
136 struct pipe_rpc_fns *next, *prev;
138 /* RPC function table associated with the current rpc_bind (associated by context) */
140 const struct api_struct *cmds;
141 int n_cmds;
142 uint32 context_id;
144 } PIPE_RPC_FNS;
147 * Different auth types we support.
148 * Can't keep in sync with wire values as spnego wraps different auth methods.
151 enum pipe_auth_type { PIPE_AUTH_TYPE_NONE = 0, PIPE_AUTH_TYPE_NTLMSSP, PIPE_AUTH_TYPE_SCHANNEL,
152 PIPE_AUTH_TYPE_SPNEGO_NTLMSSP, PIPE_AUTH_TYPE_KRB5, PIPE_AUTH_TYPE_SPNEGO_KRB5 };
154 /* Possible auth levels - keep these in sync with the wire values. */
155 enum pipe_auth_level { PIPE_AUTH_LEVEL_NONE = 0,
156 PIPE_AUTH_LEVEL_CONNECT = 1, /* We treat as NONE. */
157 PIPE_AUTH_LEVEL_INTEGRITY = 5, /* Sign. */
158 PIPE_AUTH_LEVEL_PRIVACY = 6 /* Seal. */
161 /* auth state for krb5. */
162 struct kerberos_auth_struct {
163 const char *service_principal;
164 DATA_BLOB session_key;
167 /* auth state for schannel. */
168 struct schannel_auth_struct {
169 unsigned char sess_key[16];
170 uint32 seq_num;
173 /* auth state for all bind types. */
175 struct pipe_auth_data {
176 enum pipe_auth_type auth_type; /* switch for union below. */
177 enum pipe_auth_level auth_level;
178 union {
179 struct schannel_auth_struct *schannel_auth;
180 AUTH_NTLMSSP_STATE *auth_ntlmssp_state;
181 /* struct kerberos_auth_struct *kerberos_auth; TO BE ADDED... */
182 } a_u;
183 void (*auth_data_free_func)(struct pipe_auth_data *);
187 * DCE/RPC-specific samba-internal-specific handling of data on
188 * NamedPipes.
191 typedef struct pipes_struct {
192 struct pipes_struct *next, *prev;
194 char client_address[INET6_ADDRSTRLEN];
196 struct auth_serversupplied_info *server_info;
198 struct ndr_syntax_id syntax;
200 /* linked list of rpc dispatch tables associated
201 with the open rpc contexts */
203 PIPE_RPC_FNS *contexts;
205 RPC_HDR hdr; /* Incoming RPC header. */
206 RPC_HDR_REQ hdr_req; /* Incoming request header. */
208 struct pipe_auth_data auth;
210 struct dcinfo *dc; /* Keeps the creds data from netlogon. */
213 * Set to true when an RPC bind has been done on this pipe.
216 bool pipe_bound;
219 * Set to true when we should return fault PDU's for everything.
222 bool fault_state;
225 * Set to true when we should return fault PDU's for a bad handle.
228 bool bad_handle_fault_state;
231 * Set to true when the backend does not support a call.
234 bool rng_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 /* This context is used for PDU data and is freed between each pdu.
255 Don't use for pipe state storage. */
256 TALLOC_CTX *mem_ctx;
258 /* handle database to use on this pipe. */
259 struct handle_list *pipe_handles;
261 } pipes_struct;
263 struct api_struct {
264 const char *name;
265 uint8 opnum;
266 bool (*fn) (pipes_struct *);
270 * higher order functions for use with msrpc client code
273 #define PRINT_INFO_FN(fn)\
274 void (*fn)(const char*, uint32, uint32, void *const *const)
275 #define JOB_INFO_FN(fn)\
276 void (*fn)(const char*, const char*, uint32, uint32, void *const *const)
278 /* end higher order functions */
280 #endif /* _NT_DOMAIN_H */