blob: 89f38e20f0bdb085f8f4ecf3ded95abca301bfe9 [file] [log] [blame]
Damien Miller69ff1df2011-06-23 08:30:03 +10001/* $OpenBSD: servconf.h,v 1.99 2011/06/22 21:57:01 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 Millerd4a8b7e1999-10-27 13:42:43 +100031
Ben Lindstromd8a90212001-02-15 03:08:27 +000032/* permit_root_login */
33#define PERMIT_NOT_SET -1
34#define PERMIT_NO 0
35#define PERMIT_FORCED_ONLY 1
36#define PERMIT_NO_PASSWD 2
37#define PERMIT_YES 3
38
Damien Miller69ff1df2011-06-23 08:30:03 +100039/* use_privsep */
40#define PRIVSEP_OFF 0
41#define PRIVSEP_ON 1
42#define PRIVSEP_SANDBOX 2
43
Darren Tucker89413db2004-05-24 10:36:23 +100044#define DEFAULT_AUTH_FAIL_MAX 6 /* Default for MaxAuthTries */
Damien Miller7207f642008-05-19 15:34:50 +100045#define DEFAULT_SESSIONS_MAX 10 /* Default for MaxSessions */
Ben Lindstromd8a90212001-02-15 03:08:27 +000046
Damien Miller76e95da2008-03-07 18:31:24 +110047/* Magic name for internal sftp-server */
48#define INTERNAL_SFTP_NAME "internal-sftp"
49
Damien Miller95def091999-11-25 00:26:21 +110050typedef struct {
Damien Miller3dc71ad2009-01-28 16:31:22 +110051 u_int num_ports;
52 u_int ports_from_cmdline;
53 int ports[MAX_PORTS]; /* Port number to listen on. */
Damien Miller34132e52000-01-14 15:45:46 +110054 char *listen_addr; /* Address on which the server listens. */
55 struct addrinfo *listen_addrs; /* Addresses on which the server listens. */
Darren Tucker0f383232005-01-20 10:57:56 +110056 int address_family; /* Address family used by the server. */
Damien Miller0bc1bd82000-11-13 22:57:25 +110057 char *host_key_files[MAX_HOSTKEYS]; /* Files containing host keys. */
58 int num_host_key_files; /* Number of files for host keys. */
Damien Miller0a80ca12010-02-27 07:55:05 +110059 char *host_cert_files[MAX_HOSTCERTS]; /* Files containing host certs. */
60 int num_host_cert_files; /* Number of files for host certs. */
Damien Miller6f83b8e2000-05-02 09:23:45 +100061 char *pid_file; /* Where to put our pid */
Damien Miller95def091999-11-25 00:26:21 +110062 int server_key_bits;/* Size of the server key. */
63 int login_grace_time; /* Disconnect if no auth in this time
64 * (sec). */
65 int key_regeneration_time; /* Server key lifetime (seconds). */
Ben Lindstromd8a90212001-02-15 03:08:27 +000066 int permit_root_login; /* PERMIT_*, see above */
Damien Miller95def091999-11-25 00:26:21 +110067 int ignore_rhosts; /* Ignore .rhosts and .shosts. */
68 int ignore_user_known_hosts; /* Ignore ~/.ssh/known_hosts
69 * for RhostsRsaAuth */
70 int print_motd; /* If true, print /etc/motd. */
Ben Lindstrom7bfff362001-03-26 05:45:53 +000071 int print_lastlog; /* If true, print lastlog */
Damien Miller95def091999-11-25 00:26:21 +110072 int x11_forwarding; /* If true, permit inet (spoofing) X11 fwd. */
73 int x11_display_offset; /* What DISPLAY number to start
74 * searching at */
Damien Miller95c249f2002-02-05 12:11:34 +110075 int x11_use_localhost; /* If true, use localhost for fake X11 server. */
Damien Millerd3a18572000-06-07 19:55:44 +100076 char *xauth_location; /* Location of xauth program */
Damien Miller95def091999-11-25 00:26:21 +110077 int strict_modes; /* If true, require string home dir modes. */
Damien Miller12c150e2003-12-17 16:31:10 +110078 int tcp_keep_alive; /* If true, set SO_KEEPALIVE. */
Damien Miller0dac6fb2010-11-20 15:19:38 +110079 int ip_qos_interactive; /* IP ToS/DSCP/class for interactive */
80 int ip_qos_bulk; /* IP ToS/DSCP/class for bulk traffic */
Ben Lindstrom06b33aa2001-02-15 03:01:59 +000081 char *ciphers; /* Supported SSH2 ciphers. */
82 char *macs; /* Supported SSH2 macs. */
Damien Millerd5f62bf2010-09-24 22:11:14 +100083 char *kex_algorithms; /* SSH2 kex methods in order of preference. */
Ben Lindstrom06b33aa2001-02-15 03:01:59 +000084 int protocol; /* Supported protocol versions. */
Damien Millere247cc42000-05-07 12:03:14 +100085 int gateway_ports; /* If true, allow remote connects to forwarded ports. */
Damien Miller95def091999-11-25 00:26:21 +110086 SyslogFacility log_facility; /* Facility for system logging. */
87 LogLevel log_level; /* Level for system logging. */
Damien Miller95def091999-11-25 00:26:21 +110088 int rhosts_rsa_authentication; /* If true, permit rhosts RSA
89 * authentication. */
Ben Lindstrom5eabda32001-04-12 23:34:34 +000090 int hostbased_authentication; /* If true, permit ssh2 hostbased auth */
91 int hostbased_uses_name_from_packet_only; /* experimental */
Damien Miller95def091999-11-25 00:26:21 +110092 int rsa_authentication; /* If true, permit RSA authentication. */
Damien Miller0bc1bd82000-11-13 22:57:25 +110093 int pubkey_authentication; /* If true, permit ssh2 pubkey authentication. */
Damien Miller95def091999-11-25 00:26:21 +110094 int kerberos_authentication; /* If true, permit Kerberos
95 * authentication. */
96 int kerberos_or_local_passwd; /* If true, permit kerberos
97 * and any other password
98 * authentication mechanism,
99 * such as SecurID or
100 * /etc/passwd */
101 int kerberos_ticket_cleanup; /* If true, destroy ticket
102 * file on logout. */
Darren Tucker22ef5082003-12-31 11:37:34 +1100103 int kerberos_get_afs_token; /* If true, try to get AFS token if
104 * authenticated with Kerberos. */
Darren Tucker0efd1552003-08-26 11:49:55 +1000105 int gss_authentication; /* If true, permit GSSAPI authentication */
106 int gss_cleanup_creds; /* If true, destroy cred cache on logout */
Damien Miller95def091999-11-25 00:26:21 +1100107 int password_authentication; /* If true, permit password
108 * authentication. */
Damien Miller874d77b2000-10-14 16:23:11 +1100109 int kbd_interactive_authentication; /* If true, permit */
Ben Lindstrom551ea372001-06-05 18:56:16 +0000110 int challenge_response_authentication;
Damien Miller01ed2272008-11-05 16:20:46 +1100111 int zero_knowledge_password_authentication;
112 /* If true, permit jpake auth */
Damien Miller95def091999-11-25 00:26:21 +1100113 int permit_empty_passwd; /* If false, do not permit empty
114 * passwords. */
Ben Lindstrom5d860f02002-08-01 01:28:38 +0000115 int permit_user_env; /* If true, read ~/.ssh/environment */
Damien Miller95def091999-11-25 00:26:21 +1100116 int use_login; /* If true, login(1) is used */
Ben Lindstrom23e0f662002-06-21 01:09:47 +0000117 int compression; /* If true, compression is allowed */
Damien Miller50a41ed2000-10-16 12:14:42 +1100118 int allow_tcp_forwarding;
Damien Miller4f755cd2008-05-19 14:57:41 +1000119 int allow_agent_forwarding;
Ben Lindstrom46c16222000-12-22 01:43:59 +0000120 u_int num_allow_users;
Damien Miller95def091999-11-25 00:26:21 +1100121 char *allow_users[MAX_ALLOW_USERS];
Ben Lindstrom46c16222000-12-22 01:43:59 +0000122 u_int num_deny_users;
Damien Miller95def091999-11-25 00:26:21 +1100123 char *deny_users[MAX_DENY_USERS];
Ben Lindstrom46c16222000-12-22 01:43:59 +0000124 u_int num_allow_groups;
Damien Miller95def091999-11-25 00:26:21 +1100125 char *allow_groups[MAX_ALLOW_GROUPS];
Ben Lindstrom46c16222000-12-22 01:43:59 +0000126 u_int num_deny_groups;
Damien Miller95def091999-11-25 00:26:21 +1100127 char *deny_groups[MAX_DENY_GROUPS];
Damien Millerf6d9e222000-06-18 14:50:44 +1000128
Ben Lindstrom46c16222000-12-22 01:43:59 +0000129 u_int num_subsystems;
Damien Millerf6d9e222000-06-18 14:50:44 +1000130 char *subsystem_name[MAX_SUBSYSTEMS];
131 char *subsystem_command[MAX_SUBSYSTEMS];
Damien Miller917f9b62006-07-10 20:36:47 +1000132 char *subsystem_args[MAX_SUBSYSTEMS];
Damien Miller37023962000-07-11 17:31:38 +1000133
Darren Tucker46bc0752004-05-02 22:11:30 +1000134 u_int num_accept_env;
135 char *accept_env[MAX_ACCEPT_ENV];
136
Damien Miller942da032000-08-18 13:59:06 +1000137 int max_startups_begin;
138 int max_startups_rate;
Damien Miller37023962000-07-11 17:31:38 +1000139 int max_startups;
Darren Tucker89413db2004-05-24 10:36:23 +1000140 int max_authtries;
Damien Miller7207f642008-05-19 15:34:50 +1000141 int max_sessions;
Ben Lindstrom48bd7c12001-01-09 00:35:42 +0000142 char *banner; /* SSH-2 banner message */
Damien Miller3a961dc2003-06-03 10:25:48 +1000143 int use_dns;
Ben Lindstrom5744dc42001-04-13 23:28:01 +0000144 int client_alive_interval; /*
Damien Miller9f0f5c62001-12-21 14:45:46 +1100145 * poke the client this often to
146 * see if it's still there
Ben Lindstrom5744dc42001-04-13 23:28:01 +0000147 */
148 int client_alive_count_max; /*
Ben Lindstrom7bb37b22001-09-12 16:40:05 +0000149 * If the client is unresponsive
150 * for this many intervals above,
Damien Miller9f0f5c62001-12-21 14:45:46 +1100151 * disconnect the session
Ben Lindstrom5744dc42001-04-13 23:28:01 +0000152 */
Kevin Stevese468de62001-07-04 18:37:20 +0000153
Damien Millerd8478b62011-05-29 21:39:36 +1000154 u_int num_authkeys_files; /* Files containing public keys */
155 char *authorized_keys_files[MAX_AUTHKEYS_FILES];
Damien Millerd27b9472005-12-13 19:29:02 +1100156
Damien Millere2754432006-07-24 14:06:47 +1000157 char *adm_forced_command;
158
Damien Miller4e448a32003-05-14 15:11:48 +1000159 int use_pam; /* Enable auth via PAM */
Damien Millerd27b9472005-12-13 19:29:02 +1100160
161 int permit_tun;
Damien Millera765cf42006-07-24 14:08:13 +1000162
163 int num_permitted_opens;
Damien Millerd8cb1f12008-02-10 22:40:12 +1100164
165 char *chroot_directory;
Damien Miller1aed65e2010-03-04 21:53:35 +1100166 char *revoked_keys_file;
167 char *trusted_user_ca_keys;
Damien Miller30da3442010-05-10 11:58:03 +1000168 char *authorized_principals_file;
Damien Miller95def091999-11-25 00:26:21 +1100169} ServerOptions;
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000170
Damien Millerf2e407e2011-05-20 19:04:14 +1000171/*
172 * These are string config options that must be copied between the
173 * Match sub-config and the main config, and must be sent from the
174 * privsep slave to the privsep master. We use a macro to ensure all
175 * the options are copied and the copies are done in the correct order.
176 */
177#define COPY_MATCH_STRING_OPTS() do { \
178 M_CP_STROPT(banner); \
179 M_CP_STROPT(trusted_user_ca_keys); \
180 M_CP_STROPT(revoked_keys_file); \
Damien Millerf2e407e2011-05-20 19:04:14 +1000181 M_CP_STROPT(authorized_principals_file); \
Damien Millerd8478b62011-05-29 21:39:36 +1000182 M_CP_STRARRAYOPT(authorized_keys_files, num_authkeys_files); \
Damien Millerf2e407e2011-05-20 19:04:14 +1000183 } while (0)
184
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000185void initialize_server_options(ServerOptions *);
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000186void fill_default_server_options(ServerOptions *);
Darren Tucker45150472006-07-12 22:34:17 +1000187int process_server_config_line(ServerOptions *, char *, const char *, int,
188 int *, const char *, const char *, const char *);
Darren Tucker645ab752004-06-25 13:33:20 +1000189void load_server_config(const char *, Buffer *);
Darren Tucker45150472006-07-12 22:34:17 +1000190void parse_server_config(ServerOptions *, const char *, Buffer *,
191 const char *, const char *, const char *);
192void parse_server_match_config(ServerOptions *, const char *, const char *,
193 const char *);
Darren Tucker1629c072007-02-19 22:25:37 +1100194void copy_set_server_options(ServerOptions *, ServerOptions *, int);
Darren Tuckere7140f22008-06-10 23:01:51 +1000195void dump_config(ServerOptions *);
Darren Tucker88b6fb22010-01-13 22:44:29 +1100196char *derelativise_path(const char *);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000197
Damien Miller95def091999-11-25 00:26:21 +1100198#endif /* SERVCONF_H */