openssh/gss-serv.c

   1 /* $OpenBSD: gss-serv.c,v 1.20 2006/08/03 03:34:42 deraadt Exp $ */
   2
   3 /*
   4  * Copyright (c) 2001-2006 Simon Wilkinson. All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR `AS IS'' AND ANY EXPRESS OR
  16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  */
  26
  27 #include "includes.h"
  28
  29 #ifdef GSSAPI
  30
  31 #include <sys/types.h>
  32
  33 #include <stdarg.h>
  34 #include <string.h>
  35 #include <unistd.h>
  36
  37 #include "xmalloc.h"
  38 #include "buffer.h"
  39 #include "key.h"
  40 #include "hostfile.h"
  41 #include "auth.h"
  42 #include "log.h"
  43 #include "channels.h"
  44 #include "session.h"
  45 #include "misc.h"
  46 #include "servconf.h"
  47
  48 #include "ssh-gss.h"
  49 #include "monitor_wrap.h"
  50
  51 extern ServerOptions options;
  52
  53 static ssh_gssapi_client gssapi_client =
  54     { GSS_C_EMPTY_BUFFER, GSS_C_EMPTY_BUFFER,
  55     GSS_C_NO_CREDENTIAL, NULL, {NULL, NULL, NULL}};
  56
  57 ssh_gssapi_mech gssapi_null_mech =
  58     { NULL, NULL, {0, NULL}, NULL, NULL, NULL, NULL};
  59
  60 #ifdef KRB5
  61 extern ssh_gssapi_mech gssapi_kerberos_mech;
  62 #endif
  63
  64 ssh_gssapi_mech* supported_mechs[]= {
  65 #ifdef KRB5
  66         &gssapi_kerberos_mech,
  67 #endif
  68         &gssapi_null_mech,
  69 };
  70
  71 /* Unprivileged */
  72 char *
  73 ssh_gssapi_server_mechanisms() {
  74         gss_OID_set     supported;
  75
  76         ssh_gssapi_supported_oids(&supported);
  77         return (ssh_gssapi_kex_mechs(supported, &ssh_gssapi_server_check_mech,
  78             NULL));
  79 }
  80
  81 /* Unprivileged */
  82 int
  83 ssh_gssapi_server_check_mech(Gssctxt **dum, gss_OID oid, const char *data) {
  84         Gssctxt *ctx = NULL;
  85         int res;
  86
  87         res = !GSS_ERROR(PRIVSEP(ssh_gssapi_server_ctx(&ctx, oid)));
  88         ssh_gssapi_delete_ctx(&ctx);
  89
  90         return (res);
  91 }
  92
  93 /* Unprivileged */
  94 void
  95 ssh_gssapi_supported_oids(gss_OID_set *oidset)
  96 {
  97         int i = 0;
  98         OM_uint32 min_status;
  99         int present;
 100         gss_OID_set supported;
 101
 102         gss_create_empty_oid_set(&min_status, oidset);
 103         gss_indicate_mechs(&min_status, &supported);
 104
 105         while (supported_mechs[i]->name != NULL) {
 106                 if (GSS_ERROR(gss_test_oid_set_member(&min_status,
 107                     &supported_mechs[i]->oid, supported, &present)))
 108                         present = 0;
 109                 if (present)
 110                         gss_add_oid_set_member(&min_status,
 111                             &supported_mechs[i]->oid, oidset);
 112                 i++;
 113         }
 114
 115         gss_release_oid_set(&min_status, &supported);
 116 }
 117
 118 OM_uint32
 119 ssh_gssapi_server_ctx(Gssctxt **ctx, gss_OID oid)
 120 {
 121         if (*ctx)
 122                 ssh_gssapi_delete_ctx(ctx);
 123         ssh_gssapi_build_ctx(ctx);
 124         ssh_gssapi_set_oid(*ctx, oid);
 125         return (ssh_gssapi_acquire_cred(*ctx));
 126 }
 127
 128 /* Acquire credentials for a server running on the current host.
 129  * Requires that the context structure contains a valid OID
 130  */
 131
 132 /* Returns a GSSAPI error code */
 133 OM_uint32
 134 ssh_gssapi_acquire_cred(Gssctxt *ctx)
 135 {
 136         OM_uint32 status;
 137         char lname[MAXHOSTNAMELEN];
 138         gss_OID_set oidset;
 139
 140         if (options.gss_strict_acceptor) {
 141                 gss_create_empty_oid_set(&status, &oidset);
 142                 gss_add_oid_set_member(&status, ctx->oid, &oidset);
 143
 144                 if (gethostname(lname, MAXHOSTNAMELEN)) {
 145                         gss_release_oid_set(&status, &oidset);
 146                         return (-1);
 147                 }
 148
 149                 if (GSS_ERROR(ssh_gssapi_import_name(ctx, lname))) {
 150                         gss_release_oid_set(&status, &oidset);
 151                         return (ctx->major);
 152                 }
 153
 154                 if ((ctx->major = gss_acquire_cred(&ctx->minor,
 155                     ctx->name, 0, oidset, GSS_C_ACCEPT, &ctx->creds,
 156                     NULL, NULL)))
 157                         ssh_gssapi_error(ctx);
 158
 159                 gss_release_oid_set(&status, &oidset);
 160                 return (ctx->major);
 161         } else {
 162                 ctx->name = GSS_C_NO_NAME;
 163                 ctx->creds = GSS_C_NO_CREDENTIAL;
 164         }
 165         return GSS_S_COMPLETE;
 166 }
 167
 168
 169 /* Wrapper around accept_sec_context
 170  * Requires that the context contains:
 171  *    oid
 172  *    credentials       (from ssh_gssapi_acquire_cred)
 173  */
 174 /* Privileged */
 175 OM_uint32
 176 ssh_gssapi_accept_ctx(Gssctxt *ctx, gss_buffer_desc *recv_tok,
 177     gss_buffer_desc *send_tok, OM_uint32 *flags)
 178 {
 179         OM_uint32 status;
 180         gss_OID mech;
 181
 182         ctx->major = gss_accept_sec_context(&ctx->minor,
 183             &ctx->context, ctx->creds, recv_tok,
 184             GSS_C_NO_CHANNEL_BINDINGS, &ctx->client, &mech,
 185             send_tok, flags, NULL, &ctx->client_creds);
 186
 187         if (GSS_ERROR(ctx->major))
 188                 ssh_gssapi_error(ctx);
 189
 190         if (ctx->client_creds)
 191                 debug("Received some client credentials");
 192         else
 193                 debug("Got no client credentials");
 194
 195         status = ctx->major;
 196
 197         /* Now, if we're complete and we have the right flags, then
 198          * we flag the user as also having been authenticated
 199          */
 200
 201         if (((flags == NULL) || ((*flags & GSS_C_MUTUAL_FLAG) &&
 202             (*flags & GSS_C_INTEG_FLAG))) && (ctx->major == GSS_S_COMPLETE)) {
 203                 if (ssh_gssapi_getclient(ctx, &gssapi_client))
 204                         fatal("Couldn't convert client name");
 205         }
 206
 207         return (status);
 208 }
 209
 210 /*
 211  * This parses an exported name, extracting the mechanism specific portion
 212  * to use for ACL checking. It verifies that the name belongs the mechanism
 213  * originally selected.
 214  */
 215 static OM_uint32
 216 ssh_gssapi_parse_ename(Gssctxt *ctx, gss_buffer_t ename, gss_buffer_t name)
 217 {
 218         u_char *tok;
 219         OM_uint32 offset;
 220         OM_uint32 oidl;
 221
 222         tok = ename->value;
 223
 224         /*
 225          * Check that ename is long enough for all of the fixed length
 226          * header, and that the initial ID bytes are correct
 227          */
 228
 229         if (ename->length < 6 || memcmp(tok, "\x04\x01", 2) != 0)
 230                 return GSS_S_FAILURE;
 231
 232         /*
 233          * Extract the OID, and check it. Here GSSAPI breaks with tradition
 234          * and does use the OID type and length bytes. To confuse things
 235          * there are two lengths - the first including these, and the
 236          * second without.
 237          */
 238
 239         oidl = get_u16(tok+2); /* length including next two bytes */
 240         oidl = oidl-2; /* turn it into the _real_ length of the variable OID */
 241
 242         /*
 243          * Check the BER encoding for correct type and length, that the
 244          * string is long enough and that the OID matches that in our context
 245          */
 246         if (tok[4] != 0x06 || tok[5] != oidl ||
 247             ename->length < oidl+6 ||
 248             !ssh_gssapi_check_oid(ctx, tok+6, oidl))
 249                 return GSS_S_FAILURE;
 250
 251         offset = oidl+6;
 252
 253         if (ename->length < offset+4)
 254                 return GSS_S_FAILURE;
 255
 256         name->length = get_u32(tok+offset);
 257         offset += 4;
 258
 259         if (ename->length < offset+name->length)
 260                 return GSS_S_FAILURE;
 261
 262         name->value = xmalloc(name->length+1);
 263         memcpy(name->value, tok+offset, name->length);
 264         ((char *)name->value)[name->length] = 0;
 265
 266         return GSS_S_COMPLETE;
 267 }
 268
 269 /* Extract the client details from a given context. This can only reliably
 270  * be called once for a context */
 271
 272 /* Privileged (called from accept_secure_ctx) */
 273 OM_uint32
 274 ssh_gssapi_getclient(Gssctxt *ctx, ssh_gssapi_client *client)
 275 {
 276         int i = 0;
 277
 278         gss_buffer_desc ename;
 279
 280         client->mech = NULL;
 281
 282         while (supported_mechs[i]->name != NULL) {
 283                 if (supported_mechs[i]->oid.length == ctx->oid->length &&
 284                     (memcmp(supported_mechs[i]->oid.elements,
 285                     ctx->oid->elements, ctx->oid->length) == 0))
 286                         client->mech = supported_mechs[i];
 287                 i++;
 288         }
 289
 290         if (client->mech == NULL)
 291                 return GSS_S_FAILURE;
 292
 293         if ((ctx->major = gss_display_name(&ctx->minor, ctx->client,
 294             &client->displayname, NULL))) {
 295                 ssh_gssapi_error(ctx);
 296                 return (ctx->major);
 297         }
 298
 299         if ((ctx->major = gss_export_name(&ctx->minor, ctx->client,
 300             &ename))) {
 301                 ssh_gssapi_error(ctx);
 302                 return (ctx->major);
 303         }
 304
 305         if ((ctx->major = ssh_gssapi_parse_ename(ctx,&ename,
 306             &client->exportedname))) {
 307                 return (ctx->major);
 308         }
 309
 310         /* We can't copy this structure, so we just move the pointer to it */
 311         client->creds = ctx->client_creds;
 312         ctx->client_creds = GSS_C_NO_CREDENTIAL;
 313         return (ctx->major);
 314 }
 315
 316 /* As user - called on fatal/exit */
 317 void
 318 ssh_gssapi_cleanup_creds(void)
 319 {
 320         if (gssapi_client.store.filename != NULL) {
 321                 /* Unlink probably isn't sufficient */
 322                 debug("removing gssapi cred file\"%s\"",
 323                     gssapi_client.store.filename);
 324                 unlink(gssapi_client.store.filename);
 325         }
 326 }
 327
 328 /* As user */
 329 void
 330 ssh_gssapi_storecreds(void)
 331 {
 332         if (gssapi_client.mech && gssapi_client.mech->storecreds) {
 333                 (*gssapi_client.mech->storecreds)(&gssapi_client);
 334         } else
 335                 debug("ssh_gssapi_storecreds: Not a GSSAPI mechanism");
 336 }
 337
 338 /* This allows GSSAPI methods to do things to the childs environment based
 339  * on the passed authentication process and credentials.
 340  */
 341 /* As user */
 342 void
 343 ssh_gssapi_do_child(char ***envp, u_int *envsizep)
 344 {
 345
 346         if (gssapi_client.store.envvar != NULL &&
 347             gssapi_client.store.envval != NULL) {
 348                 debug("Setting %s to %s", gssapi_client.store.envvar,
 349                     gssapi_client.store.envval);
 350                 child_set_env(envp, envsizep, gssapi_client.store.envvar,
 351                     gssapi_client.store.envval);
 352         }
 353 }
 354
 355 /* Privileged */
 356 int
 357 ssh_gssapi_userok(char *user)
 358 {
 359         OM_uint32 lmin;
 360
 361         if (gssapi_client.exportedname.length == 0 ||
 362             gssapi_client.exportedname.value == NULL) {
 363                 debug("No suitable client data");
 364                 return 0;
 365         }
 366         if (gssapi_client.mech && gssapi_client.mech->userok)
 367                 if ((*gssapi_client.mech->userok)(&gssapi_client, user))
 368                         return 1;
 369                 else {
 370                         /* Destroy delegated credentials if userok fails */
 371                         gss_release_buffer(&lmin, &gssapi_client.displayname);
 372                         gss_release_buffer(&lmin, &gssapi_client.exportedname);
 373                         gss_release_cred(&lmin, &gssapi_client.creds);
 374                         memset(&gssapi_client, 0, sizeof(ssh_gssapi_client));
 375                         return 0;
 376                 }
 377         else
 378                 debug("ssh_gssapi_userok: Unknown GSSAPI mechanism");
 379         return (0);
 380 }
 381
 382 #endif