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