blob: 9922f0c8caf3e530fb2df8a7a6e20b69c23b327a [file] [log] [blame]
djm@openbsd.org1f729f02015-01-13 07:39:19 +00001/* $OpenBSD: servconf.h,v 1.116 2015/01/13 07:39:19 djm 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 Miller95def091999-11-25 00:26:21 +110021#define MAX_ALLOW_USERS 256 /* Max # users on allow list. */
22#define MAX_DENY_USERS 256 /* Max # users on deny list. */
23#define MAX_ALLOW_GROUPS 256 /* Max # groups on allow list. */
24#define MAX_DENY_GROUPS 256 /* Max # groups on deny list. */
Damien Millerf6d9e222000-06-18 14:50:44 +100025#define MAX_SUBSYSTEMS 256 /* Max # subsystems. */
Damien Miller0bc1bd82000-11-13 22:57:25 +110026#define MAX_HOSTKEYS 256 /* Max # hostkeys. */
Damien Miller0a80ca12010-02-27 07:55:05 +110027#define MAX_HOSTCERTS 256 /* Max # host certificates. */
Darren Tucker46bc0752004-05-02 22:11:30 +100028#define MAX_ACCEPT_ENV 256 /* Max # of env vars. */
Damien Miller565ca3f2006-08-19 00:23:15 +100029#define MAX_MATCH_GROUPS 256 /* Max # of groups for Match. */
Damien Millerd8478b62011-05-29 21:39:36 +100030#define MAX_AUTHKEYS_FILES 256 /* Max # of authorized_keys files. */
Damien Millera6e3f012012-11-04 23:21:40 +110031#define MAX_AUTH_METHODS 256 /* Max # of AuthenticationMethods. */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100032
Ben Lindstromd8a90212001-02-15 03:08:27 +000033/* permit_root_login */
34#define PERMIT_NOT_SET -1
35#define PERMIT_NO 0
36#define PERMIT_FORCED_ONLY 1
37#define PERMIT_NO_PASSWD 2
38#define PERMIT_YES 3
39
Damien Miller69ff1df2011-06-23 08:30:03 +100040/* use_privsep */
41#define PRIVSEP_OFF 0
42#define PRIVSEP_ON 1
Damien Miller5a5c2b92012-07-31 12:21:34 +100043#define PRIVSEP_NOSANDBOX 2
Damien Miller69ff1df2011-06-23 08:30:03 +100044
Damien Milleraa5b3f82012-12-03 09:50:54 +110045/* AllowTCPForwarding */
46#define FORWARD_DENY 0
47#define FORWARD_REMOTE (1)
48#define FORWARD_LOCAL (1<<1)
49#define FORWARD_ALLOW (FORWARD_REMOTE|FORWARD_LOCAL)
50
Darren Tucker89413db2004-05-24 10:36:23 +100051#define DEFAULT_AUTH_FAIL_MAX 6 /* Default for MaxAuthTries */
Damien Miller7207f642008-05-19 15:34:50 +100052#define DEFAULT_SESSIONS_MAX 10 /* Default for MaxSessions */
Ben Lindstromd8a90212001-02-15 03:08:27 +000053
Damien Miller76e95da2008-03-07 18:31:24 +110054/* Magic name for internal sftp-server */
55#define INTERNAL_SFTP_NAME "internal-sftp"
56
Damien Miller95def091999-11-25 00:26:21 +110057typedef struct {
Damien Miller3dc71ad2009-01-28 16:31:22 +110058 u_int num_ports;
59 u_int ports_from_cmdline;
60 int ports[MAX_PORTS]; /* Port number to listen on. */
Damien Miller34132e52000-01-14 15:45:46 +110061 char *listen_addr; /* Address on which the server listens. */
62 struct addrinfo *listen_addrs; /* Addresses on which the server listens. */
Darren Tucker0f383232005-01-20 10:57:56 +110063 int address_family; /* Address family used by the server. */
Damien Miller0bc1bd82000-11-13 22:57:25 +110064 char *host_key_files[MAX_HOSTKEYS]; /* Files containing host keys. */
65 int num_host_key_files; /* Number of files for host keys. */
Damien Miller0a80ca12010-02-27 07:55:05 +110066 char *host_cert_files[MAX_HOSTCERTS]; /* Files containing host certs. */
67 int num_host_cert_files; /* Number of files for host certs. */
Damien Miller85b45e02013-07-20 13:21:52 +100068 char *host_key_agent; /* ssh-agent socket for host keys. */
Damien Miller6f83b8e2000-05-02 09:23:45 +100069 char *pid_file; /* Where to put our pid */
Damien Miller95def091999-11-25 00:26:21 +110070 int server_key_bits;/* Size of the server key. */
71 int login_grace_time; /* Disconnect if no auth in this time
72 * (sec). */
73 int key_regeneration_time; /* Server key lifetime (seconds). */
Ben Lindstromd8a90212001-02-15 03:08:27 +000074 int permit_root_login; /* PERMIT_*, see above */
Damien Miller95def091999-11-25 00:26:21 +110075 int ignore_rhosts; /* Ignore .rhosts and .shosts. */
76 int ignore_user_known_hosts; /* Ignore ~/.ssh/known_hosts
77 * for RhostsRsaAuth */
78 int print_motd; /* If true, print /etc/motd. */
Ben Lindstrom7bfff362001-03-26 05:45:53 +000079 int print_lastlog; /* If true, print lastlog */
Damien Miller95def091999-11-25 00:26:21 +110080 int x11_forwarding; /* If true, permit inet (spoofing) X11 fwd. */
81 int x11_display_offset; /* What DISPLAY number to start
82 * searching at */
Damien Miller95c249f2002-02-05 12:11:34 +110083 int x11_use_localhost; /* If true, use localhost for fake X11 server. */
Damien Millerd3a18572000-06-07 19:55:44 +100084 char *xauth_location; /* Location of xauth program */
Damien Miller5ff30c62013-10-30 22:21:50 +110085 int permit_tty; /* If false, deny pty allocation */
Damien Miller72e6b5c2014-07-04 09:00:04 +100086 int permit_user_rc; /* If false, deny ~/.ssh/rc execution */
Damien Miller95def091999-11-25 00:26:21 +110087 int strict_modes; /* If true, require string home dir modes. */
Damien Miller12c150e2003-12-17 16:31:10 +110088 int tcp_keep_alive; /* If true, set SO_KEEPALIVE. */
Damien Miller0dac6fb2010-11-20 15:19:38 +110089 int ip_qos_interactive; /* IP ToS/DSCP/class for interactive */
90 int ip_qos_bulk; /* IP ToS/DSCP/class for bulk traffic */
Ben Lindstrom06b33aa2001-02-15 03:01:59 +000091 char *ciphers; /* Supported SSH2 ciphers. */
92 char *macs; /* Supported SSH2 macs. */
Damien Millerd5f62bf2010-09-24 22:11:14 +100093 char *kex_algorithms; /* SSH2 kex methods in order of preference. */
Ben Lindstrom06b33aa2001-02-15 03:01:59 +000094 int protocol; /* Supported protocol versions. */
Damien Miller7acefbb2014-07-18 14:11:24 +100095 struct ForwardOptions fwd_opts; /* forwarding options */
Damien Miller95def091999-11-25 00:26:21 +110096 SyslogFacility log_facility; /* Facility for system logging. */
97 LogLevel log_level; /* Level for system logging. */
Damien Miller95def091999-11-25 00:26:21 +110098 int rhosts_rsa_authentication; /* If true, permit rhosts RSA
99 * authentication. */
Ben Lindstrom5eabda32001-04-12 23:34:34 +0000100 int hostbased_authentication; /* If true, permit ssh2 hostbased auth */
101 int hostbased_uses_name_from_packet_only; /* experimental */
djm@openbsd.org1f729f02015-01-13 07:39:19 +0000102 char *hostbased_key_types; /* Key types allowed for hostbased */
Damien Miller95def091999-11-25 00:26:21 +1100103 int rsa_authentication; /* If true, permit RSA authentication. */
Damien Miller0bc1bd82000-11-13 22:57:25 +1100104 int pubkey_authentication; /* If true, permit ssh2 pubkey authentication. */
djm@openbsd.org1f729f02015-01-13 07:39:19 +0000105 char *pubkey_key_types; /* Key types allowed for public key */
Damien Miller95def091999-11-25 00:26:21 +1100106 int kerberos_authentication; /* If true, permit Kerberos
107 * authentication. */
108 int kerberos_or_local_passwd; /* If true, permit kerberos
109 * and any other password
110 * authentication mechanism,
111 * such as SecurID or
112 * /etc/passwd */
113 int kerberos_ticket_cleanup; /* If true, destroy ticket
114 * file on logout. */
Darren Tucker22ef5082003-12-31 11:37:34 +1100115 int kerberos_get_afs_token; /* If true, try to get AFS token if
116 * authenticated with Kerberos. */
Darren Tucker0efd1552003-08-26 11:49:55 +1000117 int gss_authentication; /* If true, permit GSSAPI authentication */
118 int gss_cleanup_creds; /* If true, destroy cred cache on logout */
Damien Miller95def091999-11-25 00:26:21 +1100119 int password_authentication; /* If true, permit password
120 * authentication. */
Damien Miller874d77b2000-10-14 16:23:11 +1100121 int kbd_interactive_authentication; /* If true, permit */
Ben Lindstrom551ea372001-06-05 18:56:16 +0000122 int challenge_response_authentication;
Damien Miller95def091999-11-25 00:26:21 +1100123 int permit_empty_passwd; /* If false, do not permit empty
124 * passwords. */
Ben Lindstrom5d860f02002-08-01 01:28:38 +0000125 int permit_user_env; /* If true, read ~/.ssh/environment */
Damien Miller95def091999-11-25 00:26:21 +1100126 int use_login; /* If true, login(1) is used */
Ben Lindstrom23e0f662002-06-21 01:09:47 +0000127 int compression; /* If true, compression is allowed */
Damien Milleraa5b3f82012-12-03 09:50:54 +1100128 int allow_tcp_forwarding; /* One of FORWARD_* */
Damien Miller7acefbb2014-07-18 14:11:24 +1000129 int allow_streamlocal_forwarding; /* One of FORWARD_* */
Damien Miller4f755cd2008-05-19 14:57:41 +1000130 int allow_agent_forwarding;
Ben Lindstrom46c16222000-12-22 01:43:59 +0000131 u_int num_allow_users;
Damien Miller95def091999-11-25 00:26:21 +1100132 char *allow_users[MAX_ALLOW_USERS];
Ben Lindstrom46c16222000-12-22 01:43:59 +0000133 u_int num_deny_users;
Damien Miller95def091999-11-25 00:26:21 +1100134 char *deny_users[MAX_DENY_USERS];
Ben Lindstrom46c16222000-12-22 01:43:59 +0000135 u_int num_allow_groups;
Damien Miller95def091999-11-25 00:26:21 +1100136 char *allow_groups[MAX_ALLOW_GROUPS];
Ben Lindstrom46c16222000-12-22 01:43:59 +0000137 u_int num_deny_groups;
Damien Miller95def091999-11-25 00:26:21 +1100138 char *deny_groups[MAX_DENY_GROUPS];
Damien Millerf6d9e222000-06-18 14:50:44 +1000139
Ben Lindstrom46c16222000-12-22 01:43:59 +0000140 u_int num_subsystems;
Damien Millerf6d9e222000-06-18 14:50:44 +1000141 char *subsystem_name[MAX_SUBSYSTEMS];
142 char *subsystem_command[MAX_SUBSYSTEMS];
Damien Miller917f9b62006-07-10 20:36:47 +1000143 char *subsystem_args[MAX_SUBSYSTEMS];
Damien Miller37023962000-07-11 17:31:38 +1000144
Darren Tucker46bc0752004-05-02 22:11:30 +1000145 u_int num_accept_env;
146 char *accept_env[MAX_ACCEPT_ENV];
147
Damien Miller942da032000-08-18 13:59:06 +1000148 int max_startups_begin;
149 int max_startups_rate;
Damien Miller37023962000-07-11 17:31:38 +1000150 int max_startups;
Darren Tucker89413db2004-05-24 10:36:23 +1000151 int max_authtries;
Damien Miller7207f642008-05-19 15:34:50 +1000152 int max_sessions;
Ben Lindstrom48bd7c12001-01-09 00:35:42 +0000153 char *banner; /* SSH-2 banner message */
Damien Miller3a961dc2003-06-03 10:25:48 +1000154 int use_dns;
Ben Lindstrom5744dc42001-04-13 23:28:01 +0000155 int client_alive_interval; /*
Damien Miller9f0f5c62001-12-21 14:45:46 +1100156 * poke the client this often to
157 * see if it's still there
Ben Lindstrom5744dc42001-04-13 23:28:01 +0000158 */
159 int client_alive_count_max; /*
Ben Lindstrom7bb37b22001-09-12 16:40:05 +0000160 * If the client is unresponsive
161 * for this many intervals above,
Damien Miller9f0f5c62001-12-21 14:45:46 +1100162 * disconnect the session
Ben Lindstrom5744dc42001-04-13 23:28:01 +0000163 */
Kevin Stevese468de62001-07-04 18:37:20 +0000164
Damien Millerd8478b62011-05-29 21:39:36 +1000165 u_int num_authkeys_files; /* Files containing public keys */
166 char *authorized_keys_files[MAX_AUTHKEYS_FILES];
Damien Millerd27b9472005-12-13 19:29:02 +1100167
Damien Millere2754432006-07-24 14:06:47 +1000168 char *adm_forced_command;
169
Damien Miller4e448a32003-05-14 15:11:48 +1000170 int use_pam; /* Enable auth via PAM */
Damien Millerd27b9472005-12-13 19:29:02 +1100171
172 int permit_tun;
Damien Millera765cf42006-07-24 14:08:13 +1000173
174 int num_permitted_opens;
Damien Millerd8cb1f12008-02-10 22:40:12 +1100175
176 char *chroot_directory;
Damien Miller1aed65e2010-03-04 21:53:35 +1100177 char *revoked_keys_file;
178 char *trusted_user_ca_keys;
Damien Miller30da3442010-05-10 11:58:03 +1000179 char *authorized_principals_file;
Damien Miller09d3e122012-10-31 08:58:58 +1100180 char *authorized_keys_command;
181 char *authorized_keys_command_user;
Damien Miller23528812012-04-22 11:24:43 +1000182
Darren Tucker5f96f3b2013-05-16 20:29:28 +1000183 int64_t rekey_limit;
184 int rekey_interval;
185
Damien Miller23528812012-04-22 11:24:43 +1000186 char *version_addendum; /* Appended to SSH banner */
Damien Millera6e3f012012-11-04 23:21:40 +1100187
188 u_int num_auth_methods;
189 char *auth_methods[MAX_AUTH_METHODS];
djm@openbsd.org56d1c832014-12-21 22:27:55 +0000190
191 int fingerprint_hash;
Damien Miller95def091999-11-25 00:26:21 +1100192} ServerOptions;
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000193
Darren Tuckerfbcf8272012-05-19 19:37:01 +1000194/* Information about the incoming connection as used by Match */
195struct connection_info {
196 const char *user;
197 const char *host; /* possibly resolved hostname */
198 const char *address; /* remote address */
199 const char *laddress; /* local address */
200 int lport; /* local port */
201};
202
203
Damien Millerf2e407e2011-05-20 19:04:14 +1000204/*
205 * These are string config options that must be copied between the
206 * Match sub-config and the main config, and must be sent from the
207 * privsep slave to the privsep master. We use a macro to ensure all
208 * the options are copied and the copies are done in the correct order.
Damien Miller534b2cc2013-12-05 14:07:27 +1100209 *
210 * NB. an option must appear in servconf.c:copy_set_server_options() or
211 * COPY_MATCH_STRING_OPTS here but never both.
Damien Millerf2e407e2011-05-20 19:04:14 +1000212 */
213#define COPY_MATCH_STRING_OPTS() do { \
214 M_CP_STROPT(banner); \
215 M_CP_STROPT(trusted_user_ca_keys); \
216 M_CP_STROPT(revoked_keys_file); \
Damien Millerf2e407e2011-05-20 19:04:14 +1000217 M_CP_STROPT(authorized_principals_file); \
Damien Miller44138442013-01-09 15:56:45 +1100218 M_CP_STROPT(authorized_keys_command); \
219 M_CP_STROPT(authorized_keys_command_user); \
djm@openbsd.org1f729f02015-01-13 07:39:19 +0000220 M_CP_STROPT(hostbased_key_types); \
221 M_CP_STROPT(pubkey_key_types); \
Damien Millerd8478b62011-05-29 21:39:36 +1000222 M_CP_STRARRAYOPT(authorized_keys_files, num_authkeys_files); \
Damien Millerc24da772012-06-20 21:53:58 +1000223 M_CP_STRARRAYOPT(allow_users, num_allow_users); \
224 M_CP_STRARRAYOPT(deny_users, num_deny_users); \
225 M_CP_STRARRAYOPT(allow_groups, num_allow_groups); \
226 M_CP_STRARRAYOPT(deny_groups, num_deny_groups); \
227 M_CP_STRARRAYOPT(accept_env, num_accept_env); \
Damien Millera6e3f012012-11-04 23:21:40 +1100228 M_CP_STRARRAYOPT(auth_methods, num_auth_methods); \
Damien Millerf2e407e2011-05-20 19:04:14 +1000229 } while (0)
230
Darren Tuckerfbcf8272012-05-19 19:37:01 +1000231struct connection_info *get_connection_info(int, int);
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000232void initialize_server_options(ServerOptions *);
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000233void fill_default_server_options(ServerOptions *);
Darren Tucker45150472006-07-12 22:34:17 +1000234int process_server_config_line(ServerOptions *, char *, const char *, int,
Darren Tuckerfbcf8272012-05-19 19:37:01 +1000235 int *, struct connection_info *);
Darren Tucker645ab752004-06-25 13:33:20 +1000236void load_server_config(const char *, Buffer *);
Darren Tucker45150472006-07-12 22:34:17 +1000237void parse_server_config(ServerOptions *, const char *, Buffer *,
Darren Tuckerfbcf8272012-05-19 19:37:01 +1000238 struct connection_info *);
239void parse_server_match_config(ServerOptions *, struct connection_info *);
240int parse_server_match_testspec(struct connection_info *, char *);
241int server_match_spec_complete(struct connection_info *);
Darren Tucker1629c072007-02-19 22:25:37 +1100242void copy_set_server_options(ServerOptions *, ServerOptions *, int);
Darren Tuckere7140f22008-06-10 23:01:51 +1000243void dump_config(ServerOptions *);
Darren Tucker88b6fb22010-01-13 22:44:29 +1100244char *derelativise_path(const char *);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000245
Damien Miller95def091999-11-25 00:26:21 +1100246#endif /* SERVCONF_H */