servconf.h revision 181104 
1/* $OpenBSD: servconf.h,v 1.79 2006/08/14 12:40:25 dtucker Exp $ */
2
3/*
4 * Author: Tatu Ylonen <ylo@cs.hut.fi>
5 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
6 *                    All rights reserved
7 * Definitions for server configuration data and for the functions reading it.
8 *
9 * 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".
14 */
15
16#ifndef SERVCONF_H
17#define SERVCONF_H
18
19#define MAX_PORTS		256	/* Max # ports. */
20
21#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. */
25#define MAX_SUBSYSTEMS		256	/* Max # subsystems. */
26#define MAX_HOSTKEYS		256	/* Max # hostkeys. */
27#define MAX_ACCEPT_ENV		256	/* Max # of env vars. */
28#define MAX_MATCH_GROUPS	256	/* Max # of groups for Match. */
29
30/* permit_root_login */
31#define	PERMIT_NOT_SET		-1
32#define	PERMIT_NO		0
33#define	PERMIT_FORCED_ONLY	1
34#define	PERMIT_NO_PASSWD	2
35#define	PERMIT_YES		3
36
37#define DEFAULT_AUTH_FAIL_MAX	6	/* Default for MaxAuthTries */
38
39typedef struct {
40	u_int num_ports;
41	u_int ports_from_cmdline;
42	u_short ports[MAX_PORTS];	/* Port number to listen on. */
43	char   *listen_addr;		/* Address on which the server listens. */
44	struct addrinfo *listen_addrs;	/* Addresses on which the server listens. */
45	int     address_family;		/* Address family used by the server. */
46	char   *host_key_files[MAX_HOSTKEYS];	/* Files containing host keys. */
47	int     num_host_key_files;     /* Number of files for host keys. */
48	char   *pid_file;	/* Where to put our pid */
49	int     server_key_bits;/* Size of the server key. */
50	int     login_grace_time;	/* Disconnect if no auth in this time
51					 * (sec). */
52	int     key_regeneration_time;	/* Server key lifetime (seconds). */
53	int     permit_root_login;	/* PERMIT_*, see above */
54	int     ignore_rhosts;	/* Ignore .rhosts and .shosts. */
55	int     ignore_user_known_hosts;	/* Ignore ~/.ssh/known_hosts
56						 * for RhostsRsaAuth */
57	int     print_motd;	/* If true, print /etc/motd. */
58	int	print_lastlog;	/* If true, print lastlog */
59	int     x11_forwarding;	/* If true, permit inet (spoofing) X11 fwd. */
60	int     x11_display_offset;	/* What DISPLAY number to start
61					 * searching at */
62	int     x11_use_localhost;	/* If true, use localhost for fake X11 server. */
63	char   *xauth_location;	/* Location of xauth program */
64	int     strict_modes;	/* If true, require string home dir modes. */
65	int     tcp_keep_alive;	/* If true, set SO_KEEPALIVE. */
66	char   *ciphers;	/* Supported SSH2 ciphers. */
67	char   *macs;		/* Supported SSH2 macs. */
68	int	protocol;	/* Supported protocol versions. */
69	int     gateway_ports;	/* If true, allow remote connects to forwarded ports. */
70	SyslogFacility log_facility;	/* Facility for system logging. */
71	LogLevel log_level;	/* Level for system logging. */
72	int     rhosts_rsa_authentication;	/* If true, permit rhosts RSA
73						 * authentication. */
74	int     hostbased_authentication;	/* If true, permit ssh2 hostbased auth */
75	int     hostbased_uses_name_from_packet_only; /* experimental */
76	int     rsa_authentication;	/* If true, permit RSA authentication. */
77	int     pubkey_authentication;	/* If true, permit ssh2 pubkey authentication. */
78	int     kerberos_authentication;	/* If true, permit Kerberos
79						 * authentication. */
80	int     kerberos_or_local_passwd;	/* If true, permit kerberos
81						 * and any other password
82						 * authentication mechanism,
83						 * such as SecurID or
84						 * /etc/passwd */
85	int     kerberos_ticket_cleanup;	/* If true, destroy ticket
86						 * file on logout. */
87	int     kerberos_get_afs_token;		/* If true, try to get AFS token if
88						 * authenticated with Kerberos. */
89	int     gss_authentication;	/* If true, permit GSSAPI authentication */
90	int     gss_cleanup_creds;	/* If true, destroy cred cache on logout */
91	int     password_authentication;	/* If true, permit password
92						 * authentication. */
93	int     kbd_interactive_authentication;	/* If true, permit */
94	int     challenge_response_authentication;
95	int     permit_empty_passwd;	/* If false, do not permit empty
96					 * passwords. */
97	int     permit_user_env;	/* If true, read ~/.ssh/environment */
98	int     use_login;	/* If true, login(1) is used */
99	int     compression;	/* If true, compression is allowed */
100	int	allow_tcp_forwarding;
101	u_int num_allow_users;
102	char   *allow_users[MAX_ALLOW_USERS];
103	u_int num_deny_users;
104	char   *deny_users[MAX_DENY_USERS];
105	u_int num_allow_groups;
106	char   *allow_groups[MAX_ALLOW_GROUPS];
107	u_int num_deny_groups;
108	char   *deny_groups[MAX_DENY_GROUPS];
109
110	u_int num_subsystems;
111	char   *subsystem_name[MAX_SUBSYSTEMS];
112	char   *subsystem_command[MAX_SUBSYSTEMS];
113	char   *subsystem_args[MAX_SUBSYSTEMS];
114
115	u_int num_accept_env;
116	char   *accept_env[MAX_ACCEPT_ENV];
117
118	int	max_startups_begin;
119	int	max_startups_rate;
120	int	max_startups;
121	int	max_authtries;
122	char   *banner;			/* SSH-2 banner message */
123	int	use_dns;
124	int	client_alive_interval;	/*
125					 * poke the client this often to
126					 * see if it's still there
127					 */
128	int	client_alive_count_max;	/*
129					 * If the client is unresponsive
130					 * for this many intervals above,
131					 * disconnect the session
132					 */
133
134	char   *authorized_keys_file;	/* File containing public keys */
135	char   *authorized_keys_file2;
136
137	char   *adm_forced_command;
138
139	int	use_pam;		/* Enable auth via PAM */
140
141	int	permit_tun;
142
143	int	num_permitted_opens;
144}       ServerOptions;
145
146void	 initialize_server_options(ServerOptions *);
147void	 fill_default_server_options(ServerOptions *);
148int	 process_server_config_line(ServerOptions *, char *, const char *, int,
149	     int *, const char *, const char *, const char *);
150void	 load_server_config(const char *, Buffer *);
151void	 parse_server_config(ServerOptions *, const char *, Buffer *,
152	     const char *, const char *, const char *);
153void	 parse_server_match_config(ServerOptions *, const char *, const char *,
154	     const char *);
155void	 copy_set_server_options(ServerOptions *, ServerOptions *);
156
157#endif				/* SERVCONF_H */
158