xref: /freebsd/crypto/openssh/readconf.h (revision 4f52dfbb8d6c4d446500c5b097e3806ec219fbd4)
1 /* $OpenBSD: readconf.h,v 1.123 2017/09/03 23:33:13 djm Exp $ */
2 /* $FreeBSD$ */
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 MAX_SEND_ENV		256
23 #define SSH_MAX_HOSTS_FILES	32
24 #define MAX_CANON_DOMAINS	32
25 #define PATH_MAX_SUN		(sizeof((struct sockaddr_un *)0)->sun_path)
26 
27 struct allowed_cname {
28 	char *source_list;
29 	char *target_list;
30 };
31 
32 typedef struct {
33 	int     forward_agent;	/* Forward authentication 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     use_privileged_port;	/* Don't use privileged port if false. */
41 	int     pubkey_authentication;	/* Try ssh2 pubkey authentication. */
42 	int     hostbased_authentication;	/* ssh2's rhosts_rsa */
43 	int     challenge_response_authentication;
44 					/* Try S/Key or TIS, authentication. */
45 	int     gss_authentication;	/* Try GSS authentication */
46 	int     gss_deleg_creds;	/* Delegate GSS credentials */
47 	int     password_authentication;	/* Try password
48 						 * authentication. */
49 	int     kbd_interactive_authentication; /* Try keyboard-interactive auth. */
50 	char	*kbd_interactive_devices; /* Keyboard-interactive auth devices. */
51 	int     batch_mode;	/* Batch mode: do not ask for passwords. */
52 	int     check_host_ip;	/* Also keep track of keys for IP address */
53 	int     strict_host_key_checking;	/* Strict host key checking. */
54 	int     compression;	/* Compress packets in both directions. */
55 	int     tcp_keep_alive;	/* Set SO_KEEPALIVE. */
56 	int	ip_qos_interactive;	/* IP ToS/DSCP/class for interactive */
57 	int	ip_qos_bulk;		/* IP ToS/DSCP/class for bulk traffic */
58 	SyslogFacility log_facility;	/* Facility for system logging. */
59 	LogLevel log_level;	/* Level for logging. */
60 
61 	int     port;		/* Port to connect. */
62 	int     address_family;
63 	int     connection_attempts;	/* Max attempts (seconds) before
64 					 * giving up */
65 	int     connection_timeout;	/* Max time (seconds) before
66 					 * aborting connection attempt */
67 	int     number_of_password_prompts;	/* Max number of password
68 						 * prompts. */
69 	char   *ciphers;	/* SSH2 ciphers in order of preference. */
70 	char   *macs;		/* SSH2 macs in order of preference. */
71 	char   *hostkeyalgorithms;	/* SSH2 server key types in order of preference. */
72 	char   *kex_algorithms;	/* SSH2 kex methods in order of preference. */
73 	char   *hostname;	/* Real host to connect. */
74 	char   *host_key_alias;	/* hostname alias for .ssh/known_hosts */
75 	char   *proxy_command;	/* Proxy command for connecting the host. */
76 	char   *user;		/* User to log in as. */
77 	int     escape_char;	/* Escape character; -2 = none */
78 
79 	u_int	num_system_hostfiles;	/* Paths for /etc/ssh/ssh_known_hosts */
80 	char   *system_hostfiles[SSH_MAX_HOSTS_FILES];
81 	u_int	num_user_hostfiles;	/* Path for $HOME/.ssh/known_hosts */
82 	char   *user_hostfiles[SSH_MAX_HOSTS_FILES];
83 	char   *preferred_authentications;
84 	char   *bind_address;	/* local socket address for connection to sshd */
85 	char   *pkcs11_provider; /* PKCS#11 provider */
86 	int	verify_host_key_dns;	/* Verify host key using DNS */
87 
88 	int     num_identity_files;	/* Number of files for RSA/DSA identities. */
89 	char   *identity_files[SSH_MAX_IDENTITY_FILES];
90 	int    identity_file_userprovided[SSH_MAX_IDENTITY_FILES];
91 	struct sshkey *identity_keys[SSH_MAX_IDENTITY_FILES];
92 
93 	int	num_certificate_files; /* Number of extra certificates for ssh. */
94 	char	*certificate_files[SSH_MAX_CERTIFICATE_FILES];
95 	int	certificate_file_userprovided[SSH_MAX_CERTIFICATE_FILES];
96 	struct sshkey *certificates[SSH_MAX_CERTIFICATE_FILES];
97 
98 	int	add_keys_to_agent;
99 	char   *identity_agent;		/* Optional path to ssh-agent socket */
100 
101 	/* Local TCP/IP forward requests. */
102 	int     num_local_forwards;
103 	struct Forward *local_forwards;
104 
105 	/* Remote TCP/IP forward requests. */
106 	int     num_remote_forwards;
107 	struct Forward *remote_forwards;
108 	int	clear_forwardings;
109 
110 	/* stdio forwarding (-W) host and port */
111 	char   *stdio_forward_host;
112 	int	stdio_forward_port;
113 
114 	int	enable_ssh_keysign;
115 	int64_t rekey_limit;
116 	int	rekey_interval;
117 	int	no_host_authentication_for_localhost;
118 	int	identities_only;
119 	int	server_alive_interval;
120 	int	server_alive_count_max;
121 
122 	int     num_send_env;
123 	char   *send_env[MAX_SEND_ENV];
124 
125 	char	*control_path;
126 	int	control_master;
127 	int     control_persist; /* ControlPersist flag */
128 	int     control_persist_timeout; /* ControlPersist timeout (seconds) */
129 
130 	int	hash_known_hosts;
131 
132 	int	tun_open;	/* tun(4) */
133 	int     tun_local;	/* force tun device (optional) */
134 	int     tun_remote;	/* force tun device (optional) */
135 
136 	char	*local_command;
137 	int	permit_local_command;
138 	char	*remote_command;
139 	int	visual_host_key;
140 
141 	int	request_tty;
142 
143 	int	proxy_use_fdpass;
144 
145 	int	num_canonical_domains;
146 	char	*canonical_domains[MAX_CANON_DOMAINS];
147 	int	canonicalize_hostname;
148 	int	canonicalize_max_dots;
149 	int	canonicalize_fallback_local;
150 	int	num_permitted_cnames;
151 	struct allowed_cname permitted_cnames[MAX_CANON_DOMAINS];
152 
153 	char	*revoked_host_keys;
154 
155 	int	 fingerprint_hash;
156 
157 	int	 update_hostkeys; /* one of SSH_UPDATE_HOSTKEYS_* */
158 
159 	char   *hostbased_key_types;
160 	char   *pubkey_key_types;
161 
162 	char   *version_addendum; /* Appended to SSH banner */
163 
164 	char   *jump_user;
165 	char   *jump_host;
166 	int	jump_port;
167 	char   *jump_extra;
168 
169 	char	*ignored_unknown; /* Pattern list of unknown tokens to ignore */
170 }       Options;
171 
172 #define SSH_CANONICALISE_NO	0
173 #define SSH_CANONICALISE_YES	1
174 #define SSH_CANONICALISE_ALWAYS	2
175 
176 #define SSHCTL_MASTER_NO	0
177 #define SSHCTL_MASTER_YES	1
178 #define SSHCTL_MASTER_AUTO	2
179 #define SSHCTL_MASTER_ASK	3
180 #define SSHCTL_MASTER_AUTO_ASK	4
181 
182 #define REQUEST_TTY_AUTO	0
183 #define REQUEST_TTY_NO		1
184 #define REQUEST_TTY_YES		2
185 #define REQUEST_TTY_FORCE	3
186 
187 #define SSHCONF_CHECKPERM	1  /* check permissions on config file */
188 #define SSHCONF_USERCONF	2  /* user provided config file not system */
189 #define SSHCONF_POSTCANON	4  /* After hostname canonicalisation */
190 #define SSHCONF_NEVERMATCH	8  /* Match/Host never matches; internal only */
191 
192 #define SSH_UPDATE_HOSTKEYS_NO	0
193 #define SSH_UPDATE_HOSTKEYS_YES	1
194 #define SSH_UPDATE_HOSTKEYS_ASK	2
195 
196 #define SSH_STRICT_HOSTKEY_OFF	0
197 #define SSH_STRICT_HOSTKEY_NEW	1
198 #define SSH_STRICT_HOSTKEY_YES	2
199 #define SSH_STRICT_HOSTKEY_ASK	3
200 
201 void     initialize_options(Options *);
202 void     fill_default_options(Options *);
203 void	 fill_default_options_for_canonicalization(Options *);
204 int	 process_config_line(Options *, struct passwd *, const char *,
205     const char *, char *, const char *, int, int *, int);
206 int	 read_config_file(const char *, struct passwd *, const char *,
207     const char *, Options *, int);
208 int	 parse_forward(struct Forward *, const char *, int, int);
209 int	 parse_jump(const char *, Options *, int);
210 int	 default_ssh_port(void);
211 int	 option_clear_or_none(const char *);
212 void	 dump_client_config(Options *o, const char *host);
213 
214 void	 add_local_forward(Options *, const struct Forward *);
215 void	 add_remote_forward(Options *, const struct Forward *);
216 void	 add_identity_file(Options *, const char *, const char *, int);
217 void	 add_certificate_file(Options *, const char *, int);
218 
219 #endif				/* READCONF_H */
220