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

/*
 * Copyright (c) 2001,2002 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

#include "kex.h"
#include "buffer.h"

#include <gssapi.h>

#ifndef MECHGLUE
#ifdef KRB5
#ifndef HEIMDAL
#include <gssapi_generic.h>

/* 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-03 */
#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_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 KEX_GSS_SHA1					"gss-group1-sha1-"

enum ssh_gss_id {
#ifdef KRB5
	GSS_KERBEROS,
#endif
#ifdef GSI
	GSS_GSI,
#endif /* GSI */
	GSS_LAST_ENTRY
};

typedef struct ssh_gss_mech_struct {
        char *enc_name;
        char *name;
        gss_OID_desc oid;
} ssh_gssapi_mech;

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

extern ssh_gssapi_mech supported_mechs[];
extern gss_buffer_desc gssapi_client_name;
extern gss_cred_id_t   gssapi_client_creds;
extern enum ssh_gss_id gssapi_client_type;

char *ssh_gssapi_mechanisms(int server, char *host);
gss_OID ssh_gssapi_id_kex(Gssctxt *ctx, char *name);
void ssh_gssapi_set_oid_data(Gssctxt *ctx, void *data, size_t len);
void ssh_gssapi_set_oid(Gssctxt *ctx, gss_OID oid);
void ssh_gssapi_supported_oids(gss_OID_set *oidset);
enum ssh_gss_id ssh_gssapi_get_ctype(Gssctxt *ctxt);

OM_uint32 ssh_gssapi_import_name(Gssctxt *ctx, const char *host);
OM_uint32 ssh_gssapi_acquire_cred(Gssctxt *ctx);
OM_uint32 ssh_gssapi_init_ctx(Gssctxt *ctx, int deleg_creds,
			      gss_buffer_desc *recv_tok, 
			      gss_buffer_desc *send_tok, OM_uint32 *flags);
OM_uint32 ssh_gssapi_accept_ctx(Gssctxt *ctx,
				gss_buffer_desc *recv_tok,
				gss_buffer_desc *send_tok,
				OM_uint32 *flags);
OM_uint32 ssh_gssapi_getclient(Gssctxt *ctx,
				enum ssh_gss_id *type,
				gss_buffer_desc *name,
				gss_cred_id_t *creds);
void ssh_gssapi_error(OM_uint32 major_status,OM_uint32 minor_status);
void ssh_gssapi_send_error(OM_uint32 major_status,OM_uint32 minor_status);
void ssh_gssapi_build_ctx(Gssctxt **ctx);
void ssh_gssapi_delete_ctx(Gssctxt **ctx);
OM_uint32 ssh_gssapi_client_ctx(Gssctxt **ctx,gss_OID oid,char *host);
OM_uint32 ssh_gssapi_server_ctx(Gssctxt **ctx,gss_OID oid);

/* In the client */
void ssh_gssapi_client(Kex *kex, char *host, struct sockaddr *hostaddr,
                       Buffer *client_kexinit, Buffer *server_kexinit);

/* In the server */
int ssh_gssapi_userok(char *name);
int ssh_gssapi_localname(char **lname);
void ssh_gssapi_server(Kex *kex, Buffer *client_kexinit, 
		       Buffer *server_kexinit);

OM_uint32 ssh_gssapi_sign(Gssctxt *ctx, gss_buffer_desc *buffer, 
					gss_buffer_desc *hash);

void ssh_gssapi_do_child(char ***envp, u_int *envsizep);                 
void ssh_gssapi_cleanup_creds(void *ignored);
void ssh_gssapi_storecreds();
void ssh_gssapi_clean_env();

#ifdef GSI
int gsi_gridmap(char *subject_name, char **mapped_name);
#ifdef _HAVE_GSI_EXTENDED_GSSAPI
#define HAVE_GSSAPI_EXT
#endif
#endif

#ifdef MECHGLUE
gss_cred_id_t __gss_get_mechanism_cred
   (gss_cred_id_t,	/* union_cred */
    gss_OID		/* mech_type */
   );
#ifndef _HAVE_GSI_EXTENDED_GSSAPI
#define HAVE_GSSAPI_EXT
OM_uint32 gss_export_cred
    (OM_uint32 *,        /* minor_status */
     const gss_cred_id_t,/* cred_handle */
     const gss_OID,      /* desired mech */
     OM_uint32,          /* option req */
     gss_buffer_t);      /* output buffer */
#endif
#endif
#endif /* GSSAPI */

#endif /* _SSH_GSS_H */
Commit	Line	Data
5598e598	1	/*
b59afbfe	2	* Copyright (c) 2001,2002 Simon Wilkinson. All rights reserved.
5598e598	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
b59afbfe	25	#ifndef _SSH_GSS_H
	26	#define _SSH_GSS_H
	27
5598e598	28	#ifdef GSSAPI
	29
	30	#include "kex.h"
	31	#include "buffer.h"
	32
	33	#include <gssapi.h>
	34
8f0688f5	35	#ifndef MECHGLUE
5598e598	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 */
8f0688f5	47	#endif /* !MECHGLUE */
5598e598	48
b59afbfe	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
5598e598	57	#define SSH2_MSG_USERAUTH_GSSAPI_EXCHANGE_COMPLETE 63
b59afbfe	58	#define SSH2_MSG_USERAUTH_GSSAPI_ERROR 64
	59
	60	#define KEX_GSS_SHA1 "gss-group1-sha1-"
5598e598	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; /* client */
	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);
b59afbfe	94	gss_OID ssh_gssapi_id_kex(Gssctxt ctx, char name);
5598e598	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
af6d5f4c	100	OM_uint32 ssh_gssapi_import_name(Gssctxt ctx, const char host);
5598e598	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(OM_uint32 major_status,OM_uint32 minor_status);
de4d4506	114	void ssh_gssapi_send_error(OM_uint32 major_status,OM_uint32 minor_status);
b59afbfe	115	void ssh_gssapi_build_ctx(Gssctxt **ctx);
	116	void ssh_gssapi_delete_ctx(Gssctxt **ctx);
	117	OM_uint32 ssh_gssapi_client_ctx(Gssctxt *ctx,gss_OID oid,char host);
	118	OM_uint32 ssh_gssapi_server_ctx(Gssctxt **ctx,gss_OID oid);
5598e598	119
	120	/* In the client */
	121	void ssh_gssapi_client(Kex kex, char host, struct sockaddr *hostaddr,
	122	Buffer client_kexinit, Buffer server_kexinit);
	123
	124	/* In the server */
b59afbfe	125	int ssh_gssapi_userok(char *name);
b59afbfe	126	int ssh_gssapi_localname(char **lname);
5598e598	127	void ssh_gssapi_server(Kex kex, Buffer client_kexinit,
5598e598	128	Buffer *server_kexinit);
b59afbfe	129
	130	OM_uint32 ssh_gssapi_sign(Gssctxt ctx, gss_buffer_desc buffer,
	131	gss_buffer_desc *hash);
	132
5598e598	133	void ssh_gssapi_do_child(char **envp, u_int envsizep);
	134	void ssh_gssapi_cleanup_creds(void *ignored);
	135	void ssh_gssapi_storecreds();
c7221eee	136	void ssh_gssapi_clean_env();
b59afbfe	137
	138	#ifdef GSI
	139	int gsi_gridmap(char subject_name, char *mapped_name);
f9ee7be6	140	#ifdef _HAVE_GSI_EXTENDED_GSSAPI
	141	#define HAVE_GSSAPI_EXT
	142	#endif
	143	#endif
	144
	145	#ifdef MECHGLUE
	146	gss_cred_id_t __gss_get_mechanism_cred
	147	(gss_cred_id_t, /* union_cred */
	148	gss_OID /* mech_type */
	149	);
	150	#ifndef _HAVE_GSI_EXTENDED_GSSAPI
	151	#define HAVE_GSSAPI_EXT
	152	OM_uint32 gss_export_cred
	153	(OM_uint32 , / minor_status */
	154	const gss_cred_id_t,/* cred_handle */
	155	const gss_OID, /* desired mech */
	156	OM_uint32, /* option req */
	157	gss_buffer_t); /* output buffer */
	158	#endif
b59afbfe	159	#endif
5598e598	160	#endif /* GSSAPI */
b59afbfe	161
b59afbfe	162	#endif /* _SSH_GSS_H */