1 /* $OpenBSD: servconf.h,v 1.103 2012/07/10 02:19:15 djm 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 32 /* permit_root_login */ 33 #define PERMIT_NOT_SET -1 34 #define PERMIT_NO 0 35 #define PERMIT_FORCED_ONLY 1 36 #define PERMIT_NO_PASSWD 2 37 #define PERMIT_YES 3 38 39 /* use_privsep */ 40 #define PRIVSEP_OFF 0 41 #define PRIVSEP_ON 1 42 #define PRIVSEP_NOSANDBOX 2 43 44 #define DEFAULT_AUTH_FAIL_MAX 6 /* Default for MaxAuthTries */ 45 #define DEFAULT_SESSIONS_MAX 10 /* Default for MaxSessions */ 46 47 /* Magic name for internal sftp-server */ 48 #define INTERNAL_SFTP_NAME "internal-sftp" 49 50 typedef struct { 51 u_int num_ports; 52 u_int ports_from_cmdline; 53 int ports[MAX_PORTS]; /* Port number to listen on. */ 54 char *listen_addr; /* Address on which the server listens. */ 55 struct addrinfo *listen_addrs; /* Addresses on which the server listens. */ 56 int address_family; /* Address family used by the server. */ 57 char *host_key_files[MAX_HOSTKEYS]; /* Files containing host keys. */ 58 int num_host_key_files; /* Number of files for host keys. */ 59 char *host_cert_files[MAX_HOSTCERTS]; /* Files containing host certs. */ 60 int num_host_cert_files; /* Number of files for host certs. */ 61 char *pid_file; /* Where to put our pid */ 62 int server_key_bits;/* Size of the server key. */ 63 int login_grace_time; /* Disconnect if no auth in this time 64 * (sec). */ 65 int key_regeneration_time; /* Server key lifetime (seconds). */ 66 int permit_root_login; /* PERMIT_*, see above */ 67 int ignore_rhosts; /* Ignore .rhosts and .shosts. */ 68 int ignore_user_known_hosts; /* Ignore ~/.ssh/known_hosts 69 * for RhostsRsaAuth */ 70 int print_motd; /* If true, print /etc/motd. */ 71 int print_lastlog; /* If true, print lastlog */ 72 int x11_forwarding; /* If true, permit inet (spoofing) X11 fwd. */ 73 int x11_display_offset; /* What DISPLAY number to start 74 * searching at */ 75 int x11_use_localhost; /* If true, use localhost for fake X11 server. */ 76 char *xauth_location; /* Location of xauth program */ 77 int strict_modes; /* If true, require string home dir modes. */ 78 int tcp_keep_alive; /* If true, set SO_KEEPALIVE. */ 79 int ip_qos_interactive; /* IP ToS/DSCP/class for interactive */ 80 int ip_qos_bulk; /* IP ToS/DSCP/class for bulk traffic */ 81 char *ciphers; /* Supported SSH2 ciphers. */ 82 char *macs; /* Supported SSH2 macs. */ 83 char *kex_algorithms; /* SSH2 kex methods in order of preference. */ 84 int protocol; /* Supported protocol versions. */ 85 int gateway_ports; /* If true, allow remote connects to forwarded ports. */ 86 SyslogFacility log_facility; /* Facility for system logging. */ 87 LogLevel log_level; /* Level for system logging. */ 88 int rhosts_rsa_authentication; /* If true, permit rhosts RSA 89 * authentication. */ 90 int hostbased_authentication; /* If true, permit ssh2 hostbased auth */ 91 int hostbased_uses_name_from_packet_only; /* experimental */ 92 int rsa_authentication; /* If true, permit RSA authentication. */ 93 int pubkey_authentication; /* If true, permit ssh2 pubkey authentication. */ 94 int kerberos_authentication; /* If true, permit Kerberos 95 * authentication. */ 96 int kerberos_or_local_passwd; /* If true, permit kerberos 97 * and any other password 98 * authentication mechanism, 99 * such as SecurID or 100 * /etc/passwd */ 101 int kerberos_ticket_cleanup; /* If true, destroy ticket 102 * file on logout. */ 103 int kerberos_get_afs_token; /* If true, try to get AFS token if 104 * authenticated with Kerberos. */ 105 int gss_authentication; /* If true, permit GSSAPI authentication */ 106 int gss_cleanup_creds; /* If true, destroy cred cache on logout */ 107 int password_authentication; /* If true, permit password 108 * authentication. */ 109 int kbd_interactive_authentication; /* If true, permit */ 110 int challenge_response_authentication; 111 int zero_knowledge_password_authentication; 112 /* If true, permit jpake auth */ 113 int permit_blacklisted_keys; /* If true, permit */ 114 int permit_empty_passwd; /* If false, do not permit empty 115 * passwords. */ 116 int permit_user_env; /* If true, read ~/.ssh/environment */ 117 int use_login; /* If true, login(1) is used */ 118 int compression; /* If true, compression is allowed */ 119 int allow_tcp_forwarding; 120 int allow_agent_forwarding; 121 u_int num_allow_users; 122 char *allow_users[MAX_ALLOW_USERS]; 123 u_int num_deny_users; 124 char *deny_users[MAX_DENY_USERS]; 125 u_int num_allow_groups; 126 char *allow_groups[MAX_ALLOW_GROUPS]; 127 u_int num_deny_groups; 128 char *deny_groups[MAX_DENY_GROUPS]; 129 130 u_int num_subsystems; 131 char *subsystem_name[MAX_SUBSYSTEMS]; 132 char *subsystem_command[MAX_SUBSYSTEMS]; 133 char *subsystem_args[MAX_SUBSYSTEMS]; 134 135 u_int num_accept_env; 136 char *accept_env[MAX_ACCEPT_ENV]; 137 138 int max_startups_begin; 139 int max_startups_rate; 140 int max_startups; 141 int max_authtries; 142 int max_sessions; 143 char *banner; /* SSH-2 banner message */ 144 int use_dns; 145 int client_alive_interval; /* 146 * poke the client this often to 147 * see if it's still there 148 */ 149 int client_alive_count_max; /* 150 * If the client is unresponsive 151 * for this many intervals above, 152 * disconnect the session 153 */ 154 155 u_int num_authkeys_files; /* Files containing public keys */ 156 char *authorized_keys_files[MAX_AUTHKEYS_FILES]; 157 158 char *adm_forced_command; 159 160 int use_pam; /* Enable auth via PAM */ 161 int none_enabled; /* enable NONE cipher switch */ 162 int tcp_rcv_buf_poll; /* poll tcp rcv window in autotuning kernels*/ 163 int hpn_disabled; /* disable hpn functionality. false by default */ 164 int hpn_buffer_size; /* set the hpn buffer size - default 3MB */ 165 166 int permit_tun; 167 168 int num_permitted_opens; 169 170 char *chroot_directory; 171 char *revoked_keys_file; 172 char *trusted_user_ca_keys; 173 char *authorized_principals_file; 174 175 char *version_addendum; /* Appended to SSH banner */ 176 } ServerOptions; 177 178 /* Information about the incoming connection as used by Match */ 179 struct connection_info { 180 const char *user; 181 const char *host; /* possibly resolved hostname */ 182 const char *address; /* remote address */ 183 const char *laddress; /* local address */ 184 int lport; /* local port */ 185 }; 186 187 188 /* 189 * These are string config options that must be copied between the 190 * Match sub-config and the main config, and must be sent from the 191 * privsep slave to the privsep master. We use a macro to ensure all 192 * the options are copied and the copies are done in the correct order. 193 */ 194 #define COPY_MATCH_STRING_OPTS() do { \ 195 M_CP_STROPT(banner); \ 196 M_CP_STROPT(trusted_user_ca_keys); \ 197 M_CP_STROPT(revoked_keys_file); \ 198 M_CP_STROPT(authorized_principals_file); \ 199 M_CP_STRARRAYOPT(authorized_keys_files, num_authkeys_files); \ 200 M_CP_STRARRAYOPT(allow_users, num_allow_users); \ 201 M_CP_STRARRAYOPT(deny_users, num_deny_users); \ 202 M_CP_STRARRAYOPT(allow_groups, num_allow_groups); \ 203 M_CP_STRARRAYOPT(deny_groups, num_deny_groups); \ 204 M_CP_STRARRAYOPT(accept_env, num_accept_env); \ 205 } while (0) 206 207 struct connection_info *get_connection_info(int, int); 208 void initialize_server_options(ServerOptions *); 209 void fill_default_server_options(ServerOptions *); 210 int process_server_config_line(ServerOptions *, char *, const char *, int, 211 int *, struct connection_info *); 212 void load_server_config(const char *, Buffer *); 213 void parse_server_config(ServerOptions *, const char *, Buffer *, 214 struct connection_info *); 215 void parse_server_match_config(ServerOptions *, struct connection_info *); 216 int parse_server_match_testspec(struct connection_info *, char *); 217 int server_match_spec_complete(struct connection_info *); 218 void copy_set_server_options(ServerOptions *, ServerOptions *, int); 219 void dump_config(ServerOptions *); 220 char *derelativise_path(const char *); 221 222 #endif /* SERVCONF_H */ 223