[openssh.git] / servconf.h

/* $OpenBSD: servconf.h,v 1.90 2010/01/13 03:48:13 djm Exp $ */

/*
 * Author: Tatu Ylonen <ylo@cs.hut.fi>
 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
 *                    All rights reserved
 * Definitions for server configuration data and for the functions reading it.
 *
 * As far as I am concerned, the code I have written for this software
 * can be used freely for any purpose.  Any derived versions of this
 * software must be clearly marked as such, and if the derived work is
 * incompatible with the protocol description in the RFC file, it must be
 * called by a name other than "ssh" or "Secure Shell".
 */

#ifndef SERVCONF_H
#define SERVCONF_H

#define MAX_PORTS		256	/* Max # ports. */

#define MAX_ALLOW_USERS		256	/* Max # users on allow list. */
#define MAX_DENY_USERS		256	/* Max # users on deny list. */
#define MAX_ALLOW_GROUPS	256	/* Max # groups on allow list. */
#define MAX_DENY_GROUPS		256	/* Max # groups on deny list. */
#define MAX_SUBSYSTEMS		256	/* Max # subsystems. */
#define MAX_HOSTKEYS		256	/* Max # hostkeys. */
#define MAX_ACCEPT_ENV		256	/* Max # of env vars. */
#define MAX_MATCH_GROUPS	256	/* Max # of groups for Match. */

/* permit_root_login */
#define	PERMIT_NOT_SET		-1
#define	PERMIT_NO		0
#define	PERMIT_FORCED_ONLY	1
#define	PERMIT_NO_PASSWD	2
#define	PERMIT_YES		3

#define DEFAULT_AUTH_FAIL_MAX	6	/* Default for MaxAuthTries */
#define DEFAULT_SESSIONS_MAX	10	/* Default for MaxSessions */

/* Magic name for internal sftp-server */
#define INTERNAL_SFTP_NAME	"internal-sftp"

typedef struct {
	u_int	num_ports;
	u_int	ports_from_cmdline;
	int	ports[MAX_PORTS];	/* Port number to listen on. */
	char   *listen_addr;		/* Address on which the server listens. */
	struct addrinfo *listen_addrs;	/* Addresses on which the server listens. */
	int     address_family;		/* Address family used by the server. */
	char   *host_key_files[MAX_HOSTKEYS];	/* Files containing host keys. */
	int     num_host_key_files;     /* Number of files for host keys. */
	char   *pid_file;	/* Where to put our pid */
	int     server_key_bits;/* Size of the server key. */
	int     login_grace_time;	/* Disconnect if no auth in this time
					 * (sec). */
	int     key_regeneration_time;	/* Server key lifetime (seconds). */
	int     permit_root_login;	/* PERMIT_*, see above */
	int     ignore_rhosts;	/* Ignore .rhosts and .shosts. */
	int     ignore_user_known_hosts;	/* Ignore ~/.ssh/known_hosts
						 * for RhostsRsaAuth */
	int     print_motd;	/* If true, print /etc/motd. */
	int	print_lastlog;	/* If true, print lastlog */
	int     x11_forwarding;	/* If true, permit inet (spoofing) X11 fwd. */
	int     x11_display_offset;	/* What DISPLAY number to start
					 * searching at */
	int     x11_use_localhost;	/* If true, use localhost for fake X11 server. */
	char   *xauth_location;	/* Location of xauth program */
	int     strict_modes;	/* If true, require string home dir modes. */
	int     tcp_keep_alive;	/* If true, set SO_KEEPALIVE. */
	char   *ciphers;	/* Supported SSH2 ciphers. */
	char   *macs;		/* Supported SSH2 macs. */
	int	protocol;	/* Supported protocol versions. */
	int     gateway_ports;	/* If true, allow remote connects to forwarded ports. */
	SyslogFacility log_facility;	/* Facility for system logging. */
	LogLevel log_level;	/* Level for system logging. */
	int     rhosts_rsa_authentication;	/* If true, permit rhosts RSA
						 * authentication. */
	int     hostbased_authentication;	/* If true, permit ssh2 hostbased auth */
	int     hostbased_uses_name_from_packet_only; /* experimental */
	int     rsa_authentication;	/* If true, permit RSA authentication. */
	int     pubkey_authentication;	/* If true, permit ssh2 pubkey authentication. */
	int     kerberos_authentication;	/* If true, permit Kerberos
						 * authentication. */
	int     kerberos_or_local_passwd;	/* If true, permit kerberos
						 * and any other password
						 * authentication mechanism,
						 * such as SecurID or
						 * /etc/passwd */
	int     kerberos_ticket_cleanup;	/* If true, destroy ticket
						 * file on logout. */
	int     kerberos_get_afs_token;		/* If true, try to get AFS token if
						 * authenticated with Kerberos. */
	int     gss_authentication;	/* If true, permit GSSAPI authentication */
	int     gss_cleanup_creds;	/* If true, destroy cred cache on logout */
	int     password_authentication;	/* If true, permit password
						 * authentication. */
	int     kbd_interactive_authentication;	/* If true, permit */
	int     challenge_response_authentication;
	int     zero_knowledge_password_authentication;
					/* If true, permit jpake auth */
	int     permit_empty_passwd;	/* If false, do not permit empty
					 * passwords. */
	int     permit_user_env;	/* If true, read ~/.ssh/environment */
	int     use_login;	/* If true, login(1) is used */
	int     compression;	/* If true, compression is allowed */
	int	allow_tcp_forwarding;
	int	allow_agent_forwarding;
	u_int num_allow_users;
	char   *allow_users[MAX_ALLOW_USERS];
	u_int num_deny_users;
	char   *deny_users[MAX_DENY_USERS];
	u_int num_allow_groups;
	char   *allow_groups[MAX_ALLOW_GROUPS];
	u_int num_deny_groups;
	char   *deny_groups[MAX_DENY_GROUPS];

	u_int num_subsystems;
	char   *subsystem_name[MAX_SUBSYSTEMS];
	char   *subsystem_command[MAX_SUBSYSTEMS];
	char   *subsystem_args[MAX_SUBSYSTEMS];

	u_int num_accept_env;
	char   *accept_env[MAX_ACCEPT_ENV];

	int	max_startups_begin;
	int	max_startups_rate;
	int	max_startups;
	int	max_authtries;
	int	max_sessions;
	char   *banner;			/* SSH-2 banner message */
	int	use_dns;
	int	client_alive_interval;	/*
					 * poke the client this often to
					 * see if it's still there
					 */
	int	client_alive_count_max;	/*
					 * If the client is unresponsive
					 * for this many intervals above,
					 * disconnect the session
					 */

	char   *authorized_keys_file;	/* File containing public keys */
	char   *authorized_keys_file2;

	char   *adm_forced_command;

	int	use_pam;		/* Enable auth via PAM */

	int	permit_tun;

	int	num_permitted_opens;

	char   *chroot_directory;
}       ServerOptions;

void	 initialize_server_options(ServerOptions *);
void	 fill_default_server_options(ServerOptions *);
int	 process_server_config_line(ServerOptions *, char *, const char *, int,
	     int *, const char *, const char *, const char *);
void	 load_server_config(const char *, Buffer *);
void	 parse_server_config(ServerOptions *, const char *, Buffer *,
	     const char *, const char *, const char *);
void	 parse_server_match_config(ServerOptions *, const char *, const char *,
	     const char *);
void	 copy_set_server_options(ServerOptions *, ServerOptions *, int);
void	 dump_config(ServerOptions *);
char	*derelativise_path(const char *);

#endif				/* SERVCONF_H */
Commit	Line	Data
ca24b550	1	/* $OpenBSD: servconf.h,v 1.90 2010/01/13 03:48:13 djm Exp $ */
93c3b6de	2
8efc0c15	3	/*
5260325f	4	* Author: Tatu Ylonen <ylo@cs.hut.fi>
5260325f	5	* Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5260325f	6	* All rights reserved
5260325f	7	* Definitions for server configuration data and for the functions reading it.
6ae2364d	8	*
bcbf86ec	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".
5260325f	14	*/
8efc0c15	15
8efc0c15	16	#ifndef SERVCONF_H
	17	#define SERVCONF_H
	18
48e671d5	19	#define MAX_PORTS 256 /* Max # ports. */
48e671d5	20
5260325f	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. */
38c295d6	25	#define MAX_SUBSYSTEMS 256 /* Max # subsystems. */
fa08c86b	26	#define MAX_HOSTKEYS 256 /* Max # hostkeys. */
61a2c1da	27	#define MAX_ACCEPT_ENV 256 /* Max # of env vars. */
fa47fe3c	28	#define MAX_MATCH_GROUPS 256 /* Max # of groups for Match. */
8efc0c15	29
15853e93	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
af4bd935	37	#define DEFAULT_AUTH_FAIL_MAX 6 /* Default for MaxAuthTries */
c6dca55e	38	#define DEFAULT_SESSIONS_MAX 10 /* Default for MaxSessions */
15853e93	39
3dfce5de	40	/* Magic name for internal sftp-server */
	41	#define INTERNAL_SFTP_NAME "internal-sftp"
	42
5260325f	43	typedef struct {
5134115d	44	u_int num_ports;
	45	u_int ports_from_cmdline;
	46	int ports[MAX_PORTS]; /* Port number to listen on. */
48e671d5	47	char listen_addr; / Address on which the server listens. */
48e671d5	48	struct addrinfo listen_addrs; / Addresses on which the server listens. */
31b41ceb	49	int address_family; /* Address family used by the server. */
fa08c86b	50	char host_key_files[MAX_HOSTKEYS]; / Files containing host keys. */
fa08c86b	51	int num_host_key_files; /* Number of files for host keys. */
0fbe8c74	52	char pid_file; / Where to put our pid */
5260325f	53	int server_key_bits;/* Size of the server key. */
	54	int login_grace_time; /* Disconnect if no auth in this time
	55	* (sec). */
	56	int key_regeneration_time; /* Server key lifetime (seconds). */
15853e93	57	int permit_root_login; /* PERMIT_, see above /
5260325f	58	int ignore_rhosts; /* Ignore .rhosts and .shosts. */
	59	int ignore_user_known_hosts; /* Ignore ~/.ssh/known_hosts
	60	* for RhostsRsaAuth */
	61	int print_motd; /* If true, print /etc/motd. */
4f4648f9	62	int print_lastlog; /* If true, print lastlog */
5260325f	63	int x11_forwarding; /* If true, permit inet (spoofing) X11 fwd. */
	64	int x11_display_offset; /* What DISPLAY number to start
	65	* searching at */
e6e573bd	66	int x11_use_localhost; /* If true, use localhost for fake X11 server. */
fa649821	67	char xauth_location; / Location of xauth program */
5260325f	68	int strict_modes; /* If true, require string home dir modes. */
fd573618	69	int tcp_keep_alive; /* If true, set SO_KEEPALIVE. */
b2552997	70	char ciphers; / Supported SSH2 ciphers. */
	71	char macs; / Supported SSH2 macs. */
	72	int protocol; /* Supported protocol versions. */
1d1ffb87	73	int gateway_ports; /* If true, allow remote connects to forwarded ports. */
5260325f	74	SyslogFacility log_facility; /* Facility for system logging. */
5260325f	75	LogLevel log_level; /* Level for system logging. */
5260325f	76	int rhosts_rsa_authentication; /* If true, permit rhosts RSA
5260325f	77	* authentication. */
8002af61	78	int hostbased_authentication; /* If true, permit ssh2 hostbased auth */
8002af61	79	int hostbased_uses_name_from_packet_only; /* experimental */
5260325f	80	int rsa_authentication; /* If true, permit RSA authentication. */
fa08c86b	81	int pubkey_authentication; /* If true, permit ssh2 pubkey authentication. */
5260325f	82	int kerberos_authentication; /* If true, permit Kerberos
	83	* authentication. */
	84	int kerberos_or_local_passwd; /* If true, permit kerberos
	85	* and any other password
	86	* authentication mechanism,
	87	* such as SecurID or
	88	* /etc/passwd */
	89	int kerberos_ticket_cleanup; /* If true, destroy ticket
	90	* file on logout. */
a1e30b47	91	int kerberos_get_afs_token; /* If true, try to get AFS token if
a1e30b47	92	* authenticated with Kerberos. */
7364bd04	93	int gss_authentication; /* If true, permit GSSAPI authentication */
7364bd04	94	int gss_cleanup_creds; /* If true, destroy cred cache on logout */
5260325f	95	int password_authentication; /* If true, permit password
5260325f	96	* authentication. */
94ec8c6b	97	int kbd_interactive_authentication; /* If true, permit */
5ba55ada	98	int challenge_response_authentication;
5adf6b9a	99	int zero_knowledge_password_authentication;
5adf6b9a	100	/* If true, permit jpake auth */
5260325f	101	int permit_empty_passwd; /* If false, do not permit empty
5260325f	102	* passwords. */
f00bab84	103	int permit_user_env; /* If true, read ~/.ssh/environment */
5260325f	104	int use_login; /* If true, login(1) is used */
636f76ca	105	int compression; /* If true, compression is allowed */
33de75a3	106	int allow_tcp_forwarding;
43c3f85c	107	int allow_agent_forwarding;
1e3b8b07	108	u_int num_allow_users;
5260325f	109	char *allow_users[MAX_ALLOW_USERS];
1e3b8b07	110	u_int num_deny_users;
5260325f	111	char *deny_users[MAX_DENY_USERS];
1e3b8b07	112	u_int num_allow_groups;
5260325f	113	char *allow_groups[MAX_ALLOW_GROUPS];
1e3b8b07	114	u_int num_deny_groups;
5260325f	115	char *deny_groups[MAX_DENY_GROUPS];
38c295d6	116
1e3b8b07	117	u_int num_subsystems;
38c295d6	118	char *subsystem_name[MAX_SUBSYSTEMS];
38c295d6	119	char *subsystem_command[MAX_SUBSYSTEMS];
d66ce1a1	120	char *subsystem_args[MAX_SUBSYSTEMS];
089fbbd2	121
61a2c1da	122	u_int num_accept_env;
	123	char *accept_env[MAX_ACCEPT_ENV];
	124
c345cf9d	125	int max_startups_begin;
c345cf9d	126	int max_startups_rate;
089fbbd2	127	int max_startups;
af4bd935	128	int max_authtries;
c6dca55e	129	int max_sessions;
eea39c02	130	char banner; / SSH-2 banner message */
c5a7d788	131	int use_dns;
3ffc6336	132	int client_alive_interval; /*
184eed6a	133	* poke the client this often to
184eed6a	134	* see if it's still there
3ffc6336	135	*/
3ffc6336	136	int client_alive_count_max; /*
6d7b3036	137	* If the client is unresponsive
6d7b3036	138	* for this many intervals above,
184eed6a	139	* disconnect the session
3ffc6336	140	*/
4f1f4d8d	141
	142	char authorized_keys_file; / File containing public keys */
	143	char *authorized_keys_file2;
d20f3c9e	144
e7259e8d	145	char *adm_forced_command;
e7259e8d	146
7fceb20d	147	int use_pam; /* Enable auth via PAM */
d20f3c9e	148
d20f3c9e	149	int permit_tun;
ea46e550	150
ea46e550	151	int num_permitted_opens;
db49deeb	152
db49deeb	153	char *chroot_directory;
5260325f	154	} ServerOptions;
8efc0c15	155
255cabd9	156	void initialize_server_options(ServerOptions *);
255cabd9	157	void fill_default_server_options(ServerOptions *);
d231781a	158	int process_server_config_line(ServerOptions , char , const char *, int,
d231781a	159	int , const char , const char , const char );
b9a549d7	160	void load_server_config(const char , Buffer );
d231781a	161	void parse_server_config(ServerOptions , const char , Buffer *,
	162	const char , const char , const char *);
	163	void parse_server_match_config(ServerOptions , const char , const char *,
	164	const char *);
03bcbf84	165	void copy_set_server_options(ServerOptions , ServerOptions , int);
1760c982	166	void dump_config(ServerOptions *);
ca24b550	167	char derelativise_path(const char );
8efc0c15	168
5260325f	169	#endif /* SERVCONF_H */