Annotation of src/usr.bin/ssh/servconf.h, Revision 1.161
1.161 ! djm 1: /* $OpenBSD: servconf.h,v 1.160 2023/09/06 23:35:35 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.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:
1.125 djm 30: /* PermitOpen */
31: #define PERMITOPEN_ANY 0
32: #define PERMITOPEN_NONE -2
1.144 djm 33:
34: /* IgnoreRhosts */
35: #define IGNORE_RHOSTS_NO 0
36: #define IGNORE_RHOSTS_YES 1
37: #define IGNORE_RHOSTS_SHOSTS 2
1.125 djm 38:
1.69 dtucker 39: #define DEFAULT_AUTH_FAIL_MAX 6 /* Default for MaxAuthTries */
1.84 djm 40: #define DEFAULT_SESSIONS_MAX 10 /* Default for MaxSessions */
1.82 djm 41:
42: /* Magic name for internal sftp-server */
43: #define INTERNAL_SFTP_NAME "internal-sftp"
1.38 markus 44:
1.141 djm 45: /* PubkeyAuthOptions flags */
1.146 djm 46: #define PUBKEYAUTH_TOUCH_REQUIRED (1)
47: #define PUBKEYAUTH_VERIFY_REQUIRED (1<<1)
1.141 djm 48:
1.125 djm 49: struct ssh;
50: struct fwd_perm_list;
51:
1.128 djm 52: /*
53: * Used to store addresses from ListenAddr directives. These may be
54: * incomplete, as they may specify addresses that need to be merged
55: * with any ports requested by ListenPort.
56: */
57: struct queued_listenaddr {
58: char *addr;
59: int port; /* <=0 if unspecified */
60: char *rdomain;
61: };
62:
63: /* Resolved listen addresses, grouped by optional routing domain */
64: struct listenaddr {
65: char *rdomain;
66: struct addrinfo *addrs;
67: };
68:
1.13 deraadt 69: typedef struct {
1.87 djm 70: u_int num_ports;
71: u_int ports_from_cmdline;
72: int ports[MAX_PORTS]; /* Port number to listen on. */
1.128 djm 73: struct queued_listenaddr *queued_listen_addrs;
1.117 dtucker 74: u_int num_queued_listens;
1.128 djm 75: struct listenaddr *listen_addrs;
76: u_int num_listen_addrs;
1.127 djm 77: int address_family; /* Address family used by the server. */
78:
1.129 djm 79: char *routing_domain; /* Bind session to routing domain */
80:
1.127 djm 81: char **host_key_files; /* Files containing host keys. */
1.138 djm 82: int *host_key_file_userprovided; /* Key was specified by user. */
1.127 djm 83: u_int num_host_key_files; /* Number of files for host keys. */
84: char **host_cert_files; /* Files containing host certs. */
85: u_int num_host_cert_files; /* Number of files for host certs. */
86:
87: char *host_key_agent; /* ssh-agent socket for host keys. */
88: char *pid_file; /* Where to put our pid */
1.152 dtucker 89: char *moduli_file; /* moduli file for DH-GEX */
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.147 djm 115: u_int num_log_verbose; /* Verbose log overrides */
116: char **log_verbose;
1.40 markus 117: int hostbased_authentication; /* If true, permit ssh2 hostbased auth */
118: int hostbased_uses_name_from_packet_only; /* experimental */
1.151 dtucker 119: char *hostbased_accepted_algos; /* Algos allowed for hostbased */
1.120 markus 120: char *hostkeyalgorithms; /* SSH2 server key types */
1.137 djm 121: char *ca_sign_algorithms; /* Allowed CA signature algorithms */
1.31 markus 122: int pubkey_authentication; /* If true, permit ssh2 pubkey authentication. */
1.150 dtucker 123: char *pubkey_accepted_algos; /* Signature algos allowed for pubkey */
1.141 djm 124: int pubkey_auth_options; /* -1 or mask of PUBKEYAUTH_* flags */
1.13 deraadt 125: int kerberos_authentication; /* If true, permit Kerberos
126: * authentication. */
127: int kerberos_or_local_passwd; /* If true, permit kerberos
128: * and any other password
129: * authentication mechanism,
130: * such as SecurID or
131: * /etc/passwd */
132: int kerberos_ticket_cleanup; /* If true, destroy ticket
133: * file on logout. */
1.67 jakob 134: int kerberos_get_afs_token; /* If true, try to get AFS token if
135: * authenticated with Kerberos. */
1.64 markus 136: int gss_authentication; /* If true, permit GSSAPI authentication */
137: int gss_cleanup_creds; /* If true, destroy cred cache on logout */
1.119 djm 138: int gss_strict_acceptor; /* If true, restrict the GSSAPI acceptor name */
1.13 deraadt 139: int password_authentication; /* If true, permit password
140: * authentication. */
1.29 markus 141: int kbd_interactive_authentication; /* If true, permit */
1.13 deraadt 142: int permit_empty_passwd; /* If false, do not permit empty
143: * passwords. */
1.59 markus 144: int permit_user_env; /* If true, read ~/.ssh/environment */
1.145 djm 145: char *permit_user_env_allowlist; /* pattern-list of allowed env names */
1.58 markus 146: int compression; /* If true, compression is allowed */
1.106 djm 147: int allow_tcp_forwarding; /* One of FORWARD_* */
1.114 millert 148: int allow_streamlocal_forwarding; /* One of FORWARD_* */
1.83 pyr 149: int allow_agent_forwarding;
1.123 djm 150: int disable_forwarding;
1.32 markus 151: u_int num_allow_users;
1.127 djm 152: char **allow_users;
1.32 markus 153: u_int num_deny_users;
1.127 djm 154: char **deny_users;
1.32 markus 155: u_int num_allow_groups;
1.127 djm 156: char **allow_groups;
1.32 markus 157: u_int num_deny_groups;
1.127 djm 158: char **deny_groups;
1.24 jakob 159:
1.32 markus 160: u_int num_subsystems;
1.160 djm 161: char **subsystem_name;
162: char **subsystem_command;
163: char **subsystem_args;
1.68 djm 164:
165: u_int num_accept_env;
1.127 djm 166: char **accept_env;
1.134 djm 167: u_int num_setenv;
168: char **setenv;
1.26 markus 169:
1.27 markus 170: int max_startups_begin;
171: int max_startups_rate;
1.26 markus 172: int max_startups;
1.149 dtucker 173: int per_source_max_startups;
174: int per_source_masklen_ipv4;
175: int per_source_masklen_ipv6;
1.69 dtucker 176: int max_authtries;
1.84 djm 177: int max_sessions;
1.33 markus 178: char *banner; /* SSH-2 banner message */
1.61 markus 179: int use_dns;
1.41 beck 180: int client_alive_interval; /*
1.51 deraadt 181: * poke the client this often to
182: * see if it's still there
1.41 beck 183: */
184: int client_alive_count_max; /*
1.49 stevesk 185: * If the client is unresponsive
186: * for this many intervals above,
1.51 deraadt 187: * disconnect the session
1.41 beck 188: */
1.43 markus 189:
1.127 djm 190: u_int num_authkeys_files; /* Files containing public keys */
191: char **authorized_keys_files;
1.76 dtucker 192:
193: char *adm_forced_command;
1.72 reyk 194:
195: int permit_tun;
1.77 dtucker 196:
1.132 djm 197: char **permitted_opens; /* May also be one of PERMITOPEN_* */
198: u_int num_permitted_opens;
1.133 djm 199: char **permitted_listens; /* May also be one of PERMITOPEN_* */
200: u_int num_permitted_listens;
1.88 reyk 201:
1.81 djm 202: char *chroot_directory;
1.92 djm 203: char *revoked_keys_file;
204: char *trusted_user_ca_keys;
1.104 djm 205: char *authorized_keys_command;
206: char *authorized_keys_command_user;
1.118 djm 207: char *authorized_principals_file;
208: char *authorized_principals_command;
209: char *authorized_principals_command_user;
1.108 dtucker 210:
211: int64_t rekey_limit;
212: int rekey_interval;
1.100 djm 213:
214: char *version_addendum; /* Appended to SSH banner */
1.105 djm 215:
216: u_int num_auth_methods;
1.127 djm 217: char **auth_methods;
1.115 djm 218:
219: int fingerprint_hash;
1.124 djm 220: int expose_userauth_info;
1.131 dtucker 221: u_int64_t timing_secret;
1.142 djm 222: char *sk_provider;
1.157 djm 223: int required_rsa_size; /* minimum size of RSA keys */
1.158 djm 224:
225: char **channel_timeouts; /* inactivity timeout by channel type */
226: u_int num_channel_timeouts;
1.159 djm 227:
228: int unused_connection_timeout;
1.161 ! djm 229:
! 230: char *sshd_session_path;
1.13 deraadt 231: } ServerOptions;
1.97 djm 232:
1.101 dtucker 233: /* Information about the incoming connection as used by Match */
234: struct connection_info {
235: const char *user;
236: const char *host; /* possibly resolved hostname */
1.153 djm 237: const char *address; /* remote address */
1.101 dtucker 238: const char *laddress; /* local address */
239: int lport; /* local port */
1.130 djm 240: const char *rdomain; /* routing domain if available */
1.140 dtucker 241: int test; /* test mode, allow some attributes to be
242: * unspecified */
1.101 dtucker 243: };
244:
1.143 djm 245: /* List of included files for re-exec from the parsed configuration */
246: struct include_item {
247: char *selector;
248: char *filename;
249: struct sshbuf *contents;
250: TAILQ_ENTRY(include_item) entry;
251: };
252: TAILQ_HEAD(include_list, include_item);
253:
1.101 dtucker 254:
1.97 djm 255: /*
256: * These are string config options that must be copied between the
257: * Match sub-config and the main config, and must be sent from the
1.145 djm 258: * privsep child to the privsep master. We use a macro to ensure all
1.97 djm 259: * the options are copied and the copies are done in the correct order.
1.111 djm 260: *
261: * NB. an option must appear in servconf.c:copy_set_server_options() or
262: * COPY_MATCH_STRING_OPTS here but never both.
1.97 djm 263: */
264: #define COPY_MATCH_STRING_OPTS() do { \
265: M_CP_STROPT(banner); \
266: M_CP_STROPT(trusted_user_ca_keys); \
267: M_CP_STROPT(revoked_keys_file); \
1.107 djm 268: M_CP_STROPT(authorized_keys_command); \
269: M_CP_STROPT(authorized_keys_command_user); \
1.118 djm 270: M_CP_STROPT(authorized_principals_file); \
271: M_CP_STROPT(authorized_principals_command); \
272: M_CP_STROPT(authorized_principals_command_user); \
1.151 dtucker 273: M_CP_STROPT(hostbased_accepted_algos); \
1.150 dtucker 274: M_CP_STROPT(pubkey_accepted_algos); \
1.137 djm 275: M_CP_STROPT(ca_sign_algorithms); \
1.129 djm 276: M_CP_STROPT(routing_domain); \
1.145 djm 277: M_CP_STROPT(permit_user_env_allowlist); \
1.98 djm 278: M_CP_STRARRAYOPT(authorized_keys_files, num_authkeys_files); \
1.102 markus 279: M_CP_STRARRAYOPT(allow_users, num_allow_users); \
280: M_CP_STRARRAYOPT(deny_users, num_deny_users); \
281: M_CP_STRARRAYOPT(allow_groups, num_allow_groups); \
282: M_CP_STRARRAYOPT(deny_groups, num_deny_groups); \
283: M_CP_STRARRAYOPT(accept_env, num_accept_env); \
1.148 djm 284: M_CP_STRARRAYOPT(setenv, num_setenv); \
1.105 djm 285: M_CP_STRARRAYOPT(auth_methods, num_auth_methods); \
1.127 djm 286: M_CP_STRARRAYOPT(permitted_opens, num_permitted_opens); \
1.133 djm 287: M_CP_STRARRAYOPT(permitted_listens, num_permitted_listens); \
1.158 djm 288: M_CP_STRARRAYOPT(channel_timeouts, num_channel_timeouts); \
1.147 djm 289: M_CP_STRARRAYOPT(log_verbose, num_log_verbose); \
1.160 djm 290: M_CP_STRARRAYOPT(subsystem_name, num_subsystems); \
291: M_CP_STRARRAYOPT(subsystem_command, num_subsystems); \
292: M_CP_STRARRAYOPT(subsystem_args, num_subsystems); \
1.97 djm 293: } while (0)
1.1 deraadt 294:
1.47 markus 295: void initialize_server_options(ServerOptions *);
296: void fill_default_server_options(ServerOptions *);
1.75 dtucker 297: int process_server_config_line(ServerOptions *, char *, const char *, int,
1.154 djm 298: int *, struct connection_info *, struct include_list *includes);
1.136 markus 299: void load_server_config(const char *, struct sshbuf *);
300: void parse_server_config(ServerOptions *, const char *, struct sshbuf *,
1.156 djm 301: struct include_list *includes, struct connection_info *, int);
1.143 djm 302: void parse_server_match_config(ServerOptions *,
1.154 djm 303: struct include_list *includes, struct connection_info *);
1.161 ! djm 304: int parse_channel_timeout(const char *, char **, u_int *);
1.101 dtucker 305: int parse_server_match_testspec(struct connection_info *, char *);
306: int server_match_spec_complete(struct connection_info *);
1.160 djm 307: void servconf_merge_subsystems(ServerOptions *, ServerOptions *);
1.80 dtucker 308: void copy_set_server_options(ServerOptions *, ServerOptions *, int);
1.85 dtucker 309: void dump_config(ServerOptions *);
1.90 djm 310: char *derelativise_path(const char *);
1.127 djm 311: void servconf_add_hostkey(const char *, const int,
1.138 djm 312: ServerOptions *, const char *path, int);
1.127 djm 313: void servconf_add_hostcert(const char *, const int,
314: ServerOptions *, const char *path);
1.1 deraadt 315:
1.13 deraadt 316: #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