xref: /freebsd/crypto/openssh/ssh-gss.h (revision 43a5ec4eb41567cc92586503212743d89686d78f)
1 /* $OpenBSD: ssh-gss.h,v 1.15 2021/01/27 10:05:28 djm Exp $ */
2 /* $FreeBSD$ */
3 /*
4  * Copyright (c) 2001-2003 Simon Wilkinson. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR `AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26 
27 #ifndef _SSH_GSS_H
28 #define _SSH_GSS_H
29 
30 #ifdef GSSAPI
31 
32 #ifdef HAVE_GSSAPI_GSSAPI_H
33 #include <gssapi/gssapi.h>
34 #elif defined(HAVE_GSSAPI_H)
35 #include <gssapi.h>
36 #endif
37 
38 #ifdef KRB5
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
45 
46 /* Old MIT Kerberos doesn't seem to define GSS_NT_HOSTBASED_SERVICE */
47 
48 #  if !HAVE_DECL_GSS_C_NT_HOSTBASED_SERVICE
49 #   define GSS_C_NT_HOSTBASED_SERVICE gss_nt_service_name
50 #  endif /* !HAVE_DECL_GSS_C_NT_... */
51 
52 # endif /* !HEIMDAL */
53 #endif /* KRB5 */
54 
55 /* draft-ietf-secsh-gsskeyex-06 */
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
60 #define SSH2_MSG_USERAUTH_GSSAPI_ERRTOK			65
61 #define SSH2_MSG_USERAUTH_GSSAPI_MIC			66
62 
63 #define SSH_GSS_OIDTYPE 0x06
64 
65 typedef struct {
66 	char *filename;
67 	char *envvar;
68 	char *envval;
69 	void *data;
70 } ssh_gssapi_ccache;
71 
72 typedef struct {
73 	gss_buffer_desc displayname;
74 	gss_buffer_desc exportedname;
75 	gss_cred_id_t creds;
76 	struct ssh_gssapi_mech_struct *mech;
77 	ssh_gssapi_ccache store;
78 } ssh_gssapi_client;
79 
80 typedef struct ssh_gssapi_mech_struct {
81 	char *enc_name;
82 	char *name;
83 	gss_OID_desc oid;
84 	int (*dochild) (ssh_gssapi_client *);
85 	int (*userok) (ssh_gssapi_client *, char *);
86 	int (*localname) (ssh_gssapi_client *, char **);
87 	void (*storecreds) (ssh_gssapi_client *);
88 } ssh_gssapi_mech;
89 
90 typedef struct {
91 	OM_uint32	major; /* both */
92 	OM_uint32	minor; /* both */
93 	gss_ctx_id_t	context; /* both */
94 	gss_name_t	name; /* both */
95 	gss_OID		oid; /* client */
96 	gss_cred_id_t	creds; /* server */
97 	gss_name_t	client; /* server */
98 	gss_cred_id_t	client_creds; /* server */
99 } Gssctxt;
100 
101 extern ssh_gssapi_mech *supported_mechs[];
102 
103 int  ssh_gssapi_check_oid(Gssctxt *, void *, size_t);
104 void ssh_gssapi_set_oid_data(Gssctxt *, void *, size_t);
105 void ssh_gssapi_set_oid(Gssctxt *, gss_OID);
106 void ssh_gssapi_supported_oids(gss_OID_set *);
107 ssh_gssapi_mech *ssh_gssapi_get_ctype(Gssctxt *);
108 void ssh_gssapi_prepare_supported_oids(void);
109 OM_uint32 ssh_gssapi_test_oid_supported(OM_uint32 *, gss_OID, int *);
110 
111 struct sshbuf;
112 int ssh_gssapi_get_buffer_desc(struct sshbuf *, gss_buffer_desc *);
113 
114 OM_uint32 ssh_gssapi_import_name(Gssctxt *, const char *);
115 OM_uint32 ssh_gssapi_init_ctx(Gssctxt *, int,
116     gss_buffer_desc *, gss_buffer_desc *, OM_uint32 *);
117 OM_uint32 ssh_gssapi_accept_ctx(Gssctxt *,
118     gss_buffer_desc *, gss_buffer_desc *, OM_uint32 *);
119 OM_uint32 ssh_gssapi_getclient(Gssctxt *, ssh_gssapi_client *);
120 void ssh_gssapi_error(Gssctxt *);
121 char *ssh_gssapi_last_error(Gssctxt *, OM_uint32 *, OM_uint32 *);
122 void ssh_gssapi_build_ctx(Gssctxt **);
123 void ssh_gssapi_delete_ctx(Gssctxt **);
124 OM_uint32 ssh_gssapi_sign(Gssctxt *, gss_buffer_t, gss_buffer_t);
125 void ssh_gssapi_buildmic(struct sshbuf *, const char *,
126     const char *, const char *, const struct sshbuf *);
127 int ssh_gssapi_check_mechanism(Gssctxt **, gss_OID, const char *);
128 
129 /* In the server */
130 OM_uint32 ssh_gssapi_server_ctx(Gssctxt **, gss_OID);
131 int ssh_gssapi_userok(char *name);
132 OM_uint32 ssh_gssapi_checkmic(Gssctxt *, gss_buffer_t, gss_buffer_t);
133 void ssh_gssapi_do_child(char ***, u_int *);
134 void ssh_gssapi_cleanup_creds(void);
135 void ssh_gssapi_storecreds(void);
136 const char *ssh_gssapi_displayname(void);
137 
138 #endif /* GSSAPI */
139 
140 #endif /* _SSH_GSS_H */
141