[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.32 2000/12/19 23:17:58 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. */

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;	/* If true, permit root login. */
	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;	/* Ciphers in order of preference. */
	int	protocol;	/* Protocol in order of preference. */
	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 */
#ifdef SKEY
	int     skey_authentication;	/* If true, permit s/key
					 * authentication. */
#endif
	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;

}       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
1e3b8b07	14	/* RCSID("$OpenBSD: servconf.h,v 1.32 2000/12/19 23:17:58 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
5260325f	28	typedef struct {
1e3b8b07	29	u_int num_ports;
1e3b8b07	30	u_int ports_from_cmdline;
48e671d5	31	u_short ports[MAX_PORTS]; /* Port number to listen on. */
	32	char listen_addr; / Address on which the server listens. */
	33	struct addrinfo listen_addrs; / Addresses on which the server listens. */
fa08c86b	34	char host_key_files[MAX_HOSTKEYS]; / Files containing host keys. */
fa08c86b	35	int num_host_key_files; /* Number of files for host keys. */
0fbe8c74	36	char pid_file; / Where to put our pid */
5260325f	37	int server_key_bits;/* Size of the server key. */
	38	int login_grace_time; /* Disconnect if no auth in this time
	39	* (sec). */
	40	int key_regeneration_time; /* Server key lifetime (seconds). */
	41	int permit_root_login; /* If true, permit root login. */
	42	int ignore_rhosts; /* Ignore .rhosts and .shosts. */
	43	int ignore_user_known_hosts; /* Ignore ~/.ssh/known_hosts
	44	* for RhostsRsaAuth */
	45	int print_motd; /* If true, print /etc/motd. */
	46	int check_mail; /* If true, check for new mail. */
	47	int x11_forwarding; /* If true, permit inet (spoofing) X11 fwd. */
	48	int x11_display_offset; /* What DISPLAY number to start
	49	* searching at */
fa649821	50	char xauth_location; / Location of xauth program */
5260325f	51	int strict_modes; /* If true, require string home dir modes. */
5260325f	52	int keepalives; /* If true, set SO_KEEPALIVE. */
a8be9f80	53	char ciphers; / Ciphers in order of preference. */
a8be9f80	54	int protocol; /* Protocol in order of preference. */
1d1ffb87	55	int gateway_ports; /* If true, allow remote connects to forwarded ports. */
5260325f	56	SyslogFacility log_facility; /* Facility for system logging. */
	57	LogLevel log_level; /* Level for system logging. */
	58	int rhosts_authentication; /* If true, permit rhosts
	59	* authentication. */
	60	int rhosts_rsa_authentication; /* If true, permit rhosts RSA
	61	* authentication. */
	62	int rsa_authentication; /* If true, permit RSA authentication. */
fa08c86b	63	int pubkey_authentication; /* If true, permit ssh2 pubkey authentication. */
8efc0c15	64	#ifdef KRB4
5260325f	65	int kerberos_authentication; /* If true, permit Kerberos
	66	* authentication. */
	67	int kerberos_or_local_passwd; /* If true, permit kerberos
	68	* and any other password
	69	* authentication mechanism,
	70	* such as SecurID or
	71	* /etc/passwd */
	72	int kerberos_ticket_cleanup; /* If true, destroy ticket
	73	* file on logout. */
8efc0c15	74	#endif
8efc0c15	75	#ifdef AFS
5260325f	76	int kerberos_tgt_passing; /* If true, permit Kerberos tgt
	77	* passing. */
	78	int afs_token_passing; /* If true, permit AFS token passing. */
8efc0c15	79	#endif
5260325f	80	int password_authentication; /* If true, permit password
5260325f	81	* authentication. */
94ec8c6b	82	int kbd_interactive_authentication; /* If true, permit */
8efc0c15	83	#ifdef SKEY
5260325f	84	int skey_authentication; /* If true, permit s/key
5260325f	85	* authentication. */
8efc0c15	86	#endif
5260325f	87	int permit_empty_passwd; /* If false, do not permit empty
	88	* passwords. */
	89	int use_login; /* If true, login(1) is used */
33de75a3	90	int allow_tcp_forwarding;
1e3b8b07	91	u_int num_allow_users;
5260325f	92	char *allow_users[MAX_ALLOW_USERS];
1e3b8b07	93	u_int num_deny_users;
5260325f	94	char *deny_users[MAX_DENY_USERS];
1e3b8b07	95	u_int num_allow_groups;
5260325f	96	char *allow_groups[MAX_ALLOW_GROUPS];
1e3b8b07	97	u_int num_deny_groups;
5260325f	98	char *deny_groups[MAX_DENY_GROUPS];
38c295d6	99
1e3b8b07	100	u_int num_subsystems;
38c295d6	101	char *subsystem_name[MAX_SUBSYSTEMS];
38c295d6	102	char *subsystem_command[MAX_SUBSYSTEMS];
089fbbd2	103
c345cf9d	104	int max_startups_begin;
c345cf9d	105	int max_startups_rate;
089fbbd2	106	int max_startups;
089fbbd2	107
5260325f	108	} ServerOptions;
aa3378df	109	/*
	110	* Initializes the server options to special values that indicate that they
	111	* have not yet been set.
	112	*/
5260325f	113	void initialize_server_options(ServerOptions * options);
8efc0c15	114
aa3378df	115	/*
	116	* Reads the server configuration file. This only sets the values for those
	117	* options that have the special value indicating they have not been set.
	118	*/
5260325f	119	void read_server_config(ServerOptions * options, const char *filename);
8efc0c15	120
8efc0c15	121	/* Sets values for those values that have not yet been set. */
5260325f	122	void fill_default_server_options(ServerOptions * options);
8efc0c15	123
5260325f	124	#endif /* SERVCONF_H */