ssh-gss.h revision 264377 
1/* $OpenBSD: ssh-gss.h,v 1.11 2014/02/26 20:28:44 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#if defined(HAVE_GSSAPI_GSSAPI_H)
32#include <gssapi/gssapi.h>
33#elif defined(HAVE_GSSAPI_H)
34#include <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
64typedef struct {
65	char *filename;
66	char *envvar;
67	char *envval;
68	void *data;
69} ssh_gssapi_ccache;
70
71typedef struct {
72	gss_buffer_desc displayname;
73	gss_buffer_desc exportedname;
74	gss_cred_id_t creds;
75	struct ssh_gssapi_mech_struct *mech;
76	ssh_gssapi_ccache store;
77} ssh_gssapi_client;
78
79typedef struct ssh_gssapi_mech_struct {
80	char *enc_name;
81	char *name;
82	gss_OID_desc oid;
83	int (*dochild) (ssh_gssapi_client *);
84	int (*userok) (ssh_gssapi_client *, char *);
85	int (*localname) (ssh_gssapi_client *, char **);
86	void (*storecreds) (ssh_gssapi_client *);
87} ssh_gssapi_mech;
88
89typedef struct {
90	OM_uint32	major; /* both */
91	OM_uint32	minor; /* both */
92	gss_ctx_id_t	context; /* both */
93	gss_name_t	name; /* both */
94	gss_OID		oid; /* client */
95	gss_cred_id_t	creds; /* server */
96	gss_name_t	client; /* server */
97	gss_cred_id_t	client_creds; /* server */
98} Gssctxt;
99
100extern ssh_gssapi_mech *supported_mechs[];
101
102int  ssh_gssapi_check_oid(Gssctxt *, void *, size_t);
103void ssh_gssapi_set_oid_data(Gssctxt *, void *, size_t);
104void ssh_gssapi_set_oid(Gssctxt *, gss_OID);
105void ssh_gssapi_supported_oids(gss_OID_set *);
106ssh_gssapi_mech *ssh_gssapi_get_ctype(Gssctxt *);
107void ssh_gssapi_prepare_supported_oids(void);
108OM_uint32 ssh_gssapi_test_oid_supported(OM_uint32 *, gss_OID, int *);
109
110OM_uint32 ssh_gssapi_import_name(Gssctxt *, const char *);
111OM_uint32 ssh_gssapi_init_ctx(Gssctxt *, int,
112    gss_buffer_desc *, gss_buffer_desc *, OM_uint32 *);
113OM_uint32 ssh_gssapi_accept_ctx(Gssctxt *,
114    gss_buffer_desc *, gss_buffer_desc *, OM_uint32 *);
115OM_uint32 ssh_gssapi_getclient(Gssctxt *, ssh_gssapi_client *);
116void ssh_gssapi_error(Gssctxt *);
117char *ssh_gssapi_last_error(Gssctxt *, OM_uint32 *, OM_uint32 *);
118void ssh_gssapi_build_ctx(Gssctxt **);
119void ssh_gssapi_delete_ctx(Gssctxt **);
120OM_uint32 ssh_gssapi_sign(Gssctxt *, gss_buffer_t, gss_buffer_t);
121void ssh_gssapi_buildmic(Buffer *, const char *, const char *, const char *);
122int ssh_gssapi_check_mechanism(Gssctxt **, gss_OID, const char *);
123
124/* In the server */
125OM_uint32 ssh_gssapi_server_ctx(Gssctxt **, gss_OID);
126int ssh_gssapi_userok(char *name);
127OM_uint32 ssh_gssapi_checkmic(Gssctxt *, gss_buffer_t, gss_buffer_t);
128void ssh_gssapi_do_child(char ***, u_int *);
129void ssh_gssapi_cleanup_creds(void);
130void ssh_gssapi_storecreds(void);
131
132#endif /* GSSAPI */
133
134#endif /* _SSH_GSS_H */
135