f3969b4129be2cfaebba441a77c415b7d6aff694
[vlendec/samba-autobuild/.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         TALLOC_CTX *frame = NULL;
329         struct tevent_req *subreq = NULL;
330         bool ok;
331
332         if (gensec_security->subcontext) {
333                 /*
334                  * gensec modules are not allowed to call the sync version.
335                  */
336                 return NT_STATUS_INTERNAL_ERROR;
337         }
338
339         frame = talloc_stackframe();
340
341         if (ev == NULL) {
342                 ev = samba_tevent_context_init(frame);
343                 if (ev == NULL) {
344                         status = NT_STATUS_NO_MEMORY;
345                         goto fail;
346                 }
347
348                 /*
349                  * TODO: remove this hack once the backends
350                  * are fixed.
351                  */
352                 tevent_loop_allow_nesting(ev);
353         }
354
355         subreq = gensec_update_send(frame, ev, gensec_security, in);
356         if (subreq == NULL) {
357                 status = NT_STATUS_NO_MEMORY;
358                 goto fail;
359         }
360         ok = tevent_req_poll_ntstatus(subreq, ev, &status);
361         if (!ok) {
362                 goto fail;
363         }
364         status = gensec_update_recv(subreq, out_mem_ctx, out);
365  fail:
366         TALLOC_FREE(frame);
367         return status;
368 }
369
370 /**
371  * Next state function for the GENSEC state machine
372  *
373  * @param gensec_security GENSEC State
374  * @param out_mem_ctx The TALLOC_CTX for *out to be allocated on
375  * @param in The request, as a DATA_BLOB
376  * @param out The reply, as an talloc()ed DATA_BLOB, on *out_mem_ctx
377  * @return Error, MORE_PROCESSING_REQUIRED if a reply is sent,
378  *                or NT_STATUS_OK if the user is authenticated.
379  */
380
381 _PUBLIC_ NTSTATUS gensec_update(struct gensec_security *gensec_security,
382                                 TALLOC_CTX *out_mem_ctx,
383                                 const DATA_BLOB in, DATA_BLOB *out)
384 {
385         return gensec_update_ev(gensec_security, out_mem_ctx, NULL, in, out);
386 }
387
388 struct gensec_update_state {
389         const struct gensec_security_ops *ops;
390         struct gensec_security *gensec_security;
391         NTSTATUS status;
392         DATA_BLOB out;
393 };
394
395 static void gensec_update_cleanup(struct tevent_req *req,
396                                   enum tevent_req_state req_state);
397 static void gensec_update_done(struct tevent_req *subreq);
398
399 /**
400  * Next state function for the GENSEC state machine async version
401  *
402  * @param mem_ctx The memory context for the request
403  * @param ev The event context for the request
404  * @param gensec_security GENSEC State
405  * @param in The request, as a DATA_BLOB
406  *
407  * @return The request handle or NULL on no memory failure
408  */
409
410 _PUBLIC_ struct tevent_req *gensec_update_send(TALLOC_CTX *mem_ctx,
411                                                struct tevent_context *ev,
412                                                struct gensec_security *gensec_security,
413                                                const DATA_BLOB in)
414 {
415         struct tevent_req *req = NULL;
416         struct gensec_update_state *state = NULL;
417         struct tevent_req *subreq = NULL;
418
419         req = tevent_req_create(mem_ctx, &state,
420                                 struct gensec_update_state);
421         if (req == NULL) {
422                 return NULL;
423         }
424         state->ops = gensec_security->ops;
425         state->gensec_security = gensec_security;
426
427         if (gensec_security->update_busy_ptr != NULL) {
428                 tevent_req_nterror(req, NT_STATUS_INTERNAL_ERROR);
429                 return tevent_req_post(req, ev);
430         }
431
432         if (gensec_security->child_security != NULL) {
433                 tevent_req_nterror(req, NT_STATUS_INVALID_PARAMETER);
434                 return tevent_req_post(req, ev);
435         }
436
437         gensec_security->update_busy_ptr = &state->gensec_security;
438         tevent_req_set_cleanup_fn(req, gensec_update_cleanup);
439
440         subreq = state->ops->update_send(state, ev, gensec_security, in);
441         if (tevent_req_nomem(subreq, req)) {
442                 return tevent_req_post(req, ev);
443         }
444         tevent_req_set_callback(subreq, gensec_update_done, req);
445
446         DBG_DEBUG("%s[%p]: subreq: %p\n", state->ops->name,
447                   state->gensec_security, subreq);
448
449         return req;
450 }
451
452 static void gensec_update_cleanup(struct tevent_req *req,
453                                   enum tevent_req_state req_state)
454 {
455         struct gensec_update_state *state =
456                 tevent_req_data(req,
457                 struct gensec_update_state);
458
459         if (state->gensec_security == NULL) {
460                 return;
461         }
462
463         if (state->gensec_security->update_busy_ptr == &state->gensec_security) {
464                 state->gensec_security->update_busy_ptr = NULL;
465         }
466
467         state->gensec_security = NULL;
468 }
469
470 static void gensec_update_done(struct tevent_req *subreq)
471 {
472         struct tevent_req *req =
473                 tevent_req_callback_data(subreq,
474                 struct tevent_req);
475         struct gensec_update_state *state =
476                 tevent_req_data(req,
477                 struct gensec_update_state);
478         NTSTATUS status;
479         const char *debug_subreq = NULL;
480
481         if (CHECK_DEBUGLVL(DBGLVL_DEBUG)) {
482                 /*
483                  * We need to call tevent_req_print()
484                  * before calling the _recv function,
485                  * before tevent_req_received() was called.
486                  * in order to print the pointer value of
487                  * the subreq state.
488                  */
489                 debug_subreq = tevent_req_print(state, subreq);
490         }
491
492         status = state->ops->update_recv(subreq, state, &state->out);
493         TALLOC_FREE(subreq);
494         state->status = status;
495         if (GENSEC_UPDATE_IS_NTERROR(status)) {
496                 DBG_INFO("%s[%p]: %s%s%s\n", state->ops->name,
497                          state->gensec_security, nt_errstr(status),
498                          debug_subreq ? " " : "",
499                          debug_subreq ? debug_subreq : "");
500                 tevent_req_nterror(req, status);
501                 return;
502         }
503         DBG_DEBUG("%s[%p]: %s %s\n", state->ops->name,
504                   state->gensec_security, nt_errstr(status),
505                   debug_subreq);
506         if (NT_STATUS_EQUAL(status, NT_STATUS_MORE_PROCESSING_REQUIRED)) {
507                 tevent_req_done(req);
508                 return;
509         }
510
511         /*
512          * Because callers using the
513          * gensec_start_mech_by_authtype() never call
514          * gensec_want_feature(), it isn't sensible for them
515          * to have to call gensec_have_feature() manually, and
516          * these are not points of negotiation, but are
517          * asserted by the client
518          */
519         status = gensec_verify_features(state->gensec_security);
520         if (tevent_req_nterror(req, status)) {
521                 return;
522         }
523
524         tevent_req_done(req);
525 }
526
527 /**
528  * Next state function for the GENSEC state machine
529  *
530  * @param req request state
531  * @param out_mem_ctx The TALLOC_CTX for *out to be allocated on
532  * @param out The reply, as an talloc()ed DATA_BLOB, on *out_mem_ctx
533  * @return Error, MORE_PROCESSING_REQUIRED if a reply is sent,
534  *                or NT_STATUS_OK if the user is authenticated.
535  */
536 _PUBLIC_ NTSTATUS gensec_update_recv(struct tevent_req *req,
537                                      TALLOC_CTX *out_mem_ctx,
538                                      DATA_BLOB *out)
539 {
540         struct gensec_update_state *state =
541                 tevent_req_data(req, struct gensec_update_state);
542         NTSTATUS status;
543
544         *out = data_blob_null;
545
546         if (tevent_req_is_nterror(req, &status)) {
547                 tevent_req_received(req);
548                 return status;
549         }
550
551         *out = state->out;
552         talloc_steal(out_mem_ctx, out->data);
553         status = state->status;
554         tevent_req_received(req);
555         return status;
556 }
557
558 /**
559  * Set the requirement for a certain feature on the connection
560  *
561  */
562
563 _PUBLIC_ void gensec_want_feature(struct gensec_security *gensec_security,
564                          uint32_t feature)
565 {
566         if (!gensec_security->ops || !gensec_security->ops->want_feature) {
567                 gensec_security->want_features |= feature;
568                 return;
569         }
570         gensec_security->ops->want_feature(gensec_security, feature);
571 }
572
573 /**
574  * Check the requirement for a certain feature on the connection
575  *
576  */
577
578 _PUBLIC_ bool gensec_have_feature(struct gensec_security *gensec_security,
579                          uint32_t feature)
580 {
581         if (!gensec_security->ops || !gensec_security->ops->have_feature) {
582                 return false;
583         }
584
585         /* We might 'have' features that we don't 'want', because the
586          * other end demanded them, or we can't neotiate them off */
587         return gensec_security->ops->have_feature(gensec_security, feature);
588 }
589
590 _PUBLIC_ NTTIME gensec_expire_time(struct gensec_security *gensec_security)
591 {
592         if (!gensec_security->ops->expire_time) {
593                 return GENSEC_EXPIRE_TIME_INFINITY;
594         }
595
596         return gensec_security->ops->expire_time(gensec_security);
597 }
598 /**
599  * Return the credentials structure associated with a GENSEC context
600  *
601  */
602
603 _PUBLIC_ struct cli_credentials *gensec_get_credentials(struct gensec_security *gensec_security)
604 {
605         if (!gensec_security) {
606                 return NULL;
607         }
608         return gensec_security->credentials;
609 }
610
611 /**
612  * Set the target service (such as 'http' or 'host') on a GENSEC context - ensures it is talloc()ed
613  *
614  * This is used for Kerberos service principal name resolution.
615  */
616
617 _PUBLIC_ NTSTATUS gensec_set_target_service(struct gensec_security *gensec_security, const char *service)
618 {
619         gensec_security->target.service = talloc_strdup(gensec_security, service);
620         if (!gensec_security->target.service) {
621                 return NT_STATUS_NO_MEMORY;
622         }
623         return NT_STATUS_OK;
624 }
625
626 _PUBLIC_ const char *gensec_get_target_service(struct gensec_security *gensec_security)
627 {
628         if (gensec_security->target.service) {
629                 return gensec_security->target.service;
630         }
631
632         return "host";
633 }
634
635 /**
636  * Set the target service (such as 'samr') on an GENSEC context - ensures it is talloc()ed.
637  *
638  * This is not the Kerberos service principal, instead this is a
639  * constant value that can be logged as part of authentication and
640  * authorization logging
641  */
642 _PUBLIC_ NTSTATUS gensec_set_target_service_description(struct gensec_security *gensec_security,
643                                                         const char *service)
644 {
645         gensec_security->target.service_description = talloc_strdup(gensec_security, service);
646         if (!gensec_security->target.service_description) {
647                 return NT_STATUS_NO_MEMORY;
648         }
649         return NT_STATUS_OK;
650 }
651
652 _PUBLIC_ const char *gensec_get_target_service_description(struct gensec_security *gensec_security)
653 {
654         if (gensec_security->target.service_description) {
655                 return gensec_security->target.service_description;
656         } else if (gensec_security->target.service) {
657                 return gensec_security->target.service;
658         }
659
660         return NULL;
661 }
662
663 /**
664  * Set the target hostname (suitable for kerberos resolutation) on a GENSEC context - ensures it is talloc()ed
665  *
666  */
667
668 _PUBLIC_ NTSTATUS gensec_set_target_hostname(struct gensec_security *gensec_security, const char *hostname)
669 {
670         gensec_security->target.hostname = talloc_strdup(gensec_security, hostname);
671         if (hostname && !gensec_security->target.hostname) {
672                 return NT_STATUS_NO_MEMORY;
673         }
674         return NT_STATUS_OK;
675 }
676
677 _PUBLIC_ const char *gensec_get_target_hostname(struct gensec_security *gensec_security)
678 {
679         /* We allow the target hostname to be overridden for testing purposes */
680         if (gensec_security->settings->target_hostname) {
681                 return gensec_security->settings->target_hostname;
682         }
683
684         if (gensec_security->target.hostname) {
685                 return gensec_security->target.hostname;
686         }
687
688         /* We could add use the 'set sockaddr' call, and do a reverse
689          * lookup, but this would be both insecure (compromising the
690          * way kerberos works) and add DNS timeouts */
691         return NULL;
692 }
693
694 /**
695  * Set (and copy) local and peer socket addresses onto a socket
696  * context on the GENSEC context.
697  *
698  * This is so that kerberos can include these addresses in
699  * cryptographic tokens, to avoid certain attacks.
700  */
701
702 /**
703  * @brief Set the local gensec address.
704  *
705  * @param  gensec_security   The gensec security context to use.
706  *
707  * @param  remote       The local address to set.
708  *
709  * @return              On success NT_STATUS_OK is returned or an NT_STATUS
710  *                      error.
711  */
712 _PUBLIC_ NTSTATUS gensec_set_local_address(struct gensec_security *gensec_security,
713                 const struct tsocket_address *local)
714 {
715         TALLOC_FREE(gensec_security->local_addr);
716
717         if (local == NULL) {
718                 return NT_STATUS_OK;
719         }
720
721         gensec_security->local_addr = tsocket_address_copy(local, gensec_security);
722         if (gensec_security->local_addr == NULL) {
723                 return NT_STATUS_NO_MEMORY;
724         }
725
726         return NT_STATUS_OK;
727 }
728
729 /**
730  * @brief Set the remote gensec address.
731  *
732  * @param  gensec_security   The gensec security context to use.
733  *
734  * @param  remote       The remote address to set.
735  *
736  * @return              On success NT_STATUS_OK is returned or an NT_STATUS
737  *                      error.
738  */
739 _PUBLIC_ NTSTATUS gensec_set_remote_address(struct gensec_security *gensec_security,
740                 const struct tsocket_address *remote)
741 {
742         TALLOC_FREE(gensec_security->remote_addr);
743
744         if (remote == NULL) {
745                 return NT_STATUS_OK;
746         }
747
748         gensec_security->remote_addr = tsocket_address_copy(remote, gensec_security);
749         if (gensec_security->remote_addr == NULL) {
750                 return NT_STATUS_NO_MEMORY;
751         }
752
753         return NT_STATUS_OK;
754 }
755
756 /**
757  * @brief Get the local address from a gensec security context.
758  *
759  * @param  gensec_security   The security context to get the address from.
760  *
761  * @return              The address as tsocket_address which could be NULL if
762  *                      no address is set.
763  */
764 _PUBLIC_ const struct tsocket_address *gensec_get_local_address(struct gensec_security *gensec_security)
765 {
766         if (gensec_security == NULL) {
767                 return NULL;
768         }
769         return gensec_security->local_addr;
770 }
771
772 /**
773  * @brief Get the remote address from a gensec security context.
774  *
775  * @param  gensec_security   The security context to get the address from.
776  *
777  * @return              The address as tsocket_address which could be NULL if
778  *                      no address is set.
779  */
780 _PUBLIC_ const struct tsocket_address *gensec_get_remote_address(struct gensec_security *gensec_security)
781 {
782         if (gensec_security == NULL) {
783                 return NULL;
784         }
785         return gensec_security->remote_addr;
786 }
787
788 /**
789  * Set the target principal (assuming it it known, say from the SPNEGO reply)
790  *  - ensures it is talloc()ed
791  *
792  */
793
794 _PUBLIC_ NTSTATUS gensec_set_target_principal(struct gensec_security *gensec_security, const char *principal)
795 {
796         gensec_security->target.principal = talloc_strdup(gensec_security, principal);
797         if (!gensec_security->target.principal) {
798                 return NT_STATUS_NO_MEMORY;
799         }
800         return NT_STATUS_OK;
801 }
802
803 _PUBLIC_ const char *gensec_get_target_principal(struct gensec_security *gensec_security)
804 {
805         if (gensec_security->target.principal) {
806                 return gensec_security->target.principal;
807         }
808
809         return NULL;
810 }