xref: /openbsd/usr.bin/ssh/ssh-gss.h (revision 94a54550)
1 /* $OpenBSD: ssh-gss.h,v 1.15 2021/01/27 10:05:28 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 #include <gssapi.h>
32 
33 /* draft-ietf-secsh-gsskeyex-06 */
34 #define SSH2_MSG_USERAUTH_GSSAPI_RESPONSE		60
35 #define SSH2_MSG_USERAUTH_GSSAPI_TOKEN			61
36 #define SSH2_MSG_USERAUTH_GSSAPI_EXCHANGE_COMPLETE	63
37 #define SSH2_MSG_USERAUTH_GSSAPI_ERROR			64
38 #define SSH2_MSG_USERAUTH_GSSAPI_ERRTOK			65
39 #define SSH2_MSG_USERAUTH_GSSAPI_MIC			66
40 
41 #define SSH_GSS_OIDTYPE 0x06
42 
43 typedef struct {
44 	char *filename;
45 	char *envvar;
46 	char *envval;
47 	void *data;
48 } ssh_gssapi_ccache;
49 
50 typedef struct {
51 	gss_buffer_desc displayname;
52 	gss_buffer_desc exportedname;
53 	gss_cred_id_t creds;
54 	struct ssh_gssapi_mech_struct *mech;
55 	ssh_gssapi_ccache store;
56 } ssh_gssapi_client;
57 
58 typedef struct ssh_gssapi_mech_struct {
59 	char *enc_name;
60 	char *name;
61 	gss_OID_desc oid;
62 	int (*dochild) (ssh_gssapi_client *);
63 	int (*userok) (ssh_gssapi_client *, char *);
64 	int (*localname) (ssh_gssapi_client *, char **);
65 	void (*storecreds) (ssh_gssapi_client *);
66 } ssh_gssapi_mech;
67 
68 typedef struct {
69 	OM_uint32	major; /* both */
70 	OM_uint32	minor; /* both */
71 	gss_ctx_id_t	context; /* both */
72 	gss_name_t	name; /* both */
73 	gss_OID		oid; /* client */
74 	gss_cred_id_t	creds; /* server */
75 	gss_name_t	client; /* server */
76 	gss_cred_id_t	client_creds; /* server */
77 } Gssctxt;
78 
79 extern ssh_gssapi_mech *supported_mechs[];
80 
81 int  ssh_gssapi_check_oid(Gssctxt *, void *, size_t);
82 void ssh_gssapi_set_oid_data(Gssctxt *, void *, size_t);
83 void ssh_gssapi_set_oid(Gssctxt *, gss_OID);
84 void ssh_gssapi_supported_oids(gss_OID_set *);
85 ssh_gssapi_mech *ssh_gssapi_get_ctype(Gssctxt *);
86 void ssh_gssapi_prepare_supported_oids(void);
87 OM_uint32 ssh_gssapi_test_oid_supported(OM_uint32 *, gss_OID, int *);
88 
89 struct sshbuf;
90 int ssh_gssapi_get_buffer_desc(struct sshbuf *, gss_buffer_desc *);
91 
92 OM_uint32 ssh_gssapi_import_name(Gssctxt *, const char *);
93 OM_uint32 ssh_gssapi_init_ctx(Gssctxt *, int,
94     gss_buffer_desc *, gss_buffer_desc *, OM_uint32 *);
95 OM_uint32 ssh_gssapi_accept_ctx(Gssctxt *,
96     gss_buffer_desc *, gss_buffer_desc *, OM_uint32 *);
97 OM_uint32 ssh_gssapi_getclient(Gssctxt *, ssh_gssapi_client *);
98 void ssh_gssapi_error(Gssctxt *);
99 char *ssh_gssapi_last_error(Gssctxt *, OM_uint32 *, OM_uint32 *);
100 void ssh_gssapi_build_ctx(Gssctxt **);
101 void ssh_gssapi_delete_ctx(Gssctxt **);
102 OM_uint32 ssh_gssapi_sign(Gssctxt *, gss_buffer_t, gss_buffer_t);
103 void ssh_gssapi_buildmic(struct sshbuf *, const char *,
104     const char *, const char *, const struct sshbuf *);
105 int ssh_gssapi_check_mechanism(Gssctxt **, gss_OID, const char *);
106 
107 /* In the server */
108 OM_uint32 ssh_gssapi_server_ctx(Gssctxt **, gss_OID);
109 int ssh_gssapi_userok(char *name);
110 OM_uint32 ssh_gssapi_checkmic(Gssctxt *, gss_buffer_t, gss_buffer_t);
111 void ssh_gssapi_do_child(char ***, u_int *);
112 void ssh_gssapi_cleanup_creds(void);
113 void ssh_gssapi_storecreds(void);
114 const char *ssh_gssapi_displayname(void);
115 
116 #endif /* GSSAPI */
117 
118 #endif /* _SSH_GSS_H */
119