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 #define GENSEC_OID_NTLMSSP "1.3.6.1.4.1.311.2.2.10"
27 #define GENSEC_OID_SPNEGO "1.3.6.1.5.5.2"
28 #define GENSEC_OID_KERBEROS5 "1.2.840.113554.1.2.2"
29 #define GENSEC_OID_KERBEROS5_OLD "1.2.840.48018.1.2.2"
30 #define GENSEC_OID_KERBEROS5_USER2USER "1.2.840.113554.1.2.2.3"
32 enum gensec_priority {
42 struct gensec_security;
43 struct gensec_target {
44 const char *principal;
49 #define GENSEC_FEATURE_SESSION_KEY 0x00000001
50 #define GENSEC_FEATURE_SIGN 0x00000002
51 #define GENSEC_FEATURE_SEAL 0x00000004
52 #define GENSEC_FEATURE_DCE_STYLE 0x00000008
53 #define GENSEC_FEATURE_ASYNC_REPLIES 0x00000010
54 #define GENSEC_FEATURE_DATAGRAM_MODE 0x00000020
55 #define GENSEC_FEATURE_SIGN_PKT_HEADER 0x00000040
56 #define GENSEC_FEATURE_NEW_SPNEGO 0x00000080
65 struct auth_session_info;
66 struct cli_credentials;
67 struct gensec_settings;
69 struct gensec_update_request {
70 struct gensec_security *gensec_security;
76 void (*fn)(struct gensec_update_request *req, void *private_data);
81 struct gensec_settings {
82 struct loadparm_context *lp_ctx;
83 struct smb_iconv_convenience *iconv_convenience;
84 const char *target_hostname;
87 struct gensec_security_ops {
89 const char *sasl_name;
90 uint8_t auth_type; /* 0 if not offered on DCE-RPC */
91 const char **oid; /* NULL if not offered by SPNEGO */
92 NTSTATUS (*client_start)(struct gensec_security *gensec_security);
93 NTSTATUS (*server_start)(struct gensec_security *gensec_security);
95 Determine if a packet has the right 'magic' for this mechanism
97 NTSTATUS (*magic)(struct gensec_security *gensec_security,
98 const DATA_BLOB *first_packet);
99 NTSTATUS (*update)(struct gensec_security *gensec_security, TALLOC_CTX *out_mem_ctx,
100 const DATA_BLOB in, DATA_BLOB *out);
101 NTSTATUS (*seal_packet)(struct gensec_security *gensec_security, TALLOC_CTX *sig_mem_ctx,
102 uint8_t *data, size_t length,
103 const uint8_t *whole_pdu, size_t pdu_length,
105 NTSTATUS (*sign_packet)(struct gensec_security *gensec_security, TALLOC_CTX *sig_mem_ctx,
106 const uint8_t *data, size_t length,
107 const uint8_t *whole_pdu, size_t pdu_length,
109 size_t (*sig_size)(struct gensec_security *gensec_security, size_t data_size);
110 size_t (*max_input_size)(struct gensec_security *gensec_security);
111 size_t (*max_wrapped_size)(struct gensec_security *gensec_security);
112 NTSTATUS (*check_packet)(struct gensec_security *gensec_security, TALLOC_CTX *sig_mem_ctx,
113 const uint8_t *data, size_t length,
114 const uint8_t *whole_pdu, size_t pdu_length,
115 const DATA_BLOB *sig);
116 NTSTATUS (*unseal_packet)(struct gensec_security *gensec_security, TALLOC_CTX *sig_mem_ctx,
117 uint8_t *data, size_t length,
118 const uint8_t *whole_pdu, size_t pdu_length,
119 const DATA_BLOB *sig);
120 NTSTATUS (*wrap)(struct gensec_security *gensec_security,
124 NTSTATUS (*unwrap)(struct gensec_security *gensec_security,
128 NTSTATUS (*wrap_packets)(struct gensec_security *gensec_security,
132 size_t *len_processed);
133 NTSTATUS (*unwrap_packets)(struct gensec_security *gensec_security,
137 size_t *len_processed);
138 NTSTATUS (*packet_full_request)(struct gensec_security *gensec_security,
139 DATA_BLOB blob, size_t *size);
140 NTSTATUS (*session_key)(struct gensec_security *gensec_security, DATA_BLOB *session_key);
141 NTSTATUS (*session_info)(struct gensec_security *gensec_security,
142 struct auth_session_info **session_info);
143 void (*want_feature)(struct gensec_security *gensec_security,
145 bool (*have_feature)(struct gensec_security *gensec_security,
149 enum gensec_priority priority;
152 struct gensec_security_ops_wrapper {
153 const struct gensec_security_ops *op;
157 #define GENSEC_INTERFACE_VERSION 0
159 struct gensec_security {
160 const struct gensec_security_ops *ops;
162 struct cli_credentials *credentials;
163 struct gensec_target target;
164 enum gensec_role gensec_role;
166 uint32_t want_features;
167 struct event_context *event_ctx;
168 struct messaging_context *msg_ctx; /* only valid as server */
169 struct socket_address *my_addr, *peer_addr;
170 struct gensec_settings *settings;
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;
185 NTSTATUS gensec_socket_init(struct gensec_security *gensec_security,
187 struct socket_context *current_socket,
188 struct event_context *ev,
189 void (*recv_handler)(void *, uint16_t),
191 struct socket_context **new_socket);
192 /* These functions are for use here only (public because SPNEGO must
193 * use them for recursion) */
194 NTSTATUS gensec_wrap_packets(struct gensec_security *gensec_security,
198 size_t *len_processed);
199 /* These functions are for use here only (public because SPNEGO must
200 * use them for recursion) */
201 NTSTATUS gensec_unwrap_packets(struct gensec_security *gensec_security,
205 size_t *len_processed);
207 /* These functions are for use here only (public because SPNEGO must
208 * use them for recursion) */
209 NTSTATUS gensec_packet_full_request(struct gensec_security *gensec_security,
210 DATA_BLOB blob, size_t *size);
212 struct loadparm_context;
214 NTSTATUS gensec_subcontext_start(TALLOC_CTX *mem_ctx,
215 struct gensec_security *parent,
216 struct gensec_security **gensec_security);
217 NTSTATUS gensec_client_start(TALLOC_CTX *mem_ctx,
218 struct gensec_security **gensec_security,
219 struct event_context *ev,
220 struct gensec_settings *settings);
221 NTSTATUS gensec_start_mech_by_sasl_list(struct gensec_security *gensec_security,
222 const char **sasl_names);
223 NTSTATUS gensec_update(struct gensec_security *gensec_security, TALLOC_CTX *out_mem_ctx,
224 const DATA_BLOB in, DATA_BLOB *out);
225 void gensec_update_send(struct gensec_security *gensec_security, const DATA_BLOB in,
226 void (*callback)(struct gensec_update_request *req, void *private_data),
228 NTSTATUS gensec_update_recv(struct gensec_update_request *req, TALLOC_CTX *out_mem_ctx, DATA_BLOB *out);
229 void gensec_want_feature(struct gensec_security *gensec_security,
231 bool gensec_have_feature(struct gensec_security *gensec_security,
233 NTSTATUS gensec_set_credentials(struct gensec_security *gensec_security, struct cli_credentials *credentials);
234 NTSTATUS gensec_set_target_service(struct gensec_security *gensec_security, const char *service);
235 const char *gensec_get_target_service(struct gensec_security *gensec_security);
236 NTSTATUS gensec_set_target_hostname(struct gensec_security *gensec_security, const char *hostname);
237 const char *gensec_get_target_hostname(struct gensec_security *gensec_security);
238 NTSTATUS gensec_session_key(struct gensec_security *gensec_security,
239 DATA_BLOB *session_key);
240 NTSTATUS gensec_start_mech_by_oid(struct gensec_security *gensec_security,
241 const char *mech_oid);
242 const char *gensec_get_name_by_oid(const char *oid_string);
243 struct cli_credentials *gensec_get_credentials(struct gensec_security *gensec_security);
244 struct socket_address *gensec_get_peer_addr(struct gensec_security *gensec_security);
245 NTSTATUS gensec_init(struct loadparm_context *lp_ctx);
246 NTSTATUS gensec_unseal_packet(struct gensec_security *gensec_security,
248 uint8_t *data, size_t length,
249 const uint8_t *whole_pdu, size_t pdu_length,
250 const DATA_BLOB *sig);
251 NTSTATUS gensec_check_packet(struct gensec_security *gensec_security,
253 const uint8_t *data, size_t length,
254 const uint8_t *whole_pdu, size_t pdu_length,
255 const DATA_BLOB *sig);
256 size_t gensec_sig_size(struct gensec_security *gensec_security, size_t data_size);
257 NTSTATUS gensec_seal_packet(struct gensec_security *gensec_security,
259 uint8_t *data, size_t length,
260 const uint8_t *whole_pdu, size_t pdu_length,
262 NTSTATUS gensec_sign_packet(struct gensec_security *gensec_security,
264 const uint8_t *data, size_t length,
265 const uint8_t *whole_pdu, size_t pdu_length,
267 NTSTATUS gensec_start_mech_by_authtype(struct gensec_security *gensec_security,
268 uint8_t auth_type, uint8_t auth_level);
269 const char *gensec_get_name_by_authtype(uint8_t authtype);
270 NTSTATUS gensec_server_start(TALLOC_CTX *mem_ctx,
271 struct event_context *ev,
272 struct gensec_settings *settings,
273 struct messaging_context *msg,
274 struct gensec_security **gensec_security);
275 NTSTATUS gensec_session_info(struct gensec_security *gensec_security,
276 struct auth_session_info **session_info);
277 NTSTATUS auth_nt_status_squash(NTSTATUS nt_status);
278 struct creds_CredentialState;
279 NTSTATUS dcerpc_schannel_creds(struct gensec_security *gensec_security,
281 struct creds_CredentialState **creds);
282 NTSTATUS gensec_set_peer_addr(struct gensec_security *gensec_security, struct socket_address *peer_addr);
283 NTSTATUS gensec_set_my_addr(struct gensec_security *gensec_security, struct socket_address *my_addr);
285 NTSTATUS gensec_start_mech_by_name(struct gensec_security *gensec_security,
288 NTSTATUS gensec_unwrap(struct gensec_security *gensec_security,
292 NTSTATUS gensec_wrap(struct gensec_security *gensec_security,
297 struct gensec_security_ops **gensec_security_all(void);
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 #endif /* __GENSEC_H__ */