Annotation of src/usr.bin/ssh/servconf.h, Revision 1.126
1.126 ! djm 1: /* $OpenBSD: servconf.h,v 1.125 2017/09/12 06:32:07 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.13 deraadt 21: #define MAX_ALLOW_USERS 256 /* Max # users on allow list. */
22: #define MAX_DENY_USERS 256 /* Max # users on deny list. */
23: #define MAX_ALLOW_GROUPS 256 /* Max # groups on allow list. */
24: #define MAX_DENY_GROUPS 256 /* Max # groups on deny list. */
1.24 jakob 25: #define MAX_SUBSYSTEMS 256 /* Max # subsystems. */
1.31 markus 26: #define MAX_HOSTKEYS 256 /* Max # hostkeys. */
1.91 djm 27: #define MAX_HOSTCERTS 256 /* Max # host certificates. */
1.68 djm 28: #define MAX_ACCEPT_ENV 256 /* Max # of env vars. */
1.79 dtucker 29: #define MAX_MATCH_GROUPS 256 /* Max # of groups for Match. */
1.98 djm 30: #define MAX_AUTHKEYS_FILES 256 /* Max # of authorized_keys files. */
1.105 djm 31: #define MAX_AUTH_METHODS 256 /* Max # of AuthenticationMethods. */
1.13 deraadt 32:
1.38 markus 33: /* permit_root_login */
34: #define PERMIT_NOT_SET -1
35: #define PERMIT_NO 0
36: #define PERMIT_FORCED_ONLY 1
37: #define PERMIT_NO_PASSWD 2
38: #define PERMIT_YES 3
1.99 djm 39:
40: /* use_privsep */
41: #define PRIVSEP_OFF 0
42: #define PRIVSEP_ON 1
1.103 djm 43: #define PRIVSEP_NOSANDBOX 2
1.38 markus 44:
1.106 djm 45: /* AllowTCPForwarding */
46: #define FORWARD_DENY 0
47: #define FORWARD_REMOTE (1)
48: #define FORWARD_LOCAL (1<<1)
49: #define FORWARD_ALLOW (FORWARD_REMOTE|FORWARD_LOCAL)
50:
1.125 djm 51: /* PermitOpen */
52: #define PERMITOPEN_ANY 0
53: #define PERMITOPEN_NONE -2
54:
1.69 dtucker 55: #define DEFAULT_AUTH_FAIL_MAX 6 /* Default for MaxAuthTries */
1.84 djm 56: #define DEFAULT_SESSIONS_MAX 10 /* Default for MaxSessions */
1.82 djm 57:
58: /* Magic name for internal sftp-server */
59: #define INTERNAL_SFTP_NAME "internal-sftp"
1.38 markus 60:
1.125 djm 61: struct ssh;
62: struct fwd_perm_list;
63:
1.13 deraadt 64: typedef struct {
1.87 djm 65: u_int num_ports;
66: u_int ports_from_cmdline;
67: int ports[MAX_PORTS]; /* Port number to listen on. */
1.117 dtucker 68: u_int num_queued_listens;
69: char **queued_listen_addrs;
70: int *queued_listen_ports;
1.15 markus 71: struct addrinfo *listen_addrs; /* Addresses on which the server listens. */
1.71 djm 72: int address_family; /* Address family used by the server. */
1.31 markus 73: char *host_key_files[MAX_HOSTKEYS]; /* Files containing host keys. */
74: int num_host_key_files; /* Number of files for host keys. */
1.91 djm 75: char *host_cert_files[MAX_HOSTCERTS]; /* Files containing host certs. */
76: int num_host_cert_files; /* Number of files for host certs. */
1.109 markus 77: char *host_key_agent; /* ssh-agent socket for host keys. */
1.19 markus 78: char *pid_file; /* Where to put our pid */
1.13 deraadt 79: int login_grace_time; /* Disconnect if no auth in this time
80: * (sec). */
1.38 markus 81: int permit_root_login; /* PERMIT_*, see above */
1.13 deraadt 82: int ignore_rhosts; /* Ignore .rhosts and .shosts. */
83: int ignore_user_known_hosts; /* Ignore ~/.ssh/known_hosts
84: * for RhostsRsaAuth */
85: int print_motd; /* If true, print /etc/motd. */
1.39 stevesk 86: int print_lastlog; /* If true, print lastlog */
1.13 deraadt 87: int x11_forwarding; /* If true, permit inet (spoofing) X11 fwd. */
88: int x11_display_offset; /* What DISPLAY number to start
89: * searching at */
1.52 stevesk 90: int x11_use_localhost; /* If true, use localhost for fake X11 server. */
1.23 markus 91: char *xauth_location; /* Location of xauth program */
1.110 djm 92: int permit_tty; /* If false, deny pty allocation */
1.113 djm 93: int permit_user_rc; /* If false, deny ~/.ssh/rc execution */
1.13 deraadt 94: int strict_modes; /* If true, require string home dir modes. */
1.66 markus 95: int tcp_keep_alive; /* If true, set SO_KEEPALIVE. */
1.95 djm 96: int ip_qos_interactive; /* IP ToS/DSCP/class for interactive */
97: int ip_qos_bulk; /* IP ToS/DSCP/class for bulk traffic */
1.37 markus 98: char *ciphers; /* Supported SSH2 ciphers. */
99: char *macs; /* Supported SSH2 macs. */
1.94 djm 100: char *kex_algorithms; /* SSH2 kex methods in order of preference. */
1.114 millert 101: struct ForwardOptions fwd_opts; /* forwarding options */
1.13 deraadt 102: SyslogFacility log_facility; /* Facility for system logging. */
103: LogLevel log_level; /* Level for system logging. */
1.40 markus 104: int hostbased_authentication; /* If true, permit ssh2 hostbased auth */
105: int hostbased_uses_name_from_packet_only; /* experimental */
1.116 djm 106: char *hostbased_key_types; /* Key types allowed for hostbased */
1.120 markus 107: char *hostkeyalgorithms; /* SSH2 server key types */
1.31 markus 108: int pubkey_authentication; /* If true, permit ssh2 pubkey authentication. */
1.116 djm 109: char *pubkey_key_types; /* Key types allowed for public key */
1.13 deraadt 110: int kerberos_authentication; /* If true, permit Kerberos
111: * authentication. */
112: int kerberos_or_local_passwd; /* If true, permit kerberos
113: * and any other password
114: * authentication mechanism,
115: * such as SecurID or
116: * /etc/passwd */
117: int kerberos_ticket_cleanup; /* If true, destroy ticket
118: * file on logout. */
1.67 jakob 119: int kerberos_get_afs_token; /* If true, try to get AFS token if
120: * authenticated with Kerberos. */
1.64 markus 121: int gss_authentication; /* If true, permit GSSAPI authentication */
122: int gss_cleanup_creds; /* If true, destroy cred cache on logout */
1.119 djm 123: int gss_strict_acceptor; /* If true, restrict the GSSAPI acceptor name */
1.13 deraadt 124: int password_authentication; /* If true, permit password
125: * authentication. */
1.29 markus 126: int kbd_interactive_authentication; /* If true, permit */
1.42 markus 127: int challenge_response_authentication;
1.13 deraadt 128: int permit_empty_passwd; /* If false, do not permit empty
129: * passwords. */
1.59 markus 130: int permit_user_env; /* If true, read ~/.ssh/environment */
1.58 markus 131: int compression; /* If true, compression is allowed */
1.106 djm 132: int allow_tcp_forwarding; /* One of FORWARD_* */
1.114 millert 133: int allow_streamlocal_forwarding; /* One of FORWARD_* */
1.83 pyr 134: int allow_agent_forwarding;
1.123 djm 135: int disable_forwarding;
1.32 markus 136: u_int num_allow_users;
1.13 deraadt 137: char *allow_users[MAX_ALLOW_USERS];
1.32 markus 138: u_int num_deny_users;
1.13 deraadt 139: char *deny_users[MAX_DENY_USERS];
1.32 markus 140: u_int num_allow_groups;
1.13 deraadt 141: char *allow_groups[MAX_ALLOW_GROUPS];
1.32 markus 142: u_int num_deny_groups;
1.13 deraadt 143: char *deny_groups[MAX_DENY_GROUPS];
1.24 jakob 144:
1.32 markus 145: u_int num_subsystems;
1.24 jakob 146: char *subsystem_name[MAX_SUBSYSTEMS];
147: char *subsystem_command[MAX_SUBSYSTEMS];
1.74 djm 148: char *subsystem_args[MAX_SUBSYSTEMS];
1.68 djm 149:
150: u_int num_accept_env;
151: char *accept_env[MAX_ACCEPT_ENV];
1.26 markus 152:
1.27 markus 153: int max_startups_begin;
154: int max_startups_rate;
1.26 markus 155: int max_startups;
1.69 dtucker 156: int max_authtries;
1.84 djm 157: int max_sessions;
1.33 markus 158: char *banner; /* SSH-2 banner message */
1.61 markus 159: int use_dns;
1.41 beck 160: int client_alive_interval; /*
1.51 deraadt 161: * poke the client this often to
162: * see if it's still there
1.41 beck 163: */
164: int client_alive_count_max; /*
1.49 stevesk 165: * If the client is unresponsive
166: * for this many intervals above,
1.51 deraadt 167: * disconnect the session
1.41 beck 168: */
1.43 markus 169:
1.98 djm 170: u_int num_authkeys_files; /* Files containing public keys */
171: char *authorized_keys_files[MAX_AUTHKEYS_FILES];
1.76 dtucker 172:
173: char *adm_forced_command;
1.72 reyk 174:
175: int permit_tun;
1.77 dtucker 176:
1.125 djm 177: char **permitted_opens;
178: u_int num_permitted_opens; /* May also be one of PERMITOPEN_* */
1.88 reyk 179:
1.81 djm 180: char *chroot_directory;
1.92 djm 181: char *revoked_keys_file;
182: char *trusted_user_ca_keys;
1.104 djm 183: char *authorized_keys_command;
184: char *authorized_keys_command_user;
1.118 djm 185: char *authorized_principals_file;
186: char *authorized_principals_command;
187: char *authorized_principals_command_user;
1.108 dtucker 188:
189: int64_t rekey_limit;
190: int rekey_interval;
1.100 djm 191:
192: char *version_addendum; /* Appended to SSH banner */
1.105 djm 193:
194: u_int num_auth_methods;
195: char *auth_methods[MAX_AUTH_METHODS];
1.115 djm 196:
197: int fingerprint_hash;
1.124 djm 198: int expose_userauth_info;
1.13 deraadt 199: } ServerOptions;
1.97 djm 200:
1.101 dtucker 201: /* Information about the incoming connection as used by Match */
202: struct connection_info {
203: const char *user;
204: const char *host; /* possibly resolved hostname */
205: const char *address; /* remote address */
206: const char *laddress; /* local address */
207: int lport; /* local port */
208: };
209:
210:
1.97 djm 211: /*
212: * These are string config options that must be copied between the
213: * Match sub-config and the main config, and must be sent from the
214: * privsep slave to the privsep master. We use a macro to ensure all
215: * the options are copied and the copies are done in the correct order.
1.111 djm 216: *
217: * NB. an option must appear in servconf.c:copy_set_server_options() or
218: * COPY_MATCH_STRING_OPTS here but never both.
1.97 djm 219: */
220: #define COPY_MATCH_STRING_OPTS() do { \
221: M_CP_STROPT(banner); \
222: M_CP_STROPT(trusted_user_ca_keys); \
223: M_CP_STROPT(revoked_keys_file); \
1.107 djm 224: M_CP_STROPT(authorized_keys_command); \
225: M_CP_STROPT(authorized_keys_command_user); \
1.118 djm 226: M_CP_STROPT(authorized_principals_file); \
227: M_CP_STROPT(authorized_principals_command); \
228: M_CP_STROPT(authorized_principals_command_user); \
1.116 djm 229: M_CP_STROPT(hostbased_key_types); \
230: M_CP_STROPT(pubkey_key_types); \
1.98 djm 231: M_CP_STRARRAYOPT(authorized_keys_files, num_authkeys_files); \
1.102 markus 232: M_CP_STRARRAYOPT(allow_users, num_allow_users); \
233: M_CP_STRARRAYOPT(deny_users, num_deny_users); \
234: M_CP_STRARRAYOPT(allow_groups, num_allow_groups); \
235: M_CP_STRARRAYOPT(deny_groups, num_deny_groups); \
236: M_CP_STRARRAYOPT(accept_env, num_accept_env); \
1.105 djm 237: M_CP_STRARRAYOPT(auth_methods, num_auth_methods); \
1.126 ! djm 238: M_CP_STRARRAYOPT_ALLOC(permitted_opens, num_permitted_opens); \
1.97 djm 239: } while (0)
1.1 deraadt 240:
1.101 dtucker 241: struct connection_info *get_connection_info(int, int);
1.47 markus 242: void initialize_server_options(ServerOptions *);
243: void fill_default_server_options(ServerOptions *);
1.75 dtucker 244: int process_server_config_line(ServerOptions *, char *, const char *, int,
1.101 dtucker 245: int *, struct connection_info *);
1.125 djm 246: void process_permitopen(struct ssh *ssh, ServerOptions *options);
1.70 djm 247: void load_server_config(const char *, Buffer *);
1.75 dtucker 248: void parse_server_config(ServerOptions *, const char *, Buffer *,
1.101 dtucker 249: struct connection_info *);
250: void parse_server_match_config(ServerOptions *, struct connection_info *);
251: int parse_server_match_testspec(struct connection_info *, char *);
252: int server_match_spec_complete(struct connection_info *);
1.80 dtucker 253: void copy_set_server_options(ServerOptions *, ServerOptions *, int);
1.85 dtucker 254: void dump_config(ServerOptions *);
1.90 djm 255: char *derelativise_path(const char *);
1.1 deraadt 256:
1.13 deraadt 257: #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