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