1 /* $OpenBSD: readconf.h,v 1.102 2014/07/15 15:54:14 millert 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 MAX_SEND_ENV 256
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)
26 struct allowed_cname {
32 int forward_agent; /* Forward authentication agent. */
33 int forward_x11; /* Forward X11 display. */
34 int forward_x11_timeout; /* Expiration for Cookies */
35 int forward_x11_trusted; /* Trust Forward X11 display. */
36 int exit_on_forward_failure; /* Exit if bind(2) fails for -L/-R */
37 char *xauth_location; /* Location for xauth program */
38 struct ForwardOptions fwd_opts; /* forwarding options */
39 int use_privileged_port; /* Don't use privileged port if false. */
40 int rhosts_rsa_authentication; /* Try rhosts with RSA
42 int rsa_authentication; /* Try RSA authentication. */
43 int pubkey_authentication; /* Try ssh2 pubkey authentication. */
44 int hostbased_authentication; /* ssh2's rhosts_rsa */
45 int challenge_response_authentication;
46 /* Try S/Key or TIS, authentication. */
47 int gss_authentication; /* Try GSS authentication */
48 int gss_deleg_creds; /* Delegate GSS credentials */
49 int password_authentication; /* Try password
51 int kbd_interactive_authentication; /* Try keyboard-interactive auth. */
52 char *kbd_interactive_devices; /* Keyboard-interactive auth devices. */
53 int batch_mode; /* Batch mode: do not ask for passwords. */
54 int check_host_ip; /* Also keep track of keys for IP address */
55 int strict_host_key_checking; /* Strict host key checking. */
56 int compression; /* Compress packets in both directions. */
57 int compression_level; /* Compression level 1 (fast) to 9
59 int tcp_keep_alive; /* Set SO_KEEPALIVE. */
60 int tcp_rcv_buf; /* user switch to set tcp recv buffer */
61 int tcp_rcv_buf_poll; /* Option to poll recv buf every window transfer */
62 int hpn_disabled; /* Switch to disable HPN buffer management */
63 int hpn_buffer_size; /* User definable size for HPN buffer window */
64 int ip_qos_interactive; /* IP ToS/DSCP/class for interactive */
65 int ip_qos_bulk; /* IP ToS/DSCP/class for bulk traffic */
66 LogLevel log_level; /* Level for logging. */
68 int port; /* Port to connect. */
70 int connection_attempts; /* Max attempts (seconds) before
72 int connection_timeout; /* Max time (seconds) before
73 * aborting connection attempt */
74 int number_of_password_prompts; /* Max number of password
76 int cipher; /* Cipher to use. */
77 char *ciphers; /* SSH2 ciphers in order of preference. */
78 char *macs; /* SSH2 macs in order of preference. */
79 char *hostkeyalgorithms; /* SSH2 server key types in order of preference. */
80 char *kex_algorithms; /* SSH2 kex methods in order of preference. */
81 int protocol; /* Protocol in order of preference. */
82 char *hostname; /* Real host to connect. */
83 char *host_key_alias; /* hostname alias for .ssh/known_hosts */
84 char *proxy_command; /* Proxy command for connecting the host. */
85 char *user; /* User to log in as. */
86 int escape_char; /* Escape character; -2 = none */
88 u_int num_system_hostfiles; /* Paths for /etc/ssh/ssh_known_hosts */
89 char *system_hostfiles[SSH_MAX_HOSTS_FILES];
90 u_int num_user_hostfiles; /* Path for $HOME/.ssh/known_hosts */
91 char *user_hostfiles[SSH_MAX_HOSTS_FILES];
92 char *preferred_authentications;
93 char *bind_address; /* local socket address for connection to sshd */
94 char *pkcs11_provider; /* PKCS#11 provider */
95 int verify_host_key_dns; /* Verify host key using DNS */
97 int num_identity_files; /* Number of files for RSA/DSA identities. */
98 char *identity_files[SSH_MAX_IDENTITY_FILES];
99 int identity_file_userprovided[SSH_MAX_IDENTITY_FILES];
100 Key *identity_keys[SSH_MAX_IDENTITY_FILES];
102 /* Local TCP/IP forward requests. */
103 int num_local_forwards;
104 struct Forward *local_forwards;
106 /* Remote TCP/IP forward requests. */
107 int num_remote_forwards;
108 struct Forward *remote_forwards;
109 int clear_forwardings;
111 int enable_ssh_keysign;
113 int none_switch; /* Use none cipher */
114 int none_enabled; /* Allow none to be used */
116 int no_host_authentication_for_localhost;
118 int server_alive_interval;
119 int server_alive_count_max;
122 char *send_env[MAX_SEND_ENV];
126 int control_persist; /* ControlPersist flag */
127 int control_persist_timeout; /* ControlPersist timeout (seconds) */
129 int hash_known_hosts;
131 int tun_open; /* tun(4) */
132 int tun_local; /* force tun device (optional) */
133 int tun_remote; /* force tun device (optional) */
136 int permit_local_command;
143 int proxy_use_fdpass;
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];
153 char *ignored_unknown; /* Pattern list of unknown tokens to ignore */
156 #define SSH_CANONICALISE_NO 0
157 #define SSH_CANONICALISE_YES 1
158 #define SSH_CANONICALISE_ALWAYS 2
160 #define SSHCTL_MASTER_NO 0
161 #define SSHCTL_MASTER_YES 1
162 #define SSHCTL_MASTER_AUTO 2
163 #define SSHCTL_MASTER_ASK 3
164 #define SSHCTL_MASTER_AUTO_ASK 4
166 #define REQUEST_TTY_AUTO 0
167 #define REQUEST_TTY_NO 1
168 #define REQUEST_TTY_YES 2
169 #define REQUEST_TTY_FORCE 3
171 #define SSHCONF_CHECKPERM 1 /* check permissions on config file */
172 #define SSHCONF_USERCONF 2 /* user provided config file not system */
174 void initialize_options(Options *);
175 void fill_default_options(Options *);
176 void fill_default_options_for_canonicalization(Options *);
177 int process_config_line(Options *, struct passwd *, const char *, char *,
178 const char *, int, int *, int);
179 int read_config_file(const char *, struct passwd *, const char *,
181 int parse_forward(struct Forward *, const char *, int, int);
182 int default_ssh_port(void);
183 int option_clear_or_none(const char *);
185 void add_local_forward(Options *, const struct Forward *);
186 void add_remote_forward(Options *, const struct Forward *);
187 void add_identity_file(Options *, const char *, const char *, int);
189 #endif /* READCONF_H */