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 uint8_t dcerpc_auth_level;
171 struct tsocket_address *local_addr, *remote_addr;
172 struct gensec_settings *settings;
174 /* When we are a server, this may be filled in to provide an
175 * NTLM authentication backend, and user lookup (such as if no
177 struct auth4_context *auth_context;
180 /* this structure is used by backends to determine the size of some critical types */
181 struct gensec_critical_sizes {
182 int interface_version;
183 int sizeof_gensec_security_ops;
184 int sizeof_gensec_security;
189 struct gensec_security;
190 struct socket_context;
191 struct auth4_context;
192 struct auth_user_info_dc;
194 /* These functions are for use here only (public because SPNEGO must
195 * use them for recursion) */
196 NTSTATUS gensec_wrap_packets(struct gensec_security *gensec_security,
200 size_t *len_processed);
201 /* These functions are for use here only (public because SPNEGO must
202 * use them for recursion) */
203 NTSTATUS gensec_unwrap_packets(struct gensec_security *gensec_security,
207 size_t *len_processed);
209 /* These functions are for use here only (public because SPNEGO must
210 * use them for recursion) */
211 NTSTATUS gensec_packet_full_request(struct gensec_security *gensec_security,
212 DATA_BLOB blob, size_t *size);
214 struct loadparm_context;
216 NTSTATUS gensec_subcontext_start(TALLOC_CTX *mem_ctx,
217 struct gensec_security *parent,
218 struct gensec_security **gensec_security);
219 NTSTATUS gensec_client_start(TALLOC_CTX *mem_ctx,
220 struct gensec_security **gensec_security,
221 struct gensec_settings *settings);
222 NTSTATUS gensec_start_mech_by_ops(struct gensec_security *gensec_security,
223 const struct gensec_security_ops *ops);
224 NTSTATUS gensec_start_mech_by_sasl_list(struct gensec_security *gensec_security,
225 const char **sasl_names);
226 NTSTATUS gensec_update(struct gensec_security *gensec_security, TALLOC_CTX *out_mem_ctx,
227 struct tevent_context *ev,
228 const DATA_BLOB in, DATA_BLOB *out);
229 struct tevent_req *gensec_update_send(TALLOC_CTX *mem_ctx,
230 struct tevent_context *ev,
231 struct gensec_security *gensec_security,
233 NTSTATUS gensec_update_recv(struct tevent_req *req, TALLOC_CTX *out_mem_ctx, DATA_BLOB *out);
234 void gensec_want_feature(struct gensec_security *gensec_security,
236 bool gensec_have_feature(struct gensec_security *gensec_security,
238 NTSTATUS gensec_set_credentials(struct gensec_security *gensec_security, struct cli_credentials *credentials);
239 NTSTATUS gensec_set_target_service(struct gensec_security *gensec_security, const char *service);
240 const char *gensec_get_target_service(struct gensec_security *gensec_security);
241 NTSTATUS gensec_set_target_hostname(struct gensec_security *gensec_security, const char *hostname);
242 const char *gensec_get_target_hostname(struct gensec_security *gensec_security);
243 NTSTATUS gensec_session_key(struct gensec_security *gensec_security,
245 DATA_BLOB *session_key);
246 NTSTATUS gensec_start_mech_by_oid(struct gensec_security *gensec_security,
247 const char *mech_oid);
248 const char *gensec_get_name_by_oid(struct gensec_security *gensec_security, const char *oid_string);
249 struct cli_credentials *gensec_get_credentials(struct gensec_security *gensec_security);
250 NTSTATUS gensec_init(void);
251 size_t gensec_max_input_size(struct gensec_security *gensec_security);
252 NTSTATUS gensec_unseal_packet(struct gensec_security *gensec_security,
253 uint8_t *data, size_t length,
254 const uint8_t *whole_pdu, size_t pdu_length,
255 const DATA_BLOB *sig);
256 NTSTATUS gensec_check_packet(struct gensec_security *gensec_security,
257 const uint8_t *data, size_t length,
258 const uint8_t *whole_pdu, size_t pdu_length,
259 const DATA_BLOB *sig);
260 size_t gensec_sig_size(struct gensec_security *gensec_security, size_t data_size);
261 NTSTATUS gensec_seal_packet(struct gensec_security *gensec_security,
263 uint8_t *data, size_t length,
264 const uint8_t *whole_pdu, size_t pdu_length,
266 NTSTATUS gensec_sign_packet(struct gensec_security *gensec_security,
268 const uint8_t *data, size_t length,
269 const uint8_t *whole_pdu, size_t pdu_length,
271 NTSTATUS gensec_start_mech(struct gensec_security *gensec_security);
272 NTSTATUS gensec_start_mech_by_authtype(struct gensec_security *gensec_security,
273 uint8_t auth_type, uint8_t auth_level);
274 const char *gensec_get_name_by_authtype(struct gensec_security *gensec_security, uint8_t authtype);
275 NTSTATUS gensec_server_start(TALLOC_CTX *mem_ctx,
276 struct gensec_settings *settings,
277 struct auth4_context *auth_context,
278 struct gensec_security **gensec_security);
279 NTSTATUS gensec_session_info(struct gensec_security *gensec_security,
281 struct auth_session_info **session_info);
283 NTSTATUS gensec_set_local_address(struct gensec_security *gensec_security,
284 const struct tsocket_address *local);
285 NTSTATUS gensec_set_remote_address(struct gensec_security *gensec_security,
286 const struct tsocket_address *remote);
287 const struct tsocket_address *gensec_get_local_address(struct gensec_security *gensec_security);
288 const struct tsocket_address *gensec_get_remote_address(struct gensec_security *gensec_security);
290 NTSTATUS gensec_start_mech_by_name(struct gensec_security *gensec_security,
293 NTSTATUS gensec_unwrap(struct gensec_security *gensec_security,
297 NTSTATUS gensec_wrap(struct gensec_security *gensec_security,
302 struct gensec_security_ops **gensec_security_all(void);
303 bool gensec_security_ops_enabled(struct gensec_security_ops *ops, struct gensec_security *security);
304 struct gensec_security_ops **gensec_use_kerberos_mechs(TALLOC_CTX *mem_ctx,
305 struct gensec_security_ops **old_gensec_list,
306 struct cli_credentials *creds);
308 NTSTATUS gensec_start_mech_by_sasl_name(struct gensec_security *gensec_security,
309 const char *sasl_name);
311 int gensec_setting_int(struct gensec_settings *settings, const char *mechanism, const char *name, int default_value);
312 bool gensec_setting_bool(struct gensec_settings *settings, const char *mechanism, const char *name, bool default_value);
314 NTSTATUS gensec_set_target_principal(struct gensec_security *gensec_security, const char *principal);
316 #endif /* __GENSEC_H__ */