1/* $OpenBSD: ssh-gss.h,v 1.11 2014/02/26 20:28:44 djm Exp $ */
2/* $FreeBSD$ */
3/*
4 * Copyright (c) 2001-2003 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#ifndef _SSH_GSS_H
28#define _SSH_GSS_H
29
30#ifdef GSSAPI
31
32#if defined(HAVE_GSSAPI_GSSAPI_H)
33#include <gssapi/gssapi.h>
34#elif defined(HAVE_GSSAPI_H)
35#include <gssapi.h>
36#endif
37
38#ifdef KRB5
39# ifndef HEIMDAL
40#  ifdef HAVE_GSSAPI_GENERIC_H
41#   include <gssapi_generic.h>
42#  elif defined(HAVE_GSSAPI_GSSAPI_GENERIC_H)
43#   include <gssapi/gssapi_generic.h>
44#  endif
45
46/* Old MIT Kerberos doesn't seem to define GSS_NT_HOSTBASED_SERVICE */
47
48#  if !HAVE_DECL_GSS_C_NT_HOSTBASED_SERVICE
49#   define GSS_C_NT_HOSTBASED_SERVICE gss_nt_service_name
50#  endif /* !HAVE_DECL_GSS_C_NT_... */
51
52# endif /* !HEIMDAL */
53#endif /* KRB5 */
54
55/* draft-ietf-secsh-gsskeyex-06 */
56#define SSH2_MSG_USERAUTH_GSSAPI_RESPONSE		60
57#define SSH2_MSG_USERAUTH_GSSAPI_TOKEN			61
58#define SSH2_MSG_USERAUTH_GSSAPI_EXCHANGE_COMPLETE	63
59#define SSH2_MSG_USERAUTH_GSSAPI_ERROR			64
60#define SSH2_MSG_USERAUTH_GSSAPI_ERRTOK			65
61#define SSH2_MSG_USERAUTH_GSSAPI_MIC			66
62
63#define SSH_GSS_OIDTYPE 0x06
64
65typedef struct {
66	char *filename;
67	char *envvar;
68	char *envval;
69	void *data;
70} ssh_gssapi_ccache;
71
72typedef struct {
73	gss_buffer_desc displayname;
74	gss_buffer_desc exportedname;
75	gss_cred_id_t creds;
76	struct ssh_gssapi_mech_struct *mech;
77	ssh_gssapi_ccache store;
78} ssh_gssapi_client;
79
80typedef struct ssh_gssapi_mech_struct {
81	char *enc_name;
82	char *name;
83	gss_OID_desc oid;
84	int (*dochild) (ssh_gssapi_client *);
85	int (*userok) (ssh_gssapi_client *, char *);
86	int (*localname) (ssh_gssapi_client *, char **);
87	void (*storecreds) (ssh_gssapi_client *);
88} ssh_gssapi_mech;
89
90typedef struct {
91	OM_uint32	major; /* both */
92	OM_uint32	minor; /* both */
93	gss_ctx_id_t	context; /* both */
94	gss_name_t	name; /* both */
95	gss_OID		oid; /* client */
96	gss_cred_id_t	creds; /* server */
97	gss_name_t	client; /* server */
98	gss_cred_id_t	client_creds; /* server */
99} Gssctxt;
100
101extern ssh_gssapi_mech *supported_mechs[];
102
103int  ssh_gssapi_check_oid(Gssctxt *, void *, size_t);
104void ssh_gssapi_set_oid_data(Gssctxt *, void *, size_t);
105void ssh_gssapi_set_oid(Gssctxt *, gss_OID);
106void ssh_gssapi_supported_oids(gss_OID_set *);
107ssh_gssapi_mech *ssh_gssapi_get_ctype(Gssctxt *);
108void ssh_gssapi_prepare_supported_oids(void);
109OM_uint32 ssh_gssapi_test_oid_supported(OM_uint32 *, gss_OID, int *);
110
111OM_uint32 ssh_gssapi_import_name(Gssctxt *, const char *);
112OM_uint32 ssh_gssapi_init_ctx(Gssctxt *, int,
113    gss_buffer_desc *, gss_buffer_desc *, OM_uint32 *);
114OM_uint32 ssh_gssapi_accept_ctx(Gssctxt *,
115    gss_buffer_desc *, gss_buffer_desc *, OM_uint32 *);
116OM_uint32 ssh_gssapi_getclient(Gssctxt *, ssh_gssapi_client *);
117void ssh_gssapi_error(Gssctxt *);
118char *ssh_gssapi_last_error(Gssctxt *, OM_uint32 *, OM_uint32 *);
119void ssh_gssapi_build_ctx(Gssctxt **);
120void ssh_gssapi_delete_ctx(Gssctxt **);
121OM_uint32 ssh_gssapi_sign(Gssctxt *, gss_buffer_t, gss_buffer_t);
122void ssh_gssapi_buildmic(Buffer *, const char *, const char *, const char *);
123int ssh_gssapi_check_mechanism(Gssctxt **, gss_OID, const char *);
124
125/* In the server */
126OM_uint32 ssh_gssapi_server_ctx(Gssctxt **, gss_OID);
127int ssh_gssapi_userok(char *name);
128OM_uint32 ssh_gssapi_checkmic(Gssctxt *, gss_buffer_t, gss_buffer_t);
129void ssh_gssapi_do_child(char ***, u_int *);
130void ssh_gssapi_cleanup_creds(void);
131void ssh_gssapi_storecreds(void);
132
133#endif /* GSSAPI */
134
135#endif /* _SSH_GSS_H */
136