servconf.h revision 1.21
1/* $NetBSD: servconf.h,v 1.21 2020/02/27 00:24:40 christos Exp $ */ 2/* $OpenBSD: servconf.h,v 1.143 2020/01/31 22:42:45 djm Exp $ */ 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#ifdef WITH_LDAP_PUBKEY 21#include "ldapauth.h" 22#endif 23 24#include <sys/queue.h> 25 26#define MAX_PORTS 256 /* Max # ports. */ 27 28#define MAX_SUBSYSTEMS 256 /* Max # subsystems. */ 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/* use_privsep */ 38#define PRIVSEP_OFF 0 39#define PRIVSEP_ON 1 40#define PRIVSEP_NOSANDBOX 2 41 42/* PermitOpen */ 43#define PERMITOPEN_ANY 0 44#define PERMITOPEN_NONE -2 45 46#define DEFAULT_AUTH_FAIL_MAX 6 /* Default for MaxAuthTries */ 47#define DEFAULT_SESSIONS_MAX 10 /* Default for MaxSessions */ 48 49/* Magic name for internal sftp-server */ 50#define INTERNAL_SFTP_NAME "internal-sftp" 51 52/* PubkeyAuthOptions flags */ 53#define PUBKEYAUTH_TOUCH_REQUIRED 1 54 55struct ssh; 56struct fwd_perm_list; 57 58/* 59 * Used to store addresses from ListenAddr directives. These may be 60 * incomplete, as they may specify addresses that need to be merged 61 * with any ports requested by ListenPort. 62 */ 63struct queued_listenaddr { 64 char *addr; 65 int port; /* <=0 if unspecified */ 66 char *rdomain; 67}; 68 69/* Resolved listen addresses, grouped by optional routing domain */ 70struct listenaddr { 71 char *rdomain; 72 struct addrinfo *addrs; 73}; 74 75typedef struct { 76 u_int num_ports; 77 u_int ports_from_cmdline; 78 int ports[MAX_PORTS]; /* Port number to listen on. */ 79 struct queued_listenaddr *queued_listen_addrs; 80 u_int num_queued_listens; 81 struct listenaddr *listen_addrs; 82 u_int num_listen_addrs; 83 int address_family; /* Address family used by the server. */ 84 85 char *routing_domain; /* Bind session to routing domain */ 86 87 char **host_key_files; /* Files containing host keys. */ 88 int *host_key_file_userprovided; /* Key was specified by user. */ 89 u_int num_host_key_files; /* Number of files for host keys. */ 90 char **host_cert_files; /* Files containing host certs. */ 91 u_int num_host_cert_files; /* Number of files for host certs. */ 92 93 char *host_key_agent; /* ssh-agent socket for host keys. */ 94 char *pid_file; /* Where to put our pid */ 95 int login_grace_time; /* Disconnect if no auth in this time 96 * (sec). */ 97 int permit_root_login; /* PERMIT_*, see above */ 98 int ignore_rhosts; /* Ignore .rhosts and .shosts. */ 99 int ignore_root_rhosts; /* Ignore .rhosts and .shosts for root; 100 defaults to ignore_rhosts if not 101 given. */ 102 int ignore_user_known_hosts; /* Ignore ~/.ssh/known_hosts 103 * for RhostsRsaAuth */ 104 int print_motd; /* If true, print /etc/motd. */ 105 int print_lastlog; /* If true, print lastlog */ 106 int x11_forwarding; /* If true, permit inet (spoofing) X11 fwd. */ 107 int x11_display_offset; /* What DISPLAY number to start 108 * searching at */ 109 int x11_use_localhost; /* If true, use localhost for fake X11 server. */ 110 char *xauth_location; /* Location of xauth program */ 111 int permit_tty; /* If false, deny pty allocation */ 112 int permit_user_rc; /* If false, deny ~/.ssh/rc execution */ 113 int strict_modes; /* If true, require string home dir modes. */ 114 int tcp_keep_alive; /* If true, set SO_KEEPALIVE. */ 115 int ip_qos_interactive; /* IP ToS/DSCP/class for interactive */ 116 int ip_qos_bulk; /* IP ToS/DSCP/class for bulk traffic */ 117 char *ciphers; /* Supported SSH2 ciphers. */ 118 char *macs; /* Supported SSH2 macs. */ 119 char *kex_algorithms; /* SSH2 kex methods in order of preference. */ 120 struct ForwardOptions fwd_opts; /* forwarding options */ 121 SyslogFacility log_facility; /* Facility for system logging. */ 122 LogLevel log_level; /* Level for system logging. */ 123 int hostbased_authentication; /* If true, permit ssh2 hostbased auth */ 124 int hostbased_uses_name_from_packet_only; /* experimental */ 125 char *hostbased_key_types; /* Key types allowed for hostbased */ 126 char *hostkeyalgorithms; /* SSH2 server key types */ 127 char *ca_sign_algorithms; /* Allowed CA signature algorithms */ 128 int pubkey_authentication; /* If true, permit ssh2 pubkey authentication. */ 129 char *pubkey_key_types; /* Key types allowed for public key */ 130 int pubkey_auth_options; /* -1 or mask of PUBKEYAUTH_* flags */ 131 int kerberos_authentication; /* If true, permit Kerberos 132 * authentication. */ 133 int kerberos_or_local_passwd; /* If true, permit kerberos 134 * and any other password 135 * authentication mechanism, 136 * such as SecurID or 137 * /etc/passwd */ 138 int kerberos_ticket_cleanup; /* If true, destroy ticket 139 * file on logout. */ 140 int kerberos_tgt_passing; /* If true, permit Kerberos TGT 141 * passing. */ 142 int kerberos_get_afs_token; /* If true, try to get AFS token if 143 * authenticated with Kerberos. */ 144#ifdef AFS 145 int afs_token_passing; /* If true, permit AFS token passing. */ 146#endif 147 int gss_authentication; /* If true, permit GSSAPI authentication */ 148 int gss_cleanup_creds; /* If true, destroy cred cache on logout */ 149 int gss_strict_acceptor; /* If true, restrict the GSSAPI acceptor name */ 150 int password_authentication; /* If true, permit password 151 * authentication. */ 152 int kbd_interactive_authentication; /* If true, permit */ 153 int challenge_response_authentication; 154 int permit_empty_passwd; /* If false, do not permit empty 155 * passwords. */ 156 int permit_user_env; /* If true, read ~/.ssh/environment */ 157 char *permit_user_env_whitelist; /* pattern-list whitelist */ 158 int compression; /* If true, compression is allowed */ 159 int allow_tcp_forwarding; /* One of FORWARD_* */ 160 int allow_streamlocal_forwarding; /* One of FORWARD_* */ 161 int allow_agent_forwarding; 162 int disable_forwarding; 163 u_int num_allow_users; 164 char **allow_users; 165 u_int num_deny_users; 166 char **deny_users; 167 u_int num_allow_groups; 168 char **allow_groups; 169 u_int num_deny_groups; 170 char **deny_groups; 171 172 u_int num_subsystems; 173 char *subsystem_name[MAX_SUBSYSTEMS]; 174 char *subsystem_command[MAX_SUBSYSTEMS]; 175 char *subsystem_args[MAX_SUBSYSTEMS]; 176 177 u_int num_accept_env; 178 char **accept_env; 179 u_int num_setenv; 180 char **setenv; 181 182 int max_startups_begin; 183 int max_startups_rate; 184 int max_startups; 185 int max_authtries; 186 int max_sessions; 187 char *banner; /* SSH-2 banner message */ 188 int use_dns; 189 int client_alive_interval; /* 190 * poke the client this often to 191 * see if it's still there 192 */ 193 int client_alive_count_max; /* 194 * If the client is unresponsive 195 * for this many intervals above, 196 * disconnect the session 197 */ 198 199 u_int num_authkeys_files; /* Files containing public keys */ 200 char **authorized_keys_files; 201 202 int use_pam; /* Enable auth via PAM */ 203 int none_enabled; /* enable NONE cipher switch */ 204 int tcp_rcv_buf_poll; /* poll tcp rcv window in autotuning kernels*/ 205 int hpn_disabled; /* disable hpn functionality. false by default */ 206 int hpn_buffer_size; /* set the hpn buffer size - default 3MB */ 207 208 char *adm_forced_command; 209 210 int permit_tun; 211#ifdef WITH_LDAP_PUBKEY 212 ldap_opt_t lpk; 213#endif 214 215 char **permitted_opens; /* May also be one of PERMITOPEN_* */ 216 u_int num_permitted_opens; 217 char **permitted_listens; /* May also be one of PERMITOPEN_* */ 218 u_int num_permitted_listens; 219 220 char *chroot_directory; 221 char *revoked_keys_file; 222 char *trusted_user_ca_keys; 223 char *authorized_keys_command; 224 char *authorized_keys_command_user; 225 char *authorized_principals_file; 226 char *authorized_principals_command; 227 char *authorized_principals_command_user; 228 229 int64_t rekey_limit; 230 int rekey_interval; 231 232 char *version_addendum; /* Appended to SSH banner */ 233 234 u_int num_auth_methods; 235 char **auth_methods; 236 237 int fingerprint_hash; 238 int expose_userauth_info; 239 u_int64_t timing_secret; 240 char *sk_provider; 241} ServerOptions; 242 243/* Information about the incoming connection as used by Match */ 244struct connection_info { 245 const char *user; 246 const char *host; /* possibly resolved hostname */ 247 const char *address; /* remote address */ 248 const char *laddress; /* local address */ 249 int lport; /* local port */ 250 const char *rdomain; /* routing domain if available */ 251 int test; /* test mode, allow some attributes to be 252 * unspecified */ 253}; 254 255/* List of included files for re-exec from the parsed configuration */ 256struct include_item { 257 char *selector; 258 char *filename; 259 struct sshbuf *contents; 260 TAILQ_ENTRY(include_item) entry; 261}; 262TAILQ_HEAD(include_list, include_item); 263 264 265/* 266 * These are string config options that must be copied between the 267 * Match sub-config and the main config, and must be sent from the 268 * privsep slave to the privsep master. We use a macro to ensure all 269 * the options are copied and the copies are done in the correct order. 270 * 271 * NB. an option must appear in servconf.c:copy_set_server_options() or 272 * COPY_MATCH_STRING_OPTS here but never both. 273 */ 274#define COPY_MATCH_STRING_OPTS() do { \ 275 M_CP_STROPT(banner); \ 276 M_CP_STROPT(trusted_user_ca_keys); \ 277 M_CP_STROPT(revoked_keys_file); \ 278 M_CP_STROPT(authorized_keys_command); \ 279 M_CP_STROPT(authorized_keys_command_user); \ 280 M_CP_STROPT(authorized_principals_file); \ 281 M_CP_STROPT(authorized_principals_command); \ 282 M_CP_STROPT(authorized_principals_command_user); \ 283 M_CP_STROPT(hostbased_key_types); \ 284 M_CP_STROPT(pubkey_key_types); \ 285 M_CP_STROPT(ca_sign_algorithms); \ 286 M_CP_STROPT(routing_domain); \ 287 M_CP_STROPT(permit_user_env_whitelist); \ 288 M_CP_STRARRAYOPT(authorized_keys_files, num_authkeys_files); \ 289 M_CP_STRARRAYOPT(allow_users, num_allow_users); \ 290 M_CP_STRARRAYOPT(deny_users, num_deny_users); \ 291 M_CP_STRARRAYOPT(allow_groups, num_allow_groups); \ 292 M_CP_STRARRAYOPT(deny_groups, num_deny_groups); \ 293 M_CP_STRARRAYOPT(accept_env, num_accept_env); \ 294 M_CP_STRARRAYOPT(auth_methods, num_auth_methods); \ 295 M_CP_STRARRAYOPT(permitted_opens, num_permitted_opens); \ 296 M_CP_STRARRAYOPT(permitted_listens, num_permitted_listens); \ 297 } while (0) 298 299struct connection_info *get_connection_info(struct ssh *, int, int); 300void initialize_server_options(ServerOptions *); 301void fill_default_server_options(ServerOptions *); 302int process_server_config_line(ServerOptions *, char *, const char *, int, 303 int *, struct connection_info *, struct include_list *includes); 304void process_permitopen(struct ssh *ssh, ServerOptions *options); 305void load_server_config(const char *, struct sshbuf *); 306void parse_server_config(ServerOptions *, const char *, struct sshbuf *, 307 struct include_list *includes, struct connection_info *); 308void parse_server_match_config(ServerOptions *, 309 struct include_list *includes, struct connection_info *); 310int parse_server_match_testspec(struct connection_info *, char *); 311int server_match_spec_complete(struct connection_info *); 312void copy_set_server_options(ServerOptions *, ServerOptions *, int); 313void dump_config(ServerOptions *); 314char *derelativise_path(const char *); 315void servconf_add_hostkey(const char *, const int, 316 ServerOptions *, const char *path, int); 317void servconf_add_hostcert(const char *, const int, 318 ServerOptions *, const char *path); 319 320#endif /* SERVCONF_H */ 321