1 /* $OpenBSD: servconf.h,v 1.103 2012/07/10 02:19:15 djm Exp $ */ 2 /* $FreeBSD$ */ 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 #define MAX_PORTS 256 /* Max # ports. */ 21 22 #define MAX_ALLOW_USERS 256 /* Max # users on allow list. */ 23 #define MAX_DENY_USERS 256 /* Max # users on deny list. */ 24 #define MAX_ALLOW_GROUPS 256 /* Max # groups on allow list. */ 25 #define MAX_DENY_GROUPS 256 /* Max # groups on deny list. */ 26 #define MAX_SUBSYSTEMS 256 /* Max # subsystems. */ 27 #define MAX_HOSTKEYS 256 /* Max # hostkeys. */ 28 #define MAX_HOSTCERTS 256 /* Max # host certificates. */ 29 #define MAX_ACCEPT_ENV 256 /* Max # of env vars. */ 30 #define MAX_MATCH_GROUPS 256 /* Max # of groups for Match. */ 31 #define MAX_AUTHKEYS_FILES 256 /* Max # of authorized_keys files. */ 32 33 /* permit_root_login */ 34 #define PERMIT_NOT_SET -1 35 #define PERMIT_NO 0 36 #define PERMIT_FORCED_ONLY 1 37 #define PERMIT_NO_PASSWD 2 38 #define PERMIT_YES 3 39 40 /* use_privsep */ 41 #define PRIVSEP_OFF 0 42 #define PRIVSEP_ON 1 43 #define PRIVSEP_NOSANDBOX 2 44 45 #define DEFAULT_AUTH_FAIL_MAX 6 /* Default for MaxAuthTries */ 46 #define DEFAULT_SESSIONS_MAX 10 /* Default for MaxSessions */ 47 48 /* Magic name for internal sftp-server */ 49 #define INTERNAL_SFTP_NAME "internal-sftp" 50 51 typedef struct { 52 u_int num_ports; 53 u_int ports_from_cmdline; 54 int ports[MAX_PORTS]; /* Port number to listen on. */ 55 char *listen_addr; /* Address on which the server listens. */ 56 struct addrinfo *listen_addrs; /* Addresses on which the server listens. */ 57 int address_family; /* Address family used by the server. */ 58 char *host_key_files[MAX_HOSTKEYS]; /* Files containing host keys. */ 59 int num_host_key_files; /* Number of files for host keys. */ 60 char *host_cert_files[MAX_HOSTCERTS]; /* Files containing host certs. */ 61 int num_host_cert_files; /* Number of files for host certs. */ 62 char *pid_file; /* Where to put our pid */ 63 int server_key_bits;/* Size of the server key. */ 64 int login_grace_time; /* Disconnect if no auth in this time 65 * (sec). */ 66 int key_regeneration_time; /* Server key lifetime (seconds). */ 67 int permit_root_login; /* PERMIT_*, see above */ 68 int ignore_rhosts; /* Ignore .rhosts and .shosts. */ 69 int ignore_user_known_hosts; /* Ignore ~/.ssh/known_hosts 70 * for RhostsRsaAuth */ 71 int print_motd; /* If true, print /etc/motd. */ 72 int print_lastlog; /* If true, print lastlog */ 73 int x11_forwarding; /* If true, permit inet (spoofing) X11 fwd. */ 74 int x11_display_offset; /* What DISPLAY number to start 75 * searching at */ 76 int x11_use_localhost; /* If true, use localhost for fake X11 server. */ 77 char *xauth_location; /* Location of xauth program */ 78 int strict_modes; /* If true, require string home dir modes. */ 79 int tcp_keep_alive; /* If true, set SO_KEEPALIVE. */ 80 int ip_qos_interactive; /* IP ToS/DSCP/class for interactive */ 81 int ip_qos_bulk; /* IP ToS/DSCP/class for bulk traffic */ 82 char *ciphers; /* Supported SSH2 ciphers. */ 83 char *macs; /* Supported SSH2 macs. */ 84 char *kex_algorithms; /* SSH2 kex methods in order of preference. */ 85 int protocol; /* Supported protocol versions. */ 86 int gateway_ports; /* If true, allow remote connects to forwarded ports. */ 87 SyslogFacility log_facility; /* Facility for system logging. */ 88 LogLevel log_level; /* Level for system logging. */ 89 int rhosts_rsa_authentication; /* If true, permit rhosts RSA 90 * authentication. */ 91 int hostbased_authentication; /* If true, permit ssh2 hostbased auth */ 92 int hostbased_uses_name_from_packet_only; /* experimental */ 93 int rsa_authentication; /* If true, permit RSA authentication. */ 94 int pubkey_authentication; /* If true, permit ssh2 pubkey authentication. */ 95 int kerberos_authentication; /* If true, permit Kerberos 96 * authentication. */ 97 int kerberos_or_local_passwd; /* If true, permit kerberos 98 * and any other password 99 * authentication mechanism, 100 * such as SecurID or 101 * /etc/passwd */ 102 int kerberos_ticket_cleanup; /* If true, destroy ticket 103 * file on logout. */ 104 int kerberos_get_afs_token; /* If true, try to get AFS token if 105 * authenticated with Kerberos. */ 106 int gss_authentication; /* If true, permit GSSAPI authentication */ 107 int gss_cleanup_creds; /* If true, destroy cred cache on logout */ 108 int password_authentication; /* If true, permit password 109 * authentication. */ 110 int kbd_interactive_authentication; /* If true, permit */ 111 int challenge_response_authentication; 112 int zero_knowledge_password_authentication; 113 /* If true, permit jpake auth */ 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 162 int permit_tun; 163 164 int num_permitted_opens; 165 166 char *chroot_directory; 167 char *revoked_keys_file; 168 char *trusted_user_ca_keys; 169 char *authorized_principals_file; 170 171 char *version_addendum; /* Appended to SSH banner */ 172 173 int hpn_disabled; /* Disable HPN functionality. */ 174 int hpn_buffer_size; /* Set HPN buffer size - default 2MB.*/ 175 int tcp_rcv_buf_poll; /* Poll TCP rcv window in autotuning 176 * kernels. */ 177 178 #ifdef NONE_CIPHER_ENABLED 179 int none_enabled; /* Enable NONE cipher switch. */ 180 #endif 181 } ServerOptions; 182 183 /* Information about the incoming connection as used by Match */ 184 struct connection_info { 185 const char *user; 186 const char *host; /* possibly resolved hostname */ 187 const char *address; /* remote address */ 188 const char *laddress; /* local address */ 189 int lport; /* local port */ 190 }; 191 192 193 /* 194 * These are string config options that must be copied between the 195 * Match sub-config and the main config, and must be sent from the 196 * privsep slave to the privsep master. We use a macro to ensure all 197 * the options are copied and the copies are done in the correct order. 198 */ 199 #define COPY_MATCH_STRING_OPTS() do { \ 200 M_CP_STROPT(banner); \ 201 M_CP_STROPT(trusted_user_ca_keys); \ 202 M_CP_STROPT(revoked_keys_file); \ 203 M_CP_STROPT(authorized_principals_file); \ 204 M_CP_STRARRAYOPT(authorized_keys_files, num_authkeys_files); \ 205 M_CP_STRARRAYOPT(allow_users, num_allow_users); \ 206 M_CP_STRARRAYOPT(deny_users, num_deny_users); \ 207 M_CP_STRARRAYOPT(allow_groups, num_allow_groups); \ 208 M_CP_STRARRAYOPT(deny_groups, num_deny_groups); \ 209 M_CP_STRARRAYOPT(accept_env, num_accept_env); \ 210 } while (0) 211 212 struct connection_info *get_connection_info(int, int); 213 void initialize_server_options(ServerOptions *); 214 void fill_default_server_options(ServerOptions *); 215 int process_server_config_line(ServerOptions *, char *, const char *, int, 216 int *, struct connection_info *); 217 void load_server_config(const char *, Buffer *); 218 void parse_server_config(ServerOptions *, const char *, Buffer *, 219 struct connection_info *); 220 void parse_server_match_config(ServerOptions *, struct connection_info *); 221 int parse_server_match_testspec(struct connection_info *, char *); 222 int server_match_spec_complete(struct connection_info *); 223 void copy_set_server_options(ServerOptions *, ServerOptions *, int); 224 void dump_config(ServerOptions *); 225 char *derelativise_path(const char *); 226 227 #endif /* SERVCONF_H */ 228