1 /* $OpenBSD: readconf.h,v 1.102 2014/07/15 15:54:14 millert 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 option data. */ 20 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) 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 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. */ 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 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 char *version_addendum; /* Appended to SSH banner */ 65 int ip_qos_interactive; /* IP ToS/DSCP/class for interactive */ 66 int ip_qos_bulk; /* IP ToS/DSCP/class for bulk traffic */ 67 LogLevel log_level; /* Level for logging. */ 68 69 int port; /* Port to connect. */ 70 int address_family; 71 int connection_attempts; /* Max attempts (seconds) before 72 * giving up */ 73 int connection_timeout; /* Max time (seconds) before 74 * aborting connection attempt */ 75 int number_of_password_prompts; /* Max number of password 76 * prompts. */ 77 int cipher; /* Cipher to use. */ 78 char *ciphers; /* SSH2 ciphers in order of preference. */ 79 char *macs; /* SSH2 macs in order of preference. */ 80 char *hostkeyalgorithms; /* SSH2 server key types in order of preference. */ 81 char *kex_algorithms; /* SSH2 kex methods in order of preference. */ 82 int protocol; /* Protocol in order of preference. */ 83 char *hostname; /* Real host to connect. */ 84 char *host_key_alias; /* hostname alias for .ssh/known_hosts */ 85 char *proxy_command; /* Proxy command for connecting the host. */ 86 char *user; /* User to log in as. */ 87 int escape_char; /* Escape character; -2 = none */ 88 89 u_int num_system_hostfiles; /* Paths for /etc/ssh/ssh_known_hosts */ 90 char *system_hostfiles[SSH_MAX_HOSTS_FILES]; 91 u_int num_user_hostfiles; /* Path for $HOME/.ssh/known_hosts */ 92 char *user_hostfiles[SSH_MAX_HOSTS_FILES]; 93 char *preferred_authentications; 94 char *bind_address; /* local socket address for connection to sshd */ 95 char *pkcs11_provider; /* PKCS#11 provider */ 96 int verify_host_key_dns; /* Verify host key using DNS */ 97 98 int num_identity_files; /* Number of files for RSA/DSA identities. */ 99 char *identity_files[SSH_MAX_IDENTITY_FILES]; 100 int identity_file_userprovided[SSH_MAX_IDENTITY_FILES]; 101 Key *identity_keys[SSH_MAX_IDENTITY_FILES]; 102 103 /* Local TCP/IP forward requests. */ 104 int num_local_forwards; 105 struct Forward *local_forwards; 106 107 /* Remote TCP/IP forward requests. */ 108 int num_remote_forwards; 109 struct Forward *remote_forwards; 110 int clear_forwardings; 111 112 int enable_ssh_keysign; 113 int64_t rekey_limit; 114 int none_switch; /* Use none cipher */ 115 int none_enabled; /* Allow none to be used */ 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[MAX_SEND_ENV]; 124 125 char *control_path; 126 int control_master; 127 int control_persist; /* ControlPersist flag */ 128 int control_persist_timeout; /* ControlPersist timeout (seconds) */ 129 130 int hash_known_hosts; 131 132 int tun_open; /* tun(4) */ 133 int tun_local; /* force tun device (optional) */ 134 int tun_remote; /* force tun device (optional) */ 135 136 char *local_command; 137 int permit_local_command; 138 int visual_host_key; 139 140 int use_roaming; 141 142 int request_tty; 143 144 int proxy_use_fdpass; 145 146 int num_canonical_domains; 147 char *canonical_domains[MAX_CANON_DOMAINS]; 148 int canonicalize_hostname; 149 int canonicalize_max_dots; 150 int canonicalize_fallback_local; 151 int num_permitted_cnames; 152 struct allowed_cname permitted_cnames[MAX_CANON_DOMAINS]; 153 154 char *ignored_unknown; /* Pattern list of unknown tokens to ignore */ 155 } Options; 156 157 #define SSH_CANONICALISE_NO 0 158 #define SSH_CANONICALISE_YES 1 159 #define SSH_CANONICALISE_ALWAYS 2 160 161 #define SSHCTL_MASTER_NO 0 162 #define SSHCTL_MASTER_YES 1 163 #define SSHCTL_MASTER_AUTO 2 164 #define SSHCTL_MASTER_ASK 3 165 #define SSHCTL_MASTER_AUTO_ASK 4 166 167 #define REQUEST_TTY_AUTO 0 168 #define REQUEST_TTY_NO 1 169 #define REQUEST_TTY_YES 2 170 #define REQUEST_TTY_FORCE 3 171 172 #define SSHCONF_CHECKPERM 1 /* check permissions on config file */ 173 #define SSHCONF_USERCONF 2 /* user provided config file not system */ 174 175 void initialize_options(Options *); 176 void fill_default_options(Options *); 177 void fill_default_options_for_canonicalization(Options *); 178 int process_config_line(Options *, struct passwd *, const char *, char *, 179 const char *, int, int *, int); 180 int read_config_file(const char *, struct passwd *, const char *, 181 Options *, int); 182 int parse_forward(struct Forward *, const char *, int, int); 183 int default_ssh_port(void); 184 int option_clear_or_none(const char *); 185 186 void add_local_forward(Options *, const struct Forward *); 187 void add_remote_forward(Options *, const struct Forward *); 188 void add_identity_file(Options *, const char *, const char *, int); 189 190 #endif /* READCONF_H */ 191