Darren Tucker | e7140f2 | 2008-06-10 23:01:51 +1000 | [diff] [blame] | 1 | /* $OpenBSD: servconf.h,v 1.85 2008/06/10 04:50:25 dtucker Exp $ */ |
Ben Lindstrom | 05764b9 | 2002-03-05 01:53:02 +0000 | [diff] [blame] | 2 | |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 3 | /* |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 4 | * Author: Tatu Ylonen <ylo@cs.hut.fi> |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 5 | * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland |
| 6 | * All rights reserved |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 7 | * Definitions for server configuration data and for the functions reading it. |
Damien Miller | 4af5130 | 2000-04-16 11:18:38 +1000 | [diff] [blame] | 8 | * |
Damien Miller | e4340be | 2000-09-16 13:29:08 +1100 | [diff] [blame] | 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". |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 14 | */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 15 | |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 16 | #ifndef SERVCONF_H |
| 17 | #define SERVCONF_H |
| 18 | |
Damien Miller | 34132e5 | 2000-01-14 15:45:46 +1100 | [diff] [blame] | 19 | #define MAX_PORTS 256 /* Max # ports. */ |
| 20 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 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. */ |
Damien Miller | f6d9e22 | 2000-06-18 14:50:44 +1000 | [diff] [blame] | 25 | #define MAX_SUBSYSTEMS 256 /* Max # subsystems. */ |
Damien Miller | 0bc1bd8 | 2000-11-13 22:57:25 +1100 | [diff] [blame] | 26 | #define MAX_HOSTKEYS 256 /* Max # hostkeys. */ |
Darren Tucker | 46bc075 | 2004-05-02 22:11:30 +1000 | [diff] [blame] | 27 | #define MAX_ACCEPT_ENV 256 /* Max # of env vars. */ |
Damien Miller | 565ca3f | 2006-08-19 00:23:15 +1000 | [diff] [blame] | 28 | #define MAX_MATCH_GROUPS 256 /* Max # of groups for Match. */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 29 | |
Ben Lindstrom | d8a9021 | 2001-02-15 03:08:27 +0000 | [diff] [blame] | 30 | /* permit_root_login */ |
| 31 | #define PERMIT_NOT_SET -1 |
| 32 | #define PERMIT_NO 0 |
| 33 | #define PERMIT_FORCED_ONLY 1 |
| 34 | #define PERMIT_NO_PASSWD 2 |
| 35 | #define PERMIT_YES 3 |
| 36 | |
Darren Tucker | 89413db | 2004-05-24 10:36:23 +1000 | [diff] [blame] | 37 | #define DEFAULT_AUTH_FAIL_MAX 6 /* Default for MaxAuthTries */ |
Damien Miller | 7207f64 | 2008-05-19 15:34:50 +1000 | [diff] [blame] | 38 | #define DEFAULT_SESSIONS_MAX 10 /* Default for MaxSessions */ |
Ben Lindstrom | d8a9021 | 2001-02-15 03:08:27 +0000 | [diff] [blame] | 39 | |
Damien Miller | 76e95da | 2008-03-07 18:31:24 +1100 | [diff] [blame] | 40 | /* Magic name for internal sftp-server */ |
| 41 | #define INTERNAL_SFTP_NAME "internal-sftp" |
| 42 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 43 | typedef struct { |
Ben Lindstrom | 46c1622 | 2000-12-22 01:43:59 +0000 | [diff] [blame] | 44 | u_int num_ports; |
| 45 | u_int ports_from_cmdline; |
Damien Miller | 34132e5 | 2000-01-14 15:45:46 +1100 | [diff] [blame] | 46 | u_short ports[MAX_PORTS]; /* Port number to listen on. */ |
| 47 | char *listen_addr; /* Address on which the server listens. */ |
| 48 | struct addrinfo *listen_addrs; /* Addresses on which the server listens. */ |
Darren Tucker | 0f38323 | 2005-01-20 10:57:56 +1100 | [diff] [blame] | 49 | int address_family; /* Address family used by the server. */ |
Damien Miller | 0bc1bd8 | 2000-11-13 22:57:25 +1100 | [diff] [blame] | 50 | char *host_key_files[MAX_HOSTKEYS]; /* Files containing host keys. */ |
| 51 | int num_host_key_files; /* Number of files for host keys. */ |
Damien Miller | 6f83b8e | 2000-05-02 09:23:45 +1000 | [diff] [blame] | 52 | char *pid_file; /* Where to put our pid */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 53 | int server_key_bits;/* Size of the server key. */ |
| 54 | int login_grace_time; /* Disconnect if no auth in this time |
| 55 | * (sec). */ |
| 56 | int key_regeneration_time; /* Server key lifetime (seconds). */ |
Ben Lindstrom | d8a9021 | 2001-02-15 03:08:27 +0000 | [diff] [blame] | 57 | int permit_root_login; /* PERMIT_*, see above */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 58 | int ignore_rhosts; /* Ignore .rhosts and .shosts. */ |
| 59 | int ignore_user_known_hosts; /* Ignore ~/.ssh/known_hosts |
| 60 | * for RhostsRsaAuth */ |
| 61 | int print_motd; /* If true, print /etc/motd. */ |
Ben Lindstrom | 7bfff36 | 2001-03-26 05:45:53 +0000 | [diff] [blame] | 62 | int print_lastlog; /* If true, print lastlog */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 63 | int x11_forwarding; /* If true, permit inet (spoofing) X11 fwd. */ |
| 64 | int x11_display_offset; /* What DISPLAY number to start |
| 65 | * searching at */ |
Damien Miller | 95c249f | 2002-02-05 12:11:34 +1100 | [diff] [blame] | 66 | int x11_use_localhost; /* If true, use localhost for fake X11 server. */ |
Damien Miller | d3a1857 | 2000-06-07 19:55:44 +1000 | [diff] [blame] | 67 | char *xauth_location; /* Location of xauth program */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 68 | int strict_modes; /* If true, require string home dir modes. */ |
Damien Miller | 12c150e | 2003-12-17 16:31:10 +1100 | [diff] [blame] | 69 | int tcp_keep_alive; /* If true, set SO_KEEPALIVE. */ |
Ben Lindstrom | 06b33aa | 2001-02-15 03:01:59 +0000 | [diff] [blame] | 70 | char *ciphers; /* Supported SSH2 ciphers. */ |
| 71 | char *macs; /* Supported SSH2 macs. */ |
| 72 | int protocol; /* Supported protocol versions. */ |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 73 | int gateway_ports; /* If true, allow remote connects to forwarded ports. */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 74 | SyslogFacility log_facility; /* Facility for system logging. */ |
| 75 | LogLevel log_level; /* Level for system logging. */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 76 | int rhosts_rsa_authentication; /* If true, permit rhosts RSA |
| 77 | * authentication. */ |
Ben Lindstrom | 5eabda3 | 2001-04-12 23:34:34 +0000 | [diff] [blame] | 78 | int hostbased_authentication; /* If true, permit ssh2 hostbased auth */ |
| 79 | int hostbased_uses_name_from_packet_only; /* experimental */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 80 | int rsa_authentication; /* If true, permit RSA authentication. */ |
Damien Miller | 0bc1bd8 | 2000-11-13 22:57:25 +1100 | [diff] [blame] | 81 | int pubkey_authentication; /* If true, permit ssh2 pubkey authentication. */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 82 | int kerberos_authentication; /* If true, permit Kerberos |
| 83 | * authentication. */ |
| 84 | int kerberos_or_local_passwd; /* If true, permit kerberos |
| 85 | * and any other password |
| 86 | * authentication mechanism, |
| 87 | * such as SecurID or |
| 88 | * /etc/passwd */ |
| 89 | int kerberos_ticket_cleanup; /* If true, destroy ticket |
| 90 | * file on logout. */ |
Darren Tucker | 22ef508 | 2003-12-31 11:37:34 +1100 | [diff] [blame] | 91 | int kerberos_get_afs_token; /* If true, try to get AFS token if |
| 92 | * authenticated with Kerberos. */ |
Darren Tucker | 0efd155 | 2003-08-26 11:49:55 +1000 | [diff] [blame] | 93 | int gss_authentication; /* If true, permit GSSAPI authentication */ |
| 94 | int gss_cleanup_creds; /* If true, destroy cred cache on logout */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 95 | int password_authentication; /* If true, permit password |
| 96 | * authentication. */ |
Damien Miller | 874d77b | 2000-10-14 16:23:11 +1100 | [diff] [blame] | 97 | int kbd_interactive_authentication; /* If true, permit */ |
Ben Lindstrom | 551ea37 | 2001-06-05 18:56:16 +0000 | [diff] [blame] | 98 | int challenge_response_authentication; |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 99 | int permit_empty_passwd; /* If false, do not permit empty |
| 100 | * passwords. */ |
Ben Lindstrom | 5d860f0 | 2002-08-01 01:28:38 +0000 | [diff] [blame] | 101 | int permit_user_env; /* If true, read ~/.ssh/environment */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 102 | int use_login; /* If true, login(1) is used */ |
Ben Lindstrom | 23e0f66 | 2002-06-21 01:09:47 +0000 | [diff] [blame] | 103 | int compression; /* If true, compression is allowed */ |
Damien Miller | 50a41ed | 2000-10-16 12:14:42 +1100 | [diff] [blame] | 104 | int allow_tcp_forwarding; |
Damien Miller | 4f755cd | 2008-05-19 14:57:41 +1000 | [diff] [blame] | 105 | int allow_agent_forwarding; |
Ben Lindstrom | 46c1622 | 2000-12-22 01:43:59 +0000 | [diff] [blame] | 106 | u_int num_allow_users; |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 107 | char *allow_users[MAX_ALLOW_USERS]; |
Ben Lindstrom | 46c1622 | 2000-12-22 01:43:59 +0000 | [diff] [blame] | 108 | u_int num_deny_users; |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 109 | char *deny_users[MAX_DENY_USERS]; |
Ben Lindstrom | 46c1622 | 2000-12-22 01:43:59 +0000 | [diff] [blame] | 110 | u_int num_allow_groups; |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 111 | char *allow_groups[MAX_ALLOW_GROUPS]; |
Ben Lindstrom | 46c1622 | 2000-12-22 01:43:59 +0000 | [diff] [blame] | 112 | u_int num_deny_groups; |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 113 | char *deny_groups[MAX_DENY_GROUPS]; |
Damien Miller | f6d9e22 | 2000-06-18 14:50:44 +1000 | [diff] [blame] | 114 | |
Ben Lindstrom | 46c1622 | 2000-12-22 01:43:59 +0000 | [diff] [blame] | 115 | u_int num_subsystems; |
Damien Miller | f6d9e22 | 2000-06-18 14:50:44 +1000 | [diff] [blame] | 116 | char *subsystem_name[MAX_SUBSYSTEMS]; |
| 117 | char *subsystem_command[MAX_SUBSYSTEMS]; |
Damien Miller | 917f9b6 | 2006-07-10 20:36:47 +1000 | [diff] [blame] | 118 | char *subsystem_args[MAX_SUBSYSTEMS]; |
Damien Miller | 3702396 | 2000-07-11 17:31:38 +1000 | [diff] [blame] | 119 | |
Darren Tucker | 46bc075 | 2004-05-02 22:11:30 +1000 | [diff] [blame] | 120 | u_int num_accept_env; |
| 121 | char *accept_env[MAX_ACCEPT_ENV]; |
| 122 | |
Damien Miller | 942da03 | 2000-08-18 13:59:06 +1000 | [diff] [blame] | 123 | int max_startups_begin; |
| 124 | int max_startups_rate; |
Damien Miller | 3702396 | 2000-07-11 17:31:38 +1000 | [diff] [blame] | 125 | int max_startups; |
Darren Tucker | 89413db | 2004-05-24 10:36:23 +1000 | [diff] [blame] | 126 | int max_authtries; |
Damien Miller | 7207f64 | 2008-05-19 15:34:50 +1000 | [diff] [blame] | 127 | int max_sessions; |
Ben Lindstrom | 48bd7c1 | 2001-01-09 00:35:42 +0000 | [diff] [blame] | 128 | char *banner; /* SSH-2 banner message */ |
Damien Miller | 3a961dc | 2003-06-03 10:25:48 +1000 | [diff] [blame] | 129 | int use_dns; |
Ben Lindstrom | 5744dc4 | 2001-04-13 23:28:01 +0000 | [diff] [blame] | 130 | int client_alive_interval; /* |
Damien Miller | 9f0f5c6 | 2001-12-21 14:45:46 +1100 | [diff] [blame] | 131 | * poke the client this often to |
| 132 | * see if it's still there |
Ben Lindstrom | 5744dc4 | 2001-04-13 23:28:01 +0000 | [diff] [blame] | 133 | */ |
| 134 | int client_alive_count_max; /* |
Ben Lindstrom | 7bb37b2 | 2001-09-12 16:40:05 +0000 | [diff] [blame] | 135 | * If the client is unresponsive |
| 136 | * for this many intervals above, |
Damien Miller | 9f0f5c6 | 2001-12-21 14:45:46 +1100 | [diff] [blame] | 137 | * disconnect the session |
Ben Lindstrom | 5744dc4 | 2001-04-13 23:28:01 +0000 | [diff] [blame] | 138 | */ |
Kevin Steves | e468de6 | 2001-07-04 18:37:20 +0000 | [diff] [blame] | 139 | |
| 140 | char *authorized_keys_file; /* File containing public keys */ |
| 141 | char *authorized_keys_file2; |
Damien Miller | d27b947 | 2005-12-13 19:29:02 +1100 | [diff] [blame] | 142 | |
Damien Miller | e275443 | 2006-07-24 14:06:47 +1000 | [diff] [blame] | 143 | char *adm_forced_command; |
| 144 | |
Damien Miller | 4e448a3 | 2003-05-14 15:11:48 +1000 | [diff] [blame] | 145 | int use_pam; /* Enable auth via PAM */ |
Damien Miller | d27b947 | 2005-12-13 19:29:02 +1100 | [diff] [blame] | 146 | |
| 147 | int permit_tun; |
Damien Miller | a765cf4 | 2006-07-24 14:08:13 +1000 | [diff] [blame] | 148 | |
| 149 | int num_permitted_opens; |
Damien Miller | d8cb1f1 | 2008-02-10 22:40:12 +1100 | [diff] [blame] | 150 | |
| 151 | char *chroot_directory; |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 152 | } ServerOptions; |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 153 | |
Ben Lindstrom | 4cc240d | 2001-07-04 04:46:56 +0000 | [diff] [blame] | 154 | void initialize_server_options(ServerOptions *); |
Ben Lindstrom | 4cc240d | 2001-07-04 04:46:56 +0000 | [diff] [blame] | 155 | void fill_default_server_options(ServerOptions *); |
Darren Tucker | 4515047 | 2006-07-12 22:34:17 +1000 | [diff] [blame] | 156 | int process_server_config_line(ServerOptions *, char *, const char *, int, |
| 157 | int *, const char *, const char *, const char *); |
Darren Tucker | 645ab75 | 2004-06-25 13:33:20 +1000 | [diff] [blame] | 158 | void load_server_config(const char *, Buffer *); |
Darren Tucker | 4515047 | 2006-07-12 22:34:17 +1000 | [diff] [blame] | 159 | void parse_server_config(ServerOptions *, const char *, Buffer *, |
| 160 | const char *, const char *, const char *); |
| 161 | void parse_server_match_config(ServerOptions *, const char *, const char *, |
| 162 | const char *); |
Darren Tucker | 1629c07 | 2007-02-19 22:25:37 +1100 | [diff] [blame] | 163 | void copy_set_server_options(ServerOptions *, ServerOptions *, int); |
Darren Tucker | e7140f2 | 2008-06-10 23:01:51 +1000 | [diff] [blame] | 164 | void dump_config(ServerOptions *); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 165 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 166 | #endif /* SERVCONF_H */ |