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