Annotation of src/usr.bin/ssh/servconf.h, Revision 1.98
1.98 ! djm 1: /* $OpenBSD: servconf.h,v 1.97 2011/05/20 03:25:45 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.13 deraadt 31:
1.38 markus 32: /* permit_root_login */
33: #define PERMIT_NOT_SET -1
34: #define PERMIT_NO 0
35: #define PERMIT_FORCED_ONLY 1
36: #define PERMIT_NO_PASSWD 2
37: #define PERMIT_YES 3
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.13 deraadt 45: typedef struct {
1.87 djm 46: u_int num_ports;
47: u_int ports_from_cmdline;
48: int ports[MAX_PORTS]; /* Port number to listen on. */
1.15 markus 49: char *listen_addr; /* Address on which the server listens. */
50: struct addrinfo *listen_addrs; /* Addresses on which the server listens. */
1.71 djm 51: int address_family; /* Address family used by the server. */
1.31 markus 52: char *host_key_files[MAX_HOSTKEYS]; /* Files containing host keys. */
53: int num_host_key_files; /* Number of files for host keys. */
1.91 djm 54: char *host_cert_files[MAX_HOSTCERTS]; /* Files containing host certs. */
55: int num_host_cert_files; /* Number of files for host certs. */
1.19 markus 56: char *pid_file; /* Where to put our pid */
1.13 deraadt 57: int server_key_bits;/* Size of the server key. */
58: int login_grace_time; /* Disconnect if no auth in this time
59: * (sec). */
60: int key_regeneration_time; /* Server key lifetime (seconds). */
1.38 markus 61: int permit_root_login; /* PERMIT_*, see above */
1.13 deraadt 62: int ignore_rhosts; /* Ignore .rhosts and .shosts. */
63: int ignore_user_known_hosts; /* Ignore ~/.ssh/known_hosts
64: * for RhostsRsaAuth */
65: int print_motd; /* If true, print /etc/motd. */
1.39 stevesk 66: int print_lastlog; /* If true, print lastlog */
1.13 deraadt 67: int x11_forwarding; /* If true, permit inet (spoofing) X11 fwd. */
68: int x11_display_offset; /* What DISPLAY number to start
69: * searching at */
1.52 stevesk 70: int x11_use_localhost; /* If true, use localhost for fake X11 server. */
1.23 markus 71: char *xauth_location; /* Location of xauth program */
1.13 deraadt 72: int strict_modes; /* If true, require string home dir modes. */
1.66 markus 73: int tcp_keep_alive; /* If true, set SO_KEEPALIVE. */
1.95 djm 74: int ip_qos_interactive; /* IP ToS/DSCP/class for interactive */
75: int ip_qos_bulk; /* IP ToS/DSCP/class for bulk traffic */
1.37 markus 76: char *ciphers; /* Supported SSH2 ciphers. */
77: char *macs; /* Supported SSH2 macs. */
1.94 djm 78: char *kex_algorithms; /* SSH2 kex methods in order of preference. */
1.37 markus 79: int protocol; /* Supported protocol versions. */
1.21 markus 80: int gateway_ports; /* If true, allow remote connects to forwarded ports. */
1.13 deraadt 81: SyslogFacility log_facility; /* Facility for system logging. */
82: LogLevel log_level; /* Level for system logging. */
83: int rhosts_rsa_authentication; /* If true, permit rhosts RSA
84: * authentication. */
1.40 markus 85: int hostbased_authentication; /* If true, permit ssh2 hostbased auth */
86: int hostbased_uses_name_from_packet_only; /* experimental */
1.13 deraadt 87: int rsa_authentication; /* If true, permit RSA authentication. */
1.31 markus 88: int pubkey_authentication; /* If true, permit ssh2 pubkey authentication. */
1.13 deraadt 89: int kerberos_authentication; /* If true, permit Kerberos
90: * authentication. */
91: int kerberos_or_local_passwd; /* If true, permit kerberos
92: * and any other password
93: * authentication mechanism,
94: * such as SecurID or
95: * /etc/passwd */
96: int kerberos_ticket_cleanup; /* If true, destroy ticket
97: * file on logout. */
1.67 jakob 98: int kerberos_get_afs_token; /* If true, try to get AFS token if
99: * authenticated with Kerberos. */
1.64 markus 100: int gss_authentication; /* If true, permit GSSAPI authentication */
101: int gss_cleanup_creds; /* If true, destroy cred cache on logout */
1.13 deraadt 102: int password_authentication; /* If true, permit password
103: * authentication. */
1.29 markus 104: int kbd_interactive_authentication; /* If true, permit */
1.42 markus 105: int challenge_response_authentication;
1.86 djm 106: int zero_knowledge_password_authentication;
107: /* If true, permit jpake auth */
1.13 deraadt 108: int permit_empty_passwd; /* If false, do not permit empty
109: * passwords. */
1.59 markus 110: int permit_user_env; /* If true, read ~/.ssh/environment */
1.13 deraadt 111: int use_login; /* If true, login(1) is used */
1.58 markus 112: int compression; /* If true, compression is allowed */
1.30 markus 113: int allow_tcp_forwarding;
1.83 pyr 114: int allow_agent_forwarding;
1.32 markus 115: u_int num_allow_users;
1.13 deraadt 116: char *allow_users[MAX_ALLOW_USERS];
1.32 markus 117: u_int num_deny_users;
1.13 deraadt 118: char *deny_users[MAX_DENY_USERS];
1.32 markus 119: u_int num_allow_groups;
1.13 deraadt 120: char *allow_groups[MAX_ALLOW_GROUPS];
1.32 markus 121: u_int num_deny_groups;
1.13 deraadt 122: char *deny_groups[MAX_DENY_GROUPS];
1.24 jakob 123:
1.32 markus 124: u_int num_subsystems;
1.24 jakob 125: char *subsystem_name[MAX_SUBSYSTEMS];
126: char *subsystem_command[MAX_SUBSYSTEMS];
1.74 djm 127: char *subsystem_args[MAX_SUBSYSTEMS];
1.68 djm 128:
129: u_int num_accept_env;
130: char *accept_env[MAX_ACCEPT_ENV];
1.26 markus 131:
1.27 markus 132: int max_startups_begin;
133: int max_startups_rate;
1.26 markus 134: int max_startups;
1.69 dtucker 135: int max_authtries;
1.84 djm 136: int max_sessions;
1.33 markus 137: char *banner; /* SSH-2 banner message */
1.61 markus 138: int use_dns;
1.41 beck 139: int client_alive_interval; /*
1.51 deraadt 140: * poke the client this often to
141: * see if it's still there
1.41 beck 142: */
143: int client_alive_count_max; /*
1.49 stevesk 144: * If the client is unresponsive
145: * for this many intervals above,
1.51 deraadt 146: * disconnect the session
1.41 beck 147: */
1.43 markus 148:
1.98 ! djm 149: u_int num_authkeys_files; /* Files containing public keys */
! 150: char *authorized_keys_files[MAX_AUTHKEYS_FILES];
1.76 dtucker 151:
152: char *adm_forced_command;
1.72 reyk 153:
154: int permit_tun;
1.77 dtucker 155:
156: int num_permitted_opens;
1.88 reyk 157:
1.81 djm 158: char *chroot_directory;
1.92 djm 159: char *revoked_keys_file;
160: char *trusted_user_ca_keys;
1.93 djm 161: char *authorized_principals_file;
1.13 deraadt 162: } ServerOptions;
1.97 djm 163:
164: /*
165: * These are string config options that must be copied between the
166: * Match sub-config and the main config, and must be sent from the
167: * privsep slave to the privsep master. We use a macro to ensure all
168: * the options are copied and the copies are done in the correct order.
169: */
170: #define COPY_MATCH_STRING_OPTS() do { \
171: M_CP_STROPT(banner); \
172: M_CP_STROPT(trusted_user_ca_keys); \
173: M_CP_STROPT(revoked_keys_file); \
174: M_CP_STROPT(authorized_principals_file); \
1.98 ! djm 175: M_CP_STRARRAYOPT(authorized_keys_files, num_authkeys_files); \
1.97 djm 176: } while (0)
1.1 deraadt 177:
1.47 markus 178: void initialize_server_options(ServerOptions *);
179: void fill_default_server_options(ServerOptions *);
1.75 dtucker 180: int process_server_config_line(ServerOptions *, char *, const char *, int,
181: int *, const char *, const char *, const char *);
1.70 djm 182: void load_server_config(const char *, Buffer *);
1.75 dtucker 183: void parse_server_config(ServerOptions *, const char *, Buffer *,
184: const char *, const char *, const char *);
185: void parse_server_match_config(ServerOptions *, const char *, const char *,
186: const char *);
1.80 dtucker 187: void copy_set_server_options(ServerOptions *, ServerOptions *, int);
1.85 dtucker 188: void dump_config(ServerOptions *);
1.90 djm 189: char *derelativise_path(const char *);
1.1 deraadt 190:
1.13 deraadt 191: #endif /* SERVCONF_H */