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