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
;
76 struct smb_krb5_context
;
78 struct gensec_settings
{
79 struct loadparm_context
*lp_ctx
;
80 const char *target_hostname
;
82 /* this allows callers to specify a specific set of ops that
83 * should be used, rather than those loaded by the plugin
85 struct gensec_security_ops
**backends
;
88 struct gensec_security_ops
{
90 const char *sasl_name
;
91 uint8_t auth_type
; /* 0 if not offered on DCE-RPC */
92 const char **oid
; /* NULL if not offered by SPNEGO */
93 NTSTATUS (*client_start
)(struct gensec_security
*gensec_security
);
94 NTSTATUS (*server_start
)(struct gensec_security
*gensec_security
);
96 Determine if a packet has the right 'magic' for this mechanism
98 NTSTATUS (*magic
)(struct gensec_security
*gensec_security
,
99 const DATA_BLOB
*first_packet
);
100 NTSTATUS (*update
)(struct gensec_security
*gensec_security
, TALLOC_CTX
*out_mem_ctx
,
101 struct tevent_context
*ev
,
102 const DATA_BLOB in
, DATA_BLOB
*out
);
103 NTSTATUS (*seal_packet
)(struct gensec_security
*gensec_security
, TALLOC_CTX
*sig_mem_ctx
,
104 uint8_t *data
, size_t length
,
105 const uint8_t *whole_pdu
, size_t pdu_length
,
107 NTSTATUS (*sign_packet
)(struct gensec_security
*gensec_security
, TALLOC_CTX
*sig_mem_ctx
,
108 const uint8_t *data
, size_t length
,
109 const uint8_t *whole_pdu
, size_t pdu_length
,
111 size_t (*sig_size
)(struct gensec_security
*gensec_security
, size_t data_size
);
112 size_t (*max_input_size
)(struct gensec_security
*gensec_security
);
113 size_t (*max_wrapped_size
)(struct gensec_security
*gensec_security
);
114 NTSTATUS (*check_packet
)(struct gensec_security
*gensec_security
,
115 const uint8_t *data
, size_t length
,
116 const uint8_t *whole_pdu
, size_t pdu_length
,
117 const DATA_BLOB
*sig
);
118 NTSTATUS (*unseal_packet
)(struct gensec_security
*gensec_security
,
119 uint8_t *data
, size_t length
,
120 const uint8_t *whole_pdu
, size_t pdu_length
,
121 const DATA_BLOB
*sig
);
122 NTSTATUS (*wrap
)(struct gensec_security
*gensec_security
,
126 NTSTATUS (*unwrap
)(struct gensec_security
*gensec_security
,
130 NTSTATUS (*wrap_packets
)(struct gensec_security
*gensec_security
,
134 size_t *len_processed
);
135 NTSTATUS (*unwrap_packets
)(struct gensec_security
*gensec_security
,
139 size_t *len_processed
);
140 NTSTATUS (*packet_full_request
)(struct gensec_security
*gensec_security
,
141 DATA_BLOB blob
, size_t *size
);
142 NTSTATUS (*session_key
)(struct gensec_security
*gensec_security
, TALLOC_CTX
*mem_ctx
,
143 DATA_BLOB
*session_key
);
144 NTSTATUS (*session_info
)(struct gensec_security
*gensec_security
, TALLOC_CTX
*mem_ctx
,
145 struct auth_session_info
**session_info
);
146 void (*want_feature
)(struct gensec_security
*gensec_security
,
148 bool (*have_feature
)(struct gensec_security
*gensec_security
,
152 enum gensec_priority priority
;
155 struct gensec_security_ops_wrapper
{
156 const struct gensec_security_ops
*op
;
160 #define GENSEC_INTERFACE_VERSION 0
162 struct gensec_security
{
163 const struct gensec_security_ops
*ops
;
165 struct cli_credentials
*credentials
;
166 struct gensec_target target
;
167 enum gensec_role gensec_role
;
169 uint32_t want_features
;
170 uint32_t max_update_size
;
171 uint8_t dcerpc_auth_level
;
172 struct tsocket_address
*local_addr
, *remote_addr
;
173 struct gensec_settings
*settings
;
175 /* When we are a server, this may be filled in to provide an
176 * NTLM authentication backend, and user lookup (such as if no
178 struct auth4_context
*auth_context
;
181 /* this structure is used by backends to determine the size of some critical types */
182 struct gensec_critical_sizes
{
183 int interface_version
;
184 int sizeof_gensec_security_ops
;
185 int sizeof_gensec_security
;
190 struct gensec_security
;
191 struct socket_context
;
192 struct auth4_context
;
193 struct auth_user_info_dc
;
195 /* These functions are for use here only (public because SPNEGO must
196 * use them for recursion) */
197 NTSTATUS
gensec_wrap_packets(struct gensec_security
*gensec_security
,
201 size_t *len_processed
);
202 /* These functions are for use here only (public because SPNEGO must
203 * use them for recursion) */
204 NTSTATUS
gensec_unwrap_packets(struct gensec_security
*gensec_security
,
208 size_t *len_processed
);
210 /* These functions are for use here only (public because SPNEGO must
211 * use them for recursion) */
212 NTSTATUS
gensec_packet_full_request(struct gensec_security
*gensec_security
,
213 DATA_BLOB blob
, size_t *size
);
215 struct loadparm_context
;
217 NTSTATUS
gensec_subcontext_start(TALLOC_CTX
*mem_ctx
,
218 struct gensec_security
*parent
,
219 struct gensec_security
**gensec_security
);
220 NTSTATUS
gensec_client_start(TALLOC_CTX
*mem_ctx
,
221 struct gensec_security
**gensec_security
,
222 struct gensec_settings
*settings
);
223 NTSTATUS
gensec_start_mech_by_ops(struct gensec_security
*gensec_security
,
224 const struct gensec_security_ops
*ops
);
225 NTSTATUS
gensec_start_mech_by_sasl_list(struct gensec_security
*gensec_security
,
226 const char **sasl_names
);
227 void gensec_set_max_update_size(struct gensec_security
*gensec_security
,
228 uint32_t max_update_size
);
229 size_t gensec_max_update_size(struct gensec_security
*gensec_security
);
230 NTSTATUS
gensec_update(struct gensec_security
*gensec_security
, TALLOC_CTX
*out_mem_ctx
,
231 struct tevent_context
*ev
,
232 const DATA_BLOB in
, DATA_BLOB
*out
);
233 struct tevent_req
*gensec_update_send(TALLOC_CTX
*mem_ctx
,
234 struct tevent_context
*ev
,
235 struct gensec_security
*gensec_security
,
237 NTSTATUS
gensec_update_recv(struct tevent_req
*req
, TALLOC_CTX
*out_mem_ctx
, DATA_BLOB
*out
);
238 void gensec_want_feature(struct gensec_security
*gensec_security
,
240 bool gensec_have_feature(struct gensec_security
*gensec_security
,
242 NTSTATUS
gensec_set_credentials(struct gensec_security
*gensec_security
, struct cli_credentials
*credentials
);
243 NTSTATUS
gensec_set_target_service(struct gensec_security
*gensec_security
, const char *service
);
244 const char *gensec_get_target_service(struct gensec_security
*gensec_security
);
245 NTSTATUS
gensec_set_target_hostname(struct gensec_security
*gensec_security
, const char *hostname
);
246 const char *gensec_get_target_hostname(struct gensec_security
*gensec_security
);
247 NTSTATUS
gensec_session_key(struct gensec_security
*gensec_security
,
249 DATA_BLOB
*session_key
);
250 NTSTATUS
gensec_start_mech_by_oid(struct gensec_security
*gensec_security
,
251 const char *mech_oid
);
252 const char *gensec_get_name_by_oid(struct gensec_security
*gensec_security
, const char *oid_string
);
253 struct cli_credentials
*gensec_get_credentials(struct gensec_security
*gensec_security
);
254 NTSTATUS
gensec_init(void);
255 NTSTATUS
gensec_register(const struct gensec_security_ops
*ops
);
256 const struct gensec_security_ops
*gensec_security_by_oid(struct gensec_security
*gensec_security
,
257 const char *oid_string
);
258 const struct gensec_security_ops
*gensec_security_by_sasl_name(struct gensec_security
*gensec_security
,
259 const char *sasl_name
);
260 struct gensec_security_ops
**gensec_security_mechs(struct gensec_security
*gensec_security
,
261 TALLOC_CTX
*mem_ctx
);
262 const struct gensec_security_ops_wrapper
*gensec_security_by_oid_list(
263 struct gensec_security
*gensec_security
,
265 const char **oid_strings
,
267 const char **gensec_security_oids(struct gensec_security
*gensec_security
,
270 const char **gensec_security_oids_from_ops_wrapped(TALLOC_CTX
*mem_ctx
,
271 const struct gensec_security_ops_wrapper
*wops
);
272 size_t gensec_max_input_size(struct gensec_security
*gensec_security
);
273 size_t gensec_max_wrapped_size(struct gensec_security
*gensec_security
);
274 NTSTATUS
gensec_unseal_packet(struct gensec_security
*gensec_security
,
275 uint8_t *data
, size_t length
,
276 const uint8_t *whole_pdu
, size_t pdu_length
,
277 const DATA_BLOB
*sig
);
278 NTSTATUS
gensec_check_packet(struct gensec_security
*gensec_security
,
279 const uint8_t *data
, size_t length
,
280 const uint8_t *whole_pdu
, size_t pdu_length
,
281 const DATA_BLOB
*sig
);
282 size_t gensec_sig_size(struct gensec_security
*gensec_security
, size_t data_size
);
283 NTSTATUS
gensec_seal_packet(struct gensec_security
*gensec_security
,
285 uint8_t *data
, size_t length
,
286 const uint8_t *whole_pdu
, size_t pdu_length
,
288 NTSTATUS
gensec_sign_packet(struct gensec_security
*gensec_security
,
290 const uint8_t *data
, size_t length
,
291 const uint8_t *whole_pdu
, size_t pdu_length
,
293 NTSTATUS
gensec_start_mech(struct gensec_security
*gensec_security
);
294 NTSTATUS
gensec_start_mech_by_authtype(struct gensec_security
*gensec_security
,
295 uint8_t auth_type
, uint8_t auth_level
);
296 const char *gensec_get_name_by_authtype(struct gensec_security
*gensec_security
, uint8_t authtype
);
297 NTSTATUS
gensec_server_start(TALLOC_CTX
*mem_ctx
,
298 struct gensec_settings
*settings
,
299 struct auth4_context
*auth_context
,
300 struct gensec_security
**gensec_security
);
301 NTSTATUS
gensec_session_info(struct gensec_security
*gensec_security
,
303 struct auth_session_info
**session_info
);
305 NTSTATUS
gensec_set_local_address(struct gensec_security
*gensec_security
,
306 const struct tsocket_address
*local
);
307 NTSTATUS
gensec_set_remote_address(struct gensec_security
*gensec_security
,
308 const struct tsocket_address
*remote
);
309 const struct tsocket_address
*gensec_get_local_address(struct gensec_security
*gensec_security
);
310 const struct tsocket_address
*gensec_get_remote_address(struct gensec_security
*gensec_security
);
312 NTSTATUS
gensec_start_mech_by_name(struct gensec_security
*gensec_security
,
315 NTSTATUS
gensec_unwrap(struct gensec_security
*gensec_security
,
319 NTSTATUS
gensec_wrap(struct gensec_security
*gensec_security
,
324 struct gensec_security_ops
**gensec_security_all(void);
325 bool gensec_security_ops_enabled(struct gensec_security_ops
*ops
, struct gensec_security
*security
);
326 struct gensec_security_ops
**gensec_use_kerberos_mechs(TALLOC_CTX
*mem_ctx
,
327 struct gensec_security_ops
**old_gensec_list
,
328 struct cli_credentials
*creds
);
330 NTSTATUS
gensec_start_mech_by_sasl_name(struct gensec_security
*gensec_security
,
331 const char *sasl_name
);
333 int gensec_setting_int(struct gensec_settings
*settings
, const char *mechanism
, const char *name
, int default_value
);
334 bool gensec_setting_bool(struct gensec_settings
*settings
, const char *mechanism
, const char *name
, bool default_value
);
336 NTSTATUS
gensec_set_target_principal(struct gensec_security
*gensec_security
, const char *principal
);
337 const char *gensec_get_target_principal(struct gensec_security
*gensec_security
);
339 NTSTATUS
gensec_generate_session_info_pac(TALLOC_CTX
*mem_ctx
,
340 struct gensec_security
*gensec_security
,
341 struct smb_krb5_context
*smb_krb5_context
,
343 const char *principal_string
,
344 const struct tsocket_address
*remote_address
,
345 struct auth_session_info
**session_info
);
348 #endif /* __GENSEC_H__ */