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