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