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