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, TALLOC_CTX *sig_mem_ctx,
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, TALLOC_CTX *sig_mem_ctx,
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, DATA_BLOB *session_key);
136 NTSTATUS (*session_info)(struct gensec_security *gensec_security,
137 struct auth_session_info **session_info);
138 void (*want_feature)(struct gensec_security *gensec_security,
140 bool (*have_feature)(struct gensec_security *gensec_security,
144 enum gensec_priority priority;
147 struct gensec_security_ops_wrapper {
148 const struct gensec_security_ops *op;
152 #define GENSEC_INTERFACE_VERSION 0
154 struct gensec_security {
155 const struct gensec_security_ops *ops;
157 struct cli_credentials *credentials;
158 struct gensec_target target;
159 enum gensec_role gensec_role;
161 uint32_t want_features;
162 struct tevent_context *event_ctx;
163 struct tsocket_address *local_addr, *remote_addr;
164 struct gensec_settings *settings;
166 /* When we are a server, this may be filled in to provide an
167 * NTLM authentication backend, and user lookup (such as if no
169 struct auth4_context *auth_context;
172 /* this structure is used by backends to determine the size of some critical types */
173 struct gensec_critical_sizes {
174 int interface_version;
175 int sizeof_gensec_security_ops;
176 int sizeof_gensec_security;
181 struct gensec_security;
182 struct socket_context;
183 struct auth4_context;
184 struct auth_user_info_dc;
186 /* These functions are for use here only (public because SPNEGO must
187 * use them for recursion) */
188 NTSTATUS gensec_wrap_packets(struct gensec_security *gensec_security,
192 size_t *len_processed);
193 /* These functions are for use here only (public because SPNEGO must
194 * use them for recursion) */
195 NTSTATUS gensec_unwrap_packets(struct gensec_security *gensec_security,
199 size_t *len_processed);
201 /* These functions are for use here only (public because SPNEGO must
202 * use them for recursion) */
203 NTSTATUS gensec_packet_full_request(struct gensec_security *gensec_security,
204 DATA_BLOB blob, size_t *size);
206 struct loadparm_context;
208 NTSTATUS gensec_subcontext_start(TALLOC_CTX *mem_ctx,
209 struct gensec_security *parent,
210 struct gensec_security **gensec_security);
211 NTSTATUS gensec_client_start(TALLOC_CTX *mem_ctx,
212 struct gensec_security **gensec_security,
213 struct tevent_context *ev,
214 struct gensec_settings *settings);
215 NTSTATUS gensec_start_mech_by_ops(struct gensec_security *gensec_security,
216 const struct gensec_security_ops *ops);
217 NTSTATUS gensec_start_mech_by_sasl_list(struct gensec_security *gensec_security,
218 const char **sasl_names);
219 NTSTATUS gensec_update(struct gensec_security *gensec_security, TALLOC_CTX *out_mem_ctx,
220 const DATA_BLOB in, DATA_BLOB *out);
221 struct tevent_req *gensec_update_send(TALLOC_CTX *mem_ctx,
222 struct tevent_context *ev,
223 struct gensec_security *gensec_security,
225 NTSTATUS gensec_update_recv(struct tevent_req *req, TALLOC_CTX *out_mem_ctx, DATA_BLOB *out);
226 void gensec_want_feature(struct gensec_security *gensec_security,
228 bool gensec_have_feature(struct gensec_security *gensec_security,
230 NTSTATUS gensec_set_credentials(struct gensec_security *gensec_security, struct cli_credentials *credentials);
231 NTSTATUS gensec_set_target_service(struct gensec_security *gensec_security, const char *service);
232 const char *gensec_get_target_service(struct gensec_security *gensec_security);
233 NTSTATUS gensec_set_target_hostname(struct gensec_security *gensec_security, const char *hostname);
234 const char *gensec_get_target_hostname(struct gensec_security *gensec_security);
235 NTSTATUS gensec_session_key(struct gensec_security *gensec_security,
236 DATA_BLOB *session_key);
237 NTSTATUS gensec_start_mech_by_oid(struct gensec_security *gensec_security,
238 const char *mech_oid);
239 const char *gensec_get_name_by_oid(struct gensec_security *gensec_security, const char *oid_string);
240 struct cli_credentials *gensec_get_credentials(struct gensec_security *gensec_security);
241 NTSTATUS gensec_init(void);
242 size_t gensec_max_input_size(struct gensec_security *gensec_security);
243 NTSTATUS gensec_unseal_packet(struct gensec_security *gensec_security,
245 uint8_t *data, size_t length,
246 const uint8_t *whole_pdu, size_t pdu_length,
247 const DATA_BLOB *sig);
248 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,
274 struct auth_session_info **session_info);
276 NTSTATUS gensec_set_local_address(struct gensec_security *gensec_security,
277 const struct tsocket_address *local);
278 NTSTATUS gensec_set_remote_address(struct gensec_security *gensec_security,
279 const struct tsocket_address *remote);
280 const struct tsocket_address *gensec_get_local_address(struct gensec_security *gensec_security);
281 const struct tsocket_address *gensec_get_remote_address(struct gensec_security *gensec_security);
283 NTSTATUS gensec_start_mech_by_name(struct gensec_security *gensec_security,
286 NTSTATUS gensec_unwrap(struct gensec_security *gensec_security,
290 NTSTATUS gensec_wrap(struct gensec_security *gensec_security,
295 struct gensec_security_ops **gensec_security_all(void);
296 bool gensec_security_ops_enabled(struct gensec_security_ops *ops, struct gensec_security *security);
297 struct gensec_security_ops **gensec_use_kerberos_mechs(TALLOC_CTX *mem_ctx,
298 struct gensec_security_ops **old_gensec_list,
299 struct cli_credentials *creds);
301 NTSTATUS gensec_start_mech_by_sasl_name(struct gensec_security *gensec_security,
302 const char *sasl_name);
304 int gensec_setting_int(struct gensec_settings *settings, const char *mechanism, const char *name, int default_value);
305 bool gensec_setting_bool(struct gensec_settings *settings, const char *mechanism, const char *name, bool default_value);
307 NTSTATUS gensec_set_target_principal(struct gensec_security *gensec_security, const char *principal);
309 #endif /* __GENSEC_H__ */