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