xref: /freebsd/crypto/openssh/sshconnect.h (revision 675382f12b67e8b7b2f35bd1f8dfd96b8d8e4aae)
1 /* $OpenBSD: sshconnect.h,v 1.50 2026/02/13 01:04:47 jsg Exp $ */
2 
3 /*
4  * Copyright (c) 2000 Markus Friedl.  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 struct sshkey;
28 
29 typedef struct Sensitive Sensitive;
30 struct Sensitive {
31 	struct sshkey	**keys;
32 	int		nkeys;
33 };
34 
35 struct ssh_conn_info {
36 	char *conn_hash_hex;
37 	char *shorthost;
38 	char *uidstr;
39 	char *keyalias;
40 	char *thishost;
41 	char *host_arg;
42 	char *portstr;
43 	char *remhost;
44 	char *remuser;
45 	char *homedir;
46 	char *locuser;
47 	char *jmphost;
48 };
49 
50 struct addrinfo;
51 struct ssh;
52 struct hostkeys;
53 
54 /* default argument for client percent expansions, minus remote user */
55 #define DEFAULT_CLIENT_PERCENT_EXPAND_ARGS_NOUSER(conn_info) \
56 	"L", conn_info->shorthost, \
57 	"i", conn_info->uidstr, \
58 	"k", conn_info->keyalias, \
59 	"l", conn_info->thishost, \
60 	"n", conn_info->host_arg, \
61 	"p", conn_info->portstr, \
62 	"d", conn_info->homedir, \
63 	"h", conn_info->remhost, \
64 	"u", conn_info->locuser, \
65 	"j", conn_info->jmphost
66 
67 /* same plus remote user and hash which has user as a component */
68 #define DEFAULT_CLIENT_PERCENT_EXPAND_ARGS(conn_info) \
69 	DEFAULT_CLIENT_PERCENT_EXPAND_ARGS_NOUSER(conn_info), \
70 	"C", conn_info->conn_hash_hex, \
71 	"r", conn_info->remuser
72 
73 int	 ssh_connect(struct ssh *, const char *, const char *,
74 	    struct addrinfo *, struct sockaddr_storage *, u_short,
75 	    int, int *, int);
76 void	 ssh_kill_proxy_command(void);
77 
78 void	 ssh_login(struct ssh *, Sensitive *, const char *,
79     struct sockaddr *, u_short, struct passwd *, int,
80     const struct ssh_conn_info *);
81 
82 int	 verify_host_key(char *, struct sockaddr *, struct sshkey *,
83     const struct ssh_conn_info *);
84 
85 void	 get_hostfile_hostname_ipaddr(char *, struct sockaddr *, u_short,
86     char **, char **);
87 
88 void	 ssh_kex2(struct ssh *ssh, char *, struct sockaddr *, u_short,
89     const struct ssh_conn_info *);
90 
91 void	 ssh_userauth2(struct ssh *ssh, const char *, const char *,
92     char *, Sensitive *);
93 
94 int	 ssh_local_cmd(const char *);
95 
96 void	 maybe_add_key_to_agent(const char *, struct sshkey *,
97     const char *, const char *);
98 
99 void	 load_hostkeys_command(struct hostkeys *, const char *,
100     const char *, const struct ssh_conn_info *,
101     const struct sshkey *, const char *);
102 
103 int hostkey_accepted_by_hostkeyalgs(const struct sshkey *);
104