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