blob: 5483da0511d84bad11046678c62cc85e42cc8081 [file] [log] [blame]
dtucker@openbsd.orge826bbc2019-04-18 18:56:16 +00001/* $OpenBSD: servconf.h,v 1.140 2019/04/18 18:56:16 dtucker 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 * Definitions for server configuration data and for the functions reading it.
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 SERVCONF_H
17#define SERVCONF_H
18
Damien Miller34132e52000-01-14 15:45:46 +110019#define MAX_PORTS 256 /* Max # ports. */
20
Damien Millerf6d9e222000-06-18 14:50:44 +100021#define MAX_SUBSYSTEMS 256 /* Max # subsystems. */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100022
Ben Lindstromd8a90212001-02-15 03:08:27 +000023/* permit_root_login */
24#define PERMIT_NOT_SET -1
25#define PERMIT_NO 0
26#define PERMIT_FORCED_ONLY 1
27#define PERMIT_NO_PASSWD 2
28#define PERMIT_YES 3
29
Damien Miller69ff1df2011-06-23 08:30:03 +100030/* use_privsep */
31#define PRIVSEP_OFF 0
32#define PRIVSEP_ON 1
Damien Miller5a5c2b92012-07-31 12:21:34 +100033#define PRIVSEP_NOSANDBOX 2
Damien Miller69ff1df2011-06-23 08:30:03 +100034
djm@openbsd.orgdbee4112017-09-12 06:32:07 +000035/* PermitOpen */
36#define PERMITOPEN_ANY 0
37#define PERMITOPEN_NONE -2
38
Darren Tucker89413db2004-05-24 10:36:23 +100039#define DEFAULT_AUTH_FAIL_MAX 6 /* Default for MaxAuthTries */
Damien Miller7207f642008-05-19 15:34:50 +100040#define DEFAULT_SESSIONS_MAX 10 /* Default for MaxSessions */
Ben Lindstromd8a90212001-02-15 03:08:27 +000041
Damien Miller76e95da2008-03-07 18:31:24 +110042/* Magic name for internal sftp-server */
43#define INTERNAL_SFTP_NAME "internal-sftp"
44
djm@openbsd.orgdbee4112017-09-12 06:32:07 +000045struct ssh;
46struct fwd_perm_list;
47
djm@openbsd.orgacf559e2017-10-25 00:15:35 +000048/*
49 * Used to store addresses from ListenAddr directives. These may be
50 * incomplete, as they may specify addresses that need to be merged
51 * with any ports requested by ListenPort.
52 */
53struct queued_listenaddr {
54 char *addr;
55 int port; /* <=0 if unspecified */
56 char *rdomain;
57};
58
59/* Resolved listen addresses, grouped by optional routing domain */
60struct listenaddr {
61 char *rdomain;
62 struct addrinfo *addrs;
63};
64
Damien Miller95def091999-11-25 00:26:21 +110065typedef struct {
Damien Miller3dc71ad2009-01-28 16:31:22 +110066 u_int num_ports;
67 u_int ports_from_cmdline;
68 int ports[MAX_PORTS]; /* Port number to listen on. */
djm@openbsd.orgacf559e2017-10-25 00:15:35 +000069 struct queued_listenaddr *queued_listen_addrs;
dtucker@openbsd.org531a57a2015-04-29 03:48:56 +000070 u_int num_queued_listens;
djm@openbsd.orgacf559e2017-10-25 00:15:35 +000071 struct listenaddr *listen_addrs;
72 u_int num_listen_addrs;
Damien Miller6f722802017-10-20 12:52:50 +110073 int address_family; /* Address family used by the server. */
74
djm@openbsd.org35eb33f2017-10-25 00:17:08 +000075 char *routing_domain; /* Bind session to routing domain */
76
Damien Miller6f722802017-10-20 12:52:50 +110077 char **host_key_files; /* Files containing host keys. */
djm@openbsd.org928f1232018-11-19 04:12:32 +000078 int *host_key_file_userprovided; /* Key was specified by user. */
Damien Miller6f722802017-10-20 12:52:50 +110079 u_int num_host_key_files; /* Number of files for host keys. */
80 char **host_cert_files; /* Files containing host certs. */
81 u_int num_host_cert_files; /* Number of files for host certs. */
82
83 char *host_key_agent; /* ssh-agent socket for host keys. */
84 char *pid_file; /* Where to put our pid */
Damien Miller95def091999-11-25 00:26:21 +110085 int login_grace_time; /* Disconnect if no auth in this time
86 * (sec). */
Ben Lindstromd8a90212001-02-15 03:08:27 +000087 int permit_root_login; /* PERMIT_*, see above */
Damien Miller95def091999-11-25 00:26:21 +110088 int ignore_rhosts; /* Ignore .rhosts and .shosts. */
89 int ignore_user_known_hosts; /* Ignore ~/.ssh/known_hosts
90 * for RhostsRsaAuth */
91 int print_motd; /* If true, print /etc/motd. */
Ben Lindstrom7bfff362001-03-26 05:45:53 +000092 int print_lastlog; /* If true, print lastlog */
Damien Miller95def091999-11-25 00:26:21 +110093 int x11_forwarding; /* If true, permit inet (spoofing) X11 fwd. */
94 int x11_display_offset; /* What DISPLAY number to start
95 * searching at */
Damien Miller95c249f2002-02-05 12:11:34 +110096 int x11_use_localhost; /* If true, use localhost for fake X11 server. */
Damien Millerd3a18572000-06-07 19:55:44 +100097 char *xauth_location; /* Location of xauth program */
Damien Miller5ff30c62013-10-30 22:21:50 +110098 int permit_tty; /* If false, deny pty allocation */
Damien Miller72e6b5c2014-07-04 09:00:04 +100099 int permit_user_rc; /* If false, deny ~/.ssh/rc execution */
Damien Miller95def091999-11-25 00:26:21 +1100100 int strict_modes; /* If true, require string home dir modes. */
Damien Miller12c150e2003-12-17 16:31:10 +1100101 int tcp_keep_alive; /* If true, set SO_KEEPALIVE. */
Damien Miller0dac6fb2010-11-20 15:19:38 +1100102 int ip_qos_interactive; /* IP ToS/DSCP/class for interactive */
103 int ip_qos_bulk; /* IP ToS/DSCP/class for bulk traffic */
Ben Lindstrom06b33aa2001-02-15 03:01:59 +0000104 char *ciphers; /* Supported SSH2 ciphers. */
105 char *macs; /* Supported SSH2 macs. */
Damien Millerd5f62bf2010-09-24 22:11:14 +1000106 char *kex_algorithms; /* SSH2 kex methods in order of preference. */
Damien Miller7acefbb2014-07-18 14:11:24 +1000107 struct ForwardOptions fwd_opts; /* forwarding options */
Damien Miller95def091999-11-25 00:26:21 +1100108 SyslogFacility log_facility; /* Facility for system logging. */
109 LogLevel log_level; /* Level for system logging. */
Ben Lindstrom5eabda32001-04-12 23:34:34 +0000110 int hostbased_authentication; /* If true, permit ssh2 hostbased auth */
111 int hostbased_uses_name_from_packet_only; /* experimental */
djm@openbsd.org1f729f02015-01-13 07:39:19 +0000112 char *hostbased_key_types; /* Key types allowed for hostbased */
markus@openbsd.org3a1638d2015-07-10 06:21:53 +0000113 char *hostkeyalgorithms; /* SSH2 server key types */
djm@openbsd.org86e57372018-09-20 03:28:06 +0000114 char *ca_sign_algorithms; /* Allowed CA signature algorithms */
Damien Miller0bc1bd82000-11-13 22:57:25 +1100115 int pubkey_authentication; /* If true, permit ssh2 pubkey authentication. */
djm@openbsd.org1f729f02015-01-13 07:39:19 +0000116 char *pubkey_key_types; /* Key types allowed for public key */
Damien Miller95def091999-11-25 00:26:21 +1100117 int kerberos_authentication; /* If true, permit Kerberos
118 * authentication. */
119 int kerberos_or_local_passwd; /* If true, permit kerberos
120 * and any other password
121 * authentication mechanism,
122 * such as SecurID or
123 * /etc/passwd */
124 int kerberos_ticket_cleanup; /* If true, destroy ticket
125 * file on logout. */
Darren Tucker22ef5082003-12-31 11:37:34 +1100126 int kerberos_get_afs_token; /* If true, try to get AFS token if
127 * authenticated with Kerberos. */
Darren Tucker0efd1552003-08-26 11:49:55 +1000128 int gss_authentication; /* If true, permit GSSAPI authentication */
129 int gss_cleanup_creds; /* If true, destroy cred cache on logout */
djm@openbsd.orgd7c31da2015-05-22 03:50:02 +0000130 int gss_strict_acceptor; /* If true, restrict the GSSAPI acceptor name */
Damien Miller95def091999-11-25 00:26:21 +1100131 int password_authentication; /* If true, permit password
132 * authentication. */
Damien Miller874d77b2000-10-14 16:23:11 +1100133 int kbd_interactive_authentication; /* If true, permit */
Ben Lindstrom551ea372001-06-05 18:56:16 +0000134 int challenge_response_authentication;
Damien Miller95def091999-11-25 00:26:21 +1100135 int permit_empty_passwd; /* If false, do not permit empty
136 * passwords. */
Ben Lindstrom5d860f02002-08-01 01:28:38 +0000137 int permit_user_env; /* If true, read ~/.ssh/environment */
djm@openbsd.org95344c22018-07-03 10:59:35 +0000138 char *permit_user_env_whitelist; /* pattern-list whitelist */
Ben Lindstrom23e0f662002-06-21 01:09:47 +0000139 int compression; /* If true, compression is allowed */
Damien Milleraa5b3f82012-12-03 09:50:54 +1100140 int allow_tcp_forwarding; /* One of FORWARD_* */
Damien Miller7acefbb2014-07-18 14:11:24 +1000141 int allow_streamlocal_forwarding; /* One of FORWARD_* */
Damien Miller4f755cd2008-05-19 14:57:41 +1000142 int allow_agent_forwarding;
djm@openbsd.org7844f352016-11-30 03:00:05 +0000143 int disable_forwarding;
Ben Lindstrom46c16222000-12-22 01:43:59 +0000144 u_int num_allow_users;
Damien Miller6f722802017-10-20 12:52:50 +1100145 char **allow_users;
Ben Lindstrom46c16222000-12-22 01:43:59 +0000146 u_int num_deny_users;
Damien Miller6f722802017-10-20 12:52:50 +1100147 char **deny_users;
Ben Lindstrom46c16222000-12-22 01:43:59 +0000148 u_int num_allow_groups;
Damien Miller6f722802017-10-20 12:52:50 +1100149 char **allow_groups;
Ben Lindstrom46c16222000-12-22 01:43:59 +0000150 u_int num_deny_groups;
Damien Miller6f722802017-10-20 12:52:50 +1100151 char **deny_groups;
Damien Millerf6d9e222000-06-18 14:50:44 +1000152
Ben Lindstrom46c16222000-12-22 01:43:59 +0000153 u_int num_subsystems;
Damien Millerf6d9e222000-06-18 14:50:44 +1000154 char *subsystem_name[MAX_SUBSYSTEMS];
155 char *subsystem_command[MAX_SUBSYSTEMS];
Damien Miller917f9b62006-07-10 20:36:47 +1000156 char *subsystem_args[MAX_SUBSYSTEMS];
Damien Miller37023962000-07-11 17:31:38 +1000157
Darren Tucker46bc0752004-05-02 22:11:30 +1000158 u_int num_accept_env;
Damien Miller6f722802017-10-20 12:52:50 +1100159 char **accept_env;
djm@openbsd.org28013752018-06-09 03:03:10 +0000160 u_int num_setenv;
161 char **setenv;
Darren Tucker46bc0752004-05-02 22:11:30 +1000162
Damien Miller942da032000-08-18 13:59:06 +1000163 int max_startups_begin;
164 int max_startups_rate;
Damien Miller37023962000-07-11 17:31:38 +1000165 int max_startups;
Darren Tucker89413db2004-05-24 10:36:23 +1000166 int max_authtries;
Damien Miller7207f642008-05-19 15:34:50 +1000167 int max_sessions;
Ben Lindstrom48bd7c12001-01-09 00:35:42 +0000168 char *banner; /* SSH-2 banner message */
Damien Miller3a961dc2003-06-03 10:25:48 +1000169 int use_dns;
Ben Lindstrom5744dc42001-04-13 23:28:01 +0000170 int client_alive_interval; /*
Damien Miller9f0f5c62001-12-21 14:45:46 +1100171 * poke the client this often to
172 * see if it's still there
Ben Lindstrom5744dc42001-04-13 23:28:01 +0000173 */
174 int client_alive_count_max; /*
Ben Lindstrom7bb37b22001-09-12 16:40:05 +0000175 * If the client is unresponsive
176 * for this many intervals above,
Damien Miller9f0f5c62001-12-21 14:45:46 +1100177 * disconnect the session
Ben Lindstrom5744dc42001-04-13 23:28:01 +0000178 */
Kevin Stevese468de62001-07-04 18:37:20 +0000179
Damien Miller6f722802017-10-20 12:52:50 +1100180 u_int num_authkeys_files; /* Files containing public keys */
181 char **authorized_keys_files;
Damien Millerd27b9472005-12-13 19:29:02 +1100182
Damien Millere2754432006-07-24 14:06:47 +1000183 char *adm_forced_command;
184
Damien Miller4e448a32003-05-14 15:11:48 +1000185 int use_pam; /* Enable auth via PAM */
Damien Millerd27b9472005-12-13 19:29:02 +1100186
187 int permit_tun;
Damien Millera765cf42006-07-24 14:08:13 +1000188
djm@openbsd.org115063a2018-06-06 18:22:41 +0000189 char **permitted_opens; /* May also be one of PERMITOPEN_* */
190 u_int num_permitted_opens;
djm@openbsd.org93c06ab2018-06-06 18:23:32 +0000191 char **permitted_listens; /* May also be one of PERMITOPEN_* */
192 u_int num_permitted_listens;
Damien Millerd8cb1f12008-02-10 22:40:12 +1100193
194 char *chroot_directory;
Damien Miller1aed65e2010-03-04 21:53:35 +1100195 char *revoked_keys_file;
196 char *trusted_user_ca_keys;
Damien Miller09d3e122012-10-31 08:58:58 +1100197 char *authorized_keys_command;
198 char *authorized_keys_command_user;
djm@openbsd.orgbcc50d82015-05-21 06:43:30 +0000199 char *authorized_principals_file;
200 char *authorized_principals_command;
201 char *authorized_principals_command_user;
Damien Miller23528812012-04-22 11:24:43 +1000202
Darren Tucker5f96f3b2013-05-16 20:29:28 +1000203 int64_t rekey_limit;
204 int rekey_interval;
205
Damien Miller23528812012-04-22 11:24:43 +1000206 char *version_addendum; /* Appended to SSH banner */
Damien Millera6e3f012012-11-04 23:21:40 +1100207
208 u_int num_auth_methods;
Damien Miller6f722802017-10-20 12:52:50 +1100209 char **auth_methods;
djm@openbsd.org56d1c832014-12-21 22:27:55 +0000210
211 int fingerprint_hash;
djm@openbsd.org8f574952017-06-24 06:34:38 +0000212 int expose_userauth_info;
dtucker@openbsd.orge9d910b2018-04-13 03:57:26 +0000213 u_int64_t timing_secret;
Damien Miller95def091999-11-25 00:26:21 +1100214} ServerOptions;
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000215
Darren Tuckerfbcf8272012-05-19 19:37:01 +1000216/* Information about the incoming connection as used by Match */
217struct connection_info {
218 const char *user;
219 const char *host; /* possibly resolved hostname */
220 const char *address; /* remote address */
221 const char *laddress; /* local address */
222 int lport; /* local port */
djm@openbsd.org68af80e2017-10-25 00:19:47 +0000223 const char *rdomain; /* routing domain if available */
dtucker@openbsd.orge826bbc2019-04-18 18:56:16 +0000224 int test; /* test mode, allow some attributes to be
225 * unspecified */
Darren Tuckerfbcf8272012-05-19 19:37:01 +1000226};
227
228
Damien Millerf2e407e2011-05-20 19:04:14 +1000229/*
230 * These are string config options that must be copied between the
231 * Match sub-config and the main config, and must be sent from the
232 * privsep slave to the privsep master. We use a macro to ensure all
233 * the options are copied and the copies are done in the correct order.
Damien Miller534b2cc2013-12-05 14:07:27 +1100234 *
235 * NB. an option must appear in servconf.c:copy_set_server_options() or
236 * COPY_MATCH_STRING_OPTS here but never both.
Damien Millerf2e407e2011-05-20 19:04:14 +1000237 */
238#define COPY_MATCH_STRING_OPTS() do { \
239 M_CP_STROPT(banner); \
240 M_CP_STROPT(trusted_user_ca_keys); \
241 M_CP_STROPT(revoked_keys_file); \
Damien Miller44138442013-01-09 15:56:45 +1100242 M_CP_STROPT(authorized_keys_command); \
243 M_CP_STROPT(authorized_keys_command_user); \
djm@openbsd.orgbcc50d82015-05-21 06:43:30 +0000244 M_CP_STROPT(authorized_principals_file); \
245 M_CP_STROPT(authorized_principals_command); \
246 M_CP_STROPT(authorized_principals_command_user); \
djm@openbsd.org1f729f02015-01-13 07:39:19 +0000247 M_CP_STROPT(hostbased_key_types); \
248 M_CP_STROPT(pubkey_key_types); \
djm@openbsd.org86e57372018-09-20 03:28:06 +0000249 M_CP_STROPT(ca_sign_algorithms); \
djm@openbsd.org35eb33f2017-10-25 00:17:08 +0000250 M_CP_STROPT(routing_domain); \
djm@openbsd.org95344c22018-07-03 10:59:35 +0000251 M_CP_STROPT(permit_user_env_whitelist); \
Damien Millerd8478b62011-05-29 21:39:36 +1000252 M_CP_STRARRAYOPT(authorized_keys_files, num_authkeys_files); \
Damien Millerc24da772012-06-20 21:53:58 +1000253 M_CP_STRARRAYOPT(allow_users, num_allow_users); \
254 M_CP_STRARRAYOPT(deny_users, num_deny_users); \
255 M_CP_STRARRAYOPT(allow_groups, num_allow_groups); \
256 M_CP_STRARRAYOPT(deny_groups, num_deny_groups); \
257 M_CP_STRARRAYOPT(accept_env, num_accept_env); \
Damien Millera6e3f012012-11-04 23:21:40 +1100258 M_CP_STRARRAYOPT(auth_methods, num_auth_methods); \
Damien Miller6f722802017-10-20 12:52:50 +1100259 M_CP_STRARRAYOPT(permitted_opens, num_permitted_opens); \
djm@openbsd.org93c06ab2018-06-06 18:23:32 +0000260 M_CP_STRARRAYOPT(permitted_listens, num_permitted_listens); \
Damien Millerf2e407e2011-05-20 19:04:14 +1000261 } while (0)
262
djm@openbsd.org172a5922019-01-19 21:37:48 +0000263struct connection_info *get_connection_info(struct ssh *, int, int);
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000264void initialize_server_options(ServerOptions *);
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000265void fill_default_server_options(ServerOptions *);
Darren Tucker45150472006-07-12 22:34:17 +1000266int process_server_config_line(ServerOptions *, char *, const char *, int,
Darren Tuckerfbcf8272012-05-19 19:37:01 +1000267 int *, struct connection_info *);
djm@openbsd.orgdbee4112017-09-12 06:32:07 +0000268void process_permitopen(struct ssh *ssh, ServerOptions *options);
markus@openbsd.org2808d182018-07-09 21:26:02 +0000269void load_server_config(const char *, struct sshbuf *);
270void parse_server_config(ServerOptions *, const char *, struct sshbuf *,
Darren Tuckerfbcf8272012-05-19 19:37:01 +1000271 struct connection_info *);
272void parse_server_match_config(ServerOptions *, struct connection_info *);
273int parse_server_match_testspec(struct connection_info *, char *);
274int server_match_spec_complete(struct connection_info *);
Darren Tucker1629c072007-02-19 22:25:37 +1100275void copy_set_server_options(ServerOptions *, ServerOptions *, int);
Darren Tuckere7140f22008-06-10 23:01:51 +1000276void dump_config(ServerOptions *);
Darren Tucker88b6fb22010-01-13 22:44:29 +1100277char *derelativise_path(const char *);
Damien Miller6f722802017-10-20 12:52:50 +1100278void servconf_add_hostkey(const char *, const int,
djm@openbsd.org928f1232018-11-19 04:12:32 +0000279 ServerOptions *, const char *path, int);
Damien Miller6f722802017-10-20 12:52:50 +1100280void servconf_add_hostcert(const char *, const int,
281 ServerOptions *, const char *path);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000282
Damien Miller95def091999-11-25 00:26:21 +1100283#endif /* SERVCONF_H */