s3-include: Use struct pipes struct and get rid of the typedef.
[Samba.git] / source3 / include / ntdomain.h
blob5801fd3c3265c7ff6c2285d74b3aae625c54fa8b
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 _output_data {
33 * Raw RPC output data. This does not include RPC headers or footers.
35 DATA_BLOB rdata;
37 /* The amount of data sent from the current rdata struct. */
38 uint32 data_sent_length;
41 * The current fragment being returned. This inclues
42 * headers, data and authentication footer.
44 DATA_BLOB frag;
46 /* The amount of data sent from the current PDU. */
47 uint32 current_pdu_sent;
48 } output_data;
50 typedef struct _input_data {
52 * This is the current incoming pdu. The data here
53 * is collected via multiple writes until a complete
54 * pdu is seen, then the data is copied into the in_data
55 * structure. The maximum size of this is 0x1630 (RPC_MAX_PDU_FRAG_LEN).
56 * If length is zero, then we are at the start of a new
57 * pdu.
59 DATA_BLOB pdu;
62 * The amount of data needed to complete the in_pdu.
63 * If this is zero, then we are at the start of a new
64 * pdu.
66 uint32 pdu_needed_len;
69 * This is the collection of input data with all
70 * the rpc headers and auth footers removed.
71 * The maximum length of this (1Mb) is strictly enforced.
73 DATA_BLOB data;
75 } input_data;
77 struct handle_list;
79 typedef struct pipe_rpc_fns {
81 struct pipe_rpc_fns *next, *prev;
83 /* RPC function table associated with the current rpc_bind (associated by context) */
85 const struct api_struct *cmds;
86 int n_cmds;
87 uint32 context_id;
89 } PIPE_RPC_FNS;
92 * Different auth types we support.
93 * Can't keep in sync with wire values as spnego wraps different auth methods.
96 enum pipe_auth_type { PIPE_AUTH_TYPE_NONE = 0, PIPE_AUTH_TYPE_NTLMSSP, PIPE_AUTH_TYPE_SCHANNEL,
97 PIPE_AUTH_TYPE_SPNEGO_NTLMSSP, PIPE_AUTH_TYPE_KRB5, PIPE_AUTH_TYPE_SPNEGO_KRB5 };
99 /* auth state for krb5. */
100 struct kerberos_auth_struct {
101 const char *service_principal;
102 DATA_BLOB session_key;
105 /* auth state for all bind types. */
107 struct pipe_auth_data {
108 enum pipe_auth_type auth_type; /* switch for union below. */
109 enum dcerpc_AuthLevel auth_level;
111 union {
112 struct schannel_state *schannel_auth;
113 struct auth_ntlmssp_state *auth_ntlmssp_state;
114 struct kerberos_auth_struct *kerberos_auth; /* Client only for now */
115 } a_u;
117 /* Only the client code uses these 3 for now */
118 char *domain;
119 char *user_name;
120 DATA_BLOB user_session_key;
122 void (*auth_data_free_func)(struct pipe_auth_data *);
126 * DCE/RPC-specific samba-internal-specific handling of data on
127 * NamedPipes.
130 struct pipes_struct {
131 struct pipes_struct *next, *prev;
133 char client_address[INET6_ADDRSTRLEN];
135 struct auth_serversupplied_info *server_info;
137 struct ndr_syntax_id syntax;
139 /* linked list of rpc dispatch tables associated
140 with the open rpc contexts */
142 PIPE_RPC_FNS *contexts;
144 struct pipe_auth_data auth;
147 * Set to true when an RPC bind has been done on this pipe.
150 bool pipe_bound;
153 * Set to true when we should return fault PDU's for everything.
156 bool fault_state;
159 * Set to true when we should return fault PDU's for a bad handle.
162 bool bad_handle_fault_state;
165 * Set to true when the backend does not support a call.
168 bool rng_fault_state;
171 * Set to RPC_BIG_ENDIAN when dealing with big-endian PDU's
174 bool endian;
177 * Struct to deal with multiple pdu inputs.
180 input_data in_data;
183 * Struct to deal with multiple pdu outputs.
186 output_data out_data;
188 /* This context is used for PDU data and is freed between each pdu.
189 Don't use for pipe state storage. */
190 TALLOC_CTX *mem_ctx;
192 /* handle database to use on this pipe. */
193 struct handle_list *pipe_handles;
195 /* call id retrieved from the pdu header */
196 uint32_t call_id;
198 /* operation number retrieved from the rpc header */
199 uint16_t opnum;
201 /* private data for the interface implementation */
202 void *private_data;
206 struct api_struct {
207 const char *name;
208 uint8 opnum;
209 bool (*fn) (struct pipes_struct *);
212 #endif /* _NT_DOMAIN_H */