[gssapi-openssh.git] / openssh / ssh-gss.h

/* $OpenBSD: ssh-gss.h,v 1.10 2007/06/12 08:20:00 djm Exp $ */
/*
 * Copyright (c) 2001-2009 Simon Wilkinson. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR `AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _SSH_GSS_H
#define _SSH_GSS_H

#ifdef GSSAPI

#ifdef HAVE_GSSAPI_H
#include <gssapi.h>
#elif defined(HAVE_GSSAPI_GSSAPI_H)
#include <gssapi/gssapi.h>
#endif

#ifndef MECHGLUE
#ifdef KRB5
# ifndef HEIMDAL
#  ifdef HAVE_GSSAPI_GENERIC_H
#   include <gssapi_generic.h>
#  elif defined(HAVE_GSSAPI_GSSAPI_GENERIC_H)
#   include <gssapi/gssapi_generic.h>
#  endif

/* MIT Kerberos doesn't seem to define GSS_NT_HOSTBASED_SERVICE */

#ifndef GSS_C_NT_HOSTBASED_SERVICE
#define GSS_C_NT_HOSTBASED_SERVICE gss_nt_service_name
#endif /* GSS_C_NT_... */
#endif /* !HEIMDAL */
#endif /* KRB5 */
#endif /* !MECHGLUE */

/* draft-ietf-secsh-gsskeyex-06 */
#define SSH2_MSG_USERAUTH_GSSAPI_RESPONSE		60
#define SSH2_MSG_USERAUTH_GSSAPI_TOKEN			61
#define SSH2_MSG_USERAUTH_GSSAPI_EXCHANGE_COMPLETE	63
#define SSH2_MSG_USERAUTH_GSSAPI_ERROR			64
#define SSH2_MSG_USERAUTH_GSSAPI_ERRTOK			65
#define SSH2_MSG_USERAUTH_GSSAPI_MIC			66

#define SSH_GSS_OIDTYPE 0x06

#define SSH2_MSG_KEXGSS_INIT                            30
#define SSH2_MSG_KEXGSS_CONTINUE                        31
#define SSH2_MSG_KEXGSS_COMPLETE                        32
#define SSH2_MSG_KEXGSS_HOSTKEY                         33
#define SSH2_MSG_KEXGSS_ERROR                           34
#define SSH2_MSG_KEXGSS_GROUPREQ			40
#define SSH2_MSG_KEXGSS_GROUP				41
#define KEX_GSS_GRP1_SHA1_ID				"gss-group1-sha1-"
#define KEX_GSS_GRP14_SHA1_ID				"gss-group14-sha1-"
#define KEX_GSS_GEX_SHA1_ID				"gss-gex-sha1-"

typedef struct {
	char *filename;
	char *envvar;
	char *envval;
	struct passwd *owner;
	void *data;
} ssh_gssapi_ccache;

typedef struct {
	gss_buffer_desc displayname;
	gss_buffer_desc exportedname;
	gss_cred_id_t creds;
	gss_name_t name;
	struct ssh_gssapi_mech_struct *mech;
	ssh_gssapi_ccache store;
    gss_ctx_id_t context;
	int used;
	int updated;
} ssh_gssapi_client;

typedef struct ssh_gssapi_mech_struct {
	char *enc_name;
	char *name;
	gss_OID_desc oid;
	int (*dochild) (ssh_gssapi_client *);
	int (*userok) (ssh_gssapi_client *, char *);
	int (*localname) (ssh_gssapi_client *, char **);
	void (*storecreds) (ssh_gssapi_client *);
	int (*updatecreds) (ssh_gssapi_ccache *, ssh_gssapi_client *);
} ssh_gssapi_mech;

typedef struct {
	OM_uint32	major; /* both */
	OM_uint32	minor; /* both */
	gss_ctx_id_t	context; /* both */
	gss_name_t	name; /* both */
	gss_OID		oid; /* both */
	gss_cred_id_t	creds; /* server */
	gss_name_t	client; /* server */
	gss_cred_id_t	client_creds; /* both */
} Gssctxt;

extern ssh_gssapi_mech *supported_mechs[];
extern Gssctxt *gss_kex_context;

int  ssh_gssapi_check_oid(Gssctxt *, void *, size_t);
void ssh_gssapi_set_oid_data(Gssctxt *, void *, size_t);
void ssh_gssapi_set_oid(Gssctxt *, gss_OID);
void ssh_gssapi_supported_oids(gss_OID_set *);
ssh_gssapi_mech *ssh_gssapi_get_ctype(Gssctxt *);

OM_uint32 ssh_gssapi_import_name(Gssctxt *, const char *);
OM_uint32 ssh_gssapi_init_ctx(Gssctxt *, int,
    gss_buffer_desc *, gss_buffer_desc *, OM_uint32 *);
OM_uint32 ssh_gssapi_accept_ctx(Gssctxt *,
    gss_buffer_desc *, gss_buffer_desc *, OM_uint32 *);
OM_uint32 ssh_gssapi_getclient(Gssctxt *, ssh_gssapi_client *);
void ssh_gssapi_error(Gssctxt *);
char *ssh_gssapi_last_error(Gssctxt *, OM_uint32 *, OM_uint32 *);
void ssh_gssapi_build_ctx(Gssctxt **);
void ssh_gssapi_delete_ctx(Gssctxt **);
OM_uint32 ssh_gssapi_sign(Gssctxt *, gss_buffer_t, gss_buffer_t);
void ssh_gssapi_buildmic(Buffer *, const char *, const char *, const char *);
int ssh_gssapi_check_mechanism(Gssctxt **, gss_OID, const char *, const char *);
OM_uint32 ssh_gssapi_client_identity(Gssctxt *, const char *);
int ssh_gssapi_credentials_updated(Gssctxt *);

int ssh_gssapi_localname(char **name);
void ssh_gssapi_rekey_creds();

/* In the server */
typedef int ssh_gssapi_check_fn(Gssctxt **, gss_OID, const char *, 
    const char *);
char *ssh_gssapi_client_mechanisms(const char *, const char *);
char *ssh_gssapi_kex_mechs(gss_OID_set, ssh_gssapi_check_fn *, const char *,
    const char *);
gss_OID ssh_gssapi_id_kex(Gssctxt *, char *, int);
int ssh_gssapi_server_check_mech(Gssctxt **,gss_OID, const char *, 
    const char *);
OM_uint32 ssh_gssapi_server_ctx(Gssctxt **, gss_OID);
int ssh_gssapi_userok(char *name, struct passwd *);
OM_uint32 ssh_gssapi_checkmic(Gssctxt *, gss_buffer_t, gss_buffer_t);
void ssh_gssapi_do_child(char ***, u_int *);
void ssh_gssapi_cleanup_creds(void);
void ssh_gssapi_storecreds(void);

#ifdef MECHGLUE
gss_cred_id_t __gss_get_mechanism_cred
   (gss_cred_id_t,	/* union_cred */
    gss_OID		/* mech_type */
   );
#endif

char *ssh_gssapi_server_mechanisms(void);
int ssh_gssapi_oid_table_ok();

int ssh_gssapi_update_creds(ssh_gssapi_ccache *store);
void ssh_gssapi_get_client_info(char **userdn, char **mech);
#endif /* GSSAPI */

#endif /* _SSH_GSS_H */
Commit	Line	Data
fa0f0f45	1	/* $OpenBSD: ssh-gss.h,v 1.10 2007/06/12 08:20:00 djm Exp $ */
5598e598	2	/*
f97edba6	3	* Copyright (c) 2001-2009 Simon Wilkinson. All rights reserved.
5598e598	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
b59afbfe	26	#ifndef _SSH_GSS_H
	27	#define _SSH_GSS_H
	28
5598e598	29	#ifdef GSSAPI
5598e598	30
540d72c3	31	#ifdef HAVE_GSSAPI_H
5598e598	32	#include <gssapi.h>
540d72c3	33	#elif defined(HAVE_GSSAPI_GSSAPI_H)
	34	#include <gssapi/gssapi.h>
	35	#endif
5598e598	36
8f0688f5	37	#ifndef MECHGLUE
5598e598	38	#ifdef KRB5
540d72c3	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
5598e598	45
5598e598	46	/* MIT Kerberos doesn't seem to define GSS_NT_HOSTBASED_SERVICE */
7cac2b65	47
5598e598	48	#ifndef GSS_C_NT_HOSTBASED_SERVICE
	49	#define GSS_C_NT_HOSTBASED_SERVICE gss_nt_service_name
	50	#endif /* GSS_C_NT_... */
	51	#endif /* !HEIMDAL */
	52	#endif /* KRB5 */
8f0688f5	53	#endif /* !MECHGLUE */
5598e598	54
7cac2b65	55	/* draft-ietf-secsh-gsskeyex-06 */
7cac2b65	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
e23e524c	60	#define SSH2_MSG_USERAUTH_GSSAPI_ERRTOK 65
540d72c3	61	#define SSH2_MSG_USERAUTH_GSSAPI_MIC 66
b59afbfe	62
7cac2b65	63	#define SSH_GSS_OIDTYPE 0x06
7cac2b65	64
f713db99	65	#define SSH2_MSG_KEXGSS_INIT 30
	66	#define SSH2_MSG_KEXGSS_CONTINUE 31
	67	#define SSH2_MSG_KEXGSS_COMPLETE 32
	68	#define SSH2_MSG_KEXGSS_HOSTKEY 33
	69	#define SSH2_MSG_KEXGSS_ERROR 34
fe4ad273	70	#define SSH2_MSG_KEXGSS_GROUPREQ 40
	71	#define SSH2_MSG_KEXGSS_GROUP 41
	72	#define KEX_GSS_GRP1_SHA1_ID "gss-group1-sha1-"
f713db99	73	#define KEX_GSS_GRP14_SHA1_ID "gss-group14-sha1-"
fe4ad273	74	#define KEX_GSS_GEX_SHA1_ID "gss-gex-sha1-"
5598e598	75
23987cb8	76	typedef struct {
7cac2b65	77	char *filename;
	78	char *envvar;
	79	char *envval;
f97edba6	80	struct passwd *owner;
7cac2b65	81	void *data;
23987cb8	82	} ssh_gssapi_ccache;
	83
	84	typedef struct {
7cac2b65	85	gss_buffer_desc displayname;
	86	gss_buffer_desc exportedname;
	87	gss_cred_id_t creds;
f97edba6	88	gss_name_t name;
23987cb8	89	struct ssh_gssapi_mech_struct *mech;
23987cb8	90	ssh_gssapi_ccache store;
682b256d	91	gss_ctx_id_t context;
f97edba6	92	int used;
f97edba6	93	int updated;
23987cb8	94	} ssh_gssapi_client;
5598e598	95
23987cb8	96	typedef struct ssh_gssapi_mech_struct {
7cac2b65	97	char *enc_name;
	98	char *name;
	99	gss_OID_desc oid;
23987cb8	100	int (dochild) (ssh_gssapi_client );
	101	int (userok) (ssh_gssapi_client , char *);
	102	int (localname) (ssh_gssapi_client , char **);
	103	void (storecreds) (ssh_gssapi_client );
f97edba6	104	int (updatecreds) (ssh_gssapi_ccache , ssh_gssapi_client *);
5598e598	105	} ssh_gssapi_mech;
	106
	107	typedef struct {
23987cb8	108	OM_uint32 major; /* both */
23987cb8	109	OM_uint32 minor; /* both */
5598e598	110	gss_ctx_id_t context; /* both */
5598e598	111	gss_name_t name; /* both */
6f9f4dab	112	gss_OID oid; /* both */
5598e598	113	gss_cred_id_t creds; /* server */
5598e598	114	gss_name_t client; /* server */
f97edba6	115	gss_cred_id_t client_creds; /* both */
5598e598	116	} Gssctxt;
5598e598	117
23987cb8	118	extern ssh_gssapi_mech *supported_mechs[];
fe4ad273	119	extern Gssctxt *gss_kex_context;
7e82606e	120
	121	int ssh_gssapi_check_oid(Gssctxt , void , size_t);
	122	void ssh_gssapi_set_oid_data(Gssctxt , void , size_t);
	123	void ssh_gssapi_set_oid(Gssctxt *, gss_OID);
	124	void ssh_gssapi_supported_oids(gss_OID_set *);
	125	ssh_gssapi_mech ssh_gssapi_get_ctype(Gssctxt );
	126
	127	OM_uint32 ssh_gssapi_import_name(Gssctxt , const char );
7e82606e	128	OM_uint32 ssh_gssapi_init_ctx(Gssctxt *, int,
	129	gss_buffer_desc , gss_buffer_desc , OM_uint32 *);
	130	OM_uint32 ssh_gssapi_accept_ctx(Gssctxt *,
	131	gss_buffer_desc , gss_buffer_desc , OM_uint32 *);
	132	OM_uint32 ssh_gssapi_getclient(Gssctxt , ssh_gssapi_client );
	133	void ssh_gssapi_error(Gssctxt *);
	134	char ssh_gssapi_last_error(Gssctxt , OM_uint32 , OM_uint32 );
	135	void ssh_gssapi_build_ctx(Gssctxt **);
	136	void ssh_gssapi_delete_ctx(Gssctxt **);
540d72c3	137	OM_uint32 ssh_gssapi_sign(Gssctxt *, gss_buffer_t, gss_buffer_t);
540d72c3	138	void ssh_gssapi_buildmic(Buffer , const char , const char , const char );
f97edba6	139	int ssh_gssapi_check_mechanism(Gssctxt *, gss_OID, const char , const char *);
	140	OM_uint32 ssh_gssapi_client_identity(Gssctxt , const char );
	141	int ssh_gssapi_credentials_updated(Gssctxt *);
5598e598	142
e23e524c	143	int ssh_gssapi_localname(char **name);
db5d66a5	144	void ssh_gssapi_rekey_creds();
7e82606e	145
7a5ea9c3	146	/* In the server */
f97edba6	147	typedef int ssh_gssapi_check_fn(Gssctxt *, gss_OID, const char ,
	148	const char *);
	149	char ssh_gssapi_client_mechanisms(const char , const char *);
	150	char ssh_gssapi_kex_mechs(gss_OID_set, ssh_gssapi_check_fn , const char *,
	151	const char *);
f713db99	152	gss_OID ssh_gssapi_id_kex(Gssctxt , char , int);
f97edba6	153	int ssh_gssapi_server_check_mech(Gssctxt *,gss_OID, const char ,
f97edba6	154	const char *);
fa0f0f45	155	OM_uint32 ssh_gssapi_server_ctx(Gssctxt **, gss_OID);
f97edba6	156	int ssh_gssapi_userok(char name, struct passwd );
540d72c3	157	OM_uint32 ssh_gssapi_checkmic(Gssctxt *, gss_buffer_t, gss_buffer_t);
7e82606e	158	void ssh_gssapi_do_child(char **, u_int );
540d72c3	159	void ssh_gssapi_cleanup_creds(void);
7cac2b65	160	void ssh_gssapi_storecreds(void);
b59afbfe	161
f9ee7be6	162	#ifdef MECHGLUE
	163	gss_cred_id_t __gss_get_mechanism_cred
	164	(gss_cred_id_t, /* union_cred */
	165	gss_OID /* mech_type */
	166	);
b59afbfe	167	#endif
076a92b0	168
f97edba6	169	char *ssh_gssapi_server_mechanisms(void);
	170	int ssh_gssapi_oid_table_ok();
	171
	172	int ssh_gssapi_update_creds(ssh_gssapi_ccache *store);
9f2c8cb9	173	void ssh_gssapi_get_client_info(char userdn, char mech);
5598e598	174	#endif /* GSSAPI */
b59afbfe	175
b59afbfe	176	#endif /* _SSH_GSS_H */