1 /* $OpenBSD: readconf.h,v 1.150 2023/01/13 02:58:20 dtucker Exp $ */
4 * Author: Tatu Ylonen <ylo@cs.hut.fi>
5 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
7 * Functions for reading the configuration file.
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".
19 /* Data structure for representing option data. */
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)
25 struct allowed_cname {
31 char *host_arg; /* Host arg as specified on command line. */
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 gss_authentication; /* Try GSS authentication */
43 int gss_deleg_creds; /* Delegate GSS credentials */
44 int password_authentication; /* Try password
46 int kbd_interactive_authentication; /* Try keyboard-interactive auth. */
47 char *kbd_interactive_devices; /* Keyboard-interactive auth devices. */
48 int batch_mode; /* Batch mode: do not ask for passwords. */
49 int check_host_ip; /* Also keep track of keys for IP address */
50 int strict_host_key_checking; /* Strict host key checking. */
51 int compression; /* Compress packets in both directions. */
52 int tcp_keep_alive; /* Set SO_KEEPALIVE. */
53 int ip_qos_interactive; /* IP ToS/DSCP/class for interactive */
54 int ip_qos_bulk; /* IP ToS/DSCP/class for bulk traffic */
55 SyslogFacility log_facility; /* Facility for system logging. */
56 LogLevel log_level; /* Level for logging. */
57 u_int num_log_verbose; /* Verbose log overrides */
59 int port; /* Port to connect. */
61 int connection_attempts; /* Max attempts (seconds) before
63 int connection_timeout; /* Max time (seconds) before
64 * aborting connection attempt */
65 int number_of_password_prompts; /* Max number of password
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 */
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 */
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];
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];
99 int add_keys_to_agent;
100 int add_keys_to_agent_lifespan;
101 char *identity_agent; /* Optional path to ssh-agent socket */
103 /* Local TCP/IP forward requests. */
104 int num_local_forwards;
105 struct Forward *local_forwards;
107 /* Remote TCP/IP forward requests. */
108 int num_remote_forwards;
109 struct Forward *remote_forwards;
110 int clear_forwardings;
112 /* Restrict remote dynamic forwarding */
113 char **permitted_remote_opens;
114 u_int num_permitted_remote_opens;
116 /* stdio forwarding (-W) host and port */
117 char *stdio_forward_host;
118 int stdio_forward_port;
120 int enable_ssh_keysign;
123 int no_host_authentication_for_localhost;
125 int server_alive_interval;
126 int server_alive_count_max;
135 int control_persist; /* ControlPersist flag */
136 int control_persist_timeout; /* ControlPersist timeout (seconds) */
138 int hash_known_hosts;
140 int tun_open; /* tun(4) */
141 int tun_local; /* force tun device (optional) */
142 int tun_remote; /* force tun device (optional) */
145 int permit_local_command;
146 char *remote_command;
152 int fork_after_authentication;
154 int proxy_use_fdpass;
156 int num_canonical_domains;
157 char *canonical_domains[MAX_CANON_DOMAINS];
158 int canonicalize_hostname;
159 int canonicalize_max_dots;
160 int canonicalize_fallback_local;
161 int num_permitted_cnames;
162 struct allowed_cname permitted_cnames[MAX_CANON_DOMAINS];
164 char *revoked_host_keys;
166 int fingerprint_hash;
168 int update_hostkeys; /* one of SSH_UPDATE_HOSTKEYS_* */
170 char *hostbased_accepted_algos;
171 char *pubkey_accepted_algos;
178 char *known_hosts_command;
180 int required_rsa_size; /* minimum size of RSA keys */
181 int enable_escape_commandline; /* ~C commandline */
183 char *ignored_unknown; /* Pattern list of unknown tokens to ignore */
186 #define SSH_PUBKEY_AUTH_NO 0x00
187 #define SSH_PUBKEY_AUTH_UNBOUND 0x01
188 #define SSH_PUBKEY_AUTH_HBOUND 0x02
189 #define SSH_PUBKEY_AUTH_ALL 0x03
191 #define SSH_CANONICALISE_NO 0
192 #define SSH_CANONICALISE_YES 1
193 #define SSH_CANONICALISE_ALWAYS 2
195 #define SSHCTL_MASTER_NO 0
196 #define SSHCTL_MASTER_YES 1
197 #define SSHCTL_MASTER_AUTO 2
198 #define SSHCTL_MASTER_ASK 3
199 #define SSHCTL_MASTER_AUTO_ASK 4
201 #define REQUEST_TTY_AUTO 0
202 #define REQUEST_TTY_NO 1
203 #define REQUEST_TTY_YES 2
204 #define REQUEST_TTY_FORCE 3
206 #define SESSION_TYPE_NONE 0
207 #define SESSION_TYPE_SUBSYSTEM 1
208 #define SESSION_TYPE_DEFAULT 2
210 #define SSHCONF_CHECKPERM 1 /* check permissions on config file */
211 #define SSHCONF_USERCONF 2 /* user provided config file not system */
212 #define SSHCONF_FINAL 4 /* Final pass over config, after canon. */
213 #define SSHCONF_NEVERMATCH 8 /* Match/Host never matches; internal only */
215 #define SSH_UPDATE_HOSTKEYS_NO 0
216 #define SSH_UPDATE_HOSTKEYS_YES 1
217 #define SSH_UPDATE_HOSTKEYS_ASK 2
219 #define SSH_STRICT_HOSTKEY_OFF 0
220 #define SSH_STRICT_HOSTKEY_NEW 1
221 #define SSH_STRICT_HOSTKEY_YES 2
222 #define SSH_STRICT_HOSTKEY_ASK 3
224 const char *kex_default_pk_alg(void);
225 char *ssh_connection_hash(const char *thishost, const char *host,
226 const char *portstr, const char *user);
227 void initialize_options(Options *);
228 int fill_default_options(Options *);
229 void fill_default_options_for_canonicalization(Options *);
230 void free_options(Options *o);
231 int process_config_line(Options *, struct passwd *, const char *,
232 const char *, char *, const char *, int, int *, int);
233 int read_config_file(const char *, struct passwd *, const char *,
234 const char *, Options *, int, int *);
235 int parse_forward(struct Forward *, const char *, int, int);
236 int parse_jump(const char *, Options *, int);
237 int parse_ssh_uri(const char *, char **, char **, int *);
238 int default_ssh_port(void);
239 int option_clear_or_none(const char *);
240 int config_has_permitted_cnames(Options *);
241 void dump_client_config(Options *o, const char *host);
243 void add_local_forward(Options *, const struct Forward *);
244 void add_remote_forward(Options *, const struct Forward *);
245 void add_identity_file(Options *, const char *, const char *, int);
246 void add_certificate_file(Options *, const char *, int);
248 #endif /* READCONF_H */