1 /*        $NetBSD: sshconnect.h,v 1.19 2025/04/09 15:49:33 christos Exp $       */
2 /* $OpenBSD: sshconnect.h,v 1.49 2025/03/01 06:11:26 dtucker Exp $ */
3 
4 /*
5  * Copyright (c) 2000 Markus Friedl.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 struct sshkey;
29 
30 typedef struct Sensitive Sensitive;
31 struct Sensitive {
32           struct sshkey       **keys;
33           int                 nkeys;
34 };
35 
36 struct ssh_conn_info {
37           char *conn_hash_hex;
38           char *shorthost;
39           char *uidstr;
40           char *keyalias;
41           char *thishost;
42           char *host_arg;
43           char *portstr;
44           char *remhost;
45           char *remuser;
46           char *homedir;
47           char *locuser;
48           char *jmphost;
49 };
50 
51 struct addrinfo;
52 struct ssh;
53 struct hostkeys;
54 struct ssh_conn_info;
55 
56 /* default argument for client percent expansions, minus remote user */
57 #define DEFAULT_CLIENT_PERCENT_EXPAND_ARGS_NOUSER(conn_info) \
58           "L", conn_info->shorthost, \
59           "i", conn_info->uidstr, \
60           "k", conn_info->keyalias, \
61           "l", conn_info->thishost, \
62           "n", conn_info->host_arg, \
63           "p", conn_info->portstr, \
64           "d", conn_info->homedir, \
65           "h", conn_info->remhost, \
66           "u", conn_info->locuser, \
67           "j", conn_info->jmphost
68 
69 /* same plus remote user and hash which has user as a component */
70 #define DEFAULT_CLIENT_PERCENT_EXPAND_ARGS(conn_info) \
71           DEFAULT_CLIENT_PERCENT_EXPAND_ARGS_NOUSER(conn_info), \
72           "C", conn_info->conn_hash_hex, \
73           "r", conn_info->remuser
74 
75 int        ssh_connect(struct ssh *, const char *, const char *,
76               struct addrinfo *, struct sockaddr_storage *, u_short,
77               int, int *, int);
78 void       ssh_kill_proxy_command(void);
79 
80 void       ssh_login(struct ssh *, Sensitive *, const char *,
81     struct sockaddr *, u_short, struct passwd *, int,
82     const struct ssh_conn_info *);
83 
84 int        verify_host_key(char *, struct sockaddr *, struct sshkey *,
85     const struct ssh_conn_info *);
86 
87 void       get_hostfile_hostname_ipaddr(char *, struct sockaddr *, u_short,
88     char **, char **);
89 
90 void       ssh_kex2(struct ssh *ssh, char *, struct sockaddr *, u_short,
91     const struct ssh_conn_info *);
92 
93 void       ssh_userauth2(struct ssh *ssh, const char *, const char *,
94     char *, Sensitive *);
95 
96 int        ssh_local_cmd(const char *);
97 
98 void       maybe_add_key_to_agent(const char *, struct sshkey *,
99     const char *, const char *);
100 
101 void       load_hostkeys_command(struct hostkeys *, const char *,
102     const char *, const struct ssh_conn_info *,
103     const struct sshkey *, const char *);
104 
105 int hostkey_accepted_by_hostkeyalgs(const struct sshkey *);
106