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