servconf.h revision 1.4 
1/*	$NetBSD: servconf.h,v 1.4 2010/11/21 18:59:04 adam Exp $	*/
2/* $OpenBSD: servconf.h,v 1.93 2010/05/07 11:30:30 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
36/* permit_root_login */
37#define	PERMIT_NOT_SET		-1
38#define	PERMIT_NO		0
39#define	PERMIT_FORCED_ONLY	1
40#define	PERMIT_NO_PASSWD	2
41#define	PERMIT_YES		3
42
43#define DEFAULT_AUTH_FAIL_MAX	6	/* Default for MaxAuthTries */
44#define DEFAULT_SESSIONS_MAX	10	/* Default for MaxSessions */
45
46/* Magic name for internal sftp-server */
47#define INTERNAL_SFTP_NAME	"internal-sftp"
48
49typedef struct {
50	u_int	num_ports;
51	u_int	ports_from_cmdline;
52	int	ports[MAX_PORTS];	/* Port number to listen on. */
53	char   *listen_addr;		/* Address on which the server listens. */
54	struct addrinfo *listen_addrs;	/* Addresses on which the server listens. */
55	int     address_family;		/* Address family used by the server. */
56	char   *host_key_files[MAX_HOSTKEYS];	/* Files containing host keys. */
57	int     num_host_key_files;     /* Number of files for host keys. */
58	char   *host_cert_files[MAX_HOSTCERTS];	/* Files containing host certs. */
59	int     num_host_cert_files;     /* Number of files for host certs. */
60	char   *pid_file;	/* Where to put our pid */
61	int     server_key_bits;/* Size of the server key. */
62	int     login_grace_time;	/* Disconnect if no auth in this time
63					 * (sec). */
64	int     key_regeneration_time;	/* Server key lifetime (seconds). */
65	int     permit_root_login;	/* PERMIT_*, see above */
66	int     ignore_rhosts;	/* Ignore .rhosts and .shosts. */
67	int     ignore_root_rhosts;	/* Ignore .rhosts and .shosts for root;
68					   defaults to ignore_rhosts if not
69					   given. */
70	int     ignore_user_known_hosts;	/* Ignore ~/.ssh/known_hosts
71						 * for RhostsRsaAuth */
72	int     print_motd;	/* If true, print /etc/motd. */
73	int	print_lastlog;	/* If true, print lastlog */
74	int     x11_forwarding;	/* If true, permit inet (spoofing) X11 fwd. */
75	int     x11_display_offset;	/* What DISPLAY number to start
76					 * searching at */
77	int     x11_use_localhost;	/* If true, use localhost for fake X11 server. */
78	char   *xauth_location;	/* Location of xauth program */
79	int     strict_modes;	/* If true, require string home dir modes. */
80	int     tcp_keep_alive;	/* If true, set SO_KEEPALIVE. */
81	char   *ciphers;	/* Supported SSH2 ciphers. */
82	char   *macs;		/* Supported SSH2 macs. */
83	int	protocol;	/* Supported protocol versions. */
84	int     gateway_ports;	/* If true, allow remote connects to forwarded ports. */
85	SyslogFacility log_facility;	/* Facility for system logging. */
86	LogLevel log_level;	/* Level for system logging. */
87	int     rhosts_rsa_authentication;	/* If true, permit rhosts RSA
88						 * authentication. */
89	int     hostbased_authentication;	/* If true, permit ssh2 hostbased auth */
90	int     hostbased_uses_name_from_packet_only; /* experimental */
91	int     rsa_authentication;	/* If true, permit RSA authentication. */
92	int     pubkey_authentication;	/* If true, permit ssh2 pubkey authentication. */
93	int     kerberos_authentication;	/* If true, permit Kerberos
94						 * authentication. */
95	int     kerberos_or_local_passwd;	/* If true, permit kerberos
96						 * and any other password
97						 * authentication mechanism,
98						 * such as SecurID or
99						 * /etc/passwd */
100	int     kerberos_ticket_cleanup;	/* If true, destroy ticket
101						 * file on logout. */
102	int	kerberos_tgt_passing;		/* If true, permit Kerberos TGT
103						 * passing. */
104	int     kerberos_get_afs_token;		/* If true, try to get AFS token if
105						 * authenticated with Kerberos. */
106#ifdef AFS
107	int     afs_token_passing;      /* If true, permit AFS token passing. */
108#endif
109	int     gss_authentication;	/* If true, permit GSSAPI authentication */
110	int     gss_cleanup_creds;	/* If true, destroy cred cache on logout */
111	int     password_authentication;	/* If true, permit password
112						 * authentication. */
113	int     kbd_interactive_authentication;	/* If true, permit */
114	int     challenge_response_authentication;
115	int     zero_knowledge_password_authentication;
116					/* If true, permit jpake auth */
117	int     permit_empty_passwd;	/* If false, do not permit empty
118					 * passwords. */
119	int     permit_user_env;	/* If true, read ~/.ssh/environment */
120	int     use_login;	/* If true, login(1) is used */
121	int     compression;	/* If true, compression is allowed */
122	int	allow_tcp_forwarding;
123	int	allow_agent_forwarding;
124	u_int num_allow_users;
125	char   *allow_users[MAX_ALLOW_USERS];
126	u_int num_deny_users;
127	char   *deny_users[MAX_DENY_USERS];
128	u_int num_allow_groups;
129	char   *allow_groups[MAX_ALLOW_GROUPS];
130	u_int num_deny_groups;
131	char   *deny_groups[MAX_DENY_GROUPS];
132
133	u_int num_subsystems;
134	char   *subsystem_name[MAX_SUBSYSTEMS];
135	char   *subsystem_command[MAX_SUBSYSTEMS];
136	char   *subsystem_args[MAX_SUBSYSTEMS];
137
138	u_int num_accept_env;
139	char   *accept_env[MAX_ACCEPT_ENV];
140
141	int	max_startups_begin;
142	int	max_startups_rate;
143	int	max_startups;
144	int	max_authtries;
145	int	max_sessions;
146	char   *banner;			/* SSH-2 banner message */
147	int	use_dns;
148	int	client_alive_interval;	/*
149					 * poke the client this often to
150					 * see if it's still there
151					 */
152	int	client_alive_count_max;	/*
153					 * If the client is unresponsive
154					 * for this many intervals above,
155					 * disconnect the session
156					 */
157
158	char   *authorized_keys_file;	/* File containing public keys */
159	char   *authorized_keys_file2;
160
161	int	use_pam;		/* Enable auth via PAM */
162	int     none_enabled;           /* enable NONE cipher switch */
163	int     tcp_rcv_buf_poll;       /* poll tcp rcv window in autotuning kernels*/
164	int	hpn_disabled;		/* disable hpn functionality. false by default */
165	int	hpn_buffer_size;	/* set the hpn buffer size - default 3MB */
166
167	char   *adm_forced_command;
168
169	int	permit_tun;
170#ifdef WITH_LDAP_PUBKEY
171        ldap_opt_t lpk;
172#endif
173
174	int	num_permitted_opens;
175
176	char   *chroot_directory;
177	char   *revoked_keys_file;
178	char   *trusted_user_ca_keys;
179	char   *authorized_principals_file;
180}       ServerOptions;
181
182void	 initialize_server_options(ServerOptions *);
183void	 fill_default_server_options(ServerOptions *);
184int	 process_server_config_line(ServerOptions *, char *, const char *, int,
185	     int *, const char *, const char *, const char *);
186void	 load_server_config(const char *, Buffer *);
187void	 parse_server_config(ServerOptions *, const char *, Buffer *,
188	     const char *, const char *, const char *);
189void	 parse_server_match_config(ServerOptions *, const char *, const char *,
190	     const char *);
191void	 copy_set_server_options(ServerOptions *, ServerOptions *, int);
192void	 dump_config(ServerOptions *);
193char	*derelativise_path(const char *);
194
195#endif				/* SERVCONF_H */
196