1/* $OpenBSD: ssh-gss.h,v 1.16 2024/05/17 06:42:04 jsg 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
43typedef struct {
44	char *filename;
45	char *envvar;
46	char *envval;
47	void *data;
48} ssh_gssapi_ccache;
49
50typedef 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
58typedef 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
68typedef 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
79extern ssh_gssapi_mech *supported_mechs[];
80
81int  ssh_gssapi_check_oid(Gssctxt *, void *, size_t);
82void ssh_gssapi_set_oid_data(Gssctxt *, void *, size_t);
83void ssh_gssapi_set_oid(Gssctxt *, gss_OID);
84void ssh_gssapi_supported_oids(gss_OID_set *);
85void ssh_gssapi_prepare_supported_oids(void);
86OM_uint32 ssh_gssapi_test_oid_supported(OM_uint32 *, gss_OID, int *);
87
88struct sshbuf;
89int ssh_gssapi_get_buffer_desc(struct sshbuf *, gss_buffer_desc *);
90
91OM_uint32 ssh_gssapi_import_name(Gssctxt *, const char *);
92OM_uint32 ssh_gssapi_init_ctx(Gssctxt *, int,
93    gss_buffer_desc *, gss_buffer_desc *, OM_uint32 *);
94OM_uint32 ssh_gssapi_accept_ctx(Gssctxt *,
95    gss_buffer_desc *, gss_buffer_desc *, OM_uint32 *);
96OM_uint32 ssh_gssapi_getclient(Gssctxt *, ssh_gssapi_client *);
97void ssh_gssapi_error(Gssctxt *);
98char *ssh_gssapi_last_error(Gssctxt *, OM_uint32 *, OM_uint32 *);
99void ssh_gssapi_build_ctx(Gssctxt **);
100void ssh_gssapi_delete_ctx(Gssctxt **);
101OM_uint32 ssh_gssapi_sign(Gssctxt *, gss_buffer_t, gss_buffer_t);
102void ssh_gssapi_buildmic(struct sshbuf *, const char *,
103    const char *, const char *, const struct sshbuf *);
104int ssh_gssapi_check_mechanism(Gssctxt **, gss_OID, const char *);
105
106/* In the server */
107OM_uint32 ssh_gssapi_server_ctx(Gssctxt **, gss_OID);
108int ssh_gssapi_userok(char *name);
109OM_uint32 ssh_gssapi_checkmic(Gssctxt *, gss_buffer_t, gss_buffer_t);
110void ssh_gssapi_do_child(char ***, u_int *);
111void ssh_gssapi_cleanup_creds(void);
112void ssh_gssapi_storecreds(void);
113const char *ssh_gssapi_displayname(void);
114
115#endif /* GSSAPI */
116
117#endif /* _SSH_GSS_H */
118