[openssh.git] / servconf.h

/*
 * 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".
 */

/* RCSID("$OpenBSD: servconf.h,v 1.38 2001/02/12 16:16:23 markus Exp $"); */

#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. */

/* 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


typedef struct {
	u_int num_ports;
	u_int ports_from_cmdline;
	u_short 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. */
	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     check_mail;	/* If true, check for new mail. */
	int     x11_forwarding;	/* If true, permit inet (spoofing) X11 fwd. */
	int     x11_display_offset;	/* What DISPLAY number to start
					 * searching at */
	char   *xauth_location;	/* Location of xauth program */
	int     strict_modes;	/* If true, require string home dir modes. */
	int     keepalives;	/* 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_authentication;	/* If true, permit rhosts
					 * authentication. */
	int     rhosts_rsa_authentication;	/* If true, permit rhosts RSA
						 * authentication. */
	int     rsa_authentication;	/* If true, permit RSA authentication. */
	int     pubkey_authentication;	/* If true, permit ssh2 pubkey authentication. */
#ifdef KRB4
	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. */
#endif
#ifdef AFS
	int     kerberos_tgt_passing;	/* If true, permit Kerberos tgt
					 * passing. */
	int     afs_token_passing;	/* If true, permit AFS token passing. */
#endif
	int     password_authentication;	/* If true, permit password
						 * authentication. */
	int     kbd_interactive_authentication;	/* If true, permit */
	int     challenge_reponse_authentication;
	int     permit_empty_passwd;	/* If false, do not permit empty
					 * passwords. */
	int     use_login;	/* If true, login(1) is used */
	int	allow_tcp_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];

	int	max_startups_begin;
	int	max_startups_rate;
	int	max_startups;
	char   *banner;			/* SSH-2 banner message */
	int	reverse_mapping_check;	/* cross-check ip and dns */

}       ServerOptions;
/*
 * Initializes the server options to special values that indicate that they
 * have not yet been set.
 */
void    initialize_server_options(ServerOptions * options);

/*
 * Reads the server configuration file.  This only sets the values for those
 * options that have the special value indicating they have not been set.
 */
void    read_server_config(ServerOptions * options, const char *filename);

/* Sets values for those values that have not yet been set. */
void    fill_default_server_options(ServerOptions * options);

#endif				/* SERVCONF_H */
Commit	Line	Data
8efc0c15	1	/*
5260325f	2	* Author: Tatu Ylonen <ylo@cs.hut.fi>
5260325f	3	* Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5260325f	4	* All rights reserved
5260325f	5	* Definitions for server configuration data and for the functions reading it.
6ae2364d	6	*
bcbf86ec	7	* As far as I am concerned, the code I have written for this software
	8	* can be used freely for any purpose. Any derived versions of this
	9	* software must be clearly marked as such, and if the derived work is
	10	* incompatible with the protocol description in the RFC file, it must be
	11	* called by a name other than "ssh" or "Secure Shell".
5260325f	12	*/
8efc0c15	13
15853e93	14	/* RCSID("$OpenBSD: servconf.h,v 1.38 2001/02/12 16:16:23 markus Exp $"); */
8efc0c15	15
	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. */
8efc0c15	27
15853e93	28	/* permit_root_login */
	29	#define PERMIT_NOT_SET -1
	30	#define PERMIT_NO 0
	31	#define PERMIT_FORCED_ONLY 1
	32	#define PERMIT_NO_PASSWD 2
	33	#define PERMIT_YES 3
	34
	35
5260325f	36	typedef struct {
1e3b8b07	37	u_int num_ports;
1e3b8b07	38	u_int ports_from_cmdline;
48e671d5	39	u_short ports[MAX_PORTS]; /* Port number to listen on. */
	40	char listen_addr; / Address on which the server listens. */
	41	struct addrinfo listen_addrs; / Addresses on which the server listens. */
fa08c86b	42	char host_key_files[MAX_HOSTKEYS]; / Files containing host keys. */
fa08c86b	43	int num_host_key_files; /* Number of files for host keys. */
0fbe8c74	44	char pid_file; / Where to put our pid */
5260325f	45	int server_key_bits;/* Size of the server key. */
	46	int login_grace_time; /* Disconnect if no auth in this time
	47	* (sec). */
	48	int key_regeneration_time; /* Server key lifetime (seconds). */
15853e93	49	int permit_root_login; /* PERMIT_, see above /
5260325f	50	int ignore_rhosts; /* Ignore .rhosts and .shosts. */
	51	int ignore_user_known_hosts; /* Ignore ~/.ssh/known_hosts
	52	* for RhostsRsaAuth */
	53	int print_motd; /* If true, print /etc/motd. */
	54	int check_mail; /* If true, check for new mail. */
	55	int x11_forwarding; /* If true, permit inet (spoofing) X11 fwd. */
	56	int x11_display_offset; /* What DISPLAY number to start
	57	* searching at */
fa649821	58	char xauth_location; / Location of xauth program */
5260325f	59	int strict_modes; /* If true, require string home dir modes. */
5260325f	60	int keepalives; /* If true, set SO_KEEPALIVE. */
b2552997	61	char ciphers; / Supported SSH2 ciphers. */
	62	char macs; / Supported SSH2 macs. */
	63	int protocol; /* Supported protocol versions. */
1d1ffb87	64	int gateway_ports; /* If true, allow remote connects to forwarded ports. */
5260325f	65	SyslogFacility log_facility; /* Facility for system logging. */
	66	LogLevel log_level; /* Level for system logging. */
	67	int rhosts_authentication; /* If true, permit rhosts
	68	* authentication. */
	69	int rhosts_rsa_authentication; /* If true, permit rhosts RSA
	70	* authentication. */
	71	int rsa_authentication; /* If true, permit RSA authentication. */
fa08c86b	72	int pubkey_authentication; /* If true, permit ssh2 pubkey authentication. */
8efc0c15	73	#ifdef KRB4
5260325f	74	int kerberos_authentication; /* If true, permit Kerberos
	75	* authentication. */
	76	int kerberos_or_local_passwd; /* If true, permit kerberos
	77	* and any other password
	78	* authentication mechanism,
	79	* such as SecurID or
	80	* /etc/passwd */
	81	int kerberos_ticket_cleanup; /* If true, destroy ticket
	82	* file on logout. */
8efc0c15	83	#endif
8efc0c15	84	#ifdef AFS
5260325f	85	int kerberos_tgt_passing; /* If true, permit Kerberos tgt
	86	* passing. */
	87	int afs_token_passing; /* If true, permit AFS token passing. */
8efc0c15	88	#endif
5260325f	89	int password_authentication; /* If true, permit password
5260325f	90	* authentication. */
94ec8c6b	91	int kbd_interactive_authentication; /* If true, permit */
d464095c	92	int challenge_reponse_authentication;
5260325f	93	int permit_empty_passwd; /* If false, do not permit empty
	94	* passwords. */
	95	int use_login; /* If true, login(1) is used */
33de75a3	96	int allow_tcp_forwarding;
1e3b8b07	97	u_int num_allow_users;
5260325f	98	char *allow_users[MAX_ALLOW_USERS];
1e3b8b07	99	u_int num_deny_users;
5260325f	100	char *deny_users[MAX_DENY_USERS];
1e3b8b07	101	u_int num_allow_groups;
5260325f	102	char *allow_groups[MAX_ALLOW_GROUPS];
1e3b8b07	103	u_int num_deny_groups;
5260325f	104	char *deny_groups[MAX_DENY_GROUPS];
38c295d6	105
1e3b8b07	106	u_int num_subsystems;
38c295d6	107	char *subsystem_name[MAX_SUBSYSTEMS];
38c295d6	108	char *subsystem_command[MAX_SUBSYSTEMS];
089fbbd2	109
c345cf9d	110	int max_startups_begin;
c345cf9d	111	int max_startups_rate;
089fbbd2	112	int max_startups;
eea39c02	113	char banner; / SSH-2 banner message */
61e96248	114	int reverse_mapping_check; /* cross-check ip and dns */
089fbbd2	115
5260325f	116	} ServerOptions;
aa3378df	117	/*
	118	* Initializes the server options to special values that indicate that they
	119	* have not yet been set.
	120	*/
5260325f	121	void initialize_server_options(ServerOptions * options);
8efc0c15	122
aa3378df	123	/*
	124	* Reads the server configuration file. This only sets the values for those
	125	* options that have the special value indicating they have not been set.
	126	*/
5260325f	127	void read_server_config(ServerOptions * options, const char *filename);
8efc0c15	128
8efc0c15	129	/* Sets values for those values that have not yet been set. */
5260325f	130	void fill_default_server_options(ServerOptions * options);
8efc0c15	131
5260325f	132	#endif /* SERVCONF_H */