readconf.h revision 1.10.4.1
1/* $NetBSD: readconf.h,v 1.10.4.1 2015/04/30 06:07:30 riz Exp $ */ 2/* $OpenBSD: readconf.h,v 1.109 2015/02/16 22:13:32 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 27struct allowed_cname { 28 char *source_list; 29 char *target_list; 30}; 31 32typedef 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 /* Local TCP/IP forward requests. */ 114 int num_local_forwards; 115 struct Forward *local_forwards; 116 117 /* Remote TCP/IP forward requests. */ 118 int num_remote_forwards; 119 struct Forward *remote_forwards; 120 int clear_forwardings; 121 122 int enable_ssh_keysign; 123 int64_t rekey_limit; 124 int rekey_interval; 125 int none_switch; /* Use none cipher */ 126 int none_enabled; /* Allow none to be used */ 127 int no_host_authentication_for_localhost; 128 int identities_only; 129 int server_alive_interval; 130 int server_alive_count_max; 131 132 int num_send_env; 133 char *send_env[MAX_SEND_ENV]; 134 135 char *control_path; 136 int control_master; 137 int control_persist; /* ControlPersist flag */ 138 int control_persist_timeout; /* ControlPersist timeout (seconds) */ 139 140 int hash_known_hosts; 141 142 int tun_open; /* tun(4) */ 143 int tun_local; /* force tun device (optional) */ 144 int tun_remote; /* force tun device (optional) */ 145 146 char *local_command; 147 int permit_local_command; 148 int visual_host_key; 149 150 int use_roaming; 151 152 int request_tty; 153 int send_version_first; 154 155 int proxy_use_fdpass; 156 157 int num_canonical_domains; 158 char *canonical_domains[MAX_CANON_DOMAINS]; 159 int canonicalize_hostname; 160 int canonicalize_max_dots; 161 int canonicalize_fallback_local; 162 int num_permitted_cnames; 163 struct allowed_cname permitted_cnames[MAX_CANON_DOMAINS]; 164 165 char *revoked_host_keys; 166 167 int fingerprint_hash; 168 169 int update_hostkeys; /* one of SSH_UPDATE_HOSTKEYS_* */ 170 171 char *hostbased_key_types; 172 173 char *ignored_unknown; /* Pattern list of unknown tokens to ignore */ 174} Options; 175 176#define SSH_CANONICALISE_NO 0 177#define SSH_CANONICALISE_YES 1 178#define SSH_CANONICALISE_ALWAYS 2 179 180#define SSHCTL_MASTER_NO 0 181#define SSHCTL_MASTER_YES 1 182#define SSHCTL_MASTER_AUTO 2 183#define SSHCTL_MASTER_ASK 3 184#define SSHCTL_MASTER_AUTO_ASK 4 185 186#define REQUEST_TTY_AUTO 0 187#define REQUEST_TTY_NO 1 188#define REQUEST_TTY_YES 2 189#define REQUEST_TTY_FORCE 3 190 191#define SSHCONF_CHECKPERM 1 /* check permissions on config file */ 192#define SSHCONF_USERCONF 2 /* user provided config file not system */ 193#define SSHCONF_POSTCANON 4 /* After hostname canonicalisation */ 194 195#define SSH_UPDATE_HOSTKEYS_NO 0 196#define SSH_UPDATE_HOSTKEYS_YES 1 197#define SSH_UPDATE_HOSTKEYS_ASK 2 198 199void initialize_options(Options *); 200void fill_default_options(Options *); 201void fill_default_options_for_canonicalization(Options *); 202int process_config_line(Options *, struct passwd *, const char *, 203 const char *, char *, const char *, int, int *, int); 204int read_config_file(const char *, struct passwd *, const char *, 205 const char *, Options *, int); 206int parse_forward(struct Forward *, const char *, int, int); 207int default_ssh_port(void); 208int option_clear_or_none(const char *); 209void dump_client_config(Options *o, const char *host); 210 211void add_local_forward(Options *, const struct Forward *); 212void add_remote_forward(Options *, const struct Forward *); 213void add_identity_file(Options *, const char *, const char *, int); 214 215#endif /* READCONF_H */ 216