xref: /freebsd/crypto/openssh/servconf.h (revision d876124d6ae9d56da5b4ff4c6015efd1d0c9222a)
1 /* $OpenBSD: servconf.h,v 1.79 2006/08/14 12:40:25 dtucker Exp $ */
2 /* $FreeBSD$	*/
3 
4 /*
5  * Author: Tatu Ylonen <ylo@cs.hut.fi>
6  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
7  *                    All rights reserved
8  * Definitions for server configuration data and for the functions reading it.
9  *
10  * As far as I am concerned, the code I have written for this software
11  * can be used freely for any purpose.  Any derived versions of this
12  * software must be clearly marked as such, and if the derived work is
13  * incompatible with the protocol description in the RFC file, it must be
14  * called by a name other than "ssh" or "Secure Shell".
15  */
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 #define MAX_ACCEPT_ENV		256	/* Max # of env vars. */
29 #define MAX_MATCH_GROUPS	256	/* Max # of groups for Match. */
30 
31 /* permit_root_login */
32 #define	PERMIT_NOT_SET		-1
33 #define	PERMIT_NO		0
34 #define	PERMIT_FORCED_ONLY	1
35 #define	PERMIT_NO_PASSWD	2
36 #define	PERMIT_YES		3
37 
38 #define DEFAULT_AUTH_FAIL_MAX	6	/* Default for MaxAuthTries */
39 
40 typedef struct {
41 	u_int num_ports;
42 	u_int ports_from_cmdline;
43 	u_short ports[MAX_PORTS];	/* Port number to listen on. */
44 	char   *listen_addr;		/* Address on which the server listens. */
45 	struct addrinfo *listen_addrs;	/* Addresses on which the server listens. */
46 	int     address_family;		/* Address family used by the server. */
47 	char   *host_key_files[MAX_HOSTKEYS];	/* Files containing host keys. */
48 	int     num_host_key_files;     /* Number of files for host keys. */
49 	char   *pid_file;	/* Where to put our pid */
50 	int     server_key_bits;/* Size of the server key. */
51 	int     login_grace_time;	/* Disconnect if no auth in this time
52 					 * (sec). */
53 	int     key_regeneration_time;	/* Server key lifetime (seconds). */
54 	int     permit_root_login;	/* PERMIT_*, see above */
55 	int     ignore_rhosts;	/* Ignore .rhosts and .shosts. */
56 	int     ignore_user_known_hosts;	/* Ignore ~/.ssh/known_hosts
57 						 * for RhostsRsaAuth */
58 	int     print_motd;	/* If true, print /etc/motd. */
59 	int	print_lastlog;	/* If true, print lastlog */
60 	int     x11_forwarding;	/* If true, permit inet (spoofing) X11 fwd. */
61 	int     x11_display_offset;	/* What DISPLAY number to start
62 					 * searching at */
63 	int     x11_use_localhost;	/* If true, use localhost for fake X11 server. */
64 	char   *xauth_location;	/* Location of xauth program */
65 	int     strict_modes;	/* If true, require string home dir modes. */
66 	int     tcp_keep_alive;	/* If true, set SO_KEEPALIVE. */
67 	char   *ciphers;	/* Supported SSH2 ciphers. */
68 	char   *macs;		/* Supported SSH2 macs. */
69 	int	protocol;	/* Supported protocol versions. */
70 	int     gateway_ports;	/* If true, allow remote connects to forwarded ports. */
71 	SyslogFacility log_facility;	/* Facility for system logging. */
72 	LogLevel log_level;	/* Level for system logging. */
73 	int     rhosts_rsa_authentication;	/* If true, permit rhosts RSA
74 						 * authentication. */
75 	int     hostbased_authentication;	/* If true, permit ssh2 hostbased auth */
76 	int     hostbased_uses_name_from_packet_only; /* experimental */
77 	int     rsa_authentication;	/* If true, permit RSA authentication. */
78 	int     pubkey_authentication;	/* If true, permit ssh2 pubkey authentication. */
79 	int     kerberos_authentication;	/* If true, permit Kerberos
80 						 * authentication. */
81 	int     kerberos_or_local_passwd;	/* If true, permit kerberos
82 						 * and any other password
83 						 * authentication mechanism,
84 						 * such as SecurID or
85 						 * /etc/passwd */
86 	int     kerberos_ticket_cleanup;	/* If true, destroy ticket
87 						 * file on logout. */
88 	int     kerberos_get_afs_token;		/* If true, try to get AFS token if
89 						 * authenticated with Kerberos. */
90 	int     gss_authentication;	/* If true, permit GSSAPI authentication */
91 	int     gss_cleanup_creds;	/* If true, destroy cred cache on logout */
92 	int     password_authentication;	/* If true, permit password
93 						 * authentication. */
94 	int     kbd_interactive_authentication;	/* If true, permit */
95 	int     challenge_response_authentication;
96 	int     permit_empty_passwd;	/* If false, do not permit empty
97 					 * passwords. */
98 	int     permit_user_env;	/* If true, read ~/.ssh/environment */
99 	int     use_login;	/* If true, login(1) is used */
100 	int     compression;	/* If true, compression is allowed */
101 	int	allow_tcp_forwarding;
102 	u_int num_allow_users;
103 	char   *allow_users[MAX_ALLOW_USERS];
104 	u_int num_deny_users;
105 	char   *deny_users[MAX_DENY_USERS];
106 	u_int num_allow_groups;
107 	char   *allow_groups[MAX_ALLOW_GROUPS];
108 	u_int num_deny_groups;
109 	char   *deny_groups[MAX_DENY_GROUPS];
110 
111 	u_int num_subsystems;
112 	char   *subsystem_name[MAX_SUBSYSTEMS];
113 	char   *subsystem_command[MAX_SUBSYSTEMS];
114 	char   *subsystem_args[MAX_SUBSYSTEMS];
115 
116 	u_int num_accept_env;
117 	char   *accept_env[MAX_ACCEPT_ENV];
118 
119 	int	max_startups_begin;
120 	int	max_startups_rate;
121 	int	max_startups;
122 	int	max_authtries;
123 	char   *banner;			/* SSH-2 banner message */
124 	int	use_dns;
125 	int	client_alive_interval;	/*
126 					 * poke the client this often to
127 					 * see if it's still there
128 					 */
129 	int	client_alive_count_max;	/*
130 					 * If the client is unresponsive
131 					 * for this many intervals above,
132 					 * disconnect the session
133 					 */
134 
135 	char   *authorized_keys_file;	/* File containing public keys */
136 	char   *authorized_keys_file2;
137 
138 	char   *adm_forced_command;
139 
140 	int	use_pam;		/* Enable auth via PAM */
141 
142 	int	permit_tun;
143 
144 	int	num_permitted_opens;
145 }       ServerOptions;
146 
147 void	 initialize_server_options(ServerOptions *);
148 void	 fill_default_server_options(ServerOptions *);
149 int	 process_server_config_line(ServerOptions *, char *, const char *, int,
150 	     int *, const char *, const char *, const char *);
151 void	 load_server_config(const char *, Buffer *);
152 void	 parse_server_config(ServerOptions *, const char *, Buffer *,
153 	     const char *, const char *, const char *);
154 void	 parse_server_match_config(ServerOptions *, const char *, const char *,
155 	     const char *);
156 void	 copy_set_server_options(ServerOptions *, ServerOptions *);
157 
158 #endif				/* SERVCONF_H */
159