Annotation of src/usr.bin/ssh/servconf.h, Revision 1.107
1.107 ! djm 1: /* $OpenBSD: servconf.h,v 1.106 2012/12/02 20:46:11 djm Exp $ */
1.54 stevesk 2:
1.1 deraadt 3: /*
1.13 deraadt 4: * Author: Tatu Ylonen <ylo@cs.hut.fi>
5: * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
6: * All rights reserved
7: * Definitions for server configuration data and for the functions reading it.
1.18 markus 8: *
1.28 deraadt 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".
1.13 deraadt 14: */
1.1 deraadt 15:
16: #ifndef SERVCONF_H
17: #define SERVCONF_H
1.70 djm 18:
1.15 markus 19: #define MAX_PORTS 256 /* Max # ports. */
20:
1.13 deraadt 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. */
1.24 jakob 25: #define MAX_SUBSYSTEMS 256 /* Max # subsystems. */
1.31 markus 26: #define MAX_HOSTKEYS 256 /* Max # hostkeys. */
1.91 djm 27: #define MAX_HOSTCERTS 256 /* Max # host certificates. */
1.68 djm 28: #define MAX_ACCEPT_ENV 256 /* Max # of env vars. */
1.79 dtucker 29: #define MAX_MATCH_GROUPS 256 /* Max # of groups for Match. */
1.98 djm 30: #define MAX_AUTHKEYS_FILES 256 /* Max # of authorized_keys files. */
1.105 djm 31: #define MAX_AUTH_METHODS 256 /* Max # of AuthenticationMethods. */
1.13 deraadt 32:
1.38 markus 33: /* permit_root_login */
34: #define PERMIT_NOT_SET -1
35: #define PERMIT_NO 0
36: #define PERMIT_FORCED_ONLY 1
37: #define PERMIT_NO_PASSWD 2
38: #define PERMIT_YES 3
1.99 djm 39:
40: /* use_privsep */
41: #define PRIVSEP_OFF 0
42: #define PRIVSEP_ON 1
1.103 djm 43: #define PRIVSEP_NOSANDBOX 2
1.38 markus 44:
1.106 djm 45: /* AllowTCPForwarding */
46: #define FORWARD_DENY 0
47: #define FORWARD_REMOTE (1)
48: #define FORWARD_LOCAL (1<<1)
49: #define FORWARD_ALLOW (FORWARD_REMOTE|FORWARD_LOCAL)
50:
1.69 dtucker 51: #define DEFAULT_AUTH_FAIL_MAX 6 /* Default for MaxAuthTries */
1.84 djm 52: #define DEFAULT_SESSIONS_MAX 10 /* Default for MaxSessions */
1.82 djm 53:
54: /* Magic name for internal sftp-server */
55: #define INTERNAL_SFTP_NAME "internal-sftp"
1.38 markus 56:
1.13 deraadt 57: typedef struct {
1.87 djm 58: u_int num_ports;
59: u_int ports_from_cmdline;
60: int ports[MAX_PORTS]; /* Port number to listen on. */
1.15 markus 61: char *listen_addr; /* Address on which the server listens. */
62: struct addrinfo *listen_addrs; /* Addresses on which the server listens. */
1.71 djm 63: int address_family; /* Address family used by the server. */
1.31 markus 64: char *host_key_files[MAX_HOSTKEYS]; /* Files containing host keys. */
65: int num_host_key_files; /* Number of files for host keys. */
1.91 djm 66: char *host_cert_files[MAX_HOSTCERTS]; /* Files containing host certs. */
67: int num_host_cert_files; /* Number of files for host certs. */
1.19 markus 68: char *pid_file; /* Where to put our pid */
1.13 deraadt 69: int server_key_bits;/* Size of the server key. */
70: int login_grace_time; /* Disconnect if no auth in this time
71: * (sec). */
72: int key_regeneration_time; /* Server key lifetime (seconds). */
1.38 markus 73: int permit_root_login; /* PERMIT_*, see above */
1.13 deraadt 74: int ignore_rhosts; /* Ignore .rhosts and .shosts. */
75: int ignore_user_known_hosts; /* Ignore ~/.ssh/known_hosts
76: * for RhostsRsaAuth */
77: int print_motd; /* If true, print /etc/motd. */
1.39 stevesk 78: int print_lastlog; /* If true, print lastlog */
1.13 deraadt 79: int x11_forwarding; /* If true, permit inet (spoofing) X11 fwd. */
80: int x11_display_offset; /* What DISPLAY number to start
81: * searching at */
1.52 stevesk 82: int x11_use_localhost; /* If true, use localhost for fake X11 server. */
1.23 markus 83: char *xauth_location; /* Location of xauth program */
1.13 deraadt 84: int strict_modes; /* If true, require string home dir modes. */
1.66 markus 85: int tcp_keep_alive; /* If true, set SO_KEEPALIVE. */
1.95 djm 86: int ip_qos_interactive; /* IP ToS/DSCP/class for interactive */
87: int ip_qos_bulk; /* IP ToS/DSCP/class for bulk traffic */
1.37 markus 88: char *ciphers; /* Supported SSH2 ciphers. */
89: char *macs; /* Supported SSH2 macs. */
1.94 djm 90: char *kex_algorithms; /* SSH2 kex methods in order of preference. */
1.37 markus 91: int protocol; /* Supported protocol versions. */
1.21 markus 92: int gateway_ports; /* If true, allow remote connects to forwarded ports. */
1.13 deraadt 93: SyslogFacility log_facility; /* Facility for system logging. */
94: LogLevel log_level; /* Level for system logging. */
95: int rhosts_rsa_authentication; /* If true, permit rhosts RSA
96: * authentication. */
1.40 markus 97: int hostbased_authentication; /* If true, permit ssh2 hostbased auth */
98: int hostbased_uses_name_from_packet_only; /* experimental */
1.13 deraadt 99: int rsa_authentication; /* If true, permit RSA authentication. */
1.31 markus 100: int pubkey_authentication; /* If true, permit ssh2 pubkey authentication. */
1.13 deraadt 101: int kerberos_authentication; /* If true, permit Kerberos
102: * authentication. */
103: int kerberos_or_local_passwd; /* If true, permit kerberos
104: * and any other password
105: * authentication mechanism,
106: * such as SecurID or
107: * /etc/passwd */
108: int kerberos_ticket_cleanup; /* If true, destroy ticket
109: * file on logout. */
1.67 jakob 110: int kerberos_get_afs_token; /* If true, try to get AFS token if
111: * authenticated with Kerberos. */
1.64 markus 112: int gss_authentication; /* If true, permit GSSAPI authentication */
113: int gss_cleanup_creds; /* If true, destroy cred cache on logout */
1.13 deraadt 114: int password_authentication; /* If true, permit password
115: * authentication. */
1.29 markus 116: int kbd_interactive_authentication; /* If true, permit */
1.42 markus 117: int challenge_response_authentication;
1.86 djm 118: int zero_knowledge_password_authentication;
119: /* If true, permit jpake auth */
1.13 deraadt 120: int permit_empty_passwd; /* If false, do not permit empty
121: * passwords. */
1.59 markus 122: int permit_user_env; /* If true, read ~/.ssh/environment */
1.13 deraadt 123: int use_login; /* If true, login(1) is used */
1.58 markus 124: int compression; /* If true, compression is allowed */
1.106 djm 125: int allow_tcp_forwarding; /* One of FORWARD_* */
1.83 pyr 126: int allow_agent_forwarding;
1.32 markus 127: u_int num_allow_users;
1.13 deraadt 128: char *allow_users[MAX_ALLOW_USERS];
1.32 markus 129: u_int num_deny_users;
1.13 deraadt 130: char *deny_users[MAX_DENY_USERS];
1.32 markus 131: u_int num_allow_groups;
1.13 deraadt 132: char *allow_groups[MAX_ALLOW_GROUPS];
1.32 markus 133: u_int num_deny_groups;
1.13 deraadt 134: char *deny_groups[MAX_DENY_GROUPS];
1.24 jakob 135:
1.32 markus 136: u_int num_subsystems;
1.24 jakob 137: char *subsystem_name[MAX_SUBSYSTEMS];
138: char *subsystem_command[MAX_SUBSYSTEMS];
1.74 djm 139: char *subsystem_args[MAX_SUBSYSTEMS];
1.68 djm 140:
141: u_int num_accept_env;
142: char *accept_env[MAX_ACCEPT_ENV];
1.26 markus 143:
1.27 markus 144: int max_startups_begin;
145: int max_startups_rate;
1.26 markus 146: int max_startups;
1.69 dtucker 147: int max_authtries;
1.84 djm 148: int max_sessions;
1.33 markus 149: char *banner; /* SSH-2 banner message */
1.61 markus 150: int use_dns;
1.41 beck 151: int client_alive_interval; /*
1.51 deraadt 152: * poke the client this often to
153: * see if it's still there
1.41 beck 154: */
155: int client_alive_count_max; /*
1.49 stevesk 156: * If the client is unresponsive
157: * for this many intervals above,
1.51 deraadt 158: * disconnect the session
1.41 beck 159: */
1.43 markus 160:
1.98 djm 161: u_int num_authkeys_files; /* Files containing public keys */
162: char *authorized_keys_files[MAX_AUTHKEYS_FILES];
1.76 dtucker 163:
164: char *adm_forced_command;
1.72 reyk 165:
166: int permit_tun;
1.77 dtucker 167:
168: int num_permitted_opens;
1.88 reyk 169:
1.81 djm 170: char *chroot_directory;
1.92 djm 171: char *revoked_keys_file;
172: char *trusted_user_ca_keys;
1.93 djm 173: char *authorized_principals_file;
1.104 djm 174: char *authorized_keys_command;
175: char *authorized_keys_command_user;
1.100 djm 176:
177: char *version_addendum; /* Appended to SSH banner */
1.105 djm 178:
179: u_int num_auth_methods;
180: char *auth_methods[MAX_AUTH_METHODS];
1.13 deraadt 181: } ServerOptions;
1.97 djm 182:
1.101 dtucker 183: /* Information about the incoming connection as used by Match */
184: struct connection_info {
185: const char *user;
186: const char *host; /* possibly resolved hostname */
187: const char *address; /* remote address */
188: const char *laddress; /* local address */
189: int lport; /* local port */
190: };
191:
192:
1.97 djm 193: /*
194: * These are string config options that must be copied between the
195: * Match sub-config and the main config, and must be sent from the
196: * privsep slave to the privsep master. We use a macro to ensure all
197: * the options are copied and the copies are done in the correct order.
198: */
199: #define COPY_MATCH_STRING_OPTS() do { \
200: M_CP_STROPT(banner); \
201: M_CP_STROPT(trusted_user_ca_keys); \
202: M_CP_STROPT(revoked_keys_file); \
203: M_CP_STROPT(authorized_principals_file); \
1.107 ! djm 204: M_CP_STROPT(authorized_keys_command); \
! 205: M_CP_STROPT(authorized_keys_command_user); \
1.98 djm 206: M_CP_STRARRAYOPT(authorized_keys_files, num_authkeys_files); \
1.102 markus 207: M_CP_STRARRAYOPT(allow_users, num_allow_users); \
208: M_CP_STRARRAYOPT(deny_users, num_deny_users); \
209: M_CP_STRARRAYOPT(allow_groups, num_allow_groups); \
210: M_CP_STRARRAYOPT(deny_groups, num_deny_groups); \
211: M_CP_STRARRAYOPT(accept_env, num_accept_env); \
1.105 djm 212: M_CP_STRARRAYOPT(auth_methods, num_auth_methods); \
1.97 djm 213: } while (0)
1.1 deraadt 214:
1.101 dtucker 215: struct connection_info *get_connection_info(int, int);
1.47 markus 216: void initialize_server_options(ServerOptions *);
217: void fill_default_server_options(ServerOptions *);
1.75 dtucker 218: int process_server_config_line(ServerOptions *, char *, const char *, int,
1.101 dtucker 219: int *, struct connection_info *);
1.70 djm 220: void load_server_config(const char *, Buffer *);
1.75 dtucker 221: void parse_server_config(ServerOptions *, const char *, Buffer *,
1.101 dtucker 222: struct connection_info *);
223: void parse_server_match_config(ServerOptions *, struct connection_info *);
224: int parse_server_match_testspec(struct connection_info *, char *);
225: int server_match_spec_complete(struct connection_info *);
1.80 dtucker 226: void copy_set_server_options(ServerOptions *, ServerOptions *, int);
1.85 dtucker 227: void dump_config(ServerOptions *);
1.90 djm 228: char *derelativise_path(const char *);
1.1 deraadt 229:
1.13 deraadt 230: #endif /* SERVCONF_H */