openssh/ssh-gss.h

   1 /*
   2  * Copyright (c) 2001,2002 Simon Wilkinson. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR `AS IS'' AND ANY EXPRESS OR
  14  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  15  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  16  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  17  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  18  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  19  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  20  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  21  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  22  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  23  */
  24
  25 #ifndef _SSH_GSS_H
  26 #define _SSH_GSS_H
  27
  28 #ifdef GSSAPI
  29
  30 #include "kex.h"
  31 #include "buffer.h"
  32
  33 #include <gssapi.h>
  34
  35 #ifndef MECHGLUE
  36 #ifdef KRB5
  37 #ifndef HEIMDAL
  38 #include <gssapi_generic.h>
  39
  40 /* MIT Kerberos doesn't seem to define GSS_NT_HOSTBASED_SERVICE */
  41
  42 #ifndef GSS_C_NT_HOSTBASED_SERVICE
  43 #define GSS_C_NT_HOSTBASED_SERVICE gss_nt_service_name
  44 #endif /* GSS_C_NT_... */
  45 #endif /* !HEIMDAL */
  46 #endif /* KRB5 */
  47 #endif /* !MECHGLUE */
  48
  49 /* draft-ietf-secsh-gsskeyex-03 */
  50 #define SSH2_MSG_KEXGSS_INIT                            30
  51 #define SSH2_MSG_KEXGSS_CONTINUE                        31
  52 #define SSH2_MSG_KEXGSS_COMPLETE                        32
  53 #define SSH2_MSG_KEXGSS_HOSTKEY                         33
  54 #define SSH2_MSG_KEXGSS_ERROR                           34
  55 #define SSH2_MSG_USERAUTH_GSSAPI_RESPONSE               60
  56 #define SSH2_MSG_USERAUTH_GSSAPI_TOKEN                  61
  57 #define SSH2_MSG_USERAUTH_GSSAPI_EXCHANGE_COMPLETE      63
  58 #define SSH2_MSG_USERAUTH_GSSAPI_ERROR                  64
  59
  60 #define KEX_GSS_SHA1                                    "gss-group1-sha1-"
  61
  62 enum ssh_gss_id {
  63 #ifdef KRB5
  64         GSS_KERBEROS,
  65 #endif
  66 #ifdef GSI
  67         GSS_GSI,
  68 #endif /* GSI */
  69         GSS_LAST_ENTRY
  70 };
  71
  72 typedef struct ssh_gss_mech_struct {
  73         char *enc_name;
  74         char *name;
  75         gss_OID_desc oid;
  76 } ssh_gssapi_mech;
  77
  78 typedef struct {
  79         OM_uint32       status; /* both */
  80         gss_ctx_id_t    context; /* both */
  81         gss_name_t      name; /* both */
  82         gss_OID         oid; /* both */
  83         gss_cred_id_t   creds; /* server */
  84         gss_name_t      client; /* server */
  85         gss_cred_id_t   client_creds; /* server */
  86 } Gssctxt;
  87
  88 extern ssh_gssapi_mech supported_mechs[];
  89 extern gss_buffer_desc gssapi_client_name;
  90 extern gss_cred_id_t   gssapi_client_creds;
  91 extern enum ssh_gss_id gssapi_client_type;
  92
  93 char *ssh_gssapi_mechanisms(int server, char *host);
  94 gss_OID ssh_gssapi_id_kex(Gssctxt *ctx, char *name);
  95 void ssh_gssapi_set_oid_data(Gssctxt *ctx, void *data, size_t len);
  96 void ssh_gssapi_set_oid(Gssctxt *ctx, gss_OID oid);
  97 void ssh_gssapi_supported_oids(gss_OID_set *oidset);
  98 enum ssh_gss_id ssh_gssapi_get_ctype(Gssctxt *ctxt);
  99
 100 OM_uint32 ssh_gssapi_import_name(Gssctxt *ctx, const char *host);
 101 OM_uint32 ssh_gssapi_acquire_cred(Gssctxt *ctx);
 102 OM_uint32 ssh_gssapi_init_ctx(Gssctxt *ctx, int deleg_creds,
 103                               gss_buffer_desc *recv_tok,
 104                               gss_buffer_desc *send_tok, OM_uint32 *flags);
 105 OM_uint32 ssh_gssapi_accept_ctx(Gssctxt *ctx,
 106                                 gss_buffer_desc *recv_tok,
 107                                 gss_buffer_desc *send_tok,
 108                                 OM_uint32 *flags);
 109 OM_uint32 ssh_gssapi_getclient(Gssctxt *ctx,
 110                                 enum ssh_gss_id *type,
 111                                 gss_buffer_desc *name,
 112                                 gss_cred_id_t *creds);
 113 void ssh_gssapi_error(gss_OID mech,
 114                       OM_uint32 major_status, OM_uint32 minor_status);
 115 void ssh_gssapi_send_error(gss_OID mech,
 116                            OM_uint32 major_status,OM_uint32 minor_status);
 117 void ssh_gssapi_build_ctx(Gssctxt **ctx);
 118 void ssh_gssapi_delete_ctx(Gssctxt **ctx);
 119 OM_uint32 ssh_gssapi_client_ctx(Gssctxt **ctx,gss_OID oid,char *host);
 120 OM_uint32 ssh_gssapi_server_ctx(Gssctxt **ctx,gss_OID oid);
 121
 122 /* In the client */
 123 void ssh_gssapi_client(Kex *kex, char *host, struct sockaddr *hostaddr,
 124                        Buffer *client_kexinit, Buffer *server_kexinit);
 125
 126 /* In the server */
 127 int ssh_gssapi_userok(char *name);
 128 int ssh_gssapi_localname(char **lname);
 129 void ssh_gssapi_server(Kex *kex, Buffer *client_kexinit,
 130                        Buffer *server_kexinit);
 131
 132 OM_uint32 ssh_gssapi_sign(Gssctxt *ctx, gss_buffer_desc *buffer,
 133                                         gss_buffer_desc *hash);
 134
 135 void ssh_gssapi_do_child(char ***envp, u_int *envsizep);
 136 void ssh_gssapi_cleanup_creds(void *ignored);
 137 void ssh_gssapi_storecreds();
 138 void ssh_gssapi_clean_env();
 139
 140 #ifdef GSI
 141 int gsi_gridmap(char *subject_name, char **mapped_name);
 142 #endif
 143
 144 #ifdef MECHGLUE
 145 gss_cred_id_t __gss_get_mechanism_cred
 146    (gss_cred_id_t,      /* union_cred */
 147     gss_OID             /* mech_type */
 148    );
 149 #endif
 150
 151 #endif /* GSSAPI */
 152
 153 #endif /* _SSH_GSS_H */