xref: /freebsd/crypto/openssh/servconf.h (revision 5521ff5a4d1929056e7ffc982fac3341ca54df7c)
1 /*
2  * Author: Tatu Ylonen <ylo@cs.hut.fi>
3  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
4  *                    All rights reserved
5  * Definitions for server configuration data and for the functions reading it.
6  *
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".
12  */
13 
14 /* RCSID("$OpenBSD: servconf.h,v 1.41 2001/04/13 22:46:53 beck Exp $"); */
15 /* RCSID("$FreeBSD$"); */
16 
17 #ifndef SERVCONF_H
18 #define SERVCONF_H
19 
20 #define MAX_PORTS		256	/* Max # ports. */
21 
22 #define MAX_ALLOW_USERS		256	/* Max # users on allow list. */
23 #define MAX_DENY_USERS		256	/* Max # users on deny list. */
24 #define MAX_ALLOW_GROUPS	256	/* Max # groups on allow list. */
25 #define MAX_DENY_GROUPS		256	/* Max # groups on deny list. */
26 #define MAX_SUBSYSTEMS		256	/* Max # subsystems. */
27 #define MAX_HOSTKEYS		256	/* Max # hostkeys. */
28 
29 /* permit_root_login */
30 #define	PERMIT_NOT_SET		-1
31 #define	PERMIT_NO		0
32 #define	PERMIT_FORCED_ONLY	1
33 #define	PERMIT_NO_PASSWD	2
34 #define	PERMIT_YES		3
35 
36 
37 typedef struct {
38 	u_int num_ports;
39 	u_int ports_from_cmdline;
40 	u_short ports[MAX_PORTS];	/* Port number to listen on. */
41 	char   *listen_addr;		/* Address on which the server listens. */
42 	struct addrinfo *listen_addrs;	/* Addresses on which the server listens. */
43 	char   *host_key_files[MAX_HOSTKEYS];	/* Files containing host keys. */
44 	int     num_host_key_files;     /* Number of files for host keys. */
45 	char   *pid_file;	/* Where to put our pid */
46 	int     server_key_bits;/* Size of the server key. */
47 	int     login_grace_time;	/* Disconnect if no auth in this time
48 					 * (sec). */
49 	int     key_regeneration_time;	/* Server key lifetime (seconds). */
50 	int     permit_root_login;	/* PERMIT_*, see above */
51 	int     ignore_rhosts;	/* Ignore .rhosts and .shosts. */
52 	int     ignore_user_known_hosts;	/* Ignore ~/.ssh/known_hosts
53 						 * for RhostsRsaAuth */
54 	int     print_motd;	/* If true, print /etc/motd. */
55 	int	print_lastlog;	/* If true, print lastlog */
56 	int     check_mail;	/* If true, check for new mail. */
57 	int     x11_forwarding;	/* If true, permit inet (spoofing) X11 fwd. */
58 	int     x11_display_offset;	/* What DISPLAY number to start
59 					 * searching at */
60 	char   *xauth_location;	/* Location of xauth program */
61 	int     strict_modes;	/* If true, require string home dir modes. */
62 	int     keepalives;	/* If true, set SO_KEEPALIVE. */
63 	char   *ciphers;	/* Supported SSH2 ciphers. */
64 	char   *macs;		/* Supported SSH2 macs. */
65 	int	protocol;	/* Supported protocol versions. */
66 	int     gateway_ports;	/* If true, allow remote connects to forwarded ports. */
67 	SyslogFacility log_facility;	/* Facility for system logging. */
68 	LogLevel log_level;	/* Level for system logging. */
69 	int     rhosts_authentication;	/* If true, permit rhosts
70 					 * authentication. */
71 	int     rhosts_rsa_authentication;	/* If true, permit rhosts RSA
72 						 * authentication. */
73 	int     hostbased_authentication;	/* If true, permit ssh2 hostbased auth */
74 	int     hostbased_uses_name_from_packet_only; /* experimental */
75 	int     rsa_authentication;	/* If true, permit RSA authentication. */
76 #if defined(KRB4) || defined(KRB5)
77 	int     kerberos_authentication; /* If true, permit Kerberos auth. */
78 #endif /* KRB4 || KRB5 */
79 	int     pubkey_authentication;	/* If true, permit ssh2 pubkey authentication. */
80 #ifdef KRB4
81 	int     krb4_or_local_passwd;		/* If true, permit kerberos v4
82 						 * and any other password
83 						 * authentication mechanism,
84 						 * such as SecurID or
85 						 * /etc/passwd */
86 	int     krb4_ticket_cleanup;		/* If true, destroy ticket
87 						 * file on logout. */
88 #endif
89 #ifdef KRB5
90 	int     krb5_tgt_passing;
91 
92 #endif /* KRB5 */
93 #ifdef AFS
94 	int     krb4_tgt_passing;	/* If true, permit Kerberos v4 tgt
95 					 * passing. */
96 	int     afs_token_passing;	/* If true, permit AFS token passing. */
97 #endif
98 	int     password_authentication;	/* If true, permit password
99 						 * authentication. */
100 	int     kbd_interactive_authentication;	/* If true, permit */
101 	int     challenge_reponse_authentication;
102 	int     permit_empty_passwd;	/* If false, do not permit empty
103 					 * passwords. */
104 	int     use_login;	/* If true, login(1) is used */
105 	int	allow_tcp_forwarding;
106 	u_int num_allow_users;
107 	char   *allow_users[MAX_ALLOW_USERS];
108 	u_int num_deny_users;
109 	char   *deny_users[MAX_DENY_USERS];
110 	u_int num_allow_groups;
111 	char   *allow_groups[MAX_ALLOW_GROUPS];
112 	u_int num_deny_groups;
113 	char   *deny_groups[MAX_DENY_GROUPS];
114 	unsigned int connections_per_period;	/*
115 						 * If not 0, number of sshd
116 						 * connections accepted per
117 						 * connections_period.
118 						 */
119 	unsigned int connections_period;
120 
121 	u_int num_subsystems;
122 	char   *subsystem_name[MAX_SUBSYSTEMS];
123 	char   *subsystem_command[MAX_SUBSYSTEMS];
124 
125 	int	max_startups_begin;
126 	int	max_startups_rate;
127 	int	max_startups;
128 	char   *banner;			/* SSH-2 banner message */
129 	int	reverse_mapping_check;	/* cross-check ip and dns */
130 	int	client_alive_interval;	/*
131 					 * poke the client this often to
132 					 * see if it's still there
133 					 */
134 	int	client_alive_count_max;	/*
135 					 *If the client is unresponsive
136 					 * for this many intervals, above
137 					 * diconnect the session
138 					 */
139 
140 }       ServerOptions;
141 /*
142  * Initializes the server options to special values that indicate that they
143  * have not yet been set.
144  */
145 void    initialize_server_options(ServerOptions * options);
146 
147 /*
148  * Reads the server configuration file.  This only sets the values for those
149  * options that have the special value indicating they have not been set.
150  */
151 void    read_server_config(ServerOptions * options, const char *filename);
152 
153 /* Sets values for those values that have not yet been set. */
154 void    fill_default_server_options(ServerOptions * options);
155 
156 #endif				/* SERVCONF_H */
157