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