1 /* $OpenBSD: readconf.h,v 1.129 2018/11/23 05:08:07 djm 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 int forward_agent; /* Forward authentication agent. */
32 int forward_x11; /* Forward X11 display. */
33 int forward_x11_timeout; /* Expiration for Cookies */
34 int forward_x11_trusted; /* Trust Forward X11 display. */
35 int exit_on_forward_failure; /* Exit if bind(2) fails for -L/-R */
36 char *xauth_location; /* Location for xauth program */
37 struct ForwardOptions fwd_opts; /* forwarding options */
38 int pubkey_authentication; /* Try ssh2 pubkey authentication. */
39 int hostbased_authentication; /* ssh2's rhosts_rsa */
40 int challenge_response_authentication;
41 /* Try S/Key or TIS, authentication. */
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. */
58 int port; /* Port to connect. */
60 int connection_attempts; /* Max attempts (seconds) before
62 int connection_timeout; /* Max time (seconds) before
63 * aborting connection attempt */
64 int number_of_password_prompts; /* Max number of password
66 char *ciphers; /* SSH2 ciphers in order of preference. */
67 char *macs; /* SSH2 macs in order of preference. */
68 char *hostkeyalgorithms; /* SSH2 server key types in order of preference. */
69 char *kex_algorithms; /* SSH2 kex methods in order of preference. */
70 char *ca_sign_algorithms; /* Allowed CA signature algorithms */
71 char *hostname; /* Real host to connect. */
72 char *host_key_alias; /* hostname alias for .ssh/known_hosts */
73 char *proxy_command; /* Proxy command for connecting the host. */
74 char *user; /* User to log in as. */
75 int escape_char; /* Escape character; -2 = none */
77 u_int num_system_hostfiles; /* Paths for /etc/ssh/ssh_known_hosts */
78 char *system_hostfiles[SSH_MAX_HOSTS_FILES];
79 u_int num_user_hostfiles; /* Path for $HOME/.ssh/known_hosts */
80 char *user_hostfiles[SSH_MAX_HOSTS_FILES];
81 char *preferred_authentications;
82 char *bind_address; /* local socket address for connection to sshd */
83 char *bind_interface; /* local interface for bind address */
84 char *pkcs11_provider; /* PKCS#11 provider */
85 int verify_host_key_dns; /* Verify host key using DNS */
87 int num_identity_files; /* Number of files for RSA/DSA identities. */
88 char *identity_files[SSH_MAX_IDENTITY_FILES];
89 int identity_file_userprovided[SSH_MAX_IDENTITY_FILES];
90 struct sshkey *identity_keys[SSH_MAX_IDENTITY_FILES];
92 int num_certificate_files; /* Number of extra certificates for ssh. */
93 char *certificate_files[SSH_MAX_CERTIFICATE_FILES];
94 int certificate_file_userprovided[SSH_MAX_CERTIFICATE_FILES];
95 struct sshkey *certificates[SSH_MAX_CERTIFICATE_FILES];
97 int add_keys_to_agent;
98 char *identity_agent; /* Optional path to ssh-agent socket */
100 /* Local TCP/IP forward requests. */
101 int num_local_forwards;
102 struct Forward *local_forwards;
104 /* Remote TCP/IP forward requests. */
105 int num_remote_forwards;
106 struct Forward *remote_forwards;
107 int clear_forwardings;
109 /* stdio forwarding (-W) host and port */
110 char *stdio_forward_host;
111 int stdio_forward_port;
113 int enable_ssh_keysign;
116 int no_host_authentication_for_localhost;
118 int server_alive_interval;
119 int server_alive_count_max;
128 int control_persist; /* ControlPersist flag */
129 int control_persist_timeout; /* ControlPersist timeout (seconds) */
131 int hash_known_hosts;
133 int tun_open; /* tun(4) */
134 int tun_local; /* force tun device (optional) */
135 int tun_remote; /* force tun device (optional) */
138 int permit_local_command;
139 char *remote_command;
144 int proxy_use_fdpass;
146 int num_canonical_domains;
147 char *canonical_domains[MAX_CANON_DOMAINS];
148 int canonicalize_hostname;
149 int canonicalize_max_dots;
150 int canonicalize_fallback_local;
151 int num_permitted_cnames;
152 struct allowed_cname permitted_cnames[MAX_CANON_DOMAINS];
154 char *revoked_host_keys;
156 int fingerprint_hash;
158 int update_hostkeys; /* one of SSH_UPDATE_HOSTKEYS_* */
160 char *hostbased_key_types;
161 char *pubkey_key_types;
168 char *ignored_unknown; /* Pattern list of unknown tokens to ignore */
171 #define SSH_CANONICALISE_NO 0
172 #define SSH_CANONICALISE_YES 1
173 #define SSH_CANONICALISE_ALWAYS 2
175 #define SSHCTL_MASTER_NO 0
176 #define SSHCTL_MASTER_YES 1
177 #define SSHCTL_MASTER_AUTO 2
178 #define SSHCTL_MASTER_ASK 3
179 #define SSHCTL_MASTER_AUTO_ASK 4
181 #define REQUEST_TTY_AUTO 0
182 #define REQUEST_TTY_NO 1
183 #define REQUEST_TTY_YES 2
184 #define REQUEST_TTY_FORCE 3
186 #define SSHCONF_CHECKPERM 1 /* check permissions on config file */
187 #define SSHCONF_USERCONF 2 /* user provided config file not system */
188 #define SSHCONF_FINAL 4 /* Final pass over config, after canon. */
189 #define SSHCONF_NEVERMATCH 8 /* Match/Host never matches; internal only */
191 #define SSH_UPDATE_HOSTKEYS_NO 0
192 #define SSH_UPDATE_HOSTKEYS_YES 1
193 #define SSH_UPDATE_HOSTKEYS_ASK 2
195 #define SSH_STRICT_HOSTKEY_OFF 0
196 #define SSH_STRICT_HOSTKEY_NEW 1
197 #define SSH_STRICT_HOSTKEY_YES 2
198 #define SSH_STRICT_HOSTKEY_ASK 3
200 void initialize_options(Options *);
201 void fill_default_options(Options *);
202 void fill_default_options_for_canonicalization(Options *);
203 int process_config_line(Options *, struct passwd *, const char *,
204 const char *, char *, const char *, int, int *, int);
205 int read_config_file(const char *, struct passwd *, const char *,
206 const char *, Options *, int, int *);
207 int parse_forward(struct Forward *, const char *, int, int);
208 int parse_jump(const char *, Options *, int);
209 int parse_ssh_uri(const char *, char **, char **, 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);
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);
219 #endif /* READCONF_H */