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

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

#ifdef GSSAPI

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

#include <gssapi.h>

#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 */

/* draft-ietf-secsh-gsskeyex-01 */
#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 KEX_GSS_SHA1			"gss-group1-sha1-"

/* draft-galb-secsh-gssapi-01 */
#define SSH2_MSG_USERAUTH_GSSAPI_RESPONSE     60
#define SSH2_MSG_USERAUTH_GSSAPI_TOKEN        61
#define SSH2_MSG_USERAUTH_GSSAPI_HASH         62
#define SSH2_MSG_USERAUTH_GSSAPI_EXCHANGE_COMPLETE	63    

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);
int 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, 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_build_ctx(Gssctxt *ctx);
void ssh_gssapi_delete_ctx(Gssctxt *ctx);

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

/* In the server */
void ssh_gssapi_server(Kex *kex, Buffer *client_kexinit, 
		       Buffer *server_kexinit);
void ssh_gssapi_do_child(char ***envp, u_int *envsizep);                 
void ssh_gssapi_cleanup_creds(void *ignored);
void ssh_gssapi_storecreds();
#endif /* GSSAPI */
Commit	Line	Data
5598e598	1	/*
	2	* Copyright (c) 2001 Simon Wilkinson. All rights reserved.
	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
	25	#ifdef GSSAPI
	26
	27	#include "kex.h"
	28	#include "buffer.h"
	29
	30	#include <gssapi.h>
	31
	32	#ifdef KRB5
	33	#ifndef HEIMDAL
	34	#include <gssapi_generic.h>
	35
	36	/* MIT Kerberos doesn't seem to define GSS_NT_HOSTBASED_SERVICE */
	37
	38	#ifndef GSS_C_NT_HOSTBASED_SERVICE
	39	#define GSS_C_NT_HOSTBASED_SERVICE gss_nt_service_name
	40	#endif /* GSS_C_NT_... */
	41	#endif /* !HEIMDAL */
	42	#endif /* KRB5 */
	43
	44	/* draft-ietf-secsh-gsskeyex-01 */
	45	#define SSH2_MSG_KEXGSS_INIT 30
	46	#define SSH2_MSG_KEXGSS_CONTINUE 31
	47	#define SSH2_MSG_KEXGSS_COMPLETE 32
	48	#define SSH2_MSG_KEXGSS_HOSTKEY 33
	49	#define KEX_GSS_SHA1 "gss-group1-sha1-"
	50
	51	/* draft-galb-secsh-gssapi-01 */
	52	#define SSH2_MSG_USERAUTH_GSSAPI_RESPONSE 60
	53	#define SSH2_MSG_USERAUTH_GSSAPI_TOKEN 61
	54	#define SSH2_MSG_USERAUTH_GSSAPI_HASH 62
	55	#define SSH2_MSG_USERAUTH_GSSAPI_EXCHANGE_COMPLETE 63
	56
	57	enum ssh_gss_id {
	58	#ifdef KRB5
	59	GSS_KERBEROS,
	60	#endif
	61	#ifdef GSI
	62	GSS_GSI,
	63	#endif /* GSI */
	64	GSS_LAST_ENTRY
65	};
66
67	typedef struct ssh_gss_mech_struct {
68	char *enc_name;
69	char *name;
70	gss_OID_desc oid;
71	} ssh_gssapi_mech;
72
73	typedef struct {
74	OM_uint32 status; /* both */
75	gss_ctx_id_t context; /* both */
76	gss_name_t name; /* both */
77	gss_OID oid; /* client */
78	gss_cred_id_t creds; /* server */
79	gss_name_t client; /* server */
80	gss_cred_id_t client_creds; /* server */
81	} Gssctxt;
82
83	extern ssh_gssapi_mech supported_mechs[];
84	extern gss_buffer_desc gssapi_client_name;
85	extern gss_cred_id_t gssapi_client_creds;
86	extern enum ssh_gss_id gssapi_client_type;
87
88	char ssh_gssapi_mechanisms(int server, char host);
89	int ssh_gssapi_id_kex(Gssctxt ctx, char name);
90	void ssh_gssapi_set_oid_data(Gssctxt ctx, void data, size_t len);
91	void ssh_gssapi_set_oid(Gssctxt *ctx, gss_OID oid);
92	void ssh_gssapi_supported_oids(gss_OID_set *oidset);
93	enum ssh_gss_id ssh_gssapi_get_ctype(Gssctxt *ctxt);
94
905081a4	95	OM_uint32 ssh_gssapi_import_name(Gssctxt ctx, char host);
5598e598	96	OM_uint32 ssh_gssapi_acquire_cred(Gssctxt *ctx);
	97	OM_uint32 ssh_gssapi_init_ctx(Gssctxt *ctx, int deleg_creds,
	98	gss_buffer_desc *recv_tok,
	99	gss_buffer_desc send_tok, OM_uint32 flags);
	100	OM_uint32 ssh_gssapi_accept_ctx(Gssctxt *ctx,
	101	gss_buffer_desc *recv_tok,
	102	gss_buffer_desc *send_tok,
	103	OM_uint32 *flags);
	104	OM_uint32 ssh_gssapi_getclient(Gssctxt *ctx,
	105	enum ssh_gss_id *type,
	106	gss_buffer_desc *name,
	107	gss_cred_id_t *creds);
	108	void ssh_gssapi_error(OM_uint32 major_status,OM_uint32 minor_status);
	109	void ssh_gssapi_build_ctx(Gssctxt *ctx);
	110	void ssh_gssapi_delete_ctx(Gssctxt *ctx);
	111
	112	/* In the client */
	113	void ssh_gssapi_client(Kex kex, char host, struct sockaddr *hostaddr,
	114	Buffer client_kexinit, Buffer server_kexinit);
	115
	116	/* In the server */
	117	void ssh_gssapi_server(Kex kex, Buffer client_kexinit,
	118	Buffer *server_kexinit);
	119	void ssh_gssapi_do_child(char **envp, u_int envsizep);
	120	void ssh_gssapi_cleanup_creds(void *ignored);
	121	void ssh_gssapi_storecreds();
	122	#endif /* GSSAPI */