ssh-gss.h

   1 /* $OpenBSD: ssh-gss.h,v 1.10 2007/06/12 08:20:00 djm Exp $ */
   2 /*
   3  * Copyright (c) 2001-2009 Simon Wilkinson. All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR `AS IS'' AND ANY EXPRESS OR
  15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef _SSH_GSS_H
  27 #define _SSH_GSS_H
  28
  29 #ifdef GSSAPI
  30
  31 #ifdef HAVE_GSSAPI_H
  32 #include <gssapi.h>
  33 #elif defined(HAVE_GSSAPI_GSSAPI_H)
  34 #include <gssapi/gssapi.h>
  35 #endif
  36 #ifdef HAVE_GSSAPI_GSSAPI_EXT_H
  37 #include <gssapi/gssapi_ext.h>
  38 #endif
  39
  40 #ifdef KRB5
  41 # ifndef HEIMDAL
  42 #  ifdef HAVE_GSSAPI_GENERIC_H
  43 #   include <gssapi_generic.h>
  44 #  elif defined(HAVE_GSSAPI_GSSAPI_GENERIC_H)
  45 #   include <gssapi/gssapi_generic.h>
  46 #  endif
  47
  48 /* MIT Kerberos doesn't seem to define GSS_NT_HOSTBASED_SERVICE */
  49
  50 #ifndef GSS_C_NT_HOSTBASED_SERVICE
  51 #define GSS_C_NT_HOSTBASED_SERVICE gss_nt_service_name
  52 #endif /* GSS_C_NT_... */
  53 #endif /* !HEIMDAL */
  54 #endif /* KRB5 */
  55
  56 /* draft-ietf-secsh-gsskeyex-06 */
  57 #define SSH2_MSG_USERAUTH_GSSAPI_RESPONSE               60
  58 #define SSH2_MSG_USERAUTH_GSSAPI_TOKEN                  61
  59 #define SSH2_MSG_USERAUTH_GSSAPI_EXCHANGE_COMPLETE      63
  60 #define SSH2_MSG_USERAUTH_GSSAPI_ERROR                  64
  61 #define SSH2_MSG_USERAUTH_GSSAPI_ERRTOK                 65
  62 #define SSH2_MSG_USERAUTH_GSSAPI_MIC                    66
  63
  64 #define SSH_GSS_OIDTYPE 0x06
  65
  66 #define SSH2_MSG_KEXGSS_INIT                            30
  67 #define SSH2_MSG_KEXGSS_CONTINUE                        31
  68 #define SSH2_MSG_KEXGSS_COMPLETE                        32
  69 #define SSH2_MSG_KEXGSS_HOSTKEY                         33
  70 #define SSH2_MSG_KEXGSS_ERROR                           34
  71 #define SSH2_MSG_KEXGSS_GROUPREQ                        40
  72 #define SSH2_MSG_KEXGSS_GROUP                           41
  73 #define KEX_GSS_GRP1_SHA1_ID                            "gss-group1-sha1-"
  74 #define KEX_GSS_GRP14_SHA1_ID                           "gss-group14-sha1-"
  75 #define KEX_GSS_GEX_SHA1_ID                             "gss-gex-sha1-"
  76
  77 typedef struct {
  78         char *filename;
  79         char *envvar;
  80         char *envval;
  81         struct passwd *owner;
  82         void *data;
  83 } ssh_gssapi_ccache;
  84
  85 typedef struct {
  86   gss_OID_desc oid;
  87         gss_buffer_desc displayname;
  88         gss_buffer_desc exportedname;
  89         gss_cred_id_t creds;
  90   gss_name_t cred_name, ctx_name;
  91         struct ssh_gssapi_mech_struct *mech;
  92         ssh_gssapi_ccache store;
  93         int used;
  94         int updated;
  95 } ssh_gssapi_client;
  96
  97 typedef struct ssh_gssapi_mech_struct {
  98         char *enc_name;
  99         char *name;
 100         gss_OID_desc oid;
 101         int (*dochild) (ssh_gssapi_client *);
 102         int (*userok) (ssh_gssapi_client *, char *);
 103         int (*localname) (ssh_gssapi_client *, char **);
 104         void (*storecreds) (ssh_gssapi_client *);
 105         int (*updatecreds) (ssh_gssapi_ccache *, ssh_gssapi_client *);
 106 } ssh_gssapi_mech;
 107
 108 typedef struct {
 109         OM_uint32       major; /* both */
 110         OM_uint32       minor; /* both */
 111         gss_ctx_id_t    context; /* both */
 112         gss_name_t      name; /* both */
 113         gss_OID         oid; /* both */
 114         gss_cred_id_t   creds; /* server */
 115         gss_name_t      client; /* server */
 116         gss_cred_id_t   client_creds; /* both */
 117 } Gssctxt;
 118
 119 extern ssh_gssapi_mech *supported_mechs[];
 120 extern Gssctxt *gss_kex_context;
 121
 122 int  ssh_gssapi_check_oid(Gssctxt *, void *, size_t);
 123 void ssh_gssapi_set_oid_data(Gssctxt *, void *, size_t);
 124 void ssh_gssapi_set_oid(Gssctxt *, gss_OID);
 125 void ssh_gssapi_supported_oids(gss_OID_set *);
 126 ssh_gssapi_mech *ssh_gssapi_get_ctype(Gssctxt *);
 127
 128 OM_uint32 ssh_gssapi_import_name(Gssctxt *, const char *);
 129 OM_uint32 ssh_gssapi_init_ctx(Gssctxt *, int,
 130     gss_buffer_desc *, gss_buffer_desc *, OM_uint32 *);
 131 OM_uint32 ssh_gssapi_accept_ctx(Gssctxt *,
 132     gss_buffer_desc *, gss_buffer_desc *, OM_uint32 *);
 133 OM_uint32 ssh_gssapi_getclient(Gssctxt *, ssh_gssapi_client *);
 134 void ssh_gssapi_error(Gssctxt *);
 135 char *ssh_gssapi_last_error(Gssctxt *, OM_uint32 *, OM_uint32 *);
 136 void ssh_gssapi_build_ctx(Gssctxt **);
 137 void ssh_gssapi_delete_ctx(Gssctxt **);
 138 OM_uint32 ssh_gssapi_sign(Gssctxt *, gss_buffer_t, gss_buffer_t);
 139 void ssh_gssapi_buildmic(Buffer *, const char *, const char *, const char *);
 140 int ssh_gssapi_check_mechanism(Gssctxt **, gss_OID, const char *, const char *);
 141 OM_uint32 ssh_gssapi_client_identity(Gssctxt *, const char *);
 142 int ssh_gssapi_credentials_updated(Gssctxt *);
 143
 144 /* In the server */
 145 typedef int ssh_gssapi_check_fn(Gssctxt **, gss_OID, const char *,
 146     const char *);
 147 char *ssh_gssapi_client_mechanisms(const char *, const char *);
 148 char *ssh_gssapi_kex_mechs(gss_OID_set, ssh_gssapi_check_fn *, const char *,
 149     const char *);
 150 gss_OID ssh_gssapi_id_kex(Gssctxt *, char *, int);
 151 int ssh_gssapi_server_check_mech(Gssctxt **,gss_OID, const char *,
 152     const char *);
 153 OM_uint32 ssh_gssapi_server_ctx(Gssctxt **, gss_OID);
 154 int ssh_gssapi_userok(char *name, struct passwd *);
 155 OM_uint32 ssh_gssapi_checkmic(Gssctxt *, gss_buffer_t, gss_buffer_t);
 156 void ssh_gssapi_do_child(char ***, u_int *);
 157 void ssh_gssapi_cleanup_creds(void);
 158 void ssh_gssapi_storecreds(void);
 159
 160 char *ssh_gssapi_server_mechanisms(void);
 161 int ssh_gssapi_oid_table_ok();
 162
 163 int ssh_gssapi_update_creds(ssh_gssapi_ccache *store);
 164 #endif /* GSSAPI */
 165
 166 #endif /* _SSH_GSS_H */