2015-01-05 16:09:55 +00:00
|
|
|
/* $OpenBSD: servconf.h,v 1.114 2014/07/15 15:54:14 millert Exp $ */
|
2002-03-18 09:55:03 +00:00
|
|
|
|
2000-02-24 14:29:47 +00:00
|
|
|
/*
|
|
|
|
* Author: Tatu Ylonen <ylo@cs.hut.fi>
|
|
|
|
* Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
|
|
|
|
* All rights reserved
|
|
|
|
* Definitions for server configuration data and for the functions reading it.
|
2000-05-15 04:37:24 +00:00
|
|
|
*
|
2000-09-10 08:31:17 +00:00
|
|
|
* As far as I am concerned, the code I have written for this software
|
|
|
|
* can be used freely for any purpose. Any derived versions of this
|
|
|
|
* software must be clearly marked as such, and if the derived work is
|
|
|
|
* incompatible with the protocol description in the RFC file, it must be
|
|
|
|
* called by a name other than "ssh" or "Secure Shell".
|
2000-02-24 14:29:47 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef SERVCONF_H
|
|
|
|
#define SERVCONF_H
|
|
|
|
|
|
|
|
#define MAX_PORTS 256 /* Max # ports. */
|
|
|
|
|
|
|
|
#define MAX_ALLOW_USERS 256 /* Max # users on allow list. */
|
|
|
|
#define MAX_DENY_USERS 256 /* Max # users on deny list. */
|
|
|
|
#define MAX_ALLOW_GROUPS 256 /* Max # groups on allow list. */
|
|
|
|
#define MAX_DENY_GROUPS 256 /* Max # groups on deny list. */
|
2000-09-10 08:31:17 +00:00
|
|
|
#define MAX_SUBSYSTEMS 256 /* Max # subsystems. */
|
2001-05-04 03:57:05 +00:00
|
|
|
#define MAX_HOSTKEYS 256 /* Max # hostkeys. */
|
2010-03-08 11:19:52 +00:00
|
|
|
#define MAX_HOSTCERTS 256 /* Max # host certificates. */
|
2004-10-28 16:03:53 +00:00
|
|
|
#define MAX_ACCEPT_ENV 256 /* Max # of env vars. */
|
2006-09-30 13:29:51 +00:00
|
|
|
#define MAX_MATCH_GROUPS 256 /* Max # of groups for Match. */
|
2011-09-28 08:14:41 +00:00
|
|
|
#define MAX_AUTHKEYS_FILES 256 /* Max # of authorized_keys files. */
|
2013-03-22 11:19:48 +00:00
|
|
|
#define MAX_AUTH_METHODS 256 /* Max # of AuthenticationMethods. */
|
2001-05-04 03:57:05 +00:00
|
|
|
|
|
|
|
/* permit_root_login */
|
|
|
|
#define PERMIT_NOT_SET -1
|
|
|
|
#define PERMIT_NO 0
|
|
|
|
#define PERMIT_FORCED_ONLY 1
|
|
|
|
#define PERMIT_NO_PASSWD 2
|
|
|
|
#define PERMIT_YES 3
|
|
|
|
|
2011-09-28 08:14:41 +00:00
|
|
|
/* use_privsep */
|
|
|
|
#define PRIVSEP_OFF 0
|
|
|
|
#define PRIVSEP_ON 1
|
2012-08-29 15:55:54 +00:00
|
|
|
#define PRIVSEP_NOSANDBOX 2
|
2011-09-28 08:14:41 +00:00
|
|
|
|
2013-03-22 11:19:48 +00:00
|
|
|
/* AllowTCPForwarding */
|
|
|
|
#define FORWARD_DENY 0
|
|
|
|
#define FORWARD_REMOTE (1)
|
|
|
|
#define FORWARD_LOCAL (1<<1)
|
|
|
|
#define FORWARD_ALLOW (FORWARD_REMOTE|FORWARD_LOCAL)
|
|
|
|
|
2004-10-28 16:03:53 +00:00
|
|
|
#define DEFAULT_AUTH_FAIL_MAX 6 /* Default for MaxAuthTries */
|
2008-07-23 09:33:08 +00:00
|
|
|
#define DEFAULT_SESSIONS_MAX 10 /* Default for MaxSessions */
|
2000-02-24 14:29:47 +00:00
|
|
|
|
2008-07-23 09:28:49 +00:00
|
|
|
/* Magic name for internal sftp-server */
|
|
|
|
#define INTERNAL_SFTP_NAME "internal-sftp"
|
|
|
|
|
2000-02-24 14:29:47 +00:00
|
|
|
typedef struct {
|
2009-02-24 18:49:27 +00:00
|
|
|
u_int num_ports;
|
|
|
|
u_int ports_from_cmdline;
|
|
|
|
int ports[MAX_PORTS]; /* Port number to listen on. */
|
2000-02-24 14:29:47 +00:00
|
|
|
char *listen_addr; /* Address on which the server listens. */
|
|
|
|
struct addrinfo *listen_addrs; /* Addresses on which the server listens. */
|
2005-06-05 15:40:50 +00:00
|
|
|
int address_family; /* Address family used by the server. */
|
2001-05-04 03:57:05 +00:00
|
|
|
char *host_key_files[MAX_HOSTKEYS]; /* Files containing host keys. */
|
|
|
|
int num_host_key_files; /* Number of files for host keys. */
|
2010-03-08 11:19:52 +00:00
|
|
|
char *host_cert_files[MAX_HOSTCERTS]; /* Files containing host certs. */
|
|
|
|
int num_host_cert_files; /* Number of files for host certs. */
|
2013-09-18 17:27:38 +00:00
|
|
|
char *host_key_agent; /* ssh-agent socket for host keys. */
|
2000-05-15 04:37:24 +00:00
|
|
|
char *pid_file; /* Where to put our pid */
|
2000-02-24 14:29:47 +00:00
|
|
|
int server_key_bits;/* Size of the server key. */
|
|
|
|
int login_grace_time; /* Disconnect if no auth in this time
|
|
|
|
* (sec). */
|
|
|
|
int key_regeneration_time; /* Server key lifetime (seconds). */
|
2001-05-04 03:57:05 +00:00
|
|
|
int permit_root_login; /* PERMIT_*, see above */
|
2000-02-24 14:29:47 +00:00
|
|
|
int ignore_rhosts; /* Ignore .rhosts and .shosts. */
|
|
|
|
int ignore_user_known_hosts; /* Ignore ~/.ssh/known_hosts
|
|
|
|
* for RhostsRsaAuth */
|
|
|
|
int print_motd; /* If true, print /etc/motd. */
|
2001-05-04 03:57:05 +00:00
|
|
|
int print_lastlog; /* If true, print lastlog */
|
2000-02-24 14:29:47 +00:00
|
|
|
int x11_forwarding; /* If true, permit inet (spoofing) X11 fwd. */
|
|
|
|
int x11_display_offset; /* What DISPLAY number to start
|
|
|
|
* searching at */
|
2002-03-18 09:55:03 +00:00
|
|
|
int x11_use_localhost; /* If true, use localhost for fake X11 server. */
|
2000-09-10 08:31:17 +00:00
|
|
|
char *xauth_location; /* Location of xauth program */
|
2014-01-30 10:56:49 +00:00
|
|
|
int permit_tty; /* If false, deny pty allocation */
|
2015-01-05 16:09:55 +00:00
|
|
|
int permit_user_rc; /* If false, deny ~/.ssh/rc execution */
|
2000-02-24 14:29:47 +00:00
|
|
|
int strict_modes; /* If true, require string home dir modes. */
|
2004-02-26 10:38:49 +00:00
|
|
|
int tcp_keep_alive; /* If true, set SO_KEEPALIVE. */
|
2011-02-17 11:47:40 +00:00
|
|
|
int ip_qos_interactive; /* IP ToS/DSCP/class for interactive */
|
|
|
|
int ip_qos_bulk; /* IP ToS/DSCP/class for bulk traffic */
|
2001-05-04 03:57:05 +00:00
|
|
|
char *ciphers; /* Supported SSH2 ciphers. */
|
|
|
|
char *macs; /* Supported SSH2 macs. */
|
2011-02-17 11:47:40 +00:00
|
|
|
char *kex_algorithms; /* SSH2 kex methods in order of preference. */
|
2001-05-04 03:57:05 +00:00
|
|
|
int protocol; /* Supported protocol versions. */
|
2015-01-05 16:09:55 +00:00
|
|
|
struct ForwardOptions fwd_opts; /* forwarding options */
|
2000-02-24 14:29:47 +00:00
|
|
|
SyslogFacility log_facility; /* Facility for system logging. */
|
|
|
|
LogLevel log_level; /* Level for system logging. */
|
|
|
|
int rhosts_rsa_authentication; /* If true, permit rhosts RSA
|
|
|
|
* authentication. */
|
2001-05-04 03:57:05 +00:00
|
|
|
int hostbased_authentication; /* If true, permit ssh2 hostbased auth */
|
|
|
|
int hostbased_uses_name_from_packet_only; /* experimental */
|
2000-02-24 14:29:47 +00:00
|
|
|
int rsa_authentication; /* If true, permit RSA authentication. */
|
2001-05-04 03:57:05 +00:00
|
|
|
int pubkey_authentication; /* If true, permit ssh2 pubkey authentication. */
|
2000-02-24 14:29:47 +00:00
|
|
|
int kerberos_authentication; /* If true, permit Kerberos
|
|
|
|
* authentication. */
|
|
|
|
int kerberos_or_local_passwd; /* If true, permit kerberos
|
|
|
|
* and any other password
|
|
|
|
* authentication mechanism,
|
|
|
|
* such as SecurID or
|
|
|
|
* /etc/passwd */
|
|
|
|
int kerberos_ticket_cleanup; /* If true, destroy ticket
|
|
|
|
* file on logout. */
|
2004-02-26 10:38:49 +00:00
|
|
|
int kerberos_get_afs_token; /* If true, try to get AFS token if
|
|
|
|
* authenticated with Kerberos. */
|
2004-01-07 11:10:17 +00:00
|
|
|
int gss_authentication; /* If true, permit GSSAPI authentication */
|
|
|
|
int gss_cleanup_creds; /* If true, destroy cred cache on logout */
|
2000-02-24 14:29:47 +00:00
|
|
|
int password_authentication; /* If true, permit password
|
|
|
|
* authentication. */
|
2000-12-05 02:20:19 +00:00
|
|
|
int kbd_interactive_authentication; /* If true, permit */
|
2002-03-18 09:55:03 +00:00
|
|
|
int challenge_response_authentication;
|
2000-02-24 14:29:47 +00:00
|
|
|
int permit_empty_passwd; /* If false, do not permit empty
|
|
|
|
* passwords. */
|
2002-10-29 09:43:00 +00:00
|
|
|
int permit_user_env; /* If true, read ~/.ssh/environment */
|
2000-02-24 14:29:47 +00:00
|
|
|
int use_login; /* If true, login(1) is used */
|
2002-06-23 14:01:54 +00:00
|
|
|
int compression; /* If true, compression is allowed */
|
2013-03-22 11:19:48 +00:00
|
|
|
int allow_tcp_forwarding; /* One of FORWARD_* */
|
2015-01-05 16:09:55 +00:00
|
|
|
int allow_streamlocal_forwarding; /* One of FORWARD_* */
|
2008-07-23 09:33:08 +00:00
|
|
|
int allow_agent_forwarding;
|
2001-05-04 03:57:05 +00:00
|
|
|
u_int num_allow_users;
|
2000-02-24 14:29:47 +00:00
|
|
|
char *allow_users[MAX_ALLOW_USERS];
|
2001-05-04 03:57:05 +00:00
|
|
|
u_int num_deny_users;
|
2000-02-24 14:29:47 +00:00
|
|
|
char *deny_users[MAX_DENY_USERS];
|
2001-05-04 03:57:05 +00:00
|
|
|
u_int num_allow_groups;
|
2000-02-24 14:29:47 +00:00
|
|
|
char *allow_groups[MAX_ALLOW_GROUPS];
|
2001-05-04 03:57:05 +00:00
|
|
|
u_int num_deny_groups;
|
2000-02-24 14:29:47 +00:00
|
|
|
char *deny_groups[MAX_DENY_GROUPS];
|
2000-09-10 08:31:17 +00:00
|
|
|
|
2001-05-04 03:57:05 +00:00
|
|
|
u_int num_subsystems;
|
2000-09-10 08:31:17 +00:00
|
|
|
char *subsystem_name[MAX_SUBSYSTEMS];
|
|
|
|
char *subsystem_command[MAX_SUBSYSTEMS];
|
2006-09-30 13:29:51 +00:00
|
|
|
char *subsystem_args[MAX_SUBSYSTEMS];
|
2000-09-10 08:31:17 +00:00
|
|
|
|
2004-10-28 16:03:53 +00:00
|
|
|
u_int num_accept_env;
|
|
|
|
char *accept_env[MAX_ACCEPT_ENV];
|
|
|
|
|
2000-09-10 08:31:17 +00:00
|
|
|
int max_startups_begin;
|
|
|
|
int max_startups_rate;
|
|
|
|
int max_startups;
|
2004-10-28 16:03:53 +00:00
|
|
|
int max_authtries;
|
2008-07-23 09:33:08 +00:00
|
|
|
int max_sessions;
|
2001-05-04 03:57:05 +00:00
|
|
|
char *banner; /* SSH-2 banner message */
|
2004-01-07 11:10:17 +00:00
|
|
|
int use_dns;
|
2001-05-04 03:57:05 +00:00
|
|
|
int client_alive_interval; /*
|
2002-03-18 09:55:03 +00:00
|
|
|
* poke the client this often to
|
|
|
|
* see if it's still there
|
2001-05-04 03:57:05 +00:00
|
|
|
*/
|
|
|
|
int client_alive_count_max; /*
|
2002-03-18 09:55:03 +00:00
|
|
|
* If the client is unresponsive
|
|
|
|
* for this many intervals above,
|
|
|
|
* disconnect the session
|
2001-05-04 03:57:05 +00:00
|
|
|
*/
|
2000-09-10 08:31:17 +00:00
|
|
|
|
2011-09-28 08:14:41 +00:00
|
|
|
u_int num_authkeys_files; /* Files containing public keys */
|
|
|
|
char *authorized_keys_files[MAX_AUTHKEYS_FILES];
|
2006-03-22 19:46:12 +00:00
|
|
|
|
2006-09-30 13:29:51 +00:00
|
|
|
char *adm_forced_command;
|
|
|
|
|
2004-01-07 11:10:17 +00:00
|
|
|
int use_pam; /* Enable auth via PAM */
|
2006-03-22 19:46:12 +00:00
|
|
|
|
|
|
|
int permit_tun;
|
2006-09-30 13:29:51 +00:00
|
|
|
|
|
|
|
int num_permitted_opens;
|
2008-07-23 09:28:49 +00:00
|
|
|
|
|
|
|
char *chroot_directory;
|
2010-03-08 11:19:52 +00:00
|
|
|
char *revoked_keys_file;
|
|
|
|
char *trusted_user_ca_keys;
|
2010-11-08 10:45:44 +00:00
|
|
|
char *authorized_principals_file;
|
2013-03-22 11:19:48 +00:00
|
|
|
char *authorized_keys_command;
|
|
|
|
char *authorized_keys_command_user;
|
2012-08-29 15:55:54 +00:00
|
|
|
|
2013-09-18 17:27:38 +00:00
|
|
|
int64_t rekey_limit;
|
|
|
|
int rekey_interval;
|
|
|
|
|
2012-08-29 15:55:54 +00:00
|
|
|
char *version_addendum; /* Appended to SSH banner */
|
2013-03-22 11:19:48 +00:00
|
|
|
|
|
|
|
u_int num_auth_methods;
|
|
|
|
char *auth_methods[MAX_AUTH_METHODS];
|
2000-02-24 14:29:47 +00:00
|
|
|
} ServerOptions;
|
|
|
|
|
2012-08-29 15:55:54 +00:00
|
|
|
/* Information about the incoming connection as used by Match */
|
|
|
|
struct connection_info {
|
|
|
|
const char *user;
|
|
|
|
const char *host; /* possibly resolved hostname */
|
|
|
|
const char *address; /* remote address */
|
|
|
|
const char *laddress; /* local address */
|
|
|
|
int lport; /* local port */
|
|
|
|
};
|
|
|
|
|
|
|
|
|
2011-09-28 08:14:41 +00:00
|
|
|
/*
|
|
|
|
* These are string config options that must be copied between the
|
|
|
|
* Match sub-config and the main config, and must be sent from the
|
|
|
|
* privsep slave to the privsep master. We use a macro to ensure all
|
|
|
|
* the options are copied and the copies are done in the correct order.
|
2014-01-30 10:56:49 +00:00
|
|
|
*
|
|
|
|
* NB. an option must appear in servconf.c:copy_set_server_options() or
|
|
|
|
* COPY_MATCH_STRING_OPTS here but never both.
|
2011-09-28 08:14:41 +00:00
|
|
|
*/
|
|
|
|
#define COPY_MATCH_STRING_OPTS() do { \
|
|
|
|
M_CP_STROPT(banner); \
|
|
|
|
M_CP_STROPT(trusted_user_ca_keys); \
|
|
|
|
M_CP_STROPT(revoked_keys_file); \
|
|
|
|
M_CP_STROPT(authorized_principals_file); \
|
2013-03-22 11:19:48 +00:00
|
|
|
M_CP_STROPT(authorized_keys_command); \
|
|
|
|
M_CP_STROPT(authorized_keys_command_user); \
|
2011-09-28 08:14:41 +00:00
|
|
|
M_CP_STRARRAYOPT(authorized_keys_files, num_authkeys_files); \
|
2012-08-29 15:55:54 +00:00
|
|
|
M_CP_STRARRAYOPT(allow_users, num_allow_users); \
|
|
|
|
M_CP_STRARRAYOPT(deny_users, num_deny_users); \
|
|
|
|
M_CP_STRARRAYOPT(allow_groups, num_allow_groups); \
|
|
|
|
M_CP_STRARRAYOPT(deny_groups, num_deny_groups); \
|
|
|
|
M_CP_STRARRAYOPT(accept_env, num_accept_env); \
|
2013-03-22 11:19:48 +00:00
|
|
|
M_CP_STRARRAYOPT(auth_methods, num_auth_methods); \
|
2011-09-28 08:14:41 +00:00
|
|
|
} while (0)
|
|
|
|
|
2012-08-29 15:55:54 +00:00
|
|
|
struct connection_info *get_connection_info(int, int);
|
2002-03-18 09:55:03 +00:00
|
|
|
void initialize_server_options(ServerOptions *);
|
|
|
|
void fill_default_server_options(ServerOptions *);
|
2006-09-30 13:29:51 +00:00
|
|
|
int process_server_config_line(ServerOptions *, char *, const char *, int,
|
2012-08-29 15:55:54 +00:00
|
|
|
int *, struct connection_info *);
|
2004-10-28 16:03:53 +00:00
|
|
|
void load_server_config(const char *, Buffer *);
|
2006-09-30 13:29:51 +00:00
|
|
|
void parse_server_config(ServerOptions *, const char *, Buffer *,
|
2012-08-29 15:55:54 +00:00
|
|
|
struct connection_info *);
|
|
|
|
void parse_server_match_config(ServerOptions *, struct connection_info *);
|
|
|
|
int parse_server_match_testspec(struct connection_info *, char *);
|
|
|
|
int server_match_spec_complete(struct connection_info *);
|
2008-07-23 09:15:38 +00:00
|
|
|
void copy_set_server_options(ServerOptions *, ServerOptions *, int);
|
2008-07-23 09:33:08 +00:00
|
|
|
void dump_config(ServerOptions *);
|
2010-03-08 11:19:52 +00:00
|
|
|
char *derelativise_path(const char *);
|
2000-02-24 14:29:47 +00:00
|
|
|
|
|
|
|
#endif /* SERVCONF_H */
|