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