xref: /openssh-portable/readconf.h (revision ed833da1)
1 /* $OpenBSD: readconf.h,v 1.133 2020/04/03 02:27:12 dtucker Exp $ */
2 
3 /*
4  * Author: Tatu Ylonen <ylo@cs.hut.fi>
5  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
6  *                    All rights reserved
7  * Functions for reading the configuration file.
8  *
9  * As far as I am concerned, the code I have written for this software
10  * can be used freely for any purpose.  Any derived versions of this
11  * software must be clearly marked as such, and if the derived work is
12  * incompatible with the protocol description in the RFC file, it must be
13  * called by a name other than "ssh" or "Secure Shell".
14  */
15 
16 #ifndef READCONF_H
17 #define READCONF_H
18 
19 /* Data structure for representing option data. */
20 
21 #define SSH_MAX_HOSTS_FILES	32
22 #define MAX_CANON_DOMAINS	32
23 #define PATH_MAX_SUN		(sizeof((struct sockaddr_un *)0)->sun_path)
24 
25 struct allowed_cname {
26 	char *source_list;
27 	char *target_list;
28 };
29 
30 typedef struct {
31 	int     forward_agent;	/* Forward authentication agent. */
32 	char   *forward_agent_sock_path; /* Optional path of the agent. */
33 	int     forward_x11;	/* Forward X11 display. */
34 	int     forward_x11_timeout;	/* Expiration for Cookies */
35 	int     forward_x11_trusted;	/* Trust Forward X11 display. */
36 	int     exit_on_forward_failure;	/* Exit if bind(2) fails for -L/-R */
37 	char   *xauth_location;	/* Location for xauth program */
38 	struct ForwardOptions fwd_opts;	/* forwarding options */
39 	int     pubkey_authentication;	/* Try ssh2 pubkey authentication. */
40 	int     hostbased_authentication;	/* ssh2's rhosts_rsa */
41 	int     challenge_response_authentication;
42 					/* Try S/Key or TIS, authentication. */
43 	int     gss_authentication;	/* Try GSS authentication */
44 	int     gss_deleg_creds;	/* Delegate GSS credentials */
45 	int     password_authentication;	/* Try password
46 						 * authentication. */
47 	int     kbd_interactive_authentication; /* Try keyboard-interactive auth. */
48 	char	*kbd_interactive_devices; /* Keyboard-interactive auth devices. */
49 	int     batch_mode;	/* Batch mode: do not ask for passwords. */
50 	int     check_host_ip;	/* Also keep track of keys for IP address */
51 	int     strict_host_key_checking;	/* Strict host key checking. */
52 	int     compression;	/* Compress packets in both directions. */
53 	int     tcp_keep_alive;	/* Set SO_KEEPALIVE. */
54 	int	ip_qos_interactive;	/* IP ToS/DSCP/class for interactive */
55 	int	ip_qos_bulk;		/* IP ToS/DSCP/class for bulk traffic */
56 	SyslogFacility log_facility;	/* Facility for system logging. */
57 	LogLevel log_level;	/* Level for logging. */
58 
59 	int     port;		/* Port to connect. */
60 	int     address_family;
61 	int     connection_attempts;	/* Max attempts (seconds) before
62 					 * giving up */
63 	int     connection_timeout;	/* Max time (seconds) before
64 					 * aborting connection attempt */
65 	int     number_of_password_prompts;	/* Max number of password
66 						 * prompts. */
67 	char   *ciphers;	/* SSH2 ciphers in order of preference. */
68 	char   *macs;		/* SSH2 macs in order of preference. */
69 	char   *hostkeyalgorithms;	/* SSH2 server key types in order of preference. */
70 	char   *kex_algorithms;	/* SSH2 kex methods in order of preference. */
71 	char   *ca_sign_algorithms;	/* Allowed CA signature algorithms */
72 	char   *hostname;	/* Real host to connect. */
73 	char   *host_key_alias;	/* hostname alias for .ssh/known_hosts */
74 	char   *proxy_command;	/* Proxy command for connecting the host. */
75 	char   *user;		/* User to log in as. */
76 	int     escape_char;	/* Escape character; -2 = none */
77 
78 	u_int	num_system_hostfiles;	/* Paths for /etc/ssh/ssh_known_hosts */
79 	char   *system_hostfiles[SSH_MAX_HOSTS_FILES];
80 	u_int	num_user_hostfiles;	/* Path for $HOME/.ssh/known_hosts */
81 	char   *user_hostfiles[SSH_MAX_HOSTS_FILES];
82 	char   *preferred_authentications;
83 	char   *bind_address;	/* local socket address for connection to sshd */
84 	char   *bind_interface;	/* local interface for bind address */
85 	char   *pkcs11_provider; /* PKCS#11 provider */
86 	char   *sk_provider; /* Security key provider */
87 	int	verify_host_key_dns;	/* Verify host key using DNS */
88 
89 	int     num_identity_files;	/* Number of files for RSA/DSA identities. */
90 	char   *identity_files[SSH_MAX_IDENTITY_FILES];
91 	int    identity_file_userprovided[SSH_MAX_IDENTITY_FILES];
92 	struct sshkey *identity_keys[SSH_MAX_IDENTITY_FILES];
93 
94 	int	num_certificate_files; /* Number of extra certificates for ssh. */
95 	char	*certificate_files[SSH_MAX_CERTIFICATE_FILES];
96 	int	certificate_file_userprovided[SSH_MAX_CERTIFICATE_FILES];
97 	struct sshkey *certificates[SSH_MAX_CERTIFICATE_FILES];
98 
99 	int	add_keys_to_agent;
100 	char   *identity_agent;		/* Optional path to ssh-agent socket */
101 
102 	/* Local TCP/IP forward requests. */
103 	int     num_local_forwards;
104 	struct Forward *local_forwards;
105 
106 	/* Remote TCP/IP forward requests. */
107 	int     num_remote_forwards;
108 	struct Forward *remote_forwards;
109 	int	clear_forwardings;
110 
111 	/* stdio forwarding (-W) host and port */
112 	char   *stdio_forward_host;
113 	int	stdio_forward_port;
114 
115 	int	enable_ssh_keysign;
116 	int64_t rekey_limit;
117 	int	rekey_interval;
118 	int	no_host_authentication_for_localhost;
119 	int	identities_only;
120 	int	server_alive_interval;
121 	int	server_alive_count_max;
122 
123 	int     num_send_env;
124 	char   **send_env;
125 	int     num_setenv;
126 	char   **setenv;
127 
128 	char	*control_path;
129 	int	control_master;
130 	int     control_persist; /* ControlPersist flag */
131 	int     control_persist_timeout; /* ControlPersist timeout (seconds) */
132 
133 	int	hash_known_hosts;
134 
135 	int	tun_open;	/* tun(4) */
136 	int     tun_local;	/* force tun device (optional) */
137 	int     tun_remote;	/* force tun device (optional) */
138 
139 	char	*local_command;
140 	int	permit_local_command;
141 	char	*remote_command;
142 	int	visual_host_key;
143 
144 	int	request_tty;
145 
146 	int	proxy_use_fdpass;
147 
148 	int	num_canonical_domains;
149 	char	*canonical_domains[MAX_CANON_DOMAINS];
150 	int	canonicalize_hostname;
151 	int	canonicalize_max_dots;
152 	int	canonicalize_fallback_local;
153 	int	num_permitted_cnames;
154 	struct allowed_cname permitted_cnames[MAX_CANON_DOMAINS];
155 
156 	char	*revoked_host_keys;
157 
158 	int	 fingerprint_hash;
159 
160 	int	 update_hostkeys; /* one of SSH_UPDATE_HOSTKEYS_* */
161 
162 	char   *hostbased_key_types;
163 	char   *pubkey_key_types;
164 
165 	char   *jump_user;
166 	char   *jump_host;
167 	int	jump_port;
168 	char   *jump_extra;
169 
170 	char	*ignored_unknown; /* Pattern list of unknown tokens to ignore */
171 }       Options;
172 
173 #define SSH_CANONICALISE_NO	0
174 #define SSH_CANONICALISE_YES	1
175 #define SSH_CANONICALISE_ALWAYS	2
176 
177 #define SSHCTL_MASTER_NO	0
178 #define SSHCTL_MASTER_YES	1
179 #define SSHCTL_MASTER_AUTO	2
180 #define SSHCTL_MASTER_ASK	3
181 #define SSHCTL_MASTER_AUTO_ASK	4
182 
183 #define REQUEST_TTY_AUTO	0
184 #define REQUEST_TTY_NO		1
185 #define REQUEST_TTY_YES		2
186 #define REQUEST_TTY_FORCE	3
187 
188 #define SSHCONF_CHECKPERM	1  /* check permissions on config file */
189 #define SSHCONF_USERCONF	2  /* user provided config file not system */
190 #define SSHCONF_FINAL		4  /* Final pass over config, after canon. */
191 #define SSHCONF_NEVERMATCH	8  /* Match/Host never matches; internal only */
192 
193 #define SSH_UPDATE_HOSTKEYS_NO	0
194 #define SSH_UPDATE_HOSTKEYS_YES	1
195 #define SSH_UPDATE_HOSTKEYS_ASK	2
196 
197 #define SSH_STRICT_HOSTKEY_OFF	0
198 #define SSH_STRICT_HOSTKEY_NEW	1
199 #define SSH_STRICT_HOSTKEY_YES	2
200 #define SSH_STRICT_HOSTKEY_ASK	3
201 
202 const char *kex_default_pk_alg(void);
203 char	*ssh_connection_hash(const char *thishost, const char *host,
204     const char *portstr, const char *user);
205 void     initialize_options(Options *);
206 void     fill_default_options(Options *);
207 void	 fill_default_options_for_canonicalization(Options *);
208 int	 process_config_line(Options *, struct passwd *, const char *,
209     const char *, char *, const char *, int, int *, int);
210 int	 read_config_file(const char *, struct passwd *, const char *,
211     const char *, Options *, int, int *);
212 int	 parse_forward(struct Forward *, const char *, int, int);
213 int	 parse_jump(const char *, Options *, int);
214 int	 parse_ssh_uri(const char *, char **, char **, int *);
215 int	 default_ssh_port(void);
216 int	 option_clear_or_none(const char *);
217 void	 dump_client_config(Options *o, const char *host);
218 
219 void	 add_local_forward(Options *, const struct Forward *);
220 void	 add_remote_forward(Options *, const struct Forward *);
221 void	 add_identity_file(Options *, const char *, const char *, int);
222 void	 add_certificate_file(Options *, const char *, int);
223 
224 #endif				/* READCONF_H */
225