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