Greg Hartman | 9768ca4 | 2017-06-22 20:49:52 -0700 | [diff] [blame] | 1 | /* $OpenBSD: readconf.h,v 1.117 2016/07/15 00:24:30 djm Exp $ */ |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 2 | |
| 3 | /* |
| 4 | * Author: Tatu Ylonen <ylo@cs.hut.fi> |
| 5 | * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland |
| 6 | * All rights reserved |
| 7 | * Functions for reading the configuration file. |
| 8 | * |
| 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". |
| 14 | */ |
| 15 | |
| 16 | #ifndef READCONF_H |
| 17 | #define READCONF_H |
| 18 | |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 19 | /* Data structure for representing option data. */ |
| 20 | |
| 21 | #define MAX_SEND_ENV 256 |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 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) |
| 25 | |
| 26 | struct allowed_cname { |
| 27 | char *source_list; |
| 28 | char *target_list; |
| 29 | }; |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 30 | |
| 31 | typedef struct { |
| 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 */ |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 38 | struct ForwardOptions fwd_opts; /* forwarding options */ |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 39 | int use_privileged_port; /* Don't use privileged port if false. */ |
| 40 | int rhosts_rsa_authentication; /* Try rhosts with RSA |
| 41 | * authentication. */ |
| 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 |
| 50 | * authentication. */ |
| 51 | int kbd_interactive_authentication; /* Try keyboard-interactive auth. */ |
| 52 | char *kbd_interactive_devices; /* Keyboard-interactive auth devices. */ |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 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 |
| 58 | * (best). */ |
| 59 | int tcp_keep_alive; /* Set SO_KEEPALIVE. */ |
| 60 | int ip_qos_interactive; /* IP ToS/DSCP/class for interactive */ |
| 61 | int ip_qos_bulk; /* IP ToS/DSCP/class for bulk traffic */ |
| 62 | LogLevel log_level; /* Level for logging. */ |
| 63 | |
| 64 | int port; /* Port to connect. */ |
| 65 | int address_family; |
| 66 | int connection_attempts; /* Max attempts (seconds) before |
| 67 | * giving up */ |
| 68 | int connection_timeout; /* Max time (seconds) before |
| 69 | * aborting connection attempt */ |
| 70 | int number_of_password_prompts; /* Max number of password |
| 71 | * prompts. */ |
| 72 | int cipher; /* Cipher to use. */ |
| 73 | char *ciphers; /* SSH2 ciphers in order of preference. */ |
| 74 | char *macs; /* SSH2 macs in order of preference. */ |
| 75 | char *hostkeyalgorithms; /* SSH2 server key types in order of preference. */ |
| 76 | char *kex_algorithms; /* SSH2 kex methods in order of preference. */ |
| 77 | int protocol; /* Protocol in order of preference. */ |
| 78 | char *hostname; /* Real host to connect. */ |
| 79 | char *host_key_alias; /* hostname alias for .ssh/known_hosts */ |
| 80 | char *proxy_command; /* Proxy command for connecting the host. */ |
| 81 | char *user; /* User to log in as. */ |
| 82 | int escape_char; /* Escape character; -2 = none */ |
| 83 | |
| 84 | u_int num_system_hostfiles; /* Paths for /etc/ssh/ssh_known_hosts */ |
| 85 | char *system_hostfiles[SSH_MAX_HOSTS_FILES]; |
| 86 | u_int num_user_hostfiles; /* Path for $HOME/.ssh/known_hosts */ |
| 87 | char *user_hostfiles[SSH_MAX_HOSTS_FILES]; |
| 88 | char *preferred_authentications; |
| 89 | char *bind_address; /* local socket address for connection to sshd */ |
| 90 | char *pkcs11_provider; /* PKCS#11 provider */ |
| 91 | int verify_host_key_dns; /* Verify host key using DNS */ |
| 92 | |
| 93 | int num_identity_files; /* Number of files for RSA/DSA identities. */ |
| 94 | char *identity_files[SSH_MAX_IDENTITY_FILES]; |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 95 | int identity_file_userprovided[SSH_MAX_IDENTITY_FILES]; |
| 96 | struct sshkey *identity_keys[SSH_MAX_IDENTITY_FILES]; |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 97 | |
Greg Hartman | 9768ca4 | 2017-06-22 20:49:52 -0700 | [diff] [blame] | 98 | int num_certificate_files; /* Number of extra certificates for ssh. */ |
| 99 | char *certificate_files[SSH_MAX_CERTIFICATE_FILES]; |
| 100 | int certificate_file_userprovided[SSH_MAX_CERTIFICATE_FILES]; |
| 101 | struct sshkey *certificates[SSH_MAX_CERTIFICATE_FILES]; |
| 102 | |
| 103 | int add_keys_to_agent; |
| 104 | char *identity_agent; /* Optional path to ssh-agent socket */ |
| 105 | |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 106 | /* Local TCP/IP forward requests. */ |
| 107 | int num_local_forwards; |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 108 | struct Forward *local_forwards; |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 109 | |
| 110 | /* Remote TCP/IP forward requests. */ |
| 111 | int num_remote_forwards; |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 112 | struct Forward *remote_forwards; |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 113 | int clear_forwardings; |
| 114 | |
Greg Hartman | 9768ca4 | 2017-06-22 20:49:52 -0700 | [diff] [blame] | 115 | /* stdio forwarding (-W) host and port */ |
| 116 | char *stdio_forward_host; |
| 117 | int stdio_forward_port; |
| 118 | |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 119 | int enable_ssh_keysign; |
| 120 | int64_t rekey_limit; |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 121 | int rekey_interval; |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 122 | int no_host_authentication_for_localhost; |
| 123 | int identities_only; |
| 124 | int server_alive_interval; |
| 125 | int server_alive_count_max; |
| 126 | |
| 127 | int num_send_env; |
| 128 | char *send_env[MAX_SEND_ENV]; |
| 129 | |
| 130 | char *control_path; |
| 131 | int control_master; |
| 132 | int control_persist; /* ControlPersist flag */ |
| 133 | int control_persist_timeout; /* ControlPersist timeout (seconds) */ |
| 134 | |
| 135 | int hash_known_hosts; |
| 136 | |
| 137 | int tun_open; /* tun(4) */ |
| 138 | int tun_local; /* force tun device (optional) */ |
| 139 | int tun_remote; /* force tun device (optional) */ |
| 140 | |
| 141 | char *local_command; |
| 142 | int permit_local_command; |
| 143 | int visual_host_key; |
| 144 | |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 145 | int request_tty; |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 146 | |
| 147 | int proxy_use_fdpass; |
| 148 | |
| 149 | int num_canonical_domains; |
| 150 | char *canonical_domains[MAX_CANON_DOMAINS]; |
| 151 | int canonicalize_hostname; |
| 152 | int canonicalize_max_dots; |
| 153 | int canonicalize_fallback_local; |
| 154 | int num_permitted_cnames; |
| 155 | struct allowed_cname permitted_cnames[MAX_CANON_DOMAINS]; |
| 156 | |
| 157 | char *revoked_host_keys; |
| 158 | |
| 159 | int fingerprint_hash; |
| 160 | |
| 161 | int update_hostkeys; /* one of SSH_UPDATE_HOSTKEYS_* */ |
| 162 | |
Greg Hartman | ccacbc9 | 2016-02-03 09:59:44 -0800 | [diff] [blame] | 163 | char *hostbased_key_types; |
| 164 | char *pubkey_key_types; |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 165 | |
Greg Hartman | 9768ca4 | 2017-06-22 20:49:52 -0700 | [diff] [blame] | 166 | char *jump_user; |
| 167 | char *jump_host; |
| 168 | int jump_port; |
| 169 | char *jump_extra; |
| 170 | |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 171 | char *ignored_unknown; /* Pattern list of unknown tokens to ignore */ |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 172 | } Options; |
| 173 | |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 174 | #define SSH_CANONICALISE_NO 0 |
| 175 | #define SSH_CANONICALISE_YES 1 |
| 176 | #define SSH_CANONICALISE_ALWAYS 2 |
| 177 | |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 178 | #define SSHCTL_MASTER_NO 0 |
| 179 | #define SSHCTL_MASTER_YES 1 |
| 180 | #define SSHCTL_MASTER_AUTO 2 |
| 181 | #define SSHCTL_MASTER_ASK 3 |
| 182 | #define SSHCTL_MASTER_AUTO_ASK 4 |
| 183 | |
| 184 | #define REQUEST_TTY_AUTO 0 |
| 185 | #define REQUEST_TTY_NO 1 |
| 186 | #define REQUEST_TTY_YES 2 |
| 187 | #define REQUEST_TTY_FORCE 3 |
| 188 | |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 189 | #define SSHCONF_CHECKPERM 1 /* check permissions on config file */ |
| 190 | #define SSHCONF_USERCONF 2 /* user provided config file not system */ |
| 191 | #define SSHCONF_POSTCANON 4 /* After hostname canonicalisation */ |
Greg Hartman | 9768ca4 | 2017-06-22 20:49:52 -0700 | [diff] [blame] | 192 | #define SSHCONF_NEVERMATCH 8 /* Match/Host never matches; internal only */ |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 193 | |
| 194 | #define SSH_UPDATE_HOSTKEYS_NO 0 |
| 195 | #define SSH_UPDATE_HOSTKEYS_YES 1 |
| 196 | #define SSH_UPDATE_HOSTKEYS_ASK 2 |
| 197 | |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 198 | void initialize_options(Options *); |
| 199 | void fill_default_options(Options *); |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 200 | void fill_default_options_for_canonicalization(Options *); |
| 201 | int process_config_line(Options *, struct passwd *, const char *, |
| 202 | const char *, char *, const char *, int, int *, int); |
| 203 | int read_config_file(const char *, struct passwd *, const char *, |
| 204 | const char *, Options *, int); |
| 205 | int parse_forward(struct Forward *, const char *, int, int); |
Greg Hartman | 9768ca4 | 2017-06-22 20:49:52 -0700 | [diff] [blame] | 206 | int parse_jump(const char *, Options *, int); |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 207 | int default_ssh_port(void); |
| 208 | int option_clear_or_none(const char *); |
| 209 | void dump_client_config(Options *o, const char *host); |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 210 | |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 211 | void add_local_forward(Options *, const struct Forward *); |
| 212 | void add_remote_forward(Options *, const struct Forward *); |
| 213 | void add_identity_file(Options *, const char *, const char *, int); |
Greg Hartman | 9768ca4 | 2017-06-22 20:49:52 -0700 | [diff] [blame] | 214 | void add_certificate_file(Options *, const char *, int); |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 215 | |
| 216 | #endif /* READCONF_H */ |