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