Globus Toolkit  6.0.1493297102
servconf.h
1 /* $OpenBSD: servconf.h,v 1.120 2015/07/10 06:21:53 markus 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 #define MAX_AUTHKEYS_FILES 256 /* Max # of authorized_keys files. */
31 #define MAX_AUTH_METHODS 256 /* Max # of AuthenticationMethods. */
32 
33 /* permit_root_login */
34 #define PERMIT_NOT_SET -1
35 #define PERMIT_NO 0
36 #define PERMIT_FORCED_ONLY 1
37 #define PERMIT_NO_PASSWD 2
38 #define PERMIT_YES 3
39 
40 /* use_privsep */
41 #define PRIVSEP_OFF 0
42 #define PRIVSEP_ON 1
43 #define PRIVSEP_NOSANDBOX 2
44 
45 /* AllowTCPForwarding */
46 #define FORWARD_DENY 0
47 #define FORWARD_REMOTE (1)
48 #define FORWARD_LOCAL (1<<1)
49 #define FORWARD_ALLOW (FORWARD_REMOTE|FORWARD_LOCAL)
50 
51 #define DEFAULT_AUTH_FAIL_MAX 6 /* Default for MaxAuthTries */
52 #define DEFAULT_SESSIONS_MAX 10 /* Default for MaxSessions */
53 
54 /* Magic name for internal sftp-server */
55 #define INTERNAL_SFTP_NAME "internal-sftp"
56 
57 typedef struct {
58  u_int num_ports;
59  u_int ports_from_cmdline;
60  int ports[MAX_PORTS]; /* Port number to listen on. */
61  u_int num_queued_listens;
62  char **queued_listen_addrs;
63  int *queued_listen_ports;
64  struct addrinfo *listen_addrs; /* Addresses on which the server listens. */
65  int address_family; /* Address family used by the server. */
66  char *host_key_files[MAX_HOSTKEYS]; /* Files containing host keys. */
67  int num_host_key_files; /* Number of files for host keys. */
68  char *host_cert_files[MAX_HOSTCERTS]; /* Files containing host certs. */
69  int num_host_cert_files; /* Number of files for host certs. */
70  char *host_key_agent; /* ssh-agent socket for host keys. */
71  char *pid_file; /* Where to put our pid */
72  int server_key_bits;/* Size of the server key. */
73  int login_grace_time; /* Disconnect if no auth in this time
74  * (sec). */
75  int key_regeneration_time; /* Server key lifetime (seconds). */
76  int permit_root_login; /* PERMIT_*, see above */
77  int ignore_rhosts; /* Ignore .rhosts and .shosts. */
78  int ignore_user_known_hosts; /* Ignore ~/.ssh/known_hosts
79  * for RhostsRsaAuth */
80  int print_motd; /* If true, print /etc/motd. */
81  int print_lastlog; /* If true, print lastlog */
82  int x11_forwarding; /* If true, permit inet (spoofing) X11 fwd. */
83  int x11_display_offset; /* What DISPLAY number to start
84  * searching at */
85  int x11_use_localhost; /* If true, use localhost for fake X11 server. */
86  char *xauth_location; /* Location of xauth program */
87  int permit_tty; /* If false, deny pty allocation */
88  int permit_user_rc; /* If false, deny ~/.ssh/rc execution */
89  int strict_modes; /* If true, require string home dir modes. */
90  int tcp_keep_alive; /* If true, set SO_KEEPALIVE. */
91  int ip_qos_interactive; /* IP ToS/DSCP/class for interactive */
92  int ip_qos_bulk; /* IP ToS/DSCP/class for bulk traffic */
93  char *ciphers; /* Supported SSH2 ciphers. */
94  char *macs; /* Supported SSH2 macs. */
95  char *kex_algorithms; /* SSH2 kex methods in order of preference. */
96  int protocol; /* Supported protocol versions. */
97  struct ForwardOptions fwd_opts; /* forwarding options */
98  SyslogFacility log_facility; /* Facility for system logging. */
99  LogLevel log_level; /* Level for system logging. */
100  int rhosts_rsa_authentication; /* If true, permit rhosts RSA
101  * authentication. */
102  int hostbased_authentication; /* If true, permit ssh2 hostbased auth */
103  int hostbased_uses_name_from_packet_only; /* experimental */
104  char *hostbased_key_types; /* Key types allowed for hostbased */
105  char *hostkeyalgorithms; /* SSH2 server key types */
106  int rsa_authentication; /* If true, permit RSA authentication. */
107  int pubkey_authentication; /* If true, permit ssh2 pubkey authentication. */
108  char *pubkey_key_types; /* Key types allowed for public key */
109  int kerberos_authentication; /* If true, permit Kerberos
110  * authentication. */
111  int kerberos_or_local_passwd; /* If true, permit kerberos
112  * and any other password
113  * authentication mechanism,
114  * such as SecurID or
115  * /etc/passwd */
116  int kerberos_ticket_cleanup; /* If true, destroy ticket
117  * file on logout. */
118 #ifdef SESSION_HOOKS
119  int session_hooks_allow; /* If true, permit user hooks */
120  char* session_hooks_startup_cmd; /* cmd to be executed before */
121  char* session_hooks_shutdown_cmd; /* cmd to be executed after */
122 #endif
123  int kerberos_get_afs_token; /* If true, try to get AFS token if
124  * authenticated with Kerberos. */
125  int gsi_allow_limited_proxy; /* If true, accept limited proxies */
126  int gss_authentication; /* If true, permit GSSAPI authentication */
127  int gss_deleg_creds; /* If true, store delegated GSSAPI credentials*/
128  int gss_keyex; /* If true, permit GSSAPI key exchange */
129  int gss_cleanup_creds; /* If true, destroy cred cache on logout */
130  char* gss_creds_path; /* If true, destroy cred cache on logout */
131  int gss_strict_acceptor; /* If true, restrict the GSSAPI acceptor name */
132  int gss_store_rekey;
133  int password_authentication; /* If true, permit password
134  * authentication. */
135  int kbd_interactive_authentication; /* If true, permit */
136  int challenge_response_authentication;
137  int permit_empty_passwd; /* If false, do not permit empty
138  * passwords. */
139  int permit_user_env; /* If true, read ~/.ssh/environment */
140  int use_login; /* If true, login(1) is used */
141  int compression; /* If true, compression is allowed */
142  int allow_tcp_forwarding; /* One of FORWARD_* */
143  int allow_streamlocal_forwarding; /* One of FORWARD_* */
144  int allow_agent_forwarding;
145  u_int num_allow_users;
146  char *allow_users[MAX_ALLOW_USERS];
147  u_int num_deny_users;
148  char *deny_users[MAX_DENY_USERS];
149  u_int num_allow_groups;
150  char *allow_groups[MAX_ALLOW_GROUPS];
151  u_int num_deny_groups;
152  char *deny_groups[MAX_DENY_GROUPS];
153 
154  u_int num_subsystems;
155  char *subsystem_name[MAX_SUBSYSTEMS];
156  char *subsystem_command[MAX_SUBSYSTEMS];
157  char *subsystem_args[MAX_SUBSYSTEMS];
158 
159  u_int num_accept_env;
160  char *accept_env[MAX_ACCEPT_ENV];
161 
162  int max_startups_begin;
163  int max_startups_rate;
164  int max_startups;
165  int max_authtries;
166  int max_sessions;
167  char *banner; /* SSH-2 banner message */
168  int use_dns;
169  int client_alive_interval; /*
170  * poke the client this often to
171  * see if it's still there
172  */
173  int client_alive_count_max; /*
174  * If the client is unresponsive
175  * for this many intervals above,
176  * disconnect the session
177  */
178 
179  u_int num_authkeys_files; /* Files containing public keys */
180  char *authorized_keys_files[MAX_AUTHKEYS_FILES];
181 
182  char *adm_forced_command;
183 
184  int use_pam; /* Enable auth via PAM */
185  int tcp_rcv_buf_poll; /* poll tcp rcv window in autotuning kernels*/
186  int permit_pam_user_change; /* Allow PAM to change user name */
187  int hpn_disabled; /* disable hpn functionality. false by default */
188  int hpn_buffer_size; /* set the hpn buffer size - default 3MB */
189 
190  int none_enabled; /* Enable NONE cipher switch */
191 
192  int audit_disabled; /* disable SSHD instrumentation */
193  int disable_multithreaded; /*disable multithreaded aes-ctr cipher */
194 
195  int permit_tun;
196 
197  int num_permitted_opens;
198 
199  char *chroot_directory;
200 
201  int disable_usage_stats;
202  char *usage_stats_targets;
203 
204  char *revoked_keys_file;
205  char *trusted_user_ca_keys;
206  char *authorized_keys_command;
207  char *authorized_keys_command_user;
208  char *authorized_principals_file;
209  char *authorized_principals_command;
210  char *authorized_principals_command_user;
211 
212  int64_t rekey_limit;
213  int rekey_interval;
214 
215  char *version_addendum; /* Appended to SSH banner */
216 
217  u_int num_auth_methods;
218  char *auth_methods[MAX_AUTH_METHODS];
219 
220  int fingerprint_hash;
221 } ServerOptions;
222 
223 /* Information about the incoming connection as used by Match */
224 struct connection_info {
225  const char *user;
226  const char *host; /* possibly resolved hostname */
227  const char *address; /* remote address */
228  const char *laddress; /* local address */
229  int lport; /* local port */
230 };
231 
232 
233 /*
234  * These are string config options that must be copied between the
235  * Match sub-config and the main config, and must be sent from the
236  * privsep slave to the privsep master. We use a macro to ensure all
237  * the options are copied and the copies are done in the correct order.
238  *
239  * NB. an option must appear in servconf.c:copy_set_server_options() or
240  * COPY_MATCH_STRING_OPTS here but never both.
241  */
242 #define COPY_MATCH_STRING_OPTS() do { \
243  M_CP_STROPT(banner); \
244  M_CP_STROPT(trusted_user_ca_keys); \
245  M_CP_STROPT(revoked_keys_file); \
246  M_CP_STROPT(authorized_keys_command); \
247  M_CP_STROPT(authorized_keys_command_user); \
248  M_CP_STROPT(authorized_principals_file); \
249  M_CP_STROPT(authorized_principals_command); \
250  M_CP_STROPT(authorized_principals_command_user); \
251  M_CP_STROPT(hostbased_key_types); \
252  M_CP_STROPT(pubkey_key_types); \
253  M_CP_STRARRAYOPT(authorized_keys_files, num_authkeys_files); \
254  M_CP_STRARRAYOPT(allow_users, num_allow_users); \
255  M_CP_STRARRAYOPT(deny_users, num_deny_users); \
256  M_CP_STRARRAYOPT(allow_groups, num_allow_groups); \
257  M_CP_STRARRAYOPT(deny_groups, num_deny_groups); \
258  M_CP_STRARRAYOPT(accept_env, num_accept_env); \
259  M_CP_STRARRAYOPT(auth_methods, num_auth_methods); \
260  } while (0)
261 
262 struct connection_info *get_connection_info(int, int);
263 void initialize_server_options(ServerOptions *);
264 void fill_default_server_options(ServerOptions *);
265 int process_server_config_line(ServerOptions *, char *, const char *, int,
266  int *, struct connection_info *);
267 void load_server_config(const char *, Buffer *);
268 void parse_server_config(ServerOptions *, const char *, Buffer *,
269  struct connection_info *);
270 void parse_server_match_config(ServerOptions *, struct connection_info *);
271 int parse_server_match_testspec(struct connection_info *, char *);
272 int server_match_spec_complete(struct connection_info *);
273 void copy_set_server_options(ServerOptions *, ServerOptions *, int);
274 void dump_config(ServerOptions *);
275 char *derelativise_path(const char *);
276 
277 #endif /* SERVCONF_H */