1 /* $OpenBSD: readconf.h,v 1.128 2018/09/20 03:30:44 djm Exp $ */ 2 /* $FreeBSD$ */ 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 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 }; 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 */ 38 struct ForwardOptions fwd_opts; /* forwarding options */ 39 int pubkey_authentication; /* Try ssh2 pubkey authentication. */ 40 int hostbased_authentication; /* ssh2's rhosts_rsa */ 41 int challenge_response_authentication; 42 /* Try S/Key or TIS, authentication. */ 43 int gss_authentication; /* Try GSS authentication */ 44 int gss_deleg_creds; /* Delegate GSS credentials */ 45 int password_authentication; /* Try password 46 * authentication. */ 47 int kbd_interactive_authentication; /* Try keyboard-interactive auth. */ 48 char *kbd_interactive_devices; /* Keyboard-interactive auth devices. */ 49 int batch_mode; /* Batch mode: do not ask for passwords. */ 50 int check_host_ip; /* Also keep track of keys for IP address */ 51 int strict_host_key_checking; /* Strict host key checking. */ 52 int compression; /* Compress packets in both directions. */ 53 int tcp_keep_alive; /* Set SO_KEEPALIVE. */ 54 int ip_qos_interactive; /* IP ToS/DSCP/class for interactive */ 55 int ip_qos_bulk; /* IP ToS/DSCP/class for bulk traffic */ 56 SyslogFacility log_facility; /* Facility for system logging. */ 57 LogLevel log_level; /* Level for logging. */ 58 59 int port; /* Port to connect. */ 60 int address_family; 61 int connection_attempts; /* Max attempts (seconds) before 62 * giving up */ 63 int connection_timeout; /* Max time (seconds) before 64 * aborting connection attempt */ 65 int number_of_password_prompts; /* Max number of password 66 * prompts. */ 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 */ 77 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 int verify_host_key_dns; /* Verify host key using DNS */ 87 88 int num_identity_files; /* Number of files for RSA/DSA identities. */ 89 char *identity_files[SSH_MAX_IDENTITY_FILES]; 90 int identity_file_userprovided[SSH_MAX_IDENTITY_FILES]; 91 struct sshkey *identity_keys[SSH_MAX_IDENTITY_FILES]; 92 93 int num_certificate_files; /* Number of extra certificates for ssh. */ 94 char *certificate_files[SSH_MAX_CERTIFICATE_FILES]; 95 int certificate_file_userprovided[SSH_MAX_CERTIFICATE_FILES]; 96 struct sshkey *certificates[SSH_MAX_CERTIFICATE_FILES]; 97 98 int add_keys_to_agent; 99 char *identity_agent; /* Optional path to ssh-agent socket */ 100 101 /* Local TCP/IP forward requests. */ 102 int num_local_forwards; 103 struct Forward *local_forwards; 104 105 /* Remote TCP/IP forward requests. */ 106 int num_remote_forwards; 107 struct Forward *remote_forwards; 108 int clear_forwardings; 109 110 /* stdio forwarding (-W) host and port */ 111 char *stdio_forward_host; 112 int stdio_forward_port; 113 114 int enable_ssh_keysign; 115 int64_t rekey_limit; 116 int rekey_interval; 117 int no_host_authentication_for_localhost; 118 int identities_only; 119 int server_alive_interval; 120 int server_alive_count_max; 121 122 int num_send_env; 123 char **send_env; 124 int num_setenv; 125 char **setenv; 126 127 char *control_path; 128 int control_master; 129 int control_persist; /* ControlPersist flag */ 130 int control_persist_timeout; /* ControlPersist timeout (seconds) */ 131 132 int hash_known_hosts; 133 134 int tun_open; /* tun(4) */ 135 int tun_local; /* force tun device (optional) */ 136 int tun_remote; /* force tun device (optional) */ 137 138 char *local_command; 139 int permit_local_command; 140 char *remote_command; 141 int visual_host_key; 142 143 int request_tty; 144 145 int proxy_use_fdpass; 146 147 int num_canonical_domains; 148 char *canonical_domains[MAX_CANON_DOMAINS]; 149 int canonicalize_hostname; 150 int canonicalize_max_dots; 151 int canonicalize_fallback_local; 152 int num_permitted_cnames; 153 struct allowed_cname permitted_cnames[MAX_CANON_DOMAINS]; 154 155 char *revoked_host_keys; 156 157 int fingerprint_hash; 158 159 int update_hostkeys; /* one of SSH_UPDATE_HOSTKEYS_* */ 160 161 char *hostbased_key_types; 162 char *pubkey_key_types; 163 164 char *version_addendum; /* Appended to SSH banner */ 165 166 char *jump_user; 167 char *jump_host; 168 int jump_port; 169 char *jump_extra; 170 171 char *ignored_unknown; /* Pattern list of unknown tokens to ignore */ 172 } Options; 173 174 #define SSH_CANONICALISE_NO 0 175 #define SSH_CANONICALISE_YES 1 176 #define SSH_CANONICALISE_ALWAYS 2 177 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 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 */ 192 #define SSHCONF_NEVERMATCH 8 /* Match/Host never matches; internal only */ 193 194 #define SSH_UPDATE_HOSTKEYS_NO 0 195 #define SSH_UPDATE_HOSTKEYS_YES 1 196 #define SSH_UPDATE_HOSTKEYS_ASK 2 197 198 #define SSH_STRICT_HOSTKEY_OFF 0 199 #define SSH_STRICT_HOSTKEY_NEW 1 200 #define SSH_STRICT_HOSTKEY_YES 2 201 #define SSH_STRICT_HOSTKEY_ASK 3 202 203 void initialize_options(Options *); 204 void fill_default_options(Options *); 205 void fill_default_options_for_canonicalization(Options *); 206 int process_config_line(Options *, struct passwd *, const char *, 207 const char *, char *, const char *, int, int *, int); 208 int read_config_file(const char *, struct passwd *, const char *, 209 const char *, Options *, int); 210 int parse_forward(struct Forward *, const char *, int, int); 211 int parse_jump(const char *, Options *, int); 212 int parse_ssh_uri(const char *, char **, char **, int *); 213 int default_ssh_port(void); 214 int option_clear_or_none(const char *); 215 void dump_client_config(Options *o, const char *host); 216 217 void add_local_forward(Options *, const struct Forward *); 218 void add_remote_forward(Options *, const struct Forward *); 219 void add_identity_file(Options *, const char *, const char *, int); 220 void add_certificate_file(Options *, const char *, int); 221 222 #endif /* READCONF_H */ 223