1 /* $OpenBSD: readconf.h,v 1.101 2014/02/23 20:11:36 djm Exp $ */ 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 19 /* Data structure for representing a forwarding request. */ 20 21 typedef struct { 22 char *listen_host; /* Host (address) to listen on. */ 23 int listen_port; /* Port to forward. */ 24 char *connect_host; /* Host to connect. */ 25 int connect_port; /* Port to connect on connect_host. */ 26 int allocated_port; /* Dynamically allocated listen port */ 27 int handle; /* Handle for dynamic listen ports */ 28 } Forward; 29 /* Data structure for representing option data. */ 30 31 #define MAX_SEND_ENV 256 32 #define SSH_MAX_HOSTS_FILES 32 33 #define MAX_CANON_DOMAINS 32 34 35 struct allowed_cname { 36 char *source_list; 37 char *target_list; 38 }; 39 40 typedef struct { 41 int forward_agent; /* Forward authentication agent. */ 42 int forward_x11; /* Forward X11 display. */ 43 int forward_x11_timeout; /* Expiration for Cookies */ 44 int forward_x11_trusted; /* Trust Forward X11 display. */ 45 int exit_on_forward_failure; /* Exit if bind(2) fails for -L/-R */ 46 char *xauth_location; /* Location for xauth program */ 47 int gateway_ports; /* Allow remote connects to forwarded ports. */ 48 int use_privileged_port; /* Don't use privileged port if false. */ 49 int rhosts_rsa_authentication; /* Try rhosts with RSA 50 * authentication. */ 51 int rsa_authentication; /* Try RSA authentication. */ 52 int pubkey_authentication; /* Try ssh2 pubkey authentication. */ 53 int hostbased_authentication; /* ssh2's rhosts_rsa */ 54 int challenge_response_authentication; 55 /* Try S/Key or TIS, authentication. */ 56 int gss_authentication; /* Try GSS authentication */ 57 int gss_deleg_creds; /* Delegate GSS credentials */ 58 int password_authentication; /* Try password 59 * authentication. */ 60 int kbd_interactive_authentication; /* Try keyboard-interactive auth. */ 61 char *kbd_interactive_devices; /* Keyboard-interactive auth devices. */ 62 int batch_mode; /* Batch mode: do not ask for passwords. */ 63 int check_host_ip; /* Also keep track of keys for IP address */ 64 int strict_host_key_checking; /* Strict host key checking. */ 65 int compression; /* Compress packets in both directions. */ 66 int compression_level; /* Compression level 1 (fast) to 9 67 * (best). */ 68 int tcp_keep_alive; /* Set SO_KEEPALIVE. */ 69 int ip_qos_interactive; /* IP ToS/DSCP/class for interactive */ 70 int ip_qos_bulk; /* IP ToS/DSCP/class for bulk traffic */ 71 LogLevel log_level; /* Level for logging. */ 72 73 int port; /* Port to connect. */ 74 int address_family; 75 int connection_attempts; /* Max attempts (seconds) before 76 * giving up */ 77 int connection_timeout; /* Max time (seconds) before 78 * aborting connection attempt */ 79 int number_of_password_prompts; /* Max number of password 80 * prompts. */ 81 int cipher; /* Cipher to use. */ 82 char *ciphers; /* SSH2 ciphers in order of preference. */ 83 char *macs; /* SSH2 macs in order of preference. */ 84 char *hostkeyalgorithms; /* SSH2 server key types in order of preference. */ 85 char *kex_algorithms; /* SSH2 kex methods in order of preference. */ 86 int protocol; /* Protocol in order of preference. */ 87 char *hostname; /* Real host to connect. */ 88 char *host_key_alias; /* hostname alias for .ssh/known_hosts */ 89 char *proxy_command; /* Proxy command for connecting the host. */ 90 char *user; /* User to log in as. */ 91 int escape_char; /* Escape character; -2 = none */ 92 93 u_int num_system_hostfiles; /* Paths for /etc/ssh/ssh_known_hosts */ 94 char *system_hostfiles[SSH_MAX_HOSTS_FILES]; 95 u_int num_user_hostfiles; /* Path for $HOME/.ssh/known_hosts */ 96 char *user_hostfiles[SSH_MAX_HOSTS_FILES]; 97 char *preferred_authentications; 98 char *bind_address; /* local socket address for connection to sshd */ 99 char *pkcs11_provider; /* PKCS#11 provider */ 100 int verify_host_key_dns; /* Verify host key using DNS */ 101 102 int num_identity_files; /* Number of files for RSA/DSA identities. */ 103 char *identity_files[SSH_MAX_IDENTITY_FILES]; 104 int identity_file_userprovided[SSH_MAX_IDENTITY_FILES]; 105 Key *identity_keys[SSH_MAX_IDENTITY_FILES]; 106 107 /* Local TCP/IP forward requests. */ 108 int num_local_forwards; 109 Forward *local_forwards; 110 111 /* Remote TCP/IP forward requests. */ 112 int num_remote_forwards; 113 Forward *remote_forwards; 114 int clear_forwardings; 115 116 int enable_ssh_keysign; 117 int64_t rekey_limit; 118 int rekey_interval; 119 int no_host_authentication_for_localhost; 120 int identities_only; 121 int server_alive_interval; 122 int server_alive_count_max; 123 124 int num_send_env; 125 char *send_env[MAX_SEND_ENV]; 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 int visual_host_key; 141 142 int use_roaming; 143 144 int request_tty; 145 146 int proxy_use_fdpass; 147 148 int num_canonical_domains; 149 char *canonical_domains[MAX_CANON_DOMAINS]; 150 int canonicalize_hostname; 151 int canonicalize_max_dots; 152 int canonicalize_fallback_local; 153 int num_permitted_cnames; 154 struct allowed_cname permitted_cnames[MAX_CANON_DOMAINS]; 155 156 char *ignored_unknown; /* Pattern list of unknown tokens to ignore */ 157 158 char *version_addendum; /* Appended to SSH banner */ 159 160 int hpn_disabled; /* Switch to disable HPN buffer management. */ 161 int hpn_buffer_size; /* User definable size for HPN buffer 162 * window. */ 163 int tcp_rcv_buf_poll; /* Option to poll recv buf every window 164 * transfer. */ 165 int tcp_rcv_buf; /* User switch to set tcp recv buffer. */ 166 167 } Options; 168 169 #define SSH_CANONICALISE_NO 0 170 #define SSH_CANONICALISE_YES 1 171 #define SSH_CANONICALISE_ALWAYS 2 172 173 #define SSHCTL_MASTER_NO 0 174 #define SSHCTL_MASTER_YES 1 175 #define SSHCTL_MASTER_AUTO 2 176 #define SSHCTL_MASTER_ASK 3 177 #define SSHCTL_MASTER_AUTO_ASK 4 178 179 #define REQUEST_TTY_AUTO 0 180 #define REQUEST_TTY_NO 1 181 #define REQUEST_TTY_YES 2 182 #define REQUEST_TTY_FORCE 3 183 184 #define SSHCONF_CHECKPERM 1 /* check permissions on config file */ 185 #define SSHCONF_USERCONF 2 /* user provided config file not system */ 186 187 void initialize_options(Options *); 188 void fill_default_options(Options *); 189 void fill_default_options_for_canonicalization(Options *); 190 int process_config_line(Options *, struct passwd *, const char *, char *, 191 const char *, int, int *, int); 192 int read_config_file(const char *, struct passwd *, const char *, 193 Options *, int); 194 int parse_forward(Forward *, const char *, int, int); 195 int default_ssh_port(void); 196 int option_clear_or_none(const char *); 197 198 void add_local_forward(Options *, const Forward *); 199 void add_remote_forward(Options *, const Forward *); 200 void add_identity_file(Options *, const char *, const char *, int); 201 202 #endif /* READCONF_H */ 203