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