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