openssh/ssh-gss.h

   1 /* $OpenBSD: ssh-gss.h,v 1.9 2006/08/18 14:40:34 djm Exp $ */
   2 /*
   3  * Copyright (c) 2001-2003 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
  37 #ifdef KRB5
  38 # ifndef HEIMDAL
  39 #  ifdef HAVE_GSSAPI_GENERIC_H
  40 #   include <gssapi_generic.h>
  41 #  elif defined(HAVE_GSSAPI_GSSAPI_GENERIC_H)
  42 #   include <gssapi/gssapi_generic.h>
  43 #  endif
  44
  45 /* MIT Kerberos doesn't seem to define GSS_NT_HOSTBASED_SERVICE */
  46
  47 #ifndef GSS_C_NT_HOSTBASED_SERVICE
  48 #define GSS_C_NT_HOSTBASED_SERVICE gss_nt_service_name
  49 #endif /* GSS_C_NT_... */
  50 #endif /* !HEIMDAL */
  51 #endif /* KRB5 */
  52
  53 /* draft-ietf-secsh-gsskeyex-06 */
  54 #define SSH2_MSG_USERAUTH_GSSAPI_RESPONSE               60
  55 #define SSH2_MSG_USERAUTH_GSSAPI_TOKEN                  61
  56 #define SSH2_MSG_USERAUTH_GSSAPI_EXCHANGE_COMPLETE      63
  57 #define SSH2_MSG_USERAUTH_GSSAPI_ERROR                  64
  58 #define SSH2_MSG_USERAUTH_GSSAPI_ERRTOK                 65
  59 #define SSH2_MSG_USERAUTH_GSSAPI_MIC                    66
  60
  61 #define SSH_GSS_OIDTYPE 0x06
  62
  63 #define SSH2_MSG_KEXGSS_INIT                            30
  64 #define SSH2_MSG_KEXGSS_CONTINUE                        31
  65 #define SSH2_MSG_KEXGSS_COMPLETE                        32
  66 #define SSH2_MSG_KEXGSS_HOSTKEY                         33
  67 #define SSH2_MSG_KEXGSS_ERROR                           34
  68 #define SSH2_MSG_KEXGSS_GROUPREQ                        40
  69 #define SSH2_MSG_KEXGSS_GROUP                           41
  70 #define KEX_GSS_GRP1_SHA1_ID                            "gss-group1-sha1-"
  71 #define KEX_GSS_GRP14_SHA1_ID                           "gss-group14-sha1-"
  72 #define KEX_GSS_GEX_SHA1_ID                             "gss-gex-sha1-"
  73
  74 typedef struct {
  75         char *filename;
  76         char *envvar;
  77         char *envval;
  78         void *data;
  79 } ssh_gssapi_ccache;
  80
  81 typedef struct {
  82         gss_buffer_desc displayname;
  83         gss_buffer_desc exportedname;
  84         gss_cred_id_t creds;
  85         struct ssh_gssapi_mech_struct *mech;
  86         ssh_gssapi_ccache store;
  87 } ssh_gssapi_client;
  88
  89 typedef struct ssh_gssapi_mech_struct {
  90         char *enc_name;
  91         char *name;
  92         gss_OID_desc oid;
  93         int (*dochild) (ssh_gssapi_client *);
  94         int (*userok) (ssh_gssapi_client *, char *);
  95         int (*localname) (ssh_gssapi_client *, char **);
  96         void (*storecreds) (ssh_gssapi_client *);
  97 } ssh_gssapi_mech;
  98
  99 typedef struct {
 100         OM_uint32       major; /* both */
 101         OM_uint32       minor; /* both */
 102         gss_ctx_id_t    context; /* both */
 103         gss_name_t      name; /* both */
 104         gss_OID         oid; /* client */
 105         gss_cred_id_t   creds; /* server */
 106         gss_name_t      client; /* server */
 107         gss_cred_id_t   client_creds; /* server */
 108 } Gssctxt;
 109
 110 extern ssh_gssapi_mech *supported_mechs[];
 111 extern Gssctxt *gss_kex_context;
 112
 113 int  ssh_gssapi_check_oid(Gssctxt *, void *, size_t);
 114 void ssh_gssapi_set_oid_data(Gssctxt *, void *, size_t);
 115 void ssh_gssapi_set_oid(Gssctxt *, gss_OID);
 116 void ssh_gssapi_supported_oids(gss_OID_set *);
 117 ssh_gssapi_mech *ssh_gssapi_get_ctype(Gssctxt *);
 118
 119 OM_uint32 ssh_gssapi_import_name(Gssctxt *, const char *);
 120 OM_uint32 ssh_gssapi_acquire_cred(Gssctxt *);
 121 OM_uint32 ssh_gssapi_init_ctx(Gssctxt *, int,
 122     gss_buffer_desc *, gss_buffer_desc *, OM_uint32 *);
 123 OM_uint32 ssh_gssapi_accept_ctx(Gssctxt *,
 124     gss_buffer_desc *, gss_buffer_desc *, OM_uint32 *);
 125 OM_uint32 ssh_gssapi_getclient(Gssctxt *, ssh_gssapi_client *);
 126 void ssh_gssapi_error(Gssctxt *);
 127 char *ssh_gssapi_last_error(Gssctxt *, OM_uint32 *, OM_uint32 *);
 128 void ssh_gssapi_build_ctx(Gssctxt **);
 129 void ssh_gssapi_delete_ctx(Gssctxt **);
 130 OM_uint32 ssh_gssapi_sign(Gssctxt *, gss_buffer_t, gss_buffer_t);
 131 OM_uint32 ssh_gssapi_server_ctx(Gssctxt **, gss_OID);
 132 void ssh_gssapi_buildmic(Buffer *, const char *, const char *, const char *);
 133 int ssh_gssapi_check_mechanism(Gssctxt **, gss_OID, const char *);
 134
 135 /* In the server */
 136 typedef int ssh_gssapi_check_fn(Gssctxt **, gss_OID, const char *);
 137 char *ssh_gssapi_client_mechanisms(const char *host);
 138 char *ssh_gssapi_kex_mechs(gss_OID_set, ssh_gssapi_check_fn *, const char *);
 139 gss_OID ssh_gssapi_id_kex(Gssctxt *, char *, int);
 140 int ssh_gssapi_server_check_mech(Gssctxt **,gss_OID, const char *);
 141 int ssh_gssapi_userok(char *name);
 142 OM_uint32 ssh_gssapi_checkmic(Gssctxt *, gss_buffer_t, gss_buffer_t);
 143 void ssh_gssapi_do_child(char ***, u_int *);
 144 void ssh_gssapi_cleanup_creds(void);
 145 void ssh_gssapi_storecreds(void);
 146
 147 char *ssh_gssapi_server_mechanisms(void);
 148 int ssh_gssapi_oid_table_ok();
 149 #endif /* GSSAPI */
 150
 151 #endif /* _SSH_GSS_H */