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