Darren Tucker | 0763698 | 2013-05-16 20:30:03 +1000 | [diff] [blame] | 1 | /* $OpenBSD: readconf.h,v 1.95 2013/05/16 04:27:50 djm Exp $ */ |
Ben Lindstrom | 05764b9 | 2002-03-05 01:53:02 +0000 | [diff] [blame] | 2 | |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 3 | /* |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 4 | * Author: Tatu Ylonen <ylo@cs.hut.fi> |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 5 | * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland |
| 6 | * All rights reserved |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 7 | * Functions for reading the configuration file. |
Damien Miller | 4af5130 | 2000-04-16 11:18:38 +1000 | [diff] [blame] | 8 | * |
Damien Miller | e4340be | 2000-09-16 13:29:08 +1100 | [diff] [blame] | 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". |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 14 | */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 15 | |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 16 | #ifndef READCONF_H |
| 17 | #define READCONF_H |
| 18 | |
| 19 | /* Data structure for representing a forwarding request. */ |
| 20 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 21 | typedef struct { |
Damien Miller | f91ee4c | 2005-03-01 21:24:33 +1100 | [diff] [blame] | 22 | char *listen_host; /* Host (address) to listen on. */ |
Damien Miller | 3dc71ad | 2009-01-28 16:31:22 +1100 | [diff] [blame] | 23 | int listen_port; /* Port to forward. */ |
Damien Miller | f91ee4c | 2005-03-01 21:24:33 +1100 | [diff] [blame] | 24 | char *connect_host; /* Host to connect. */ |
Damien Miller | 3dc71ad | 2009-01-28 16:31:22 +1100 | [diff] [blame] | 25 | int connect_port; /* Port to connect on connect_host. */ |
Damien Miller | 388f6fc | 2010-05-21 14:57:35 +1000 | [diff] [blame] | 26 | int allocated_port; /* Dynamically allocated listen port */ |
Darren Tucker | 68afb8c | 2011-10-02 18:59:03 +1100 | [diff] [blame] | 27 | int handle; /* Handle for dynamic listen ports */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 28 | } Forward; |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 29 | /* Data structure for representing option data. */ |
| 30 | |
Damien Miller | 295ee63 | 2011-05-29 21:42:31 +1000 | [diff] [blame] | 31 | #define MAX_SEND_ENV 256 |
| 32 | #define SSH_MAX_HOSTS_FILES 256 |
Darren Tucker | 46bc075 | 2004-05-02 22:11:30 +1000 | [diff] [blame] | 33 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 34 | typedef struct { |
| 35 | int forward_agent; /* Forward authentication agent. */ |
| 36 | int forward_x11; /* Forward X11 display. */ |
Damien Miller | 1ab6a51 | 2010-06-26 10:02:24 +1000 | [diff] [blame] | 37 | int forward_x11_timeout; /* Expiration for Cookies */ |
Darren Tucker | 0a118da | 2003-10-15 15:54:32 +1000 | [diff] [blame] | 38 | int forward_x11_trusted; /* Trust Forward X11 display. */ |
Darren Tucker | e7d4b19 | 2006-07-12 22:17:10 +1000 | [diff] [blame] | 39 | int exit_on_forward_failure; /* Exit if bind(2) fails for -L/-R */ |
Damien Miller | d3a1857 | 2000-06-07 19:55:44 +1000 | [diff] [blame] | 40 | char *xauth_location; /* Location for xauth program */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 41 | int gateway_ports; /* Allow remote connects to forwarded ports. */ |
| 42 | int use_privileged_port; /* Don't use privileged port if false. */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 43 | int rhosts_rsa_authentication; /* Try rhosts with RSA |
| 44 | * authentication. */ |
| 45 | int rsa_authentication; /* Try RSA authentication. */ |
Damien Miller | 0bc1bd8 | 2000-11-13 22:57:25 +1100 | [diff] [blame] | 46 | int pubkey_authentication; /* Try ssh2 pubkey authentication. */ |
Ben Lindstrom | 5eabda3 | 2001-04-12 23:34:34 +0000 | [diff] [blame] | 47 | int hostbased_authentication; /* ssh2's rhosts_rsa */ |
Ben Lindstrom | 551ea37 | 2001-06-05 18:56:16 +0000 | [diff] [blame] | 48 | int challenge_response_authentication; |
Ben Lindstrom | 95fb2dd | 2001-01-23 03:12:10 +0000 | [diff] [blame] | 49 | /* Try S/Key or TIS, authentication. */ |
Darren Tucker | 0efd155 | 2003-08-26 11:49:55 +1000 | [diff] [blame] | 50 | int gss_authentication; /* Try GSS authentication */ |
| 51 | int gss_deleg_creds; /* Delegate GSS credentials */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 52 | int password_authentication; /* Try password |
| 53 | * authentication. */ |
Damien Miller | 874d77b | 2000-10-14 16:23:11 +1100 | [diff] [blame] | 54 | int kbd_interactive_authentication; /* Try keyboard-interactive auth. */ |
| 55 | char *kbd_interactive_devices; /* Keyboard-interactive auth devices. */ |
Damien Miller | 01ed227 | 2008-11-05 16:20:46 +1100 | [diff] [blame] | 56 | int zero_knowledge_password_authentication; /* Try jpake */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 57 | int batch_mode; /* Batch mode: do not ask for passwords. */ |
| 58 | int check_host_ip; /* Also keep track of keys for IP address */ |
| 59 | int strict_host_key_checking; /* Strict host key checking. */ |
| 60 | int compression; /* Compress packets in both directions. */ |
| 61 | int compression_level; /* Compression level 1 (fast) to 9 |
| 62 | * (best). */ |
Damien Miller | 12c150e | 2003-12-17 16:31:10 +1100 | [diff] [blame] | 63 | int tcp_keep_alive; /* Set SO_KEEPALIVE. */ |
Damien Miller | 0dac6fb | 2010-11-20 15:19:38 +1100 | [diff] [blame] | 64 | int ip_qos_interactive; /* IP ToS/DSCP/class for interactive */ |
| 65 | int ip_qos_bulk; /* IP ToS/DSCP/class for bulk traffic */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 66 | LogLevel log_level; /* Level for logging. */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 67 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 68 | int port; /* Port to connect. */ |
Darren Tucker | 0a4f04b | 2003-07-03 20:37:47 +1000 | [diff] [blame] | 69 | int address_family; |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 70 | int connection_attempts; /* Max attempts (seconds) before |
| 71 | * giving up */ |
Damien Miller | b78d5eb | 2003-05-16 11:39:04 +1000 | [diff] [blame] | 72 | int connection_timeout; /* Max time (seconds) before |
Damien Miller | a8e06ce | 2003-11-21 23:48:55 +1100 | [diff] [blame] | 73 | * aborting connection attempt */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 74 | int number_of_password_prompts; /* Max number of password |
| 75 | * prompts. */ |
| 76 | int cipher; /* Cipher to use. */ |
Damien Miller | 30c3d42 | 2000-05-09 11:02:59 +1000 | [diff] [blame] | 77 | char *ciphers; /* SSH2 ciphers in order of preference. */ |
Ben Lindstrom | 06b33aa | 2001-02-15 03:01:59 +0000 | [diff] [blame] | 78 | char *macs; /* SSH2 macs in order of preference. */ |
Ben Lindstrom | 982dbbc | 2001-04-17 18:11:36 +0000 | [diff] [blame] | 79 | char *hostkeyalgorithms; /* SSH2 server key types in order of preference. */ |
Damien Miller | d5f62bf | 2010-09-24 22:11:14 +1000 | [diff] [blame] | 80 | char *kex_algorithms; /* SSH2 kex methods in order of preference. */ |
Damien Miller | 7892879 | 2000-04-12 20:17:38 +1000 | [diff] [blame] | 81 | int protocol; /* Protocol in order of preference. */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 82 | char *hostname; /* Real host to connect. */ |
Ben Lindstrom | 4dccfa5 | 2000-12-28 16:40:05 +0000 | [diff] [blame] | 83 | char *host_key_alias; /* hostname alias for .ssh/known_hosts */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 84 | char *proxy_command; /* Proxy command for connecting the host. */ |
| 85 | char *user; /* User to log in as. */ |
| 86 | int escape_char; /* Escape character; -2 = none */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 87 | |
Damien Miller | 295ee63 | 2011-05-29 21:42:31 +1000 | [diff] [blame] | 88 | u_int num_system_hostfiles; /* Paths for /etc/ssh/ssh_known_hosts */ |
| 89 | char *system_hostfiles[SSH_MAX_HOSTS_FILES]; |
| 90 | u_int num_user_hostfiles; /* Path for $HOME/.ssh/known_hosts */ |
| 91 | char *user_hostfiles[SSH_MAX_HOSTS_FILES]; |
Ben Lindstrom | b9be60a | 2001-03-11 01:49:19 +0000 | [diff] [blame] | 92 | char *preferred_authentications; |
Ben Lindstrom | e0f8804 | 2001-04-30 13:06:24 +0000 | [diff] [blame] | 93 | char *bind_address; /* local socket address for connection to sshd */ |
Damien Miller | 7ea845e | 2010-02-12 09:21:02 +1100 | [diff] [blame] | 94 | char *pkcs11_provider; /* PKCS#11 provider */ |
Damien Miller | 37876e9 | 2003-05-15 10:19:46 +1000 | [diff] [blame] | 95 | int verify_host_key_dns; /* Verify host key using DNS */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 96 | |
Damien Miller | 0bc1bd8 | 2000-11-13 22:57:25 +1100 | [diff] [blame] | 97 | int num_identity_files; /* Number of files for RSA/DSA identities. */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 98 | char *identity_files[SSH_MAX_IDENTITY_FILES]; |
Darren Tucker | 1910478 | 2013-04-05 11:13:08 +1100 | [diff] [blame] | 99 | int identity_file_userprovided[SSH_MAX_IDENTITY_FILES]; |
Ben Lindstrom | 266dfdf | 2001-03-09 00:12:22 +0000 | [diff] [blame] | 100 | Key *identity_keys[SSH_MAX_IDENTITY_FILES]; |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 101 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 102 | /* Local TCP/IP forward requests. */ |
| 103 | int num_local_forwards; |
Damien Miller | 232cfb1 | 2010-06-26 09:50:30 +1000 | [diff] [blame] | 104 | Forward *local_forwards; |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 105 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 106 | /* Remote TCP/IP forward requests. */ |
| 107 | int num_remote_forwards; |
Damien Miller | 232cfb1 | 2010-06-26 09:50:30 +1000 | [diff] [blame] | 108 | Forward *remote_forwards; |
Ben Lindstrom | 2b7a0e9 | 2001-09-20 00:57:55 +0000 | [diff] [blame] | 109 | int clear_forwardings; |
Ben Lindstrom | b6df73b | 2002-11-09 15:52:31 +0000 | [diff] [blame] | 110 | |
| 111 | int enable_ssh_keysign; |
Damien Miller | 3dff176 | 2008-02-10 22:25:52 +1100 | [diff] [blame] | 112 | int64_t rekey_limit; |
Darren Tucker | c53c2af | 2013-05-16 20:28:16 +1000 | [diff] [blame] | 113 | int rekey_interval; |
Ben Lindstrom | 3cecc9a | 2001-10-03 17:39:38 +0000 | [diff] [blame] | 114 | int no_host_authentication_for_localhost; |
Damien Miller | bd394c3 | 2004-03-08 23:12:36 +1100 | [diff] [blame] | 115 | int identities_only; |
Darren Tucker | fc95970 | 2004-07-17 16:12:08 +1000 | [diff] [blame] | 116 | int server_alive_interval; |
Damien Miller | 509b010 | 2003-12-17 16:33:10 +1100 | [diff] [blame] | 117 | int server_alive_count_max; |
Darren Tucker | 46bc075 | 2004-05-02 22:11:30 +1000 | [diff] [blame] | 118 | |
| 119 | int num_send_env; |
| 120 | char *send_env[MAX_SEND_ENV]; |
Damien Miller | 0e220db | 2004-06-15 10:34:08 +1000 | [diff] [blame] | 121 | |
| 122 | char *control_path; |
| 123 | int control_master; |
Damien Miller | e11e1ea | 2010-08-03 16:04:46 +1000 | [diff] [blame] | 124 | int control_persist; /* ControlPersist flag */ |
| 125 | int control_persist_timeout; /* ControlPersist timeout (seconds) */ |
Damien Miller | e177615 | 2005-03-01 21:47:37 +1100 | [diff] [blame] | 126 | |
| 127 | int hash_known_hosts; |
Damien Miller | d27b947 | 2005-12-13 19:29:02 +1100 | [diff] [blame] | 128 | |
| 129 | int tun_open; /* tun(4) */ |
| 130 | int tun_local; /* force tun device (optional) */ |
| 131 | int tun_remote; /* force tun device (optional) */ |
| 132 | |
| 133 | char *local_command; |
| 134 | int permit_local_command; |
Damien Miller | 1028824 | 2008-06-30 00:04:03 +1000 | [diff] [blame] | 135 | int visual_host_key; |
Damien Miller | d27b947 | 2005-12-13 19:29:02 +1100 | [diff] [blame] | 136 | |
Darren Tucker | 71e4d54 | 2009-07-06 07:12:27 +1000 | [diff] [blame] | 137 | int use_roaming; |
| 138 | |
Damien Miller | 21771e2 | 2011-05-15 08:45:50 +1000 | [diff] [blame] | 139 | int request_tty; |
Darren Tucker | 0763698 | 2013-05-16 20:30:03 +1000 | [diff] [blame] | 140 | |
| 141 | char *ignored_unknown; /* Pattern list of unknown tokens to ignore */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 142 | } Options; |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 143 | |
Damien Miller | d14b1e7 | 2005-06-16 13:19:41 +1000 | [diff] [blame] | 144 | #define SSHCTL_MASTER_NO 0 |
| 145 | #define SSHCTL_MASTER_YES 1 |
| 146 | #define SSHCTL_MASTER_AUTO 2 |
| 147 | #define SSHCTL_MASTER_ASK 3 |
| 148 | #define SSHCTL_MASTER_AUTO_ASK 4 |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 149 | |
Damien Miller | 21771e2 | 2011-05-15 08:45:50 +1000 | [diff] [blame] | 150 | #define REQUEST_TTY_AUTO 0 |
| 151 | #define REQUEST_TTY_NO 1 |
| 152 | #define REQUEST_TTY_YES 2 |
| 153 | #define REQUEST_TTY_FORCE 3 |
| 154 | |
Darren Tucker | aefa368 | 2013-04-05 11:18:35 +1100 | [diff] [blame] | 155 | #define SSHCONF_CHECKPERM 1 /* check permissions on config file */ |
| 156 | #define SSHCONF_USERCONF 2 /* user provided config file not system */ |
| 157 | |
Ben Lindstrom | 4cc240d | 2001-07-04 04:46:56 +0000 | [diff] [blame] | 158 | void initialize_options(Options *); |
| 159 | void fill_default_options(Options *); |
Damien Miller | 57a4476 | 2004-04-20 20:11:57 +1000 | [diff] [blame] | 160 | int read_config_file(const char *, const char *, Options *, int); |
Damien Miller | 4bf648f | 2009-02-14 16:28:21 +1100 | [diff] [blame] | 161 | int parse_forward(Forward *, const char *, int, int); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 162 | |
Damien Miller | 4af5130 | 2000-04-16 11:18:38 +1000 | [diff] [blame] | 163 | int |
Darren Tucker | aefa368 | 2013-04-05 11:18:35 +1100 | [diff] [blame] | 164 | process_config_line(Options *, const char *, char *, const char *, int, int *, |
| 165 | int); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 166 | |
Damien Miller | f91ee4c | 2005-03-01 21:24:33 +1100 | [diff] [blame] | 167 | void add_local_forward(Options *, const Forward *); |
| 168 | void add_remote_forward(Options *, const Forward *); |
Darren Tucker | 1910478 | 2013-04-05 11:13:08 +1100 | [diff] [blame] | 169 | void add_identity_file(Options *, const char *, const char *, int); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 170 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 171 | #endif /* READCONF_H */ |