blob: 81a68be89ac0b274c69243077352df056cc3439c [file] [log] [blame]
Damien Millerd8cb1f12008-02-10 22:40:12 +11001/* $OpenBSD: servconf.h,v 1.81 2008/02/08 23:24:08 djm 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 Miller565ca3f2006-08-19 00:23:15 +100028#define MAX_MATCH_GROUPS 256 /* Max # of groups for Match. */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100029
Ben Lindstromd8a90212001-02-15 03:08:27 +000030/* 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 Tucker89413db2004-05-24 10:36:23 +100037#define DEFAULT_AUTH_FAIL_MAX 6 /* Default for MaxAuthTries */
Ben Lindstromd8a90212001-02-15 03:08:27 +000038
Damien Miller95def091999-11-25 00:26:21 +110039typedef struct {
Ben Lindstrom46c16222000-12-22 01:43:59 +000040 u_int num_ports;
41 u_int ports_from_cmdline;
Damien Miller34132e52000-01-14 15:45:46 +110042 u_short ports[MAX_PORTS]; /* Port number to listen on. */
43 char *listen_addr; /* Address on which the server listens. */
44 struct addrinfo *listen_addrs; /* Addresses on which the server listens. */
Darren Tucker0f383232005-01-20 10:57:56 +110045 int address_family; /* Address family used by the server. */
Damien Miller0bc1bd82000-11-13 22:57:25 +110046 char *host_key_files[MAX_HOSTKEYS]; /* Files containing host keys. */
47 int num_host_key_files; /* Number of files for host keys. */
Damien Miller6f83b8e2000-05-02 09:23:45 +100048 char *pid_file; /* Where to put our pid */
Damien Miller95def091999-11-25 00:26:21 +110049 int server_key_bits;/* Size of the server key. */
50 int login_grace_time; /* Disconnect if no auth in this time
51 * (sec). */
52 int key_regeneration_time; /* Server key lifetime (seconds). */
Ben Lindstromd8a90212001-02-15 03:08:27 +000053 int permit_root_login; /* PERMIT_*, see above */
Damien Miller95def091999-11-25 00:26:21 +110054 int ignore_rhosts; /* Ignore .rhosts and .shosts. */
55 int ignore_user_known_hosts; /* Ignore ~/.ssh/known_hosts
56 * for RhostsRsaAuth */
57 int print_motd; /* If true, print /etc/motd. */
Ben Lindstrom7bfff362001-03-26 05:45:53 +000058 int print_lastlog; /* If true, print lastlog */
Damien Miller95def091999-11-25 00:26:21 +110059 int x11_forwarding; /* If true, permit inet (spoofing) X11 fwd. */
60 int x11_display_offset; /* What DISPLAY number to start
61 * searching at */
Damien Miller95c249f2002-02-05 12:11:34 +110062 int x11_use_localhost; /* If true, use localhost for fake X11 server. */
Damien Millerd3a18572000-06-07 19:55:44 +100063 char *xauth_location; /* Location of xauth program */
Damien Miller95def091999-11-25 00:26:21 +110064 int strict_modes; /* If true, require string home dir modes. */
Damien Miller12c150e2003-12-17 16:31:10 +110065 int tcp_keep_alive; /* If true, set SO_KEEPALIVE. */
Ben Lindstrom06b33aa2001-02-15 03:01:59 +000066 char *ciphers; /* Supported SSH2 ciphers. */
67 char *macs; /* Supported SSH2 macs. */
68 int protocol; /* Supported protocol versions. */
Damien Millere247cc42000-05-07 12:03:14 +100069 int gateway_ports; /* If true, allow remote connects to forwarded ports. */
Damien Miller95def091999-11-25 00:26:21 +110070 SyslogFacility log_facility; /* Facility for system logging. */
71 LogLevel log_level; /* Level for system logging. */
Damien Miller95def091999-11-25 00:26:21 +110072 int rhosts_rsa_authentication; /* If true, permit rhosts RSA
73 * authentication. */
Ben Lindstrom5eabda32001-04-12 23:34:34 +000074 int hostbased_authentication; /* If true, permit ssh2 hostbased auth */
75 int hostbased_uses_name_from_packet_only; /* experimental */
Damien Miller95def091999-11-25 00:26:21 +110076 int rsa_authentication; /* If true, permit RSA authentication. */
Damien Miller0bc1bd82000-11-13 22:57:25 +110077 int pubkey_authentication; /* If true, permit ssh2 pubkey authentication. */
Damien Miller95def091999-11-25 00:26:21 +110078 int kerberos_authentication; /* If true, permit Kerberos
79 * authentication. */
80 int kerberos_or_local_passwd; /* If true, permit kerberos
81 * and any other password
82 * authentication mechanism,
83 * such as SecurID or
84 * /etc/passwd */
85 int kerberos_ticket_cleanup; /* If true, destroy ticket
86 * file on logout. */
Darren Tucker22ef5082003-12-31 11:37:34 +110087 int kerberos_get_afs_token; /* If true, try to get AFS token if
88 * authenticated with Kerberos. */
Darren Tucker0efd1552003-08-26 11:49:55 +100089 int gss_authentication; /* If true, permit GSSAPI authentication */
90 int gss_cleanup_creds; /* If true, destroy cred cache on logout */
Damien Miller95def091999-11-25 00:26:21 +110091 int password_authentication; /* If true, permit password
92 * authentication. */
Damien Miller874d77b2000-10-14 16:23:11 +110093 int kbd_interactive_authentication; /* If true, permit */
Ben Lindstrom551ea372001-06-05 18:56:16 +000094 int challenge_response_authentication;
Damien Miller95def091999-11-25 00:26:21 +110095 int permit_empty_passwd; /* If false, do not permit empty
96 * passwords. */
Ben Lindstrom5d860f02002-08-01 01:28:38 +000097 int permit_user_env; /* If true, read ~/.ssh/environment */
Damien Miller95def091999-11-25 00:26:21 +110098 int use_login; /* If true, login(1) is used */
Ben Lindstrom23e0f662002-06-21 01:09:47 +000099 int compression; /* If true, compression is allowed */
Damien Miller50a41ed2000-10-16 12:14:42 +1100100 int allow_tcp_forwarding;
Ben Lindstrom46c16222000-12-22 01:43:59 +0000101 u_int num_allow_users;
Damien Miller95def091999-11-25 00:26:21 +1100102 char *allow_users[MAX_ALLOW_USERS];
Ben Lindstrom46c16222000-12-22 01:43:59 +0000103 u_int num_deny_users;
Damien Miller95def091999-11-25 00:26:21 +1100104 char *deny_users[MAX_DENY_USERS];
Ben Lindstrom46c16222000-12-22 01:43:59 +0000105 u_int num_allow_groups;
Damien Miller95def091999-11-25 00:26:21 +1100106 char *allow_groups[MAX_ALLOW_GROUPS];
Ben Lindstrom46c16222000-12-22 01:43:59 +0000107 u_int num_deny_groups;
Damien Miller95def091999-11-25 00:26:21 +1100108 char *deny_groups[MAX_DENY_GROUPS];
Damien Millerf6d9e222000-06-18 14:50:44 +1000109
Ben Lindstrom46c16222000-12-22 01:43:59 +0000110 u_int num_subsystems;
Damien Millerf6d9e222000-06-18 14:50:44 +1000111 char *subsystem_name[MAX_SUBSYSTEMS];
112 char *subsystem_command[MAX_SUBSYSTEMS];
Damien Miller917f9b62006-07-10 20:36:47 +1000113 char *subsystem_args[MAX_SUBSYSTEMS];
Damien Miller37023962000-07-11 17:31:38 +1000114
Darren Tucker46bc0752004-05-02 22:11:30 +1000115 u_int num_accept_env;
116 char *accept_env[MAX_ACCEPT_ENV];
117
Damien Miller942da032000-08-18 13:59:06 +1000118 int max_startups_begin;
119 int max_startups_rate;
Damien Miller37023962000-07-11 17:31:38 +1000120 int max_startups;
Darren Tucker89413db2004-05-24 10:36:23 +1000121 int max_authtries;
Ben Lindstrom48bd7c12001-01-09 00:35:42 +0000122 char *banner; /* SSH-2 banner message */
Damien Miller3a961dc2003-06-03 10:25:48 +1000123 int use_dns;
Ben Lindstrom5744dc42001-04-13 23:28:01 +0000124 int client_alive_interval; /*
Damien Miller9f0f5c62001-12-21 14:45:46 +1100125 * poke the client this often to
126 * see if it's still there
Ben Lindstrom5744dc42001-04-13 23:28:01 +0000127 */
128 int client_alive_count_max; /*
Ben Lindstrom7bb37b22001-09-12 16:40:05 +0000129 * If the client is unresponsive
130 * for this many intervals above,
Damien Miller9f0f5c62001-12-21 14:45:46 +1100131 * disconnect the session
Ben Lindstrom5744dc42001-04-13 23:28:01 +0000132 */
Kevin Stevese468de62001-07-04 18:37:20 +0000133
134 char *authorized_keys_file; /* File containing public keys */
135 char *authorized_keys_file2;
Damien Millerd27b9472005-12-13 19:29:02 +1100136
Damien Millere2754432006-07-24 14:06:47 +1000137 char *adm_forced_command;
138
Damien Miller4e448a32003-05-14 15:11:48 +1000139 int use_pam; /* Enable auth via PAM */
Damien Millerd27b9472005-12-13 19:29:02 +1100140
141 int permit_tun;
Damien Millera765cf42006-07-24 14:08:13 +1000142
143 int num_permitted_opens;
Damien Millerd8cb1f12008-02-10 22:40:12 +1100144
145 char *chroot_directory;
Damien Miller95def091999-11-25 00:26:21 +1100146} ServerOptions;
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000147
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000148void initialize_server_options(ServerOptions *);
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000149void fill_default_server_options(ServerOptions *);
Darren Tucker45150472006-07-12 22:34:17 +1000150int process_server_config_line(ServerOptions *, char *, const char *, int,
151 int *, const char *, const char *, const char *);
Darren Tucker645ab752004-06-25 13:33:20 +1000152void load_server_config(const char *, Buffer *);
Darren Tucker45150472006-07-12 22:34:17 +1000153void parse_server_config(ServerOptions *, const char *, Buffer *,
154 const char *, const char *, const char *);
155void parse_server_match_config(ServerOptions *, const char *, const char *,
156 const char *);
Darren Tucker1629c072007-02-19 22:25:37 +1100157void copy_set_server_options(ServerOptions *, ServerOptions *, int);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000158
Damien Miller95def091999-11-25 00:26:21 +1100159#endif /* SERVCONF_H */