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
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/* Old MIT Kerberos doesn't seem to define GSS_NT_HOSTBASED_SERVICE */
46
47#  if !HAVE_DECL_GSS_C_NT_HOSTBASED_SERVICE
48#   define GSS_C_NT_HOSTBASED_SERVICE gss_nt_service_name
49#  endif /* !HAVE_DECL_GSS_C_NT_... */
50
51# endif /* !HEIMDAL */
52#endif /* KRB5 */
53
54/* draft-ietf-secsh-gsskeyex-06 */
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#define SSH2_MSG_USERAUTH_GSSAPI_ERRTOK			65
60#define SSH2_MSG_USERAUTH_GSSAPI_MIC			66
61
62#define SSH_GSS_OIDTYPE 0x06
63
64#define SSH2_MSG_KEXGSS_INIT                            30
65#define SSH2_MSG_KEXGSS_CONTINUE                        31
66#define SSH2_MSG_KEXGSS_COMPLETE                        32
67#define SSH2_MSG_KEXGSS_HOSTKEY                         33
68#define SSH2_MSG_KEXGSS_ERROR                           34
69#define SSH2_MSG_KEXGSS_GROUPREQ			40
70#define SSH2_MSG_KEXGSS_GROUP				41
71#define KEX_GSS_GRP1_SHA1_ID				"gss-group1-sha1-"
72#define KEX_GSS_GRP14_SHA1_ID				"gss-group14-sha1-"
73#define KEX_GSS_GEX_SHA1_ID				"gss-gex-sha1-"
74
75typedef struct {
76	char *filename;
77	char *envvar;
78	char *envval;
79	struct passwd *owner;
80	void *data;
81} ssh_gssapi_ccache;
82
83typedef struct {
84	gss_buffer_desc displayname;
85	gss_buffer_desc exportedname;
86	gss_cred_id_t creds;
87	gss_name_t name;
88	struct ssh_gssapi_mech_struct *mech;
89	ssh_gssapi_ccache store;
90	int used;
91	int updated;
92} ssh_gssapi_client;
93
94typedef struct ssh_gssapi_mech_struct {
95	char *enc_name;
96	char *name;
97	gss_OID_desc oid;
98	int (*dochild) (ssh_gssapi_client *);
99	int (*userok) (ssh_gssapi_client *, char *);
100	int (*localname) (ssh_gssapi_client *, char **);
101	void (*storecreds) (ssh_gssapi_client *);
102	int (*updatecreds) (ssh_gssapi_ccache *, ssh_gssapi_client *);
103} ssh_gssapi_mech;
104
105typedef struct {
106	OM_uint32	major; /* both */
107	OM_uint32	minor; /* both */
108	gss_ctx_id_t	context; /* both */
109	gss_name_t	name; /* both */
110	gss_OID		oid; /* client */
111	gss_cred_id_t	creds; /* server */
112	gss_name_t	client; /* server */
113	gss_cred_id_t	client_creds; /* both */
114} Gssctxt;
115
116extern ssh_gssapi_mech *supported_mechs[];
117extern Gssctxt *gss_kex_context;
118
119int  ssh_gssapi_check_oid(Gssctxt *, void *, size_t);
120void ssh_gssapi_set_oid_data(Gssctxt *, void *, size_t);
121void ssh_gssapi_set_oid(Gssctxt *, gss_OID);
122void ssh_gssapi_supported_oids(gss_OID_set *);
123ssh_gssapi_mech *ssh_gssapi_get_ctype(Gssctxt *);
124
125OM_uint32 ssh_gssapi_import_name(Gssctxt *, const char *);
126OM_uint32 ssh_gssapi_init_ctx(Gssctxt *, int,
127    gss_buffer_desc *, gss_buffer_desc *, OM_uint32 *);
128OM_uint32 ssh_gssapi_accept_ctx(Gssctxt *,
129    gss_buffer_desc *, gss_buffer_desc *, OM_uint32 *);
130OM_uint32 ssh_gssapi_getclient(Gssctxt *, ssh_gssapi_client *);
131void ssh_gssapi_error(Gssctxt *);
132char *ssh_gssapi_last_error(Gssctxt *, OM_uint32 *, OM_uint32 *);
133void ssh_gssapi_build_ctx(Gssctxt **);
134void ssh_gssapi_delete_ctx(Gssctxt **);
135OM_uint32 ssh_gssapi_sign(Gssctxt *, gss_buffer_t, gss_buffer_t);
136void ssh_gssapi_buildmic(Buffer *, const char *, const char *, const char *);
137int ssh_gssapi_check_mechanism(Gssctxt **, gss_OID, const char *, const char *);
138OM_uint32 ssh_gssapi_client_identity(Gssctxt *, const char *);
139int ssh_gssapi_credentials_updated(Gssctxt *);
140
141/* In the server */
142typedef int ssh_gssapi_check_fn(Gssctxt **, gss_OID, const char *,
143    const char *);
144char *ssh_gssapi_client_mechanisms(const char *, const char *);
145char *ssh_gssapi_kex_mechs(gss_OID_set, ssh_gssapi_check_fn *, const char *,
146    const char *);
147gss_OID ssh_gssapi_id_kex(Gssctxt *, char *, int);
148int ssh_gssapi_server_check_mech(Gssctxt **,gss_OID, const char *,
149    const char *);
150OM_uint32 ssh_gssapi_server_ctx(Gssctxt **, gss_OID);
151int ssh_gssapi_userok(char *name, struct passwd *);
152OM_uint32 ssh_gssapi_checkmic(Gssctxt *, gss_buffer_t, gss_buffer_t);
153void ssh_gssapi_do_child(char ***, u_int *);
154void ssh_gssapi_cleanup_creds(void);
155void ssh_gssapi_storecreds(void);
156
157char *ssh_gssapi_server_mechanisms(void);
158int ssh_gssapi_oid_table_ok();
159
160int ssh_gssapi_update_creds(ssh_gssapi_ccache *store);
161#endif /* GSSAPI */
162
163#endif /* _SSH_GSS_H */
164