[gssapi-openssh.git] / openssh / servconf.h

/* $OpenBSD: servconf.h,v 1.87 2009/01/22 10:02:34 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. */
#ifdef SESSION_HOOKS
        int     session_hooks_allow;        /* If true, permit user hooks */
        char*   session_hooks_startup_cmd;  /* cmd to be executed before */
        char*   session_hooks_shutdown_cmd; /* cmd to be executed after */
#endif
	int     kerberos_get_afs_token;		/* If true, try to get AFS token if
						 * authenticated with Kerberos. */
	int     gsi_allow_limited_proxy;	/* If true, accept limited proxies */
	int     gss_authentication;	/* If true, permit GSSAPI authentication */
	int     gss_deleg_creds;	/* If true, store delegated GSSAPI credentials*/
	int     gss_keyex;		/* If true, permit GSSAPI key exchange */
	int     gss_cleanup_creds;	/* If true, destroy cred cache on logout */
	char*   gss_creds_path;	/* If true, destroy cred cache on logout */
	int 	gss_strict_acceptor;	/* If true, restrict the GSSAPI acceptor name */
	int 	gss_store_rekey;
	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_pam_user_change;	/* Allow PAM to change user name */
        int     none_enabled;           /* enable NONE cipher switch */
        int     tcp_rcv_buf_poll;       /* poll tcp rcv window in autotuning kernels*/
	int	hpn_disabled;		/* disable hpn functionality. false by default */
	int	hpn_buffer_size;	/* set the hpn buffer size - default 3MB */

	int	permit_tun;

	int	num_permitted_opens;

	char   *chroot_directory;

	int    disable_usage_stats;

	char   *usage_stats_targets;
}       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 *);

#endif				/* SERVCONF_H */
Commit	Line	Data
5262cbfb	1	/* $OpenBSD: servconf.h,v 1.87 2009/01/22 10:02:34 djm Exp $ */
e9702f7d	2
3c0ef626	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
3c0ef626	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. */
7e82606e	27	#define MAX_ACCEPT_ENV 256 /* Max # of env vars. */
30460aeb	28	#define MAX_MATCH_GROUPS 256 /* Max # of groups for Match. */
3c0ef626	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
7e82606e	37	#define DEFAULT_AUTH_FAIL_MAX 6 /* Default for MaxAuthTries */
5156b1a1	38	#define DEFAULT_SESSIONS_MAX 10 /* Default for MaxSessions */
3c0ef626	39
e74dc197	40	/* Magic name for internal sftp-server */
	41	#define INTERNAL_SFTP_NAME "internal-sftp"
	42
3c0ef626	43	typedef struct {
5262cbfb	44	u_int num_ports;
	45	u_int ports_from_cmdline;
	46	int ports[MAX_PORTS]; /* Port number to listen on. */
3c0ef626	47	char listen_addr; / Address on which the server listens. */
3c0ef626	48	struct addrinfo listen_addrs; / Addresses on which the server listens. */
dfddba3d	49	int address_family; /* Address family used by the server. */
3c0ef626	50	char host_key_files[MAX_HOSTKEYS]; / Files containing host keys. */
	51	int num_host_key_files; /* Number of files for host keys. */
	52	char pid_file; / Where to put our pid */
	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). */
	57	int permit_root_login; /* PERMIT_, see above /
	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. */
	62	int print_lastlog; /* If true, print lastlog */
	63	int x11_forwarding; /* If true, permit inet (spoofing) X11 fwd. */
	64	int x11_display_offset; /* What DISPLAY number to start
	65	* searching at */
e9702f7d	66	int x11_use_localhost; /* If true, use localhost for fake X11 server. */
3c0ef626	67	char xauth_location; / Location of xauth program */
3c0ef626	68	int strict_modes; /* If true, require string home dir modes. */
540d72c3	69	int tcp_keep_alive; /* If true, set SO_KEEPALIVE. */
3c0ef626	70	char ciphers; / Supported SSH2 ciphers. */
	71	char macs; / Supported SSH2 macs. */
	72	int protocol; /* Supported protocol versions. */
	73	int gateway_ports; /* If true, allow remote connects to forwarded ports. */
	74	SyslogFacility log_facility; /* Facility for system logging. */
	75	LogLevel log_level; /* Level for system logging. */
3c0ef626	76	int rhosts_rsa_authentication; /* If true, permit rhosts RSA
	77	* authentication. */
	78	int hostbased_authentication; /* If true, permit ssh2 hostbased auth */
	79	int hostbased_uses_name_from_packet_only; /* experimental */
	80	int rsa_authentication; /* If true, permit RSA authentication. */
	81	int pubkey_authentication; /* If true, permit ssh2 pubkey authentication. */
3c0ef626	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. */
75be3237	91	#ifdef SESSION_HOOKS
	92	int session_hooks_allow; /* If true, permit user hooks */
	93	char* session_hooks_startup_cmd; /* cmd to be executed before */
	94	char* session_hooks_shutdown_cmd; /* cmd to be executed after */
3c0ef626	95	#endif
540d72c3	96	int kerberos_get_afs_token; /* If true, try to get AFS token if
540d72c3	97	* authenticated with Kerberos. */
c7931c9a	98	int gsi_allow_limited_proxy; /* If true, accept limited proxies */
7cac2b65	99	int gss_authentication; /* If true, permit GSSAPI authentication */
05ed7e1e	100	int gss_deleg_creds; /* If true, store delegated GSSAPI credentials*/
f97edba6	101	int gss_keyex; /* If true, permit GSSAPI key exchange */
7cac2b65	102	int gss_cleanup_creds; /* If true, destroy cred cache on logout */
9c0efabd	103	char* gss_creds_path; /* If true, destroy cred cache on logout */
f97edba6	104	int gss_strict_acceptor; /* If true, restrict the GSSAPI acceptor name */
f97edba6	105	int gss_store_rekey;
3c0ef626	106	int password_authentication; /* If true, permit password
	107	* authentication. */
	108	int kbd_interactive_authentication; /* If true, permit */
	109	int challenge_response_authentication;
5262cbfb	110	int zero_knowledge_password_authentication;
5262cbfb	111	/* If true, permit jpake auth */
3c0ef626	112	int permit_empty_passwd; /* If false, do not permit empty
3c0ef626	113	* passwords. */
d03f4262	114	int permit_user_env; /* If true, read ~/.ssh/environment */
3c0ef626	115	int use_login; /* If true, login(1) is used */
44a053a3	116	int compression; /* If true, compression is allowed */
3c0ef626	117	int allow_tcp_forwarding;
5156b1a1	118	int allow_agent_forwarding;
3c0ef626	119	u_int num_allow_users;
	120	char *allow_users[MAX_ALLOW_USERS];
	121	u_int num_deny_users;
	122	char *deny_users[MAX_DENY_USERS];
	123	u_int num_allow_groups;
	124	char *allow_groups[MAX_ALLOW_GROUPS];
	125	u_int num_deny_groups;
	126	char *deny_groups[MAX_DENY_GROUPS];
	127
	128	u_int num_subsystems;
	129	char *subsystem_name[MAX_SUBSYSTEMS];
	130	char *subsystem_command[MAX_SUBSYSTEMS];
30460aeb	131	char *subsystem_args[MAX_SUBSYSTEMS];
3c0ef626	132
7e82606e	133	u_int num_accept_env;
	134	char *accept_env[MAX_ACCEPT_ENV];
	135
3c0ef626	136	int max_startups_begin;
	137	int max_startups_rate;
	138	int max_startups;
7e82606e	139	int max_authtries;
5156b1a1	140	int max_sessions;
3c0ef626	141	char banner; / SSH-2 banner message */
7cac2b65	142	int use_dns;
3c0ef626	143	int client_alive_interval; /*
e9702f7d	144	* poke the client this often to
e9702f7d	145	* see if it's still there
3c0ef626	146	*/
	147	int client_alive_count_max; /*
	148	* If the client is unresponsive
	149	* for this many intervals above,
e9702f7d	150	* disconnect the session
3c0ef626	151	*/
	152
	153	char authorized_keys_file; / File containing public keys */
	154	char *authorized_keys_file2;
08822d99	155
30460aeb	156	char *adm_forced_command;
30460aeb	157
7cac2b65	158	int use_pam; /* Enable auth via PAM */
d037a8b0	159	int permit_pam_user_change; /* Allow PAM to change user name */
a7213e65	160	int none_enabled; /* enable NONE cipher switch */
	161	int tcp_rcv_buf_poll; /* poll tcp rcv window in autotuning kernels*/
	162	int hpn_disabled; /* disable hpn functionality. false by default */
	163	int hpn_buffer_size; /* set the hpn buffer size - default 3MB */
08822d99	164
08822d99	165	int permit_tun;
30460aeb	166
30460aeb	167	int num_permitted_opens;
e74dc197	168
e74dc197	169	char *chroot_directory;
9f2c8cb9	170
	171	int disable_usage_stats;
	172
	173	char *usage_stats_targets;
3c0ef626	174	} ServerOptions;
	175
	176	void initialize_server_options(ServerOptions *);
3c0ef626	177	void fill_default_server_options(ServerOptions *);
30460aeb	178	int process_server_config_line(ServerOptions , char , const char *, int,
30460aeb	179	int , const char , const char , const char );
7e82606e	180	void load_server_config(const char , Buffer );
30460aeb	181	void parse_server_config(ServerOptions , const char , Buffer *,
	182	const char , const char , const char *);
	183	void parse_server_match_config(ServerOptions , const char , const char *,
	184	const char *);
0b90ac93	185	void copy_set_server_options(ServerOptions , ServerOptions , int);
5156b1a1	186	void dump_config(ServerOptions *);
3c0ef626	187
3c0ef626	188	#endif /* SERVCONF_H */