2 Unix SMB/CIFS implementation.
4 Generic Authentication Interface
6 Copyright (C) Andrew Tridgell 2003
7 Copyright (C) Andrew Bartlett <abartlet@samba.org> 2004-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 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/>.
26 #include "../lib/util/data_blob.h"
27 #include "libcli/util/ntstatus.h"
29 #define GENSEC_SASL_NAME_NTLMSSP "NTLM"
31 #define GENSEC_OID_NTLMSSP "1.3.6.1.4.1.311.2.2.10"
32 #define GENSEC_OID_SPNEGO "1.3.6.1.5.5.2"
33 #define GENSEC_OID_KERBEROS5 "1.2.840.113554.1.2.2"
34 #define GENSEC_OID_KERBEROS5_OLD "1.2.840.48018.1.2.2"
35 #define GENSEC_OID_KERBEROS5_USER2USER "1.2.840.113554.1.2.2.3"
37 enum gensec_priority
{
47 struct gensec_security
;
48 struct gensec_target
{
49 const char *principal
;
54 #define GENSEC_FEATURE_SESSION_KEY 0x00000001
55 #define GENSEC_FEATURE_SIGN 0x00000002
56 #define GENSEC_FEATURE_SEAL 0x00000004
57 #define GENSEC_FEATURE_DCE_STYLE 0x00000008
58 #define GENSEC_FEATURE_ASYNC_REPLIES 0x00000010
59 #define GENSEC_FEATURE_DATAGRAM_MODE 0x00000020
60 #define GENSEC_FEATURE_SIGN_PKT_HEADER 0x00000040
61 #define GENSEC_FEATURE_NEW_SPNEGO 0x00000080
62 #define GENSEC_FEATURE_UNIX_TOKEN 0x00000100
71 struct auth_session_info
;
72 struct cli_credentials
;
73 struct gensec_settings
;
74 struct tevent_context
;
77 struct gensec_settings
{
78 struct loadparm_context
*lp_ctx
;
79 const char *target_hostname
;
82 struct gensec_security_ops
{
84 const char *sasl_name
;
85 uint8_t auth_type
; /* 0 if not offered on DCE-RPC */
86 const char **oid
; /* NULL if not offered by SPNEGO */
87 NTSTATUS (*client_start
)(struct gensec_security
*gensec_security
);
88 NTSTATUS (*server_start
)(struct gensec_security
*gensec_security
);
90 Determine if a packet has the right 'magic' for this mechanism
92 NTSTATUS (*magic
)(struct gensec_security
*gensec_security
,
93 const DATA_BLOB
*first_packet
);
94 NTSTATUS (*update
)(struct gensec_security
*gensec_security
, TALLOC_CTX
*out_mem_ctx
,
95 const DATA_BLOB in
, DATA_BLOB
*out
);
96 NTSTATUS (*seal_packet
)(struct gensec_security
*gensec_security
, TALLOC_CTX
*sig_mem_ctx
,
97 uint8_t *data
, size_t length
,
98 const uint8_t *whole_pdu
, size_t pdu_length
,
100 NTSTATUS (*sign_packet
)(struct gensec_security
*gensec_security
, TALLOC_CTX
*sig_mem_ctx
,
101 const uint8_t *data
, size_t length
,
102 const uint8_t *whole_pdu
, size_t pdu_length
,
104 size_t (*sig_size
)(struct gensec_security
*gensec_security
, size_t data_size
);
105 size_t (*max_input_size
)(struct gensec_security
*gensec_security
);
106 size_t (*max_wrapped_size
)(struct gensec_security
*gensec_security
);
107 NTSTATUS (*check_packet
)(struct gensec_security
*gensec_security
,
108 const uint8_t *data
, size_t length
,
109 const uint8_t *whole_pdu
, size_t pdu_length
,
110 const DATA_BLOB
*sig
);
111 NTSTATUS (*unseal_packet
)(struct gensec_security
*gensec_security
,
112 uint8_t *data
, size_t length
,
113 const uint8_t *whole_pdu
, size_t pdu_length
,
114 const DATA_BLOB
*sig
);
115 NTSTATUS (*wrap
)(struct gensec_security
*gensec_security
,
119 NTSTATUS (*unwrap
)(struct gensec_security
*gensec_security
,
123 NTSTATUS (*wrap_packets
)(struct gensec_security
*gensec_security
,
127 size_t *len_processed
);
128 NTSTATUS (*unwrap_packets
)(struct gensec_security
*gensec_security
,
132 size_t *len_processed
);
133 NTSTATUS (*packet_full_request
)(struct gensec_security
*gensec_security
,
134 DATA_BLOB blob
, size_t *size
);
135 NTSTATUS (*session_key
)(struct gensec_security
*gensec_security
, TALLOC_CTX
*mem_ctx
,
136 DATA_BLOB
*session_key
);
137 NTSTATUS (*session_info
)(struct gensec_security
*gensec_security
, TALLOC_CTX
*mem_ctx
,
138 struct auth_session_info
**session_info
);
139 void (*want_feature
)(struct gensec_security
*gensec_security
,
141 bool (*have_feature
)(struct gensec_security
*gensec_security
,
145 enum gensec_priority priority
;
148 struct gensec_security_ops_wrapper
{
149 const struct gensec_security_ops
*op
;
153 #define GENSEC_INTERFACE_VERSION 0
155 struct gensec_security
{
156 const struct gensec_security_ops
*ops
;
158 struct cli_credentials
*credentials
;
159 struct gensec_target target
;
160 enum gensec_role gensec_role
;
162 uint32_t want_features
;
163 struct tevent_context
*event_ctx
;
164 struct tsocket_address
*local_addr
, *remote_addr
;
165 struct gensec_settings
*settings
;
167 /* When we are a server, this may be filled in to provide an
168 * NTLM authentication backend, and user lookup (such as if no
170 struct auth4_context
*auth_context
;
173 /* this structure is used by backends to determine the size of some critical types */
174 struct gensec_critical_sizes
{
175 int interface_version
;
176 int sizeof_gensec_security_ops
;
177 int sizeof_gensec_security
;
182 struct gensec_security
;
183 struct socket_context
;
184 struct auth4_context
;
185 struct auth_user_info_dc
;
187 /* These functions are for use here only (public because SPNEGO must
188 * use them for recursion) */
189 NTSTATUS
gensec_wrap_packets(struct gensec_security
*gensec_security
,
193 size_t *len_processed
);
194 /* These functions are for use here only (public because SPNEGO must
195 * use them for recursion) */
196 NTSTATUS
gensec_unwrap_packets(struct gensec_security
*gensec_security
,
200 size_t *len_processed
);
202 /* These functions are for use here only (public because SPNEGO must
203 * use them for recursion) */
204 NTSTATUS
gensec_packet_full_request(struct gensec_security
*gensec_security
,
205 DATA_BLOB blob
, size_t *size
);
207 struct loadparm_context
;
209 NTSTATUS
gensec_subcontext_start(TALLOC_CTX
*mem_ctx
,
210 struct gensec_security
*parent
,
211 struct gensec_security
**gensec_security
);
212 NTSTATUS
gensec_client_start(TALLOC_CTX
*mem_ctx
,
213 struct gensec_security
**gensec_security
,
214 struct tevent_context
*ev
,
215 struct gensec_settings
*settings
);
216 NTSTATUS
gensec_start_mech_by_ops(struct gensec_security
*gensec_security
,
217 const struct gensec_security_ops
*ops
);
218 NTSTATUS
gensec_start_mech_by_sasl_list(struct gensec_security
*gensec_security
,
219 const char **sasl_names
);
220 NTSTATUS
gensec_update(struct gensec_security
*gensec_security
, TALLOC_CTX
*out_mem_ctx
,
221 const DATA_BLOB in
, DATA_BLOB
*out
);
222 struct tevent_req
*gensec_update_send(TALLOC_CTX
*mem_ctx
,
223 struct tevent_context
*ev
,
224 struct gensec_security
*gensec_security
,
226 NTSTATUS
gensec_update_recv(struct tevent_req
*req
, TALLOC_CTX
*out_mem_ctx
, DATA_BLOB
*out
);
227 void gensec_want_feature(struct gensec_security
*gensec_security
,
229 bool gensec_have_feature(struct gensec_security
*gensec_security
,
231 NTSTATUS
gensec_set_credentials(struct gensec_security
*gensec_security
, struct cli_credentials
*credentials
);
232 NTSTATUS
gensec_set_target_service(struct gensec_security
*gensec_security
, const char *service
);
233 const char *gensec_get_target_service(struct gensec_security
*gensec_security
);
234 NTSTATUS
gensec_set_target_hostname(struct gensec_security
*gensec_security
, const char *hostname
);
235 const char *gensec_get_target_hostname(struct gensec_security
*gensec_security
);
236 NTSTATUS
gensec_session_key(struct gensec_security
*gensec_security
,
238 DATA_BLOB
*session_key
);
239 NTSTATUS
gensec_start_mech_by_oid(struct gensec_security
*gensec_security
,
240 const char *mech_oid
);
241 const char *gensec_get_name_by_oid(struct gensec_security
*gensec_security
, const char *oid_string
);
242 struct cli_credentials
*gensec_get_credentials(struct gensec_security
*gensec_security
);
243 NTSTATUS
gensec_init(void);
244 size_t gensec_max_input_size(struct gensec_security
*gensec_security
);
245 NTSTATUS
gensec_unseal_packet(struct gensec_security
*gensec_security
,
246 uint8_t *data
, size_t length
,
247 const uint8_t *whole_pdu
, size_t pdu_length
,
248 const DATA_BLOB
*sig
);
249 NTSTATUS
gensec_check_packet(struct gensec_security
*gensec_security
,
250 const uint8_t *data
, size_t length
,
251 const uint8_t *whole_pdu
, size_t pdu_length
,
252 const DATA_BLOB
*sig
);
253 size_t gensec_sig_size(struct gensec_security
*gensec_security
, size_t data_size
);
254 NTSTATUS
gensec_seal_packet(struct gensec_security
*gensec_security
,
256 uint8_t *data
, size_t length
,
257 const uint8_t *whole_pdu
, size_t pdu_length
,
259 NTSTATUS
gensec_sign_packet(struct gensec_security
*gensec_security
,
261 const uint8_t *data
, size_t length
,
262 const uint8_t *whole_pdu
, size_t pdu_length
,
264 NTSTATUS
gensec_start_mech(struct gensec_security
*gensec_security
);
265 NTSTATUS
gensec_start_mech_by_authtype(struct gensec_security
*gensec_security
,
266 uint8_t auth_type
, uint8_t auth_level
);
267 const char *gensec_get_name_by_authtype(struct gensec_security
*gensec_security
, uint8_t authtype
);
268 NTSTATUS
gensec_server_start(TALLOC_CTX
*mem_ctx
,
269 struct tevent_context
*ev
,
270 struct gensec_settings
*settings
,
271 struct auth4_context
*auth_context
,
272 struct gensec_security
**gensec_security
);
273 NTSTATUS
gensec_session_info(struct gensec_security
*gensec_security
,
275 struct auth_session_info
**session_info
);
277 NTSTATUS
gensec_set_local_address(struct gensec_security
*gensec_security
,
278 const struct tsocket_address
*local
);
279 NTSTATUS
gensec_set_remote_address(struct gensec_security
*gensec_security
,
280 const struct tsocket_address
*remote
);
281 const struct tsocket_address
*gensec_get_local_address(struct gensec_security
*gensec_security
);
282 const struct tsocket_address
*gensec_get_remote_address(struct gensec_security
*gensec_security
);
284 NTSTATUS
gensec_start_mech_by_name(struct gensec_security
*gensec_security
,
287 NTSTATUS
gensec_unwrap(struct gensec_security
*gensec_security
,
291 NTSTATUS
gensec_wrap(struct gensec_security
*gensec_security
,
296 struct gensec_security_ops
**gensec_security_all(void);
297 bool gensec_security_ops_enabled(struct gensec_security_ops
*ops
, struct gensec_security
*security
);
298 struct gensec_security_ops
**gensec_use_kerberos_mechs(TALLOC_CTX
*mem_ctx
,
299 struct gensec_security_ops
**old_gensec_list
,
300 struct cli_credentials
*creds
);
302 NTSTATUS
gensec_start_mech_by_sasl_name(struct gensec_security
*gensec_security
,
303 const char *sasl_name
);
305 int gensec_setting_int(struct gensec_settings
*settings
, const char *mechanism
, const char *name
, int default_value
);
306 bool gensec_setting_bool(struct gensec_settings
*settings
, const char *mechanism
, const char *name
, bool default_value
);
308 NTSTATUS
gensec_set_target_principal(struct gensec_security
*gensec_security
, const char *principal
);
310 #endif /* __GENSEC_H__ */