Annotation of src/usr.bin/ssh/servconf.h, Revision 1.128
1.128 ! djm 1: /* $OpenBSD: servconf.h,v 1.127 2017/10/05 15:52:03 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.24 jakob 21: #define MAX_SUBSYSTEMS 256 /* Max # subsystems. */
1.13 deraadt 22:
1.38 markus 23: /* permit_root_login */
24: #define PERMIT_NOT_SET -1
25: #define PERMIT_NO 0
26: #define PERMIT_FORCED_ONLY 1
27: #define PERMIT_NO_PASSWD 2
28: #define PERMIT_YES 3
1.99 djm 29:
30: /* use_privsep */
31: #define PRIVSEP_OFF 0
32: #define PRIVSEP_ON 1
1.103 djm 33: #define PRIVSEP_NOSANDBOX 2
1.38 markus 34:
1.106 djm 35: /* AllowTCPForwarding */
36: #define FORWARD_DENY 0
37: #define FORWARD_REMOTE (1)
38: #define FORWARD_LOCAL (1<<1)
39: #define FORWARD_ALLOW (FORWARD_REMOTE|FORWARD_LOCAL)
40:
1.125 djm 41: /* PermitOpen */
42: #define PERMITOPEN_ANY 0
43: #define PERMITOPEN_NONE -2
44:
1.69 dtucker 45: #define DEFAULT_AUTH_FAIL_MAX 6 /* Default for MaxAuthTries */
1.84 djm 46: #define DEFAULT_SESSIONS_MAX 10 /* Default for MaxSessions */
1.82 djm 47:
48: /* Magic name for internal sftp-server */
49: #define INTERNAL_SFTP_NAME "internal-sftp"
1.38 markus 50:
1.125 djm 51: struct ssh;
52: struct fwd_perm_list;
53:
1.128 ! djm 54: /*
! 55: * Used to store addresses from ListenAddr directives. These may be
! 56: * incomplete, as they may specify addresses that need to be merged
! 57: * with any ports requested by ListenPort.
! 58: */
! 59: struct queued_listenaddr {
! 60: char *addr;
! 61: int port; /* <=0 if unspecified */
! 62: char *rdomain;
! 63: };
! 64:
! 65: /* Resolved listen addresses, grouped by optional routing domain */
! 66: struct listenaddr {
! 67: char *rdomain;
! 68: struct addrinfo *addrs;
! 69: };
! 70:
1.13 deraadt 71: typedef struct {
1.87 djm 72: u_int num_ports;
73: u_int ports_from_cmdline;
74: int ports[MAX_PORTS]; /* Port number to listen on. */
1.128 ! djm 75: struct queued_listenaddr *queued_listen_addrs;
1.117 dtucker 76: u_int num_queued_listens;
1.128 ! djm 77: struct listenaddr *listen_addrs;
! 78: u_int num_listen_addrs;
1.127 djm 79: int address_family; /* Address family used by the server. */
80:
81: char **host_key_files; /* Files containing host keys. */
82: u_int num_host_key_files; /* Number of files for host keys. */
83: char **host_cert_files; /* Files containing host certs. */
84: u_int num_host_cert_files; /* Number of files for host certs. */
85:
86: char *host_key_agent; /* ssh-agent socket for host keys. */
87: char *pid_file; /* Where to put our pid */
1.13 deraadt 88: int login_grace_time; /* Disconnect if no auth in this time
89: * (sec). */
1.38 markus 90: int permit_root_login; /* PERMIT_*, see above */
1.13 deraadt 91: int ignore_rhosts; /* Ignore .rhosts and .shosts. */
92: int ignore_user_known_hosts; /* Ignore ~/.ssh/known_hosts
93: * for RhostsRsaAuth */
94: int print_motd; /* If true, print /etc/motd. */
1.39 stevesk 95: int print_lastlog; /* If true, print lastlog */
1.13 deraadt 96: int x11_forwarding; /* If true, permit inet (spoofing) X11 fwd. */
97: int x11_display_offset; /* What DISPLAY number to start
98: * searching at */
1.52 stevesk 99: int x11_use_localhost; /* If true, use localhost for fake X11 server. */
1.23 markus 100: char *xauth_location; /* Location of xauth program */
1.110 djm 101: int permit_tty; /* If false, deny pty allocation */
1.113 djm 102: int permit_user_rc; /* If false, deny ~/.ssh/rc execution */
1.13 deraadt 103: int strict_modes; /* If true, require string home dir modes. */
1.66 markus 104: int tcp_keep_alive; /* If true, set SO_KEEPALIVE. */
1.95 djm 105: int ip_qos_interactive; /* IP ToS/DSCP/class for interactive */
106: int ip_qos_bulk; /* IP ToS/DSCP/class for bulk traffic */
1.37 markus 107: char *ciphers; /* Supported SSH2 ciphers. */
108: char *macs; /* Supported SSH2 macs. */
1.94 djm 109: char *kex_algorithms; /* SSH2 kex methods in order of preference. */
1.114 millert 110: struct ForwardOptions fwd_opts; /* forwarding options */
1.13 deraadt 111: SyslogFacility log_facility; /* Facility for system logging. */
112: LogLevel log_level; /* Level for system logging. */
1.40 markus 113: int hostbased_authentication; /* If true, permit ssh2 hostbased auth */
114: int hostbased_uses_name_from_packet_only; /* experimental */
1.116 djm 115: char *hostbased_key_types; /* Key types allowed for hostbased */
1.120 markus 116: char *hostkeyalgorithms; /* SSH2 server key types */
1.31 markus 117: int pubkey_authentication; /* If true, permit ssh2 pubkey authentication. */
1.116 djm 118: char *pubkey_key_types; /* Key types allowed for public key */
1.13 deraadt 119: int kerberos_authentication; /* If true, permit Kerberos
120: * authentication. */
121: int kerberos_or_local_passwd; /* If true, permit kerberos
122: * and any other password
123: * authentication mechanism,
124: * such as SecurID or
125: * /etc/passwd */
126: int kerberos_ticket_cleanup; /* If true, destroy ticket
127: * file on logout. */
1.67 jakob 128: int kerberos_get_afs_token; /* If true, try to get AFS token if
129: * authenticated with Kerberos. */
1.64 markus 130: int gss_authentication; /* If true, permit GSSAPI authentication */
131: int gss_cleanup_creds; /* If true, destroy cred cache on logout */
1.119 djm 132: int gss_strict_acceptor; /* If true, restrict the GSSAPI acceptor name */
1.13 deraadt 133: int password_authentication; /* If true, permit password
134: * authentication. */
1.29 markus 135: int kbd_interactive_authentication; /* If true, permit */
1.42 markus 136: int challenge_response_authentication;
1.13 deraadt 137: int permit_empty_passwd; /* If false, do not permit empty
138: * passwords. */
1.59 markus 139: int permit_user_env; /* If true, read ~/.ssh/environment */
1.58 markus 140: int compression; /* If true, compression is allowed */
1.106 djm 141: int allow_tcp_forwarding; /* One of FORWARD_* */
1.114 millert 142: int allow_streamlocal_forwarding; /* One of FORWARD_* */
1.83 pyr 143: int allow_agent_forwarding;
1.123 djm 144: int disable_forwarding;
1.32 markus 145: u_int num_allow_users;
1.127 djm 146: char **allow_users;
1.32 markus 147: u_int num_deny_users;
1.127 djm 148: char **deny_users;
1.32 markus 149: u_int num_allow_groups;
1.127 djm 150: char **allow_groups;
1.32 markus 151: u_int num_deny_groups;
1.127 djm 152: char **deny_groups;
1.24 jakob 153:
1.32 markus 154: u_int num_subsystems;
1.24 jakob 155: char *subsystem_name[MAX_SUBSYSTEMS];
156: char *subsystem_command[MAX_SUBSYSTEMS];
1.74 djm 157: char *subsystem_args[MAX_SUBSYSTEMS];
1.68 djm 158:
159: u_int num_accept_env;
1.127 djm 160: char **accept_env;
1.26 markus 161:
1.27 markus 162: int max_startups_begin;
163: int max_startups_rate;
1.26 markus 164: int max_startups;
1.69 dtucker 165: int max_authtries;
1.84 djm 166: int max_sessions;
1.33 markus 167: char *banner; /* SSH-2 banner message */
1.61 markus 168: int use_dns;
1.41 beck 169: int client_alive_interval; /*
1.51 deraadt 170: * poke the client this often to
171: * see if it's still there
1.41 beck 172: */
173: int client_alive_count_max; /*
1.49 stevesk 174: * If the client is unresponsive
175: * for this many intervals above,
1.51 deraadt 176: * disconnect the session
1.41 beck 177: */
1.43 markus 178:
1.127 djm 179: u_int num_authkeys_files; /* Files containing public keys */
180: char **authorized_keys_files;
1.76 dtucker 181:
182: char *adm_forced_command;
1.72 reyk 183:
184: int permit_tun;
1.77 dtucker 185:
1.125 djm 186: char **permitted_opens;
187: u_int num_permitted_opens; /* May also be one of PERMITOPEN_* */
1.88 reyk 188:
1.81 djm 189: char *chroot_directory;
1.92 djm 190: char *revoked_keys_file;
191: char *trusted_user_ca_keys;
1.104 djm 192: char *authorized_keys_command;
193: char *authorized_keys_command_user;
1.118 djm 194: char *authorized_principals_file;
195: char *authorized_principals_command;
196: char *authorized_principals_command_user;
1.108 dtucker 197:
198: int64_t rekey_limit;
199: int rekey_interval;
1.100 djm 200:
201: char *version_addendum; /* Appended to SSH banner */
1.105 djm 202:
203: u_int num_auth_methods;
1.127 djm 204: char **auth_methods;
1.115 djm 205:
206: int fingerprint_hash;
1.124 djm 207: int expose_userauth_info;
1.13 deraadt 208: } ServerOptions;
1.97 djm 209:
1.101 dtucker 210: /* Information about the incoming connection as used by Match */
211: struct connection_info {
212: const char *user;
213: const char *host; /* possibly resolved hostname */
214: const char *address; /* remote address */
215: const char *laddress; /* local address */
216: int lport; /* local port */
217: };
218:
219:
1.97 djm 220: /*
221: * These are string config options that must be copied between the
222: * Match sub-config and the main config, and must be sent from the
223: * privsep slave to the privsep master. We use a macro to ensure all
224: * the options are copied and the copies are done in the correct order.
1.111 djm 225: *
226: * NB. an option must appear in servconf.c:copy_set_server_options() or
227: * COPY_MATCH_STRING_OPTS here but never both.
1.97 djm 228: */
229: #define COPY_MATCH_STRING_OPTS() do { \
230: M_CP_STROPT(banner); \
231: M_CP_STROPT(trusted_user_ca_keys); \
232: M_CP_STROPT(revoked_keys_file); \
1.107 djm 233: M_CP_STROPT(authorized_keys_command); \
234: M_CP_STROPT(authorized_keys_command_user); \
1.118 djm 235: M_CP_STROPT(authorized_principals_file); \
236: M_CP_STROPT(authorized_principals_command); \
237: M_CP_STROPT(authorized_principals_command_user); \
1.116 djm 238: M_CP_STROPT(hostbased_key_types); \
239: M_CP_STROPT(pubkey_key_types); \
1.98 djm 240: M_CP_STRARRAYOPT(authorized_keys_files, num_authkeys_files); \
1.102 markus 241: M_CP_STRARRAYOPT(allow_users, num_allow_users); \
242: M_CP_STRARRAYOPT(deny_users, num_deny_users); \
243: M_CP_STRARRAYOPT(allow_groups, num_allow_groups); \
244: M_CP_STRARRAYOPT(deny_groups, num_deny_groups); \
245: M_CP_STRARRAYOPT(accept_env, num_accept_env); \
1.105 djm 246: M_CP_STRARRAYOPT(auth_methods, num_auth_methods); \
1.127 djm 247: M_CP_STRARRAYOPT(permitted_opens, num_permitted_opens); \
1.97 djm 248: } while (0)
1.1 deraadt 249:
1.101 dtucker 250: struct connection_info *get_connection_info(int, int);
1.47 markus 251: void initialize_server_options(ServerOptions *);
252: void fill_default_server_options(ServerOptions *);
1.75 dtucker 253: int process_server_config_line(ServerOptions *, char *, const char *, int,
1.101 dtucker 254: int *, struct connection_info *);
1.125 djm 255: void process_permitopen(struct ssh *ssh, ServerOptions *options);
1.70 djm 256: void load_server_config(const char *, Buffer *);
1.75 dtucker 257: void parse_server_config(ServerOptions *, const char *, Buffer *,
1.101 dtucker 258: struct connection_info *);
259: void parse_server_match_config(ServerOptions *, struct connection_info *);
260: int parse_server_match_testspec(struct connection_info *, char *);
261: int server_match_spec_complete(struct connection_info *);
1.80 dtucker 262: void copy_set_server_options(ServerOptions *, ServerOptions *, int);
1.85 dtucker 263: void dump_config(ServerOptions *);
1.90 djm 264: char *derelativise_path(const char *);
1.127 djm 265: void servconf_add_hostkey(const char *, const int,
266: ServerOptions *, const char *path);
267: void servconf_add_hostcert(const char *, const int,
268: ServerOptions *, const char *path);
1.1 deraadt 269:
1.13 deraadt 270: #endif /* SERVCONF_H */