xref: /openbsd/usr.bin/ssh/servconf.h (revision 7b36286a)
1 /* $OpenBSD: servconf.h,v 1.85 2008/06/10 04:50:25 dtucker 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_ACCEPT_ENV		256	/* Max # of env vars. */
28 #define MAX_MATCH_GROUPS	256	/* Max # of groups for Match. */
29 
30 /* permit_root_login */
31 #define	PERMIT_NOT_SET		-1
32 #define	PERMIT_NO		0
33 #define	PERMIT_FORCED_ONLY	1
34 #define	PERMIT_NO_PASSWD	2
35 #define	PERMIT_YES		3
36 
37 #define DEFAULT_AUTH_FAIL_MAX	6	/* Default for MaxAuthTries */
38 #define DEFAULT_SESSIONS_MAX	10	/* Default for MaxSessions */
39 
40 /* Magic name for internal sftp-server */
41 #define INTERNAL_SFTP_NAME	"internal-sftp"
42 
43 typedef struct {
44 	u_int num_ports;
45 	u_int ports_from_cmdline;
46 	u_short ports[MAX_PORTS];	/* Port number to listen on. */
47 	char   *listen_addr;		/* Address on which the server listens. */
48 	struct addrinfo *listen_addrs;	/* Addresses on which the server listens. */
49 	int     address_family;		/* Address family used by the server. */
50 	char   *host_key_files[MAX_HOSTKEYS];	/* Files containing host keys. */
51 	int     num_host_key_files;     /* Number of files for host keys. */
52 	char   *pid_file;	/* Where to put our pid */
53 	int     server_key_bits;/* Size of the server key. */
54 	int     login_grace_time;	/* Disconnect if no auth in this time
55 					 * (sec). */
56 	int     key_regeneration_time;	/* Server key lifetime (seconds). */
57 	int     permit_root_login;	/* PERMIT_*, see above */
58 	int     ignore_rhosts;	/* Ignore .rhosts and .shosts. */
59 	int     ignore_user_known_hosts;	/* Ignore ~/.ssh/known_hosts
60 						 * for RhostsRsaAuth */
61 	int     print_motd;	/* If true, print /etc/motd. */
62 	int	print_lastlog;	/* If true, print lastlog */
63 	int     x11_forwarding;	/* If true, permit inet (spoofing) X11 fwd. */
64 	int     x11_display_offset;	/* What DISPLAY number to start
65 					 * searching at */
66 	int     x11_use_localhost;	/* If true, use localhost for fake X11 server. */
67 	char   *xauth_location;	/* Location of xauth program */
68 	int     strict_modes;	/* If true, require string home dir modes. */
69 	int     tcp_keep_alive;	/* If true, set SO_KEEPALIVE. */
70 	char   *ciphers;	/* Supported SSH2 ciphers. */
71 	char   *macs;		/* Supported SSH2 macs. */
72 	int	protocol;	/* Supported protocol versions. */
73 	int     gateway_ports;	/* If true, allow remote connects to forwarded ports. */
74 	SyslogFacility log_facility;	/* Facility for system logging. */
75 	LogLevel log_level;	/* Level for system logging. */
76 	int     rhosts_rsa_authentication;	/* If true, permit rhosts RSA
77 						 * authentication. */
78 	int     hostbased_authentication;	/* If true, permit ssh2 hostbased auth */
79 	int     hostbased_uses_name_from_packet_only; /* experimental */
80 	int     rsa_authentication;	/* If true, permit RSA authentication. */
81 	int     pubkey_authentication;	/* If true, permit ssh2 pubkey authentication. */
82 	int     kerberos_authentication;	/* If true, permit Kerberos
83 						 * authentication. */
84 	int     kerberos_or_local_passwd;	/* If true, permit kerberos
85 						 * and any other password
86 						 * authentication mechanism,
87 						 * such as SecurID or
88 						 * /etc/passwd */
89 	int     kerberos_ticket_cleanup;	/* If true, destroy ticket
90 						 * file on logout. */
91 	int     kerberos_get_afs_token;		/* If true, try to get AFS token if
92 						 * authenticated with Kerberos. */
93 	int     gss_authentication;	/* If true, permit GSSAPI authentication */
94 	int     gss_cleanup_creds;	/* If true, destroy cred cache on logout */
95 	int     password_authentication;	/* If true, permit password
96 						 * authentication. */
97 	int     kbd_interactive_authentication;	/* If true, permit */
98 	int     challenge_response_authentication;
99 	int     permit_empty_passwd;	/* If false, do not permit empty
100 					 * passwords. */
101 	int     permit_user_env;	/* If true, read ~/.ssh/environment */
102 	int     use_login;	/* If true, login(1) is used */
103 	int     compression;	/* If true, compression is allowed */
104 	int	allow_tcp_forwarding;
105 	int	allow_agent_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 
115 	u_int num_subsystems;
116 	char   *subsystem_name[MAX_SUBSYSTEMS];
117 	char   *subsystem_command[MAX_SUBSYSTEMS];
118 	char   *subsystem_args[MAX_SUBSYSTEMS];
119 
120 	u_int num_accept_env;
121 	char   *accept_env[MAX_ACCEPT_ENV];
122 
123 	int	max_startups_begin;
124 	int	max_startups_rate;
125 	int	max_startups;
126 	int	max_authtries;
127 	int	max_sessions;
128 	char   *banner;			/* SSH-2 banner message */
129 	int	use_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 					 * disconnect the session
138 					 */
139 
140 	char   *authorized_keys_file;	/* File containing public keys */
141 	char   *authorized_keys_file2;
142 
143 	char   *adm_forced_command;
144 
145 	int	permit_tun;
146 
147 	int	num_permitted_opens;
148 
149 	char   *chroot_directory;
150 }       ServerOptions;
151 
152 void	 initialize_server_options(ServerOptions *);
153 void	 fill_default_server_options(ServerOptions *);
154 int	 process_server_config_line(ServerOptions *, char *, const char *, int,
155 	     int *, const char *, const char *, const char *);
156 void	 load_server_config(const char *, Buffer *);
157 void	 parse_server_config(ServerOptions *, const char *, Buffer *,
158 	     const char *, const char *, const char *);
159 void	 parse_server_match_config(ServerOptions *, const char *, const char *,
160 	     const char *);
161 void	 copy_set_server_options(ServerOptions *, ServerOptions *, int);
162 void	 dump_config(ServerOptions *);
163 
164 #endif				/* SERVCONF_H */
165