servconf.h revision 1.9.4.1 
1/*	$NetBSD: servconf.h,v 1.9.4.1 2015/04/30 06:07:30 riz Exp $	*/
2/* $OpenBSD: servconf.h,v 1.116 2015/01/13 07:39:19 djm Exp $ */
3
4/*
5 * Author: Tatu Ylonen <ylo@cs.hut.fi>
6 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
7 *                    All rights reserved
8 * Definitions for server configuration data and for the functions reading it.
9 *
10 * As far as I am concerned, the code I have written for this software
11 * can be used freely for any purpose.  Any derived versions of this
12 * software must be clearly marked as such, and if the derived work is
13 * incompatible with the protocol description in the RFC file, it must be
14 * called by a name other than "ssh" or "Secure Shell".
15 */
16
17#ifndef SERVCONF_H
18#define SERVCONF_H
19
20#ifdef WITH_LDAP_PUBKEY
21#include "ldapauth.h"
22#endif
23
24#define MAX_PORTS		256	/* Max # ports. */
25
26#define MAX_ALLOW_USERS		256	/* Max # users on allow list. */
27#define MAX_DENY_USERS		256	/* Max # users on deny list. */
28#define MAX_ALLOW_GROUPS	256	/* Max # groups on allow list. */
29#define MAX_DENY_GROUPS		256	/* Max # groups on deny list. */
30#define MAX_SUBSYSTEMS		256	/* Max # subsystems. */
31#define MAX_HOSTKEYS		256	/* Max # hostkeys. */
32#define MAX_HOSTCERTS		256	/* Max # host certificates. */
33#define MAX_ACCEPT_ENV		256	/* Max # of env vars. */
34#define MAX_MATCH_GROUPS	256	/* Max # of groups for Match. */
35#define MAX_AUTHKEYS_FILES	256	/* Max # of authorized_keys files. */
36#define MAX_AUTH_METHODS	256	/* Max # of AuthenticationMethods. */
37
38/* permit_root_login */
39#define	PERMIT_NOT_SET		-1
40#define	PERMIT_NO		0
41#define	PERMIT_FORCED_ONLY	1
42#define	PERMIT_NO_PASSWD	2
43#define	PERMIT_YES		3
44
45/* use_privsep */
46#define PRIVSEP_OFF		0
47#define PRIVSEP_ON		1
48#define PRIVSEP_NOSANDBOX	2
49
50/* AllowTCPForwarding */
51#define FORWARD_DENY		0
52#define FORWARD_REMOTE		(1)
53#define FORWARD_LOCAL		(1<<1)
54#define FORWARD_ALLOW		(FORWARD_REMOTE|FORWARD_LOCAL)
55
56#define DEFAULT_AUTH_FAIL_MAX	6	/* Default for MaxAuthTries */
57#define DEFAULT_SESSIONS_MAX	10	/* Default for MaxSessions */
58
59/* Magic name for internal sftp-server */
60#define INTERNAL_SFTP_NAME	"internal-sftp"
61
62typedef struct {
63	u_int	num_ports;
64	u_int	ports_from_cmdline;
65	int	ports[MAX_PORTS];	/* Port number to listen on. */
66	char   *listen_addr;		/* Address on which the server listens. */
67	struct addrinfo *listen_addrs;	/* Addresses on which the server listens. */
68	int     address_family;		/* Address family used by the server. */
69	char   *host_key_files[MAX_HOSTKEYS];	/* Files containing host keys. */
70	int     num_host_key_files;     /* Number of files for host keys. */
71	char   *host_cert_files[MAX_HOSTCERTS];	/* Files containing host certs. */
72	int     num_host_cert_files;     /* Number of files for host certs. */
73	char   *host_key_agent;		 /* ssh-agent socket for host keys. */
74	char   *pid_file;	/* Where to put our pid */
75	int     server_key_bits;/* Size of the server key. */
76	int     login_grace_time;	/* Disconnect if no auth in this time
77					 * (sec). */
78	int     key_regeneration_time;	/* Server key lifetime (seconds). */
79	int     permit_root_login;	/* PERMIT_*, see above */
80	int     ignore_rhosts;	/* Ignore .rhosts and .shosts. */
81	int     ignore_root_rhosts;	/* Ignore .rhosts and .shosts for root;
82					   defaults to ignore_rhosts if not
83					   given. */
84	int     ignore_user_known_hosts;	/* Ignore ~/.ssh/known_hosts
85						 * for RhostsRsaAuth */
86	int     print_motd;	/* If true, print /etc/motd. */
87	int	print_lastlog;	/* If true, print lastlog */
88	int     x11_forwarding;	/* If true, permit inet (spoofing) X11 fwd. */
89	int     x11_display_offset;	/* What DISPLAY number to start
90					 * searching at */
91	int     x11_use_localhost;	/* If true, use localhost for fake X11 server. */
92	char   *xauth_location;	/* Location of xauth program */
93	int	permit_tty;	/* If false, deny pty allocation */
94	int	permit_user_rc;	/* If false, deny ~/.ssh/rc execution */
95	int     strict_modes;	/* If true, require string home dir modes. */
96	int     tcp_keep_alive;	/* If true, set SO_KEEPALIVE. */
97	int	ip_qos_interactive;	/* IP ToS/DSCP/class for interactive */
98	int	ip_qos_bulk;		/* IP ToS/DSCP/class for bulk traffic */
99	char   *ciphers;	/* Supported SSH2 ciphers. */
100	char   *macs;		/* Supported SSH2 macs. */
101	char   *kex_algorithms;	/* SSH2 kex methods in order of preference. */
102	int	protocol;	/* Supported protocol versions. */
103	struct ForwardOptions fwd_opts;	/* forwarding options */
104	SyslogFacility log_facility;	/* Facility for system logging. */
105	LogLevel log_level;	/* Level for system logging. */
106	int     rhosts_rsa_authentication;	/* If true, permit rhosts RSA
107						 * authentication. */
108	int     hostbased_authentication;	/* If true, permit ssh2 hostbased auth */
109	int     hostbased_uses_name_from_packet_only; /* experimental */
110	char   *hostbased_key_types;	/* Key types allowed for hostbased */
111	int     rsa_authentication;	/* If true, permit RSA authentication. */
112	int     pubkey_authentication;	/* If true, permit ssh2 pubkey authentication. */
113	char   *pubkey_key_types;	/* Key types allowed for public key */
114	int     kerberos_authentication;	/* If true, permit Kerberos
115						 * authentication. */
116	int     kerberos_or_local_passwd;	/* If true, permit kerberos
117						 * and any other password
118						 * authentication mechanism,
119						 * such as SecurID or
120						 * /etc/passwd */
121	int     kerberos_ticket_cleanup;	/* If true, destroy ticket
122						 * file on logout. */
123	int	kerberos_tgt_passing;		/* If true, permit Kerberos TGT
124						 * passing. */
125	int     kerberos_get_afs_token;		/* If true, try to get AFS token if
126						 * authenticated with Kerberos. */
127#ifdef AFS
128	int     afs_token_passing;      /* If true, permit AFS token passing. */
129#endif
130	int     gss_authentication;	/* If true, permit GSSAPI authentication */
131	int     gss_cleanup_creds;	/* If true, destroy cred cache on logout */
132	int     password_authentication;	/* If true, permit password
133						 * authentication. */
134	int     kbd_interactive_authentication;	/* If true, permit */
135	int     challenge_response_authentication;
136	int     permit_empty_passwd;	/* If false, do not permit empty
137					 * passwords. */
138	int     permit_user_env;	/* If true, read ~/.ssh/environment */
139	int     use_login;	/* If true, login(1) is used */
140	int     compression;	/* If true, compression is allowed */
141	int	allow_tcp_forwarding; /* One of FORWARD_* */
142	int	allow_streamlocal_forwarding; /* One of FORWARD_* */
143	int	allow_agent_forwarding;
144	u_int num_allow_users;
145	char   *allow_users[MAX_ALLOW_USERS];
146	u_int num_deny_users;
147	char   *deny_users[MAX_DENY_USERS];
148	u_int num_allow_groups;
149	char   *allow_groups[MAX_ALLOW_GROUPS];
150	u_int num_deny_groups;
151	char   *deny_groups[MAX_DENY_GROUPS];
152
153	u_int num_subsystems;
154	char   *subsystem_name[MAX_SUBSYSTEMS];
155	char   *subsystem_command[MAX_SUBSYSTEMS];
156	char   *subsystem_args[MAX_SUBSYSTEMS];
157
158	u_int num_accept_env;
159	char   *accept_env[MAX_ACCEPT_ENV];
160
161	int	max_startups_begin;
162	int	max_startups_rate;
163	int	max_startups;
164	int	max_authtries;
165	int	max_sessions;
166	char   *banner;			/* SSH-2 banner message */
167	int	use_dns;
168	int	client_alive_interval;	/*
169					 * poke the client this often to
170					 * see if it's still there
171					 */
172	int	client_alive_count_max;	/*
173					 * If the client is unresponsive
174					 * for this many intervals above,
175					 * disconnect the session
176					 */
177
178	u_int num_authkeys_files;	/* Files containing public keys */
179	char   *authorized_keys_files[MAX_AUTHKEYS_FILES];
180
181	int	use_pam;		/* Enable auth via PAM */
182	int     none_enabled;           /* enable NONE cipher switch */
183	int     tcp_rcv_buf_poll;       /* poll tcp rcv window in autotuning kernels*/
184	int	hpn_disabled;		/* disable hpn functionality. false by default */
185	int	hpn_buffer_size;	/* set the hpn buffer size - default 3MB */
186
187	char   *adm_forced_command;
188
189	int	permit_tun;
190#ifdef WITH_LDAP_PUBKEY
191        ldap_opt_t lpk;
192#endif
193
194	int	num_permitted_opens;
195
196	char   *chroot_directory;
197	char   *revoked_keys_file;
198	char   *trusted_user_ca_keys;
199	char   *authorized_principals_file;
200	char   *authorized_keys_command;
201	char   *authorized_keys_command_user;
202
203	int64_t rekey_limit;
204	int	rekey_interval;
205
206	char   *version_addendum;	/* Appended to SSH banner */
207
208	u_int	num_auth_methods;
209	char   *auth_methods[MAX_AUTH_METHODS];
210
211	int	fingerprint_hash;
212}       ServerOptions;
213
214/* Information about the incoming connection as used by Match */
215struct connection_info {
216	const char *user;
217	const char *host;	/* possibly resolved hostname */
218	const char *address; 	/* remote address */
219	const char *laddress;	/* local address */
220	int lport;		/* local port */
221};
222
223
224/*
225 * These are string config options that must be copied between the
226 * Match sub-config and the main config, and must be sent from the
227 * privsep slave to the privsep master. We use a macro to ensure all
228 * the options are copied and the copies are done in the correct order.
229 *
230 * NB. an option must appear in servconf.c:copy_set_server_options() or
231 * COPY_MATCH_STRING_OPTS here but never both.
232 */
233#define COPY_MATCH_STRING_OPTS() do { \
234		M_CP_STROPT(banner); \
235		M_CP_STROPT(trusted_user_ca_keys); \
236		M_CP_STROPT(revoked_keys_file); \
237		M_CP_STROPT(authorized_principals_file); \
238		M_CP_STROPT(authorized_keys_command); \
239		M_CP_STROPT(authorized_keys_command_user); \
240		M_CP_STROPT(hostbased_key_types); \
241		M_CP_STROPT(pubkey_key_types); \
242		M_CP_STRARRAYOPT(authorized_keys_files, num_authkeys_files); \
243		M_CP_STRARRAYOPT(allow_users, num_allow_users); \
244		M_CP_STRARRAYOPT(deny_users, num_deny_users); \
245		M_CP_STRARRAYOPT(allow_groups, num_allow_groups); \
246		M_CP_STRARRAYOPT(deny_groups, num_deny_groups); \
247		M_CP_STRARRAYOPT(accept_env, num_accept_env); \
248		M_CP_STRARRAYOPT(auth_methods, num_auth_methods); \
249	} while (0)
250
251struct connection_info *get_connection_info(int, int);
252void	 initialize_server_options(ServerOptions *);
253void	 fill_default_server_options(ServerOptions *);
254int	 process_server_config_line(ServerOptions *, char *, const char *, int,
255	     int *, struct connection_info *);
256void	 load_server_config(const char *, Buffer *);
257void	 parse_server_config(ServerOptions *, const char *, Buffer *,
258	     struct connection_info *);
259void	 parse_server_match_config(ServerOptions *, struct connection_info *);
260int	 parse_server_match_testspec(struct connection_info *, char *);
261int	 server_match_spec_complete(struct connection_info *);
262void	 copy_set_server_options(ServerOptions *, ServerOptions *, int);
263void	 dump_config(ServerOptions *);
264char	*derelativise_path(const char *);
265
266#endif				/* SERVCONF_H */
267