2 Unix SMB/CIFS implementation.
4 Generic Authentication Interface
6 Copyright (C) Andrew Tridgell 2003
7 Copyright (C) Andrew Bartlett <abartlet@samba.org> 2004-2006
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/>.
24 #include "system/network.h"
25 #define TEVENT_DEPRECATED 1
27 #include "lib/tsocket/tsocket.h"
28 #include "lib/util/tevent_ntstatus.h"
29 #include "auth/gensec/gensec.h"
30 #include "auth/gensec/gensec_internal.h"
31 #include "librpc/gen_ndr/dcerpc.h"
32 #include "auth/common_auth.h"
34 _PRIVATE_ NTSTATUS gensec_may_reset_crypto(struct gensec_security *gensec_security,
37 if (!gensec_security->ops->may_reset_crypto) {
41 return gensec_security->ops->may_reset_crypto(gensec_security, full_reset);
45 wrappers for the gensec function pointers
47 _PUBLIC_ NTSTATUS gensec_unseal_packet(struct gensec_security *gensec_security,
48 uint8_t *data, size_t length,
49 const uint8_t *whole_pdu, size_t pdu_length,
52 if (!gensec_security->ops->unseal_packet) {
53 return NT_STATUS_NOT_IMPLEMENTED;
55 if (!gensec_have_feature(gensec_security, GENSEC_FEATURE_SIGN)) {
56 return NT_STATUS_INVALID_PARAMETER;
58 if (!gensec_have_feature(gensec_security, GENSEC_FEATURE_SEAL)) {
59 return NT_STATUS_INVALID_PARAMETER;
61 if (!gensec_have_feature(gensec_security, GENSEC_FEATURE_DCE_STYLE)) {
62 return NT_STATUS_INVALID_PARAMETER;
65 return gensec_security->ops->unseal_packet(gensec_security,
67 whole_pdu, pdu_length,
71 _PUBLIC_ NTSTATUS gensec_check_packet(struct gensec_security *gensec_security,
72 const uint8_t *data, size_t length,
73 const uint8_t *whole_pdu, size_t pdu_length,
76 if (!gensec_security->ops->check_packet) {
77 return NT_STATUS_NOT_IMPLEMENTED;
79 if (!gensec_have_feature(gensec_security, GENSEC_FEATURE_SIGN)) {
80 return NT_STATUS_INVALID_PARAMETER;
83 return gensec_security->ops->check_packet(gensec_security, data, length, whole_pdu, pdu_length, sig);
86 _PUBLIC_ NTSTATUS gensec_seal_packet(struct gensec_security *gensec_security,
88 uint8_t *data, size_t length,
89 const uint8_t *whole_pdu, size_t pdu_length,
92 if (!gensec_security->ops->seal_packet) {
93 return NT_STATUS_NOT_IMPLEMENTED;
95 if (!gensec_have_feature(gensec_security, GENSEC_FEATURE_SEAL)) {
96 return NT_STATUS_INVALID_PARAMETER;
98 if (!gensec_have_feature(gensec_security, GENSEC_FEATURE_SIGN)) {
99 return NT_STATUS_INVALID_PARAMETER;
101 if (!gensec_have_feature(gensec_security, GENSEC_FEATURE_DCE_STYLE)) {
102 return NT_STATUS_INVALID_PARAMETER;
105 return gensec_security->ops->seal_packet(gensec_security, mem_ctx, data, length, whole_pdu, pdu_length, sig);
108 _PUBLIC_ NTSTATUS gensec_sign_packet(struct gensec_security *gensec_security,
110 const uint8_t *data, size_t length,
111 const uint8_t *whole_pdu, size_t pdu_length,
114 if (!gensec_security->ops->sign_packet) {
115 return NT_STATUS_NOT_IMPLEMENTED;
117 if (!gensec_have_feature(gensec_security, GENSEC_FEATURE_SIGN)) {
118 return NT_STATUS_INVALID_PARAMETER;
121 return gensec_security->ops->sign_packet(gensec_security, mem_ctx, data, length, whole_pdu, pdu_length, sig);
124 _PUBLIC_ size_t gensec_sig_size(struct gensec_security *gensec_security, size_t data_size)
126 if (!gensec_security->ops->sig_size) {
129 if (!gensec_have_feature(gensec_security, GENSEC_FEATURE_SIGN)) {
132 if (gensec_have_feature(gensec_security, GENSEC_FEATURE_SEAL)) {
133 if (!gensec_have_feature(gensec_security, GENSEC_FEATURE_DCE_STYLE)) {
138 return gensec_security->ops->sig_size(gensec_security, data_size);
141 _PUBLIC_ size_t gensec_max_wrapped_size(struct gensec_security *gensec_security)
143 if (!gensec_security->ops->max_wrapped_size) {
147 return gensec_security->ops->max_wrapped_size(gensec_security);
150 _PUBLIC_ size_t gensec_max_input_size(struct gensec_security *gensec_security)
152 if (!gensec_security->ops->max_input_size) {
153 return (1 << 17) - gensec_sig_size(gensec_security, 1 << 17);
156 return gensec_security->ops->max_input_size(gensec_security);
159 _PUBLIC_ NTSTATUS gensec_wrap(struct gensec_security *gensec_security,
164 if (!gensec_security->ops->wrap) {
165 return NT_STATUS_NOT_IMPLEMENTED;
167 return gensec_security->ops->wrap(gensec_security, mem_ctx, in, out);
170 _PUBLIC_ NTSTATUS gensec_unwrap(struct gensec_security *gensec_security,
175 if (!gensec_security->ops->unwrap) {
176 return NT_STATUS_NOT_IMPLEMENTED;
178 return gensec_security->ops->unwrap(gensec_security, mem_ctx, in, out);
181 _PUBLIC_ NTSTATUS gensec_session_key(struct gensec_security *gensec_security,
183 DATA_BLOB *session_key)
185 if (!gensec_have_feature(gensec_security, GENSEC_FEATURE_SESSION_KEY)) {
186 return NT_STATUS_NO_USER_SESSION_KEY;
189 if (!gensec_security->ops->session_key) {
190 return NT_STATUS_NOT_IMPLEMENTED;
193 return gensec_security->ops->session_key(gensec_security, mem_ctx, session_key);
197 * Log details of a successful GENSEC authorization to a service.
199 * Only successful authorizations are logged, as only these call gensec_session_info()
201 * The service may later refuse authorization due to an ACL.
204 static void log_successful_gensec_authz_event(struct gensec_security *gensec_security,
205 struct auth_session_info *session_info)
207 const struct tsocket_address *remote
208 = gensec_get_remote_address(gensec_security);
209 const struct tsocket_address *local
210 = gensec_get_local_address(gensec_security);
211 const char *service_description
212 = gensec_get_target_service_description(gensec_security);
213 log_successful_authz_event(remote, local, service_description, session_info);
218 * Return the credentials of a logged on user, including session keys
221 * Only valid after a successful authentication
223 * May only be called once per authentication. This will also make an
224 * authorization log entry, as it is already called by all the
229 _PUBLIC_ NTSTATUS gensec_session_info(struct gensec_security *gensec_security,
231 struct auth_session_info **session_info)
234 if (!gensec_security->ops->session_info) {
235 return NT_STATUS_NOT_IMPLEMENTED;
237 status = gensec_security->ops->session_info(gensec_security, mem_ctx, session_info);
239 if (NT_STATUS_IS_OK(status) && !gensec_security->subcontext
240 && (gensec_security->want_features & GENSEC_FEATURE_NO_AUTHZ_LOG) == 0) {
241 log_successful_gensec_authz_event(gensec_security, *session_info);
247 _PUBLIC_ void gensec_set_max_update_size(struct gensec_security *gensec_security,
248 uint32_t max_update_size)
250 gensec_security->max_update_size = max_update_size;
253 _PUBLIC_ size_t gensec_max_update_size(struct gensec_security *gensec_security)
255 if (gensec_security->max_update_size == 0) {
259 return gensec_security->max_update_size;
262 static NTSTATUS gensec_verify_features(struct gensec_security *gensec_security)
265 * gensec_want_feature(GENSEC_FEATURE_SIGN)
267 * gensec_want_feature(GENSEC_FEATURE_SEAL)
268 * require these flags to be available.
270 if (gensec_security->want_features & GENSEC_FEATURE_SIGN) {
271 if (!gensec_have_feature(gensec_security, GENSEC_FEATURE_SIGN)) {
272 DEBUG(0,("Did not manage to negotiate mandatory feature "
274 return NT_STATUS_ACCESS_DENIED;
277 if (gensec_security->want_features & GENSEC_FEATURE_SEAL) {
278 if (!gensec_have_feature(gensec_security, GENSEC_FEATURE_SEAL)) {
279 DEBUG(0,("Did not manage to negotiate mandatory feature "
281 return NT_STATUS_ACCESS_DENIED;
283 if (!gensec_have_feature(gensec_security, GENSEC_FEATURE_SIGN)) {
284 DEBUG(0,("Did not manage to negotiate mandatory feature "
286 return NT_STATUS_ACCESS_DENIED;
293 _PUBLIC_ NTSTATUS gensec_update_ev(struct gensec_security *gensec_security,
294 TALLOC_CTX *out_mem_ctx,
295 struct tevent_context *ev,
296 const DATA_BLOB in, DATA_BLOB *out)
299 const struct gensec_security_ops *ops = gensec_security->ops;
300 TALLOC_CTX *frame = NULL;
301 struct tevent_req *subreq = NULL;
304 if (ops->update_send == NULL) {
307 frame = talloc_stackframe();
309 ev = samba_tevent_context_init(frame);
311 status = NT_STATUS_NO_MEMORY;
316 * TODO: remove this hack once the backends
319 tevent_loop_allow_nesting(ev);
322 status = ops->update(gensec_security, out_mem_ctx,
325 if (!NT_STATUS_IS_OK(status)) {
330 * Because callers using the
331 * gensec_start_mech_by_auth_type() never call
332 * gensec_want_feature(), it isn't sensible for them
333 * to have to call gensec_have_feature() manually, and
334 * these are not points of negotiation, but are
335 * asserted by the client
337 status = gensec_verify_features(gensec_security);
338 if (!NT_STATUS_IS_OK(status)) {
345 frame = talloc_stackframe();
348 ev = samba_tevent_context_init(frame);
350 status = NT_STATUS_NO_MEMORY;
355 * TODO: remove this hack once the backends
358 tevent_loop_allow_nesting(ev);
361 subreq = ops->update_send(frame, ev, gensec_security, in);
362 if (subreq == NULL) {
363 status = NT_STATUS_NO_MEMORY;
366 ok = tevent_req_poll_ntstatus(subreq, ev, &status);
370 status = ops->update_recv(subreq, out_mem_ctx, out);
377 * Next state function for the GENSEC state machine
379 * @param gensec_security GENSEC State
380 * @param out_mem_ctx The TALLOC_CTX for *out to be allocated on
381 * @param in The request, as a DATA_BLOB
382 * @param out The reply, as an talloc()ed DATA_BLOB, on *out_mem_ctx
383 * @return Error, MORE_PROCESSING_REQUIRED if a reply is sent,
384 * or NT_STATUS_OK if the user is authenticated.
387 _PUBLIC_ NTSTATUS gensec_update(struct gensec_security *gensec_security,
388 TALLOC_CTX *out_mem_ctx,
389 const DATA_BLOB in, DATA_BLOB *out)
391 return gensec_update_ev(gensec_security, out_mem_ctx, NULL, in, out);
394 struct gensec_update_state {
395 const struct gensec_security_ops *ops;
396 struct tevent_req *subreq;
397 struct gensec_security *gensec_security;
401 * only for sync backends, we should remove this
402 * once all backends are async.
404 struct tevent_immediate *im;
408 static void gensec_update_async_trigger(struct tevent_context *ctx,
409 struct tevent_immediate *im,
411 static void gensec_update_subreq_done(struct tevent_req *subreq);
414 * Next state function for the GENSEC state machine async version
416 * @param mem_ctx The memory context for the request
417 * @param ev The event context for the request
418 * @param gensec_security GENSEC State
419 * @param in The request, as a DATA_BLOB
421 * @return The request handle or NULL on no memory failure
424 _PUBLIC_ struct tevent_req *gensec_update_send(TALLOC_CTX *mem_ctx,
425 struct tevent_context *ev,
426 struct gensec_security *gensec_security,
429 struct tevent_req *req;
430 struct gensec_update_state *state = NULL;
432 req = tevent_req_create(mem_ctx, &state,
433 struct gensec_update_state);
438 state->ops = gensec_security->ops;
439 state->gensec_security = gensec_security;
441 if (state->ops->update_send == NULL) {
443 state->im = tevent_create_immediate(state);
444 if (tevent_req_nomem(state->im, req)) {
445 return tevent_req_post(req, ev);
448 tevent_schedule_immediate(state->im, ev,
449 gensec_update_async_trigger,
455 state->subreq = state->ops->update_send(state, ev, gensec_security, in);
456 if (tevent_req_nomem(state->subreq, req)) {
457 return tevent_req_post(req, ev);
460 tevent_req_set_callback(state->subreq,
461 gensec_update_subreq_done,
467 static void gensec_update_async_trigger(struct tevent_context *ctx,
468 struct tevent_immediate *im,
471 struct tevent_req *req =
472 talloc_get_type_abort(private_data, struct tevent_req);
473 struct gensec_update_state *state =
474 tevent_req_data(req, struct gensec_update_state);
477 status = state->ops->update(state->gensec_security, state, ctx,
478 state->in, &state->out);
479 if (tevent_req_nterror(req, status)) {
483 tevent_req_done(req);
486 static void gensec_update_subreq_done(struct tevent_req *subreq)
488 struct tevent_req *req =
489 tevent_req_callback_data(subreq,
491 struct gensec_update_state *state =
493 struct gensec_update_state);
496 state->subreq = NULL;
498 status = state->ops->update_recv(subreq, state, &state->out);
500 if (tevent_req_nterror(req, status)) {
505 * Because callers using the
506 * gensec_start_mech_by_authtype() never call
507 * gensec_want_feature(), it isn't sensible for them
508 * to have to call gensec_have_feature() manually, and
509 * these are not points of negotiation, but are
510 * asserted by the client
512 status = gensec_verify_features(state->gensec_security);
513 if (tevent_req_nterror(req, status)) {
517 tevent_req_done(req);
521 * Next state function for the GENSEC state machine
523 * @param req request state
524 * @param out_mem_ctx The TALLOC_CTX for *out to be allocated on
525 * @param out The reply, as an talloc()ed DATA_BLOB, on *out_mem_ctx
526 * @return Error, MORE_PROCESSING_REQUIRED if a reply is sent,
527 * or NT_STATUS_OK if the user is authenticated.
529 _PUBLIC_ NTSTATUS gensec_update_recv(struct tevent_req *req,
530 TALLOC_CTX *out_mem_ctx,
533 struct gensec_update_state *state =
534 tevent_req_data(req, struct gensec_update_state);
537 if (tevent_req_is_nterror(req, &status)) {
538 if (!NT_STATUS_EQUAL(status, NT_STATUS_MORE_PROCESSING_REQUIRED)) {
539 tevent_req_received(req);
543 status = NT_STATUS_OK;
547 talloc_steal(out_mem_ctx, out->data);
549 tevent_req_received(req);
554 * Set the requirement for a certain feature on the connection
558 _PUBLIC_ void gensec_want_feature(struct gensec_security *gensec_security,
561 if (!gensec_security->ops || !gensec_security->ops->want_feature) {
562 gensec_security->want_features |= feature;
565 gensec_security->ops->want_feature(gensec_security, feature);
569 * Check the requirement for a certain feature on the connection
573 _PUBLIC_ bool gensec_have_feature(struct gensec_security *gensec_security,
576 if (!gensec_security->ops || !gensec_security->ops->have_feature) {
580 /* We might 'have' features that we don't 'want', because the
581 * other end demanded them, or we can't neotiate them off */
582 return gensec_security->ops->have_feature(gensec_security, feature);
585 _PUBLIC_ NTTIME gensec_expire_time(struct gensec_security *gensec_security)
587 if (!gensec_security->ops->expire_time) {
588 return GENSEC_EXPIRE_TIME_INFINITY;
591 return gensec_security->ops->expire_time(gensec_security);
594 * Return the credentials structure associated with a GENSEC context
598 _PUBLIC_ struct cli_credentials *gensec_get_credentials(struct gensec_security *gensec_security)
600 if (!gensec_security) {
603 return gensec_security->credentials;
607 * Set the target service (such as 'http' or 'host') on a GENSEC context - ensures it is talloc()ed
609 * This is used for Kerberos service principal name resolution.
612 _PUBLIC_ NTSTATUS gensec_set_target_service(struct gensec_security *gensec_security, const char *service)
614 gensec_security->target.service = talloc_strdup(gensec_security, service);
615 if (!gensec_security->target.service) {
616 return NT_STATUS_NO_MEMORY;
621 _PUBLIC_ const char *gensec_get_target_service(struct gensec_security *gensec_security)
623 if (gensec_security->target.service) {
624 return gensec_security->target.service;
631 * Set the target service (such as 'samr') on an GENSEC context - ensures it is talloc()ed.
633 * This is not the Kerberos service principal, instead this is a
634 * constant value that can be logged as part of authentication and
635 * authorization logging
637 _PUBLIC_ NTSTATUS gensec_set_target_service_description(struct gensec_security *gensec_security,
640 gensec_security->target.service_description = talloc_strdup(gensec_security, service);
641 if (!gensec_security->target.service_description) {
642 return NT_STATUS_NO_MEMORY;
647 _PUBLIC_ const char *gensec_get_target_service_description(struct gensec_security *gensec_security)
649 if (gensec_security->target.service_description) {
650 return gensec_security->target.service_description;
651 } else if (gensec_security->target.service) {
652 return gensec_security->target.service;
659 * Set the target hostname (suitable for kerberos resolutation) on a GENSEC context - ensures it is talloc()ed
663 _PUBLIC_ NTSTATUS gensec_set_target_hostname(struct gensec_security *gensec_security, const char *hostname)
665 gensec_security->target.hostname = talloc_strdup(gensec_security, hostname);
666 if (hostname && !gensec_security->target.hostname) {
667 return NT_STATUS_NO_MEMORY;
672 _PUBLIC_ const char *gensec_get_target_hostname(struct gensec_security *gensec_security)
674 /* We allow the target hostname to be overridden for testing purposes */
675 if (gensec_security->settings->target_hostname) {
676 return gensec_security->settings->target_hostname;
679 if (gensec_security->target.hostname) {
680 return gensec_security->target.hostname;
683 /* We could add use the 'set sockaddr' call, and do a reverse
684 * lookup, but this would be both insecure (compromising the
685 * way kerberos works) and add DNS timeouts */
690 * Set (and copy) local and peer socket addresses onto a socket
691 * context on the GENSEC context.
693 * This is so that kerberos can include these addresses in
694 * cryptographic tokens, to avoid certain attacks.
698 * @brief Set the local gensec address.
700 * @param gensec_security The gensec security context to use.
702 * @param remote The local address to set.
704 * @return On success NT_STATUS_OK is returned or an NT_STATUS
707 _PUBLIC_ NTSTATUS gensec_set_local_address(struct gensec_security *gensec_security,
708 const struct tsocket_address *local)
710 TALLOC_FREE(gensec_security->local_addr);
716 gensec_security->local_addr = tsocket_address_copy(local, gensec_security);
717 if (gensec_security->local_addr == NULL) {
718 return NT_STATUS_NO_MEMORY;
725 * @brief Set the remote gensec address.
727 * @param gensec_security The gensec security context to use.
729 * @param remote The remote address to set.
731 * @return On success NT_STATUS_OK is returned or an NT_STATUS
734 _PUBLIC_ NTSTATUS gensec_set_remote_address(struct gensec_security *gensec_security,
735 const struct tsocket_address *remote)
737 TALLOC_FREE(gensec_security->remote_addr);
739 if (remote == NULL) {
743 gensec_security->remote_addr = tsocket_address_copy(remote, gensec_security);
744 if (gensec_security->remote_addr == NULL) {
745 return NT_STATUS_NO_MEMORY;
752 * @brief Get the local address from a gensec security context.
754 * @param gensec_security The security context to get the address from.
756 * @return The address as tsocket_address which could be NULL if
759 _PUBLIC_ const struct tsocket_address *gensec_get_local_address(struct gensec_security *gensec_security)
761 if (gensec_security == NULL) {
764 return gensec_security->local_addr;
768 * @brief Get the remote address from a gensec security context.
770 * @param gensec_security The security context to get the address from.
772 * @return The address as tsocket_address which could be NULL if
775 _PUBLIC_ const struct tsocket_address *gensec_get_remote_address(struct gensec_security *gensec_security)
777 if (gensec_security == NULL) {
780 return gensec_security->remote_addr;
784 * Set the target principal (assuming it it known, say from the SPNEGO reply)
785 * - ensures it is talloc()ed
789 _PUBLIC_ NTSTATUS gensec_set_target_principal(struct gensec_security *gensec_security, const char *principal)
791 gensec_security->target.principal = talloc_strdup(gensec_security, principal);
792 if (!gensec_security->target.principal) {
793 return NT_STATUS_NO_MEMORY;
798 _PUBLIC_ const char *gensec_get_target_principal(struct gensec_security *gensec_security)
800 if (gensec_security->target.principal) {
801 return gensec_security->target.principal;