blob: 34aad83cf5bc4540900b401a1fde508f1538f029 [file] [log] [blame]
millert@openbsd.org887669e2017-10-21 23:06:24 +00001/* $OpenBSD: readconf.h,v 1.124 2017/10/21 23:06:24 millert Exp $ */
Ben Lindstrom05764b92002-03-05 01:53:02 +00002
Damien Millerd4a8b7e1999-10-27 13:42:43 +10003/*
Damien Miller95def091999-11-25 00:26:21 +11004 * Author: Tatu Ylonen <ylo@cs.hut.fi>
Damien Miller95def091999-11-25 00:26:21 +11005 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
6 * All rights reserved
Damien Miller95def091999-11-25 00:26:21 +11007 * Functions for reading the configuration file.
Damien Miller4af51302000-04-16 11:18:38 +10008 *
Damien Millere4340be2000-09-16 13:29:08 +11009 * 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 Miller95def091999-11-25 00:26:21 +110014 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100015
Damien Millerd4a8b7e1999-10-27 13:42:43 +100016#ifndef READCONF_H
17#define READCONF_H
18
Damien Millerd4a8b7e1999-10-27 13:42:43 +100019/* Data structure for representing option data. */
20
Damien Miller295ee632011-05-29 21:42:31 +100021#define MAX_SEND_ENV 256
Damien Miller0faf7472013-10-17 11:47:23 +110022#define SSH_MAX_HOSTS_FILES 32
23#define MAX_CANON_DOMAINS 32
Damien Miller7acefbb2014-07-18 14:11:24 +100024#define PATH_MAX_SUN (sizeof((struct sockaddr_un *)0)->sun_path)
Damien Miller0faf7472013-10-17 11:47:23 +110025
26struct allowed_cname {
27 char *source_list;
28 char *target_list;
29};
Darren Tucker46bc0752004-05-02 22:11:30 +100030
Damien Miller95def091999-11-25 00:26:21 +110031typedef struct {
32 int forward_agent; /* Forward authentication agent. */
33 int forward_x11; /* Forward X11 display. */
Damien Miller1ab6a512010-06-26 10:02:24 +100034 int forward_x11_timeout; /* Expiration for Cookies */
Darren Tucker0a118da2003-10-15 15:54:32 +100035 int forward_x11_trusted; /* Trust Forward X11 display. */
Darren Tuckere7d4b192006-07-12 22:17:10 +100036 int exit_on_forward_failure; /* Exit if bind(2) fails for -L/-R */
Damien Millerd3a18572000-06-07 19:55:44 +100037 char *xauth_location; /* Location for xauth program */
Damien Miller7acefbb2014-07-18 14:11:24 +100038 struct ForwardOptions fwd_opts; /* forwarding options */
Damien Miller95def091999-11-25 00:26:21 +110039 int use_privileged_port; /* Don't use privileged port if false. */
Damien Miller0bc1bd82000-11-13 22:57:25 +110040 int pubkey_authentication; /* Try ssh2 pubkey authentication. */
Ben Lindstrom5eabda32001-04-12 23:34:34 +000041 int hostbased_authentication; /* ssh2's rhosts_rsa */
Ben Lindstrom551ea372001-06-05 18:56:16 +000042 int challenge_response_authentication;
Ben Lindstrom95fb2dd2001-01-23 03:12:10 +000043 /* Try S/Key or TIS, authentication. */
Darren Tucker0efd1552003-08-26 11:49:55 +100044 int gss_authentication; /* Try GSS authentication */
45 int gss_deleg_creds; /* Delegate GSS credentials */
Damien Miller95def091999-11-25 00:26:21 +110046 int password_authentication; /* Try password
47 * authentication. */
Damien Miller874d77b2000-10-14 16:23:11 +110048 int kbd_interactive_authentication; /* Try keyboard-interactive auth. */
49 char *kbd_interactive_devices; /* Keyboard-interactive auth devices. */
Damien Miller95def091999-11-25 00:26:21 +110050 int batch_mode; /* Batch mode: do not ask for passwords. */
51 int check_host_ip; /* Also keep track of keys for IP address */
52 int strict_host_key_checking; /* Strict host key checking. */
53 int compression; /* Compress packets in both directions. */
Damien Miller12c150e2003-12-17 16:31:10 +110054 int tcp_keep_alive; /* Set SO_KEEPALIVE. */
Damien Miller0dac6fb2010-11-20 15:19:38 +110055 int ip_qos_interactive; /* IP ToS/DSCP/class for interactive */
56 int ip_qos_bulk; /* IP ToS/DSCP/class for bulk traffic */
dtucker@openbsd.org68d3a2a2017-04-28 03:20:27 +000057 SyslogFacility log_facility; /* Facility for system logging. */
Damien Miller95def091999-11-25 00:26:21 +110058 LogLevel log_level; /* Level for logging. */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100059
Damien Miller95def091999-11-25 00:26:21 +110060 int port; /* Port to connect. */
Darren Tucker0a4f04b2003-07-03 20:37:47 +100061 int address_family;
Damien Miller95def091999-11-25 00:26:21 +110062 int connection_attempts; /* Max attempts (seconds) before
63 * giving up */
Damien Millerb78d5eb2003-05-16 11:39:04 +100064 int connection_timeout; /* Max time (seconds) before
Damien Millera8e06ce2003-11-21 23:48:55 +110065 * aborting connection attempt */
Damien Miller95def091999-11-25 00:26:21 +110066 int number_of_password_prompts; /* Max number of password
67 * prompts. */
Damien Miller30c3d422000-05-09 11:02:59 +100068 char *ciphers; /* SSH2 ciphers in order of preference. */
Ben Lindstrom06b33aa2001-02-15 03:01:59 +000069 char *macs; /* SSH2 macs in order of preference. */
Ben Lindstrom982dbbc2001-04-17 18:11:36 +000070 char *hostkeyalgorithms; /* SSH2 server key types in order of preference. */
Damien Millerd5f62bf2010-09-24 22:11:14 +100071 char *kex_algorithms; /* SSH2 kex methods in order of preference. */
Damien Miller95def091999-11-25 00:26:21 +110072 char *hostname; /* Real host to connect. */
Ben Lindstrom4dccfa52000-12-28 16:40:05 +000073 char *host_key_alias; /* hostname alias for .ssh/known_hosts */
Damien Miller95def091999-11-25 00:26:21 +110074 char *proxy_command; /* Proxy command for connecting the host. */
75 char *user; /* User to log in as. */
76 int escape_char; /* Escape character; -2 = none */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100077
Damien Miller295ee632011-05-29 21:42:31 +100078 u_int num_system_hostfiles; /* Paths for /etc/ssh/ssh_known_hosts */
79 char *system_hostfiles[SSH_MAX_HOSTS_FILES];
80 u_int num_user_hostfiles; /* Path for $HOME/.ssh/known_hosts */
81 char *user_hostfiles[SSH_MAX_HOSTS_FILES];
Ben Lindstromb9be60a2001-03-11 01:49:19 +000082 char *preferred_authentications;
Ben Lindstrome0f88042001-04-30 13:06:24 +000083 char *bind_address; /* local socket address for connection to sshd */
Damien Miller7ea845e2010-02-12 09:21:02 +110084 char *pkcs11_provider; /* PKCS#11 provider */
Damien Miller37876e92003-05-15 10:19:46 +100085 int verify_host_key_dns; /* Verify host key using DNS */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100086
Damien Miller0bc1bd82000-11-13 22:57:25 +110087 int num_identity_files; /* Number of files for RSA/DSA identities. */
Damien Miller95def091999-11-25 00:26:21 +110088 char *identity_files[SSH_MAX_IDENTITY_FILES];
Darren Tucker19104782013-04-05 11:13:08 +110089 int identity_file_userprovided[SSH_MAX_IDENTITY_FILES];
djm@openbsd.org1129dcf2015-01-15 09:40:00 +000090 struct sshkey *identity_keys[SSH_MAX_IDENTITY_FILES];
Damien Millerd4a8b7e1999-10-27 13:42:43 +100091
djm@openbsd.org4e44a792015-09-24 06:15:11 +000092 int num_certificate_files; /* Number of extra certificates for ssh. */
93 char *certificate_files[SSH_MAX_CERTIFICATE_FILES];
94 int certificate_file_userprovided[SSH_MAX_CERTIFICATE_FILES];
95 struct sshkey *certificates[SSH_MAX_CERTIFICATE_FILES];
96
jcs@openbsd.orgf361df42015-11-15 22:26:49 +000097 int add_keys_to_agent;
markus@openbsd.orgb02ad1c2016-05-04 12:21:53 +000098 char *identity_agent; /* Optional path to ssh-agent socket */
jcs@openbsd.orgf361df42015-11-15 22:26:49 +000099
Damien Miller95def091999-11-25 00:26:21 +1100100 /* Local TCP/IP forward requests. */
101 int num_local_forwards;
Damien Miller7acefbb2014-07-18 14:11:24 +1000102 struct Forward *local_forwards;
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000103
Damien Miller95def091999-11-25 00:26:21 +1100104 /* Remote TCP/IP forward requests. */
105 int num_remote_forwards;
Damien Miller7acefbb2014-07-18 14:11:24 +1000106 struct Forward *remote_forwards;
Ben Lindstrom2b7a0e92001-09-20 00:57:55 +0000107 int clear_forwardings;
Ben Lindstromb6df73b2002-11-09 15:52:31 +0000108
dtucker@openbsd.org8543ff32016-06-03 03:14:41 +0000109 /* stdio forwarding (-W) host and port */
110 char *stdio_forward_host;
111 int stdio_forward_port;
112
Ben Lindstromb6df73b2002-11-09 15:52:31 +0000113 int enable_ssh_keysign;
Damien Miller3dff1762008-02-10 22:25:52 +1100114 int64_t rekey_limit;
Darren Tuckerc53c2af2013-05-16 20:28:16 +1000115 int rekey_interval;
Ben Lindstrom3cecc9a2001-10-03 17:39:38 +0000116 int no_host_authentication_for_localhost;
Damien Millerbd394c32004-03-08 23:12:36 +1100117 int identities_only;
Darren Tuckerfc959702004-07-17 16:12:08 +1000118 int server_alive_interval;
Damien Miller509b0102003-12-17 16:33:10 +1100119 int server_alive_count_max;
Darren Tucker46bc0752004-05-02 22:11:30 +1000120
121 int num_send_env;
122 char *send_env[MAX_SEND_ENV];
Damien Miller0e220db2004-06-15 10:34:08 +1000123
124 char *control_path;
125 int control_master;
Damien Millere11e1ea2010-08-03 16:04:46 +1000126 int control_persist; /* ControlPersist flag */
127 int control_persist_timeout; /* ControlPersist timeout (seconds) */
Damien Millere1776152005-03-01 21:47:37 +1100128
129 int hash_known_hosts;
Damien Millerd27b9472005-12-13 19:29:02 +1100130
131 int tun_open; /* tun(4) */
132 int tun_local; /* force tun device (optional) */
133 int tun_remote; /* force tun device (optional) */
134
135 char *local_command;
136 int permit_local_command;
bluhm@openbsd.org1112b532017-05-30 18:58:37 +0000137 char *remote_command;
Damien Miller10288242008-06-30 00:04:03 +1000138 int visual_host_key;
Damien Millerd27b9472005-12-13 19:29:02 +1100139
Damien Miller21771e22011-05-15 08:45:50 +1000140 int request_tty;
Darren Tucker07636982013-05-16 20:30:03 +1000141
Damien Miller1262b662013-08-21 02:44:24 +1000142 int proxy_use_fdpass;
143
Damien Miller0faf7472013-10-17 11:47:23 +1100144 int num_canonical_domains;
145 char *canonical_domains[MAX_CANON_DOMAINS];
Damien Miller38505592013-10-17 11:48:13 +1100146 int canonicalize_hostname;
147 int canonicalize_max_dots;
148 int canonicalize_fallback_local;
Damien Miller0faf7472013-10-17 11:47:23 +1100149 int num_permitted_cnames;
150 struct allowed_cname permitted_cnames[MAX_CANON_DOMAINS];
151
djm@openbsd.org5e39a492014-12-04 02:24:32 +0000152 char *revoked_host_keys;
153
djm@openbsd.org8d4f8722015-01-26 03:04:45 +0000154 int fingerprint_hash;
155
djm@openbsd.org523463a2015-02-16 22:13:32 +0000156 int update_hostkeys; /* one of SSH_UPDATE_HOSTKEYS_* */
djm@openbsd.org56d1c832014-12-21 22:27:55 +0000157
markus@openbsd.org3a1638d2015-07-10 06:21:53 +0000158 char *hostbased_key_types;
159 char *pubkey_key_types;
djm@openbsd.org46347ed2015-01-30 11:43:14 +0000160
djm@openbsd.orged877ef2016-07-15 00:24:30 +0000161 char *jump_user;
162 char *jump_host;
163 int jump_port;
164 char *jump_extra;
165
Darren Tucker07636982013-05-16 20:30:03 +1000166 char *ignored_unknown; /* Pattern list of unknown tokens to ignore */
Damien Miller95def091999-11-25 00:26:21 +1100167} Options;
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000168
Damien Miller0faf7472013-10-17 11:47:23 +1100169#define SSH_CANONICALISE_NO 0
170#define SSH_CANONICALISE_YES 1
171#define SSH_CANONICALISE_ALWAYS 2
172
Damien Millerd14b1e72005-06-16 13:19:41 +1000173#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
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000178
Damien Miller21771e22011-05-15 08:45:50 +1000179#define REQUEST_TTY_AUTO 0
180#define REQUEST_TTY_NO 1
181#define REQUEST_TTY_YES 2
182#define REQUEST_TTY_FORCE 3
183
Darren Tuckeraefa3682013-04-05 11:18:35 +1100184#define SSHCONF_CHECKPERM 1 /* check permissions on config file */
185#define SSHCONF_USERCONF 2 /* user provided config file not system */
djm@openbsd.org957fbce2014-10-08 22:20:25 +0000186#define SSHCONF_POSTCANON 4 /* After hostname canonicalisation */
djm@openbsd.orgdc7990b2016-04-15 00:30:19 +0000187#define SSHCONF_NEVERMATCH 8 /* Match/Host never matches; internal only */
Darren Tuckeraefa3682013-04-05 11:18:35 +1100188
djm@openbsd.org523463a2015-02-16 22:13:32 +0000189#define SSH_UPDATE_HOSTKEYS_NO 0
190#define SSH_UPDATE_HOSTKEYS_YES 1
191#define SSH_UPDATE_HOSTKEYS_ASK 2
192
djm@openbsd.org22376d22017-09-03 23:33:13 +0000193#define SSH_STRICT_HOSTKEY_OFF 0
194#define SSH_STRICT_HOSTKEY_NEW 1
195#define SSH_STRICT_HOSTKEY_YES 2
196#define SSH_STRICT_HOSTKEY_ASK 3
197
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000198void initialize_options(Options *);
199void fill_default_options(Options *);
Damien Miller13f97b22014-02-24 15:57:55 +1100200void fill_default_options_for_canonicalization(Options *);
djm@openbsd.org957fbce2014-10-08 22:20:25 +0000201int process_config_line(Options *, struct passwd *, const char *,
202 const char *, char *, const char *, int, int *, int);
Damien Miller194fd902013-10-15 12:13:05 +1100203int read_config_file(const char *, struct passwd *, const char *,
djm@openbsd.org957fbce2014-10-08 22:20:25 +0000204 const char *, Options *, int);
Damien Miller7acefbb2014-07-18 14:11:24 +1000205int parse_forward(struct Forward *, const char *, int, int);
djm@openbsd.orged877ef2016-07-15 00:24:30 +0000206int parse_jump(const char *, Options *, int);
millert@openbsd.org887669e2017-10-21 23:06:24 +0000207int parse_ssh_uri(const char *, char **, char **, int *);
Damien Miller194fd902013-10-15 12:13:05 +1100208int default_ssh_port(void);
Damien Miller13f97b22014-02-24 15:57:55 +1100209int option_clear_or_none(const char *);
djm@openbsd.org957fbce2014-10-08 22:20:25 +0000210void dump_client_config(Options *o, const char *host);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000211
Damien Miller7acefbb2014-07-18 14:11:24 +1000212void add_local_forward(Options *, const struct Forward *);
213void add_remote_forward(Options *, const struct Forward *);
Darren Tucker19104782013-04-05 11:13:08 +1100214void add_identity_file(Options *, const char *, const char *, int);
djm@openbsd.org4e44a792015-09-24 06:15:11 +0000215void add_certificate_file(Options *, const char *, int);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000216
Damien Miller95def091999-11-25 00:26:21 +1100217#endif /* READCONF_H */