auth: Add hooks for notification of authentication events over the message bus
[samba.git] / auth / gensec / gensec.c
1 /*
2    Unix SMB/CIFS implementation.
3
4    Generic Authentication Interface
5
6    Copyright (C) Andrew Tridgell 2003
7    Copyright (C) Andrew Bartlett <abartlet@samba.org> 2004-2006
8
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.
13
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.
18
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/>.
21 */
22
23 #include "includes.h"
24 #include "system/network.h"
25 #define TEVENT_DEPRECATED 1
26 #include <tevent.h>
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"
33
34 _PRIVATE_ NTSTATUS gensec_may_reset_crypto(struct gensec_security *gensec_security,
35                                            bool full_reset)
36 {
37         if (!gensec_security->ops->may_reset_crypto) {
38                 return NT_STATUS_OK;
39         }
40
41         return gensec_security->ops->may_reset_crypto(gensec_security, full_reset);
42 }
43
44 /*
45   wrappers for the gensec function pointers
46 */
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,
50                               const DATA_BLOB *sig)
51 {
52         if (!gensec_security->ops->unseal_packet) {
53                 return NT_STATUS_NOT_IMPLEMENTED;
54         }
55         if (!gensec_have_feature(gensec_security, GENSEC_FEATURE_SIGN)) {
56                 return NT_STATUS_INVALID_PARAMETER;
57         }
58         if (!gensec_have_feature(gensec_security, GENSEC_FEATURE_SEAL)) {
59                 return NT_STATUS_INVALID_PARAMETER;
60         }
61         if (!gensec_have_feature(gensec_security, GENSEC_FEATURE_DCE_STYLE)) {
62                 return NT_STATUS_INVALID_PARAMETER;
63         }
64
65         return gensec_security->ops->unseal_packet(gensec_security,
66                                                    data, length,
67                                                    whole_pdu, pdu_length,
68                                                    sig);
69 }
70
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,
74                              const DATA_BLOB *sig)
75 {
76         if (!gensec_security->ops->check_packet) {
77                 return NT_STATUS_NOT_IMPLEMENTED;
78         }
79         if (!gensec_have_feature(gensec_security, GENSEC_FEATURE_SIGN)) {
80                 return NT_STATUS_INVALID_PARAMETER;
81         }
82
83         return gensec_security->ops->check_packet(gensec_security, data, length, whole_pdu, pdu_length, sig);
84 }
85
86 _PUBLIC_ NTSTATUS gensec_seal_packet(struct gensec_security *gensec_security,
87                             TALLOC_CTX *mem_ctx,
88                             uint8_t *data, size_t length,
89                             const uint8_t *whole_pdu, size_t pdu_length,
90                             DATA_BLOB *sig)
91 {
92         if (!gensec_security->ops->seal_packet) {
93                 return NT_STATUS_NOT_IMPLEMENTED;
94         }
95         if (!gensec_have_feature(gensec_security, GENSEC_FEATURE_SEAL)) {
96                 return NT_STATUS_INVALID_PARAMETER;
97         }
98         if (!gensec_have_feature(gensec_security, GENSEC_FEATURE_SIGN)) {
99                 return NT_STATUS_INVALID_PARAMETER;
100         }
101         if (!gensec_have_feature(gensec_security, GENSEC_FEATURE_DCE_STYLE)) {
102                 return NT_STATUS_INVALID_PARAMETER;
103         }
104
105         return gensec_security->ops->seal_packet(gensec_security, mem_ctx, data, length, whole_pdu, pdu_length, sig);
106 }
107
108 _PUBLIC_ NTSTATUS gensec_sign_packet(struct gensec_security *gensec_security,
109                             TALLOC_CTX *mem_ctx,
110                             const uint8_t *data, size_t length,
111                             const uint8_t *whole_pdu, size_t pdu_length,
112                             DATA_BLOB *sig)
113 {
114         if (!gensec_security->ops->sign_packet) {
115                 return NT_STATUS_NOT_IMPLEMENTED;
116         }
117         if (!gensec_have_feature(gensec_security, GENSEC_FEATURE_SIGN)) {
118                 return NT_STATUS_INVALID_PARAMETER;
119         }
120
121         return gensec_security->ops->sign_packet(gensec_security, mem_ctx, data, length, whole_pdu, pdu_length, sig);
122 }
123
124 _PUBLIC_ size_t gensec_sig_size(struct gensec_security *gensec_security, size_t data_size)
125 {
126         if (!gensec_security->ops->sig_size) {
127                 return 0;
128         }
129         if (!gensec_have_feature(gensec_security, GENSEC_FEATURE_SIGN)) {
130                 return 0;
131         }
132         if (gensec_have_feature(gensec_security, GENSEC_FEATURE_SEAL)) {
133                 if (!gensec_have_feature(gensec_security, GENSEC_FEATURE_DCE_STYLE)) {
134                         return 0;
135                 }
136         }
137
138         return gensec_security->ops->sig_size(gensec_security, data_size);
139 }
140
141 _PUBLIC_ size_t gensec_max_wrapped_size(struct gensec_security *gensec_security)
142 {
143         if (!gensec_security->ops->max_wrapped_size) {
144                 return (1 << 17);
145         }
146
147         return gensec_security->ops->max_wrapped_size(gensec_security);
148 }
149
150 _PUBLIC_ size_t gensec_max_input_size(struct gensec_security *gensec_security)
151 {
152         if (!gensec_security->ops->max_input_size) {
153                 return (1 << 17) - gensec_sig_size(gensec_security, 1 << 17);
154         }
155
156         return gensec_security->ops->max_input_size(gensec_security);
157 }
158
159 _PUBLIC_ NTSTATUS gensec_wrap(struct gensec_security *gensec_security,
160                      TALLOC_CTX *mem_ctx,
161                      const DATA_BLOB *in,
162                      DATA_BLOB *out)
163 {
164         if (!gensec_security->ops->wrap) {
165                 return NT_STATUS_NOT_IMPLEMENTED;
166         }
167         return gensec_security->ops->wrap(gensec_security, mem_ctx, in, out);
168 }
169
170 _PUBLIC_ NTSTATUS gensec_unwrap(struct gensec_security *gensec_security,
171                        TALLOC_CTX *mem_ctx,
172                        const DATA_BLOB *in,
173                        DATA_BLOB *out)
174 {
175         if (!gensec_security->ops->unwrap) {
176                 return NT_STATUS_NOT_IMPLEMENTED;
177         }
178         return gensec_security->ops->unwrap(gensec_security, mem_ctx, in, out);
179 }
180
181 _PUBLIC_ NTSTATUS gensec_session_key(struct gensec_security *gensec_security,
182                                      TALLOC_CTX *mem_ctx,
183                                      DATA_BLOB *session_key)
184 {
185         if (!gensec_have_feature(gensec_security, GENSEC_FEATURE_SESSION_KEY)) {
186                 return NT_STATUS_NO_USER_SESSION_KEY;
187         }
188
189         if (!gensec_security->ops->session_key) {
190                 return NT_STATUS_NOT_IMPLEMENTED;
191         }
192
193         return gensec_security->ops->session_key(gensec_security, mem_ctx, session_key);
194 }
195
196 const char *gensec_final_auth_type(struct gensec_security *gensec_security)
197 {
198         if (!gensec_security->ops->final_auth_type) {
199                 return gensec_security->ops->name;
200         }
201
202         return gensec_security->ops->final_auth_type(gensec_security);
203 }
204
205 /*
206  * Log details of a successful GENSEC authorization to a service.
207  *
208  * Only successful authorizations are logged, as only these call gensec_session_info()
209  *
210  * The service may later refuse authorization due to an ACL.
211  *
212  */
213 static void log_successful_gensec_authz_event(struct gensec_security *gensec_security,
214                                               struct auth_session_info *session_info)
215 {
216         const struct tsocket_address *remote
217                 = gensec_get_remote_address(gensec_security);
218         const struct tsocket_address *local
219                 = gensec_get_local_address(gensec_security);
220         const char *service_description
221                 = gensec_get_target_service_description(gensec_security);
222         const char *final_auth_type
223                 = gensec_final_auth_type(gensec_security);
224         const char *transport_protection = NULL;
225         if (gensec_security->want_features & GENSEC_FEATURE_SMB_TRANSPORT) {
226                 transport_protection = AUTHZ_TRANSPORT_PROTECTION_SMB;
227         } else if (gensec_security->want_features & GENSEC_FEATURE_LDAPS_TRANSPORT) {
228                 transport_protection = AUTHZ_TRANSPORT_PROTECTION_TLS;
229         } else if (gensec_have_feature(gensec_security, GENSEC_FEATURE_SEAL)) {
230                 transport_protection = AUTHZ_TRANSPORT_PROTECTION_SEAL;
231         } else if (gensec_have_feature(gensec_security, GENSEC_FEATURE_SIGN)) {
232                 transport_protection = AUTHZ_TRANSPORT_PROTECTION_SIGN;
233         } else {
234                 transport_protection = AUTHZ_TRANSPORT_PROTECTION_NONE;
235         }
236         log_successful_authz_event(gensec_security->auth_context->msg_ctx,
237                                    gensec_security->auth_context->lp_ctx,
238                                    remote, local,
239                                    service_description,
240                                    final_auth_type,
241                                    transport_protection,
242                                    session_info);
243 }
244
245
246 /**
247  * Return the credentials of a logged on user, including session keys
248  * etc.
249  *
250  * Only valid after a successful authentication
251  *
252  * May only be called once per authentication.  This will also make an
253  * authorization log entry, as it is already called by all the
254  * callers.
255  *
256  */
257
258 _PUBLIC_ NTSTATUS gensec_session_info(struct gensec_security *gensec_security,
259                                       TALLOC_CTX *mem_ctx,
260                                       struct auth_session_info **session_info)
261 {
262         NTSTATUS status;
263         if (!gensec_security->ops->session_info) {
264                 return NT_STATUS_NOT_IMPLEMENTED;
265         }
266         status = gensec_security->ops->session_info(gensec_security, mem_ctx, session_info);
267
268         if (NT_STATUS_IS_OK(status) && !gensec_security->subcontext
269             && (gensec_security->want_features & GENSEC_FEATURE_NO_AUTHZ_LOG) == 0) {
270                 log_successful_gensec_authz_event(gensec_security, *session_info);
271         }
272
273         return status;
274 }
275
276 _PUBLIC_ void gensec_set_max_update_size(struct gensec_security *gensec_security,
277                                 uint32_t max_update_size)
278 {
279         gensec_security->max_update_size = max_update_size;
280 }
281
282 _PUBLIC_ size_t gensec_max_update_size(struct gensec_security *gensec_security)
283 {
284         if (gensec_security->max_update_size == 0) {
285                 return UINT32_MAX;
286         }
287
288         return gensec_security->max_update_size;
289 }
290
291 static NTSTATUS gensec_verify_features(struct gensec_security *gensec_security)
292 {
293         /*
294          * gensec_want_feature(GENSEC_FEATURE_SIGN)
295          * and
296          * gensec_want_feature(GENSEC_FEATURE_SEAL)
297          * require these flags to be available.
298          */
299         if (gensec_security->want_features & GENSEC_FEATURE_SIGN) {
300                 if (!gensec_have_feature(gensec_security, GENSEC_FEATURE_SIGN)) {
301                         DEBUG(0,("Did not manage to negotiate mandatory feature "
302                                  "SIGN\n"));
303                         return NT_STATUS_ACCESS_DENIED;
304                 }
305         }
306         if (gensec_security->want_features & GENSEC_FEATURE_SEAL) {
307                 if (!gensec_have_feature(gensec_security, GENSEC_FEATURE_SEAL)) {
308                         DEBUG(0,("Did not manage to negotiate mandatory feature "
309                                  "SEAL\n"));
310                         return NT_STATUS_ACCESS_DENIED;
311                 }
312                 if (!gensec_have_feature(gensec_security, GENSEC_FEATURE_SIGN)) {
313                         DEBUG(0,("Did not manage to negotiate mandatory feature "
314                                  "SIGN for SEAL\n"));
315                         return NT_STATUS_ACCESS_DENIED;
316                 }
317         }
318
319         return NT_STATUS_OK;
320 }
321
322 _PUBLIC_ NTSTATUS gensec_update_ev(struct gensec_security *gensec_security,
323                                    TALLOC_CTX *out_mem_ctx,
324                                    struct tevent_context *ev,
325                                    const DATA_BLOB in, DATA_BLOB *out)
326 {
327         NTSTATUS status;
328         const struct gensec_security_ops *ops = gensec_security->ops;
329         TALLOC_CTX *frame = NULL;
330         struct tevent_req *subreq = NULL;
331         bool ok;
332
333         if (ops->update_send == NULL) {
334
335                 if (ev == NULL) {
336                         frame = talloc_stackframe();
337
338                         ev = samba_tevent_context_init(frame);
339                         if (ev == NULL) {
340                                 status = NT_STATUS_NO_MEMORY;
341                                 goto fail;
342                         }
343
344                         /*
345                          * TODO: remove this hack once the backends
346                          * are fixed.
347                          */
348                         tevent_loop_allow_nesting(ev);
349                 }
350
351                 status = ops->update(gensec_security, out_mem_ctx,
352                                      ev, in, out);
353                 TALLOC_FREE(frame);
354                 if (!NT_STATUS_IS_OK(status)) {
355                         return status;
356                 }
357
358                 /*
359                  * Because callers using the
360                  * gensec_start_mech_by_auth_type() never call
361                  * gensec_want_feature(), it isn't sensible for them
362                  * to have to call gensec_have_feature() manually, and
363                  * these are not points of negotiation, but are
364                  * asserted by the client
365                  */
366                 status = gensec_verify_features(gensec_security);
367                 if (!NT_STATUS_IS_OK(status)) {
368                         return status;
369                 }
370
371                 return NT_STATUS_OK;
372         }
373
374         frame = talloc_stackframe();
375
376         if (ev == NULL) {
377                 ev = samba_tevent_context_init(frame);
378                 if (ev == NULL) {
379                         status = NT_STATUS_NO_MEMORY;
380                         goto fail;
381                 }
382
383                 /*
384                  * TODO: remove this hack once the backends
385                  * are fixed.
386                  */
387                 tevent_loop_allow_nesting(ev);
388         }
389
390         subreq = ops->update_send(frame, ev, gensec_security, in);
391         if (subreq == NULL) {
392                 status = NT_STATUS_NO_MEMORY;
393                 goto fail;
394         }
395         ok = tevent_req_poll_ntstatus(subreq, ev, &status);
396         if (!ok) {
397                 goto fail;
398         }
399         status = ops->update_recv(subreq, out_mem_ctx, out);
400  fail:
401         TALLOC_FREE(frame);
402         return status;
403 }
404
405 /**
406  * Next state function for the GENSEC state machine
407  *
408  * @param gensec_security GENSEC State
409  * @param out_mem_ctx The TALLOC_CTX for *out to be allocated on
410  * @param in The request, as a DATA_BLOB
411  * @param out The reply, as an talloc()ed DATA_BLOB, on *out_mem_ctx
412  * @return Error, MORE_PROCESSING_REQUIRED if a reply is sent,
413  *                or NT_STATUS_OK if the user is authenticated.
414  */
415
416 _PUBLIC_ NTSTATUS gensec_update(struct gensec_security *gensec_security,
417                                 TALLOC_CTX *out_mem_ctx,
418                                 const DATA_BLOB in, DATA_BLOB *out)
419 {
420         return gensec_update_ev(gensec_security, out_mem_ctx, NULL, in, out);
421 }
422
423 struct gensec_update_state {
424         const struct gensec_security_ops *ops;
425         struct tevent_req *subreq;
426         struct gensec_security *gensec_security;
427         DATA_BLOB out;
428
429         /*
430          * only for sync backends, we should remove this
431          * once all backends are async.
432          */
433         struct tevent_immediate *im;
434         DATA_BLOB in;
435 };
436
437 static void gensec_update_async_trigger(struct tevent_context *ctx,
438                                         struct tevent_immediate *im,
439                                         void *private_data);
440 static void gensec_update_subreq_done(struct tevent_req *subreq);
441
442 /**
443  * Next state function for the GENSEC state machine async version
444  *
445  * @param mem_ctx The memory context for the request
446  * @param ev The event context for the request
447  * @param gensec_security GENSEC State
448  * @param in The request, as a DATA_BLOB
449  *
450  * @return The request handle or NULL on no memory failure
451  */
452
453 _PUBLIC_ struct tevent_req *gensec_update_send(TALLOC_CTX *mem_ctx,
454                                                struct tevent_context *ev,
455                                                struct gensec_security *gensec_security,
456                                                const DATA_BLOB in)
457 {
458         struct tevent_req *req;
459         struct gensec_update_state *state = NULL;
460
461         req = tevent_req_create(mem_ctx, &state,
462                                 struct gensec_update_state);
463         if (req == NULL) {
464                 return NULL;
465         }
466
467         state->ops = gensec_security->ops;
468         state->gensec_security = gensec_security;
469
470         if (state->ops->update_send == NULL) {
471                 state->in = in;
472                 state->im = tevent_create_immediate(state);
473                 if (tevent_req_nomem(state->im, req)) {
474                         return tevent_req_post(req, ev);
475                 }
476
477                 tevent_schedule_immediate(state->im, ev,
478                                           gensec_update_async_trigger,
479                                           req);
480
481                 return req;
482         }
483
484         state->subreq = state->ops->update_send(state, ev, gensec_security, in);
485         if (tevent_req_nomem(state->subreq, req)) {
486                 return tevent_req_post(req, ev);
487         }
488
489         tevent_req_set_callback(state->subreq,
490                                 gensec_update_subreq_done,
491                                 req);
492
493         return req;
494 }
495
496 static void gensec_update_async_trigger(struct tevent_context *ctx,
497                                         struct tevent_immediate *im,
498                                         void *private_data)
499 {
500         struct tevent_req *req =
501                 talloc_get_type_abort(private_data, struct tevent_req);
502         struct gensec_update_state *state =
503                 tevent_req_data(req, struct gensec_update_state);
504         NTSTATUS status;
505
506         status = state->ops->update(state->gensec_security, state, ctx,
507                                     state->in, &state->out);
508         if (tevent_req_nterror(req, status)) {
509                 return;
510         }
511
512         tevent_req_done(req);
513 }
514
515 static void gensec_update_subreq_done(struct tevent_req *subreq)
516 {
517         struct tevent_req *req =
518                 tevent_req_callback_data(subreq,
519                 struct tevent_req);
520         struct gensec_update_state *state =
521                 tevent_req_data(req,
522                 struct gensec_update_state);
523         NTSTATUS status;
524
525         state->subreq = NULL;
526
527         status = state->ops->update_recv(subreq, state, &state->out);
528         TALLOC_FREE(subreq);
529         if (tevent_req_nterror(req, status)) {
530                 return;
531         }
532
533         /*
534          * Because callers using the
535          * gensec_start_mech_by_authtype() never call
536          * gensec_want_feature(), it isn't sensible for them
537          * to have to call gensec_have_feature() manually, and
538          * these are not points of negotiation, but are
539          * asserted by the client
540          */
541         status = gensec_verify_features(state->gensec_security);
542         if (tevent_req_nterror(req, status)) {
543                 return;
544         }
545
546         tevent_req_done(req);
547 }
548
549 /**
550  * Next state function for the GENSEC state machine
551  *
552  * @param req request state
553  * @param out_mem_ctx The TALLOC_CTX for *out to be allocated on
554  * @param out The reply, as an talloc()ed DATA_BLOB, on *out_mem_ctx
555  * @return Error, MORE_PROCESSING_REQUIRED if a reply is sent,
556  *                or NT_STATUS_OK if the user is authenticated.
557  */
558 _PUBLIC_ NTSTATUS gensec_update_recv(struct tevent_req *req,
559                                      TALLOC_CTX *out_mem_ctx,
560                                      DATA_BLOB *out)
561 {
562         struct gensec_update_state *state =
563                 tevent_req_data(req, struct gensec_update_state);
564         NTSTATUS status;
565
566         if (tevent_req_is_nterror(req, &status)) {
567                 if (!NT_STATUS_EQUAL(status, NT_STATUS_MORE_PROCESSING_REQUIRED)) {
568                         tevent_req_received(req);
569                         return status;
570                 }
571         } else {
572                 status = NT_STATUS_OK;
573         }
574
575         *out = state->out;
576         talloc_steal(out_mem_ctx, out->data);
577
578         tevent_req_received(req);
579         return status;
580 }
581
582 /**
583  * Set the requirement for a certain feature on the connection
584  *
585  */
586
587 _PUBLIC_ void gensec_want_feature(struct gensec_security *gensec_security,
588                          uint32_t feature)
589 {
590         if (!gensec_security->ops || !gensec_security->ops->want_feature) {
591                 gensec_security->want_features |= feature;
592                 return;
593         }
594         gensec_security->ops->want_feature(gensec_security, feature);
595 }
596
597 /**
598  * Check the requirement for a certain feature on the connection
599  *
600  */
601
602 _PUBLIC_ bool gensec_have_feature(struct gensec_security *gensec_security,
603                          uint32_t feature)
604 {
605         if (!gensec_security->ops || !gensec_security->ops->have_feature) {
606                 return false;
607         }
608
609         /* We might 'have' features that we don't 'want', because the
610          * other end demanded them, or we can't neotiate them off */
611         return gensec_security->ops->have_feature(gensec_security, feature);
612 }
613
614 _PUBLIC_ NTTIME gensec_expire_time(struct gensec_security *gensec_security)
615 {
616         if (!gensec_security->ops->expire_time) {
617                 return GENSEC_EXPIRE_TIME_INFINITY;
618         }
619
620         return gensec_security->ops->expire_time(gensec_security);
621 }
622 /**
623  * Return the credentials structure associated with a GENSEC context
624  *
625  */
626
627 _PUBLIC_ struct cli_credentials *gensec_get_credentials(struct gensec_security *gensec_security)
628 {
629         if (!gensec_security) {
630                 return NULL;
631         }
632         return gensec_security->credentials;
633 }
634
635 /**
636  * Set the target service (such as 'http' or 'host') on a GENSEC context - ensures it is talloc()ed
637  *
638  * This is used for Kerberos service principal name resolution.
639  */
640
641 _PUBLIC_ NTSTATUS gensec_set_target_service(struct gensec_security *gensec_security, const char *service)
642 {
643         gensec_security->target.service = talloc_strdup(gensec_security, service);
644         if (!gensec_security->target.service) {
645                 return NT_STATUS_NO_MEMORY;
646         }
647         return NT_STATUS_OK;
648 }
649
650 _PUBLIC_ const char *gensec_get_target_service(struct gensec_security *gensec_security)
651 {
652         if (gensec_security->target.service) {
653                 return gensec_security->target.service;
654         }
655
656         return "host";
657 }
658
659 /**
660  * Set the target service (such as 'samr') on an GENSEC context - ensures it is talloc()ed.
661  *
662  * This is not the Kerberos service principal, instead this is a
663  * constant value that can be logged as part of authentication and
664  * authorization logging
665  */
666 _PUBLIC_ NTSTATUS gensec_set_target_service_description(struct gensec_security *gensec_security,
667                                                         const char *service)
668 {
669         gensec_security->target.service_description = talloc_strdup(gensec_security, service);
670         if (!gensec_security->target.service_description) {
671                 return NT_STATUS_NO_MEMORY;
672         }
673         return NT_STATUS_OK;
674 }
675
676 _PUBLIC_ const char *gensec_get_target_service_description(struct gensec_security *gensec_security)
677 {
678         if (gensec_security->target.service_description) {
679                 return gensec_security->target.service_description;
680         } else if (gensec_security->target.service) {
681                 return gensec_security->target.service;
682         }
683
684         return NULL;
685 }
686
687 /**
688  * Set the target hostname (suitable for kerberos resolutation) on a GENSEC context - ensures it is talloc()ed
689  *
690  */
691
692 _PUBLIC_ NTSTATUS gensec_set_target_hostname(struct gensec_security *gensec_security, const char *hostname)
693 {
694         gensec_security->target.hostname = talloc_strdup(gensec_security, hostname);
695         if (hostname && !gensec_security->target.hostname) {
696                 return NT_STATUS_NO_MEMORY;
697         }
698         return NT_STATUS_OK;
699 }
700
701 _PUBLIC_ const char *gensec_get_target_hostname(struct gensec_security *gensec_security)
702 {
703         /* We allow the target hostname to be overridden for testing purposes */
704         if (gensec_security->settings->target_hostname) {
705                 return gensec_security->settings->target_hostname;
706         }
707
708         if (gensec_security->target.hostname) {
709                 return gensec_security->target.hostname;
710         }
711
712         /* We could add use the 'set sockaddr' call, and do a reverse
713          * lookup, but this would be both insecure (compromising the
714          * way kerberos works) and add DNS timeouts */
715         return NULL;
716 }
717
718 /**
719  * Set (and copy) local and peer socket addresses onto a socket
720  * context on the GENSEC context.
721  *
722  * This is so that kerberos can include these addresses in
723  * cryptographic tokens, to avoid certain attacks.
724  */
725
726 /**
727  * @brief Set the local gensec address.
728  *
729  * @param  gensec_security   The gensec security context to use.
730  *
731  * @param  remote       The local address to set.
732  *
733  * @return              On success NT_STATUS_OK is returned or an NT_STATUS
734  *                      error.
735  */
736 _PUBLIC_ NTSTATUS gensec_set_local_address(struct gensec_security *gensec_security,
737                 const struct tsocket_address *local)
738 {
739         TALLOC_FREE(gensec_security->local_addr);
740
741         if (local == NULL) {
742                 return NT_STATUS_OK;
743         }
744
745         gensec_security->local_addr = tsocket_address_copy(local, gensec_security);
746         if (gensec_security->local_addr == NULL) {
747                 return NT_STATUS_NO_MEMORY;
748         }
749
750         return NT_STATUS_OK;
751 }
752
753 /**
754  * @brief Set the remote gensec address.
755  *
756  * @param  gensec_security   The gensec security context to use.
757  *
758  * @param  remote       The remote address to set.
759  *
760  * @return              On success NT_STATUS_OK is returned or an NT_STATUS
761  *                      error.
762  */
763 _PUBLIC_ NTSTATUS gensec_set_remote_address(struct gensec_security *gensec_security,
764                 const struct tsocket_address *remote)
765 {
766         TALLOC_FREE(gensec_security->remote_addr);
767
768         if (remote == NULL) {
769                 return NT_STATUS_OK;
770         }
771
772         gensec_security->remote_addr = tsocket_address_copy(remote, gensec_security);
773         if (gensec_security->remote_addr == NULL) {
774                 return NT_STATUS_NO_MEMORY;
775         }
776
777         return NT_STATUS_OK;
778 }
779
780 /**
781  * @brief Get the local address from a gensec security context.
782  *
783  * @param  gensec_security   The security context to get the address from.
784  *
785  * @return              The address as tsocket_address which could be NULL if
786  *                      no address is set.
787  */
788 _PUBLIC_ const struct tsocket_address *gensec_get_local_address(struct gensec_security *gensec_security)
789 {
790         if (gensec_security == NULL) {
791                 return NULL;
792         }
793         return gensec_security->local_addr;
794 }
795
796 /**
797  * @brief Get the remote address from a gensec security context.
798  *
799  * @param  gensec_security   The security context to get the address from.
800  *
801  * @return              The address as tsocket_address which could be NULL if
802  *                      no address is set.
803  */
804 _PUBLIC_ const struct tsocket_address *gensec_get_remote_address(struct gensec_security *gensec_security)
805 {
806         if (gensec_security == NULL) {
807                 return NULL;
808         }
809         return gensec_security->remote_addr;
810 }
811
812 /**
813  * Set the target principal (assuming it it known, say from the SPNEGO reply)
814  *  - ensures it is talloc()ed
815  *
816  */
817
818 _PUBLIC_ NTSTATUS gensec_set_target_principal(struct gensec_security *gensec_security, const char *principal)
819 {
820         gensec_security->target.principal = talloc_strdup(gensec_security, principal);
821         if (!gensec_security->target.principal) {
822                 return NT_STATUS_NO_MEMORY;
823         }
824         return NT_STATUS_OK;
825 }
826
827 _PUBLIC_ const char *gensec_get_target_principal(struct gensec_security *gensec_security)
828 {
829         if (gensec_security->target.principal) {
830                 return gensec_security->target.principal;
831         }
832
833         return NULL;
834 }