[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.29 2000/10/11 20:14:39 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. */

typedef struct {
	unsigned int num_ports;
	unsigned 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_file;	/* File containing host key. */
	char   *host_dsa_key_file;	/* File containing dsa host key. */
	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     dsa_authentication;	/* If true, permit DSA 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 */
	unsigned int num_allow_users;
	char   *allow_users[MAX_ALLOW_USERS];
	unsigned int num_deny_users;
	char   *deny_users[MAX_DENY_USERS];
	unsigned int num_allow_groups;
	char   *allow_groups[MAX_ALLOW_GROUPS];
	unsigned int num_deny_groups;
	char   *deny_groups[MAX_DENY_GROUPS];

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