blob: 2593b1cd1f322a163d874ff5ac8fcd8c0ced7eed [file] [log] [blame]
Damien Millerd7834352006-08-05 12:39:39 +10001/* $OpenBSD: servconf.h,v 1.78 2006/08/03 03:34:42 deraadt Exp $ */
Ben Lindstrom05764b92002-03-05 01:53:02 +00002
Damien Millerd4a8b7e1999-10-27 13:42:43 +10003/*
Damien Miller95def091999-11-25 00:26:21 +11004 * Author: Tatu Ylonen <ylo@cs.hut.fi>
Damien Miller95def091999-11-25 00:26:21 +11005 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
6 * All rights reserved
Damien Miller95def091999-11-25 00:26:21 +11007 * Definitions for server configuration data and for the functions reading it.
Damien Miller4af51302000-04-16 11:18:38 +10008 *
Damien Millere4340be2000-09-16 13:29:08 +11009 * 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 Miller95def091999-11-25 00:26:21 +110014 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100015
Damien Millerd4a8b7e1999-10-27 13:42:43 +100016#ifndef SERVCONF_H
17#define SERVCONF_H
18
Damien Miller34132e52000-01-14 15:45:46 +110019#define MAX_PORTS 256 /* Max # ports. */
20
Damien Miller95def091999-11-25 00:26:21 +110021#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 Millerf6d9e222000-06-18 14:50:44 +100025#define MAX_SUBSYSTEMS 256 /* Max # subsystems. */
Damien Miller0bc1bd82000-11-13 22:57:25 +110026#define MAX_HOSTKEYS 256 /* Max # hostkeys. */
Darren Tucker46bc0752004-05-02 22:11:30 +100027#define MAX_ACCEPT_ENV 256 /* Max # of env vars. */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100028
Ben Lindstromd8a90212001-02-15 03:08:27 +000029/* permit_root_login */
30#define PERMIT_NOT_SET -1
31#define PERMIT_NO 0
32#define PERMIT_FORCED_ONLY 1
33#define PERMIT_NO_PASSWD 2
34#define PERMIT_YES 3
35
Darren Tucker89413db2004-05-24 10:36:23 +100036#define DEFAULT_AUTH_FAIL_MAX 6 /* Default for MaxAuthTries */
Ben Lindstromd8a90212001-02-15 03:08:27 +000037
Damien Miller95def091999-11-25 00:26:21 +110038typedef struct {
Ben Lindstrom46c16222000-12-22 01:43:59 +000039 u_int num_ports;
40 u_int ports_from_cmdline;
Damien Miller34132e52000-01-14 15:45:46 +110041 u_short ports[MAX_PORTS]; /* Port number to listen on. */
42 char *listen_addr; /* Address on which the server listens. */
43 struct addrinfo *listen_addrs; /* Addresses on which the server listens. */
Darren Tucker0f383232005-01-20 10:57:56 +110044 int address_family; /* Address family used by the server. */
Damien Miller0bc1bd82000-11-13 22:57:25 +110045 char *host_key_files[MAX_HOSTKEYS]; /* Files containing host keys. */
46 int num_host_key_files; /* Number of files for host keys. */
Damien Miller6f83b8e2000-05-02 09:23:45 +100047 char *pid_file; /* Where to put our pid */
Damien Miller95def091999-11-25 00:26:21 +110048 int server_key_bits;/* Size of the server key. */
49 int login_grace_time; /* Disconnect if no auth in this time
50 * (sec). */
51 int key_regeneration_time; /* Server key lifetime (seconds). */
Ben Lindstromd8a90212001-02-15 03:08:27 +000052 int permit_root_login; /* PERMIT_*, see above */
Damien Miller95def091999-11-25 00:26:21 +110053 int ignore_rhosts; /* Ignore .rhosts and .shosts. */
54 int ignore_user_known_hosts; /* Ignore ~/.ssh/known_hosts
55 * for RhostsRsaAuth */
56 int print_motd; /* If true, print /etc/motd. */
Ben Lindstrom7bfff362001-03-26 05:45:53 +000057 int print_lastlog; /* If true, print lastlog */
Damien Miller95def091999-11-25 00:26:21 +110058 int x11_forwarding; /* If true, permit inet (spoofing) X11 fwd. */
59 int x11_display_offset; /* What DISPLAY number to start
60 * searching at */
Damien Miller95c249f2002-02-05 12:11:34 +110061 int x11_use_localhost; /* If true, use localhost for fake X11 server. */
Damien Millerd3a18572000-06-07 19:55:44 +100062 char *xauth_location; /* Location of xauth program */
Damien Miller95def091999-11-25 00:26:21 +110063 int strict_modes; /* If true, require string home dir modes. */
Damien Miller12c150e2003-12-17 16:31:10 +110064 int tcp_keep_alive; /* If true, set SO_KEEPALIVE. */
Ben Lindstrom06b33aa2001-02-15 03:01:59 +000065 char *ciphers; /* Supported SSH2 ciphers. */
66 char *macs; /* Supported SSH2 macs. */
67 int protocol; /* Supported protocol versions. */
Damien Millere247cc42000-05-07 12:03:14 +100068 int gateway_ports; /* If true, allow remote connects to forwarded ports. */
Damien Miller95def091999-11-25 00:26:21 +110069 SyslogFacility log_facility; /* Facility for system logging. */
70 LogLevel log_level; /* Level for system logging. */
Damien Miller95def091999-11-25 00:26:21 +110071 int rhosts_rsa_authentication; /* If true, permit rhosts RSA
72 * authentication. */
Ben Lindstrom5eabda32001-04-12 23:34:34 +000073 int hostbased_authentication; /* If true, permit ssh2 hostbased auth */
74 int hostbased_uses_name_from_packet_only; /* experimental */
Damien Miller95def091999-11-25 00:26:21 +110075 int rsa_authentication; /* If true, permit RSA authentication. */
Damien Miller0bc1bd82000-11-13 22:57:25 +110076 int pubkey_authentication; /* If true, permit ssh2 pubkey authentication. */
Damien Miller95def091999-11-25 00:26:21 +110077 int kerberos_authentication; /* If true, permit Kerberos
78 * authentication. */
79 int kerberos_or_local_passwd; /* If true, permit kerberos
80 * and any other password
81 * authentication mechanism,
82 * such as SecurID or
83 * /etc/passwd */
84 int kerberos_ticket_cleanup; /* If true, destroy ticket
85 * file on logout. */
Darren Tucker22ef5082003-12-31 11:37:34 +110086 int kerberos_get_afs_token; /* If true, try to get AFS token if
87 * authenticated with Kerberos. */
Darren Tucker0efd1552003-08-26 11:49:55 +100088 int gss_authentication; /* If true, permit GSSAPI authentication */
89 int gss_cleanup_creds; /* If true, destroy cred cache on logout */
Damien Miller95def091999-11-25 00:26:21 +110090 int password_authentication; /* If true, permit password
91 * authentication. */
Damien Miller874d77b2000-10-14 16:23:11 +110092 int kbd_interactive_authentication; /* If true, permit */
Ben Lindstrom551ea372001-06-05 18:56:16 +000093 int challenge_response_authentication;
Damien Miller95def091999-11-25 00:26:21 +110094 int permit_empty_passwd; /* If false, do not permit empty
95 * passwords. */
Ben Lindstrom5d860f02002-08-01 01:28:38 +000096 int permit_user_env; /* If true, read ~/.ssh/environment */
Damien Miller95def091999-11-25 00:26:21 +110097 int use_login; /* If true, login(1) is used */
Ben Lindstrom23e0f662002-06-21 01:09:47 +000098 int compression; /* If true, compression is allowed */
Damien Miller50a41ed2000-10-16 12:14:42 +110099 int allow_tcp_forwarding;
Ben Lindstrom46c16222000-12-22 01:43:59 +0000100 u_int num_allow_users;
Damien Miller95def091999-11-25 00:26:21 +1100101 char *allow_users[MAX_ALLOW_USERS];
Ben Lindstrom46c16222000-12-22 01:43:59 +0000102 u_int num_deny_users;
Damien Miller95def091999-11-25 00:26:21 +1100103 char *deny_users[MAX_DENY_USERS];
Ben Lindstrom46c16222000-12-22 01:43:59 +0000104 u_int num_allow_groups;
Damien Miller95def091999-11-25 00:26:21 +1100105 char *allow_groups[MAX_ALLOW_GROUPS];
Ben Lindstrom46c16222000-12-22 01:43:59 +0000106 u_int num_deny_groups;
Damien Miller95def091999-11-25 00:26:21 +1100107 char *deny_groups[MAX_DENY_GROUPS];
Damien Millerf6d9e222000-06-18 14:50:44 +1000108
Ben Lindstrom46c16222000-12-22 01:43:59 +0000109 u_int num_subsystems;
Damien Millerf6d9e222000-06-18 14:50:44 +1000110 char *subsystem_name[MAX_SUBSYSTEMS];
111 char *subsystem_command[MAX_SUBSYSTEMS];
Damien Miller917f9b62006-07-10 20:36:47 +1000112 char *subsystem_args[MAX_SUBSYSTEMS];
Damien Miller37023962000-07-11 17:31:38 +1000113
Darren Tucker46bc0752004-05-02 22:11:30 +1000114 u_int num_accept_env;
115 char *accept_env[MAX_ACCEPT_ENV];
116
Damien Miller942da032000-08-18 13:59:06 +1000117 int max_startups_begin;
118 int max_startups_rate;
Damien Miller37023962000-07-11 17:31:38 +1000119 int max_startups;
Darren Tucker89413db2004-05-24 10:36:23 +1000120 int max_authtries;
Ben Lindstrom48bd7c12001-01-09 00:35:42 +0000121 char *banner; /* SSH-2 banner message */
Damien Miller3a961dc2003-06-03 10:25:48 +1000122 int use_dns;
Ben Lindstrom5744dc42001-04-13 23:28:01 +0000123 int client_alive_interval; /*
Damien Miller9f0f5c62001-12-21 14:45:46 +1100124 * poke the client this often to
125 * see if it's still there
Ben Lindstrom5744dc42001-04-13 23:28:01 +0000126 */
127 int client_alive_count_max; /*
Ben Lindstrom7bb37b22001-09-12 16:40:05 +0000128 * If the client is unresponsive
129 * for this many intervals above,
Damien Miller9f0f5c62001-12-21 14:45:46 +1100130 * disconnect the session
Ben Lindstrom5744dc42001-04-13 23:28:01 +0000131 */
Kevin Stevese468de62001-07-04 18:37:20 +0000132
133 char *authorized_keys_file; /* File containing public keys */
134 char *authorized_keys_file2;
Damien Millerd27b9472005-12-13 19:29:02 +1100135
Damien Millere2754432006-07-24 14:06:47 +1000136 char *adm_forced_command;
137
Damien Miller4e448a32003-05-14 15:11:48 +1000138 int use_pam; /* Enable auth via PAM */
Damien Millerd27b9472005-12-13 19:29:02 +1100139
140 int permit_tun;
Damien Millera765cf42006-07-24 14:08:13 +1000141
142 int num_permitted_opens;
Damien Miller95def091999-11-25 00:26:21 +1100143} ServerOptions;
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000144
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000145void initialize_server_options(ServerOptions *);
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000146void fill_default_server_options(ServerOptions *);
Darren Tucker45150472006-07-12 22:34:17 +1000147int process_server_config_line(ServerOptions *, char *, const char *, int,
148 int *, const char *, const char *, const char *);
Darren Tucker645ab752004-06-25 13:33:20 +1000149void load_server_config(const char *, Buffer *);
Darren Tucker45150472006-07-12 22:34:17 +1000150void parse_server_config(ServerOptions *, const char *, Buffer *,
151 const char *, const char *, const char *);
152void parse_server_match_config(ServerOptions *, const char *, const char *,
153 const char *);
154void copy_set_server_options(ServerOptions *, ServerOptions *);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000155
Damien Miller95def091999-11-25 00:26:21 +1100156#endif /* SERVCONF_H */