freebsd-nq/crypto/openssh/readconf.h

220 lines
7.8 KiB
C
Raw Normal View History

2017-01-31 12:29:48 +00:00
/* $OpenBSD: readconf.h,v 1.117 2016/07/15 00:24:30 djm Exp $ */
/* $FreeBSD$ */
2002-03-18 09:55:03 +00:00
2000-02-24 14:29:47 +00:00
/*
* Author: Tatu Ylonen <ylo@cs.hut.fi>
* Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
* All rights reserved
* Functions for reading the configuration file.
2000-05-15 04:37:24 +00:00
*
* As far as I am concerned, the code I have written for this software
* can be used freely for any purpose. Any derived versions of this
* software must be clearly marked as such, and if the derived work is
* incompatible with the protocol description in the RFC file, it must be
* called by a name other than "ssh" or "Secure Shell".
2000-02-24 14:29:47 +00:00
*/
#ifndef READCONF_H
#define READCONF_H
/* Data structure for representing option data. */
2011-09-28 08:14:41 +00:00
#define MAX_SEND_ENV 256
2014-01-30 10:56:49 +00:00
#define SSH_MAX_HOSTS_FILES 32
#define MAX_CANON_DOMAINS 32
2015-01-05 16:09:55 +00:00
#define PATH_MAX_SUN (sizeof((struct sockaddr_un *)0)->sun_path)
2014-01-30 10:56:49 +00:00
struct allowed_cname {
char *source_list;
char *target_list;
};
2004-10-28 16:03:53 +00:00
2000-02-24 14:29:47 +00:00
typedef struct {
int forward_agent; /* Forward authentication agent. */
int forward_x11; /* Forward X11 display. */
2010-11-08 10:45:44 +00:00
int forward_x11_timeout; /* Expiration for Cookies */
2004-02-26 10:38:49 +00:00
int forward_x11_trusted; /* Trust Forward X11 display. */
2006-09-30 13:29:51 +00:00
int exit_on_forward_failure; /* Exit if bind(2) fails for -L/-R */
char *xauth_location; /* Location for xauth program */
2015-01-05 16:09:55 +00:00
struct ForwardOptions fwd_opts; /* forwarding options */
2000-02-24 14:29:47 +00:00
int use_privileged_port; /* Don't use privileged port if false. */
int rhosts_rsa_authentication; /* Try rhosts with RSA
* authentication. */
int rsa_authentication; /* Try RSA authentication. */
int pubkey_authentication; /* Try ssh2 pubkey authentication. */
int hostbased_authentication; /* ssh2's rhosts_rsa */
2002-03-18 09:55:03 +00:00
int challenge_response_authentication;
/* Try S/Key or TIS, authentication. */
2004-01-07 11:10:17 +00:00
int gss_authentication; /* Try GSS authentication */
int gss_deleg_creds; /* Delegate GSS credentials */
2000-02-24 14:29:47 +00:00
int password_authentication; /* Try password
* authentication. */
int kbd_interactive_authentication; /* Try keyboard-interactive auth. */
char *kbd_interactive_devices; /* Keyboard-interactive auth devices. */
2000-02-24 14:29:47 +00:00
int batch_mode; /* Batch mode: do not ask for passwords. */
int check_host_ip; /* Also keep track of keys for IP address */
int strict_host_key_checking; /* Strict host key checking. */
int compression; /* Compress packets in both directions. */
int compression_level; /* Compression level 1 (fast) to 9
* (best). */
2004-02-26 10:38:49 +00:00
int tcp_keep_alive; /* Set SO_KEEPALIVE. */
2011-02-17 11:47:40 +00:00
int ip_qos_interactive; /* IP ToS/DSCP/class for interactive */
int ip_qos_bulk; /* IP ToS/DSCP/class for bulk traffic */
2000-02-24 14:29:47 +00:00
LogLevel log_level; /* Level for logging. */
int port; /* Port to connect. */
2004-01-07 11:10:17 +00:00
int address_family;
2000-02-24 14:29:47 +00:00
int connection_attempts; /* Max attempts (seconds) before
* giving up */
2004-01-07 11:10:17 +00:00
int connection_timeout; /* Max time (seconds) before
2004-02-26 10:38:49 +00:00
* aborting connection attempt */
2000-02-24 14:29:47 +00:00
int number_of_password_prompts; /* Max number of password
* prompts. */
int cipher; /* Cipher to use. */
2000-05-15 04:37:24 +00:00
char *ciphers; /* SSH2 ciphers in order of preference. */
char *macs; /* SSH2 macs in order of preference. */
char *hostkeyalgorithms; /* SSH2 server key types in order of preference. */
2011-02-17 11:47:40 +00:00
char *kex_algorithms; /* SSH2 kex methods in order of preference. */
2000-05-15 04:37:24 +00:00
int protocol; /* Protocol in order of preference. */
2000-02-24 14:29:47 +00:00
char *hostname; /* Real host to connect. */
char *host_key_alias; /* hostname alias for .ssh/known_hosts */
2000-02-24 14:29:47 +00:00
char *proxy_command; /* Proxy command for connecting the host. */
char *user; /* User to log in as. */
int escape_char; /* Escape character; -2 = none */
2011-09-28 08:14:41 +00:00
u_int num_system_hostfiles; /* Paths for /etc/ssh/ssh_known_hosts */
char *system_hostfiles[SSH_MAX_HOSTS_FILES];
u_int num_user_hostfiles; /* Path for $HOME/.ssh/known_hosts */
char *user_hostfiles[SSH_MAX_HOSTS_FILES];
char *preferred_authentications;
2002-03-18 09:55:03 +00:00
char *bind_address; /* local socket address for connection to sshd */
2010-03-08 11:19:52 +00:00
char *pkcs11_provider; /* PKCS#11 provider */
2004-01-07 11:10:17 +00:00
int verify_host_key_dns; /* Verify host key using DNS */
2000-02-24 14:29:47 +00:00
int num_identity_files; /* Number of files for RSA/DSA identities. */
2000-02-24 14:29:47 +00:00
char *identity_files[SSH_MAX_IDENTITY_FILES];
int identity_file_userprovided[SSH_MAX_IDENTITY_FILES];
2015-07-02 13:15:34 +00:00
struct sshkey *identity_keys[SSH_MAX_IDENTITY_FILES];
2000-02-24 14:29:47 +00:00
2016-03-10 20:10:25 +00:00
int num_certificate_files; /* Number of extra certificates for ssh. */
char *certificate_files[SSH_MAX_CERTIFICATE_FILES];
int certificate_file_userprovided[SSH_MAX_CERTIFICATE_FILES];
struct sshkey *certificates[SSH_MAX_CERTIFICATE_FILES];
int add_keys_to_agent;
2017-01-31 12:29:48 +00:00
char *identity_agent; /* Optional path to ssh-agent socket */
2016-03-10 20:10:25 +00:00
2000-02-24 14:29:47 +00:00
/* Local TCP/IP forward requests. */
int num_local_forwards;
2015-01-05 16:09:55 +00:00
struct Forward *local_forwards;
2000-02-24 14:29:47 +00:00
/* Remote TCP/IP forward requests. */
int num_remote_forwards;
2015-01-05 16:09:55 +00:00
struct Forward *remote_forwards;
2002-03-18 09:55:03 +00:00
int clear_forwardings;
2017-01-31 12:29:48 +00:00
/* stdio forwarding (-W) host and port */
char *stdio_forward_host;
int stdio_forward_port;
int enable_ssh_keysign;
int64_t rekey_limit;
2013-09-18 17:27:38 +00:00
int rekey_interval;
2002-03-18 09:55:03 +00:00
int no_host_authentication_for_localhost;
2004-04-20 09:35:04 +00:00
int identities_only;
2004-10-28 16:03:53 +00:00
int server_alive_interval;
2004-02-26 10:38:49 +00:00
int server_alive_count_max;
2004-10-28 16:03:53 +00:00
int num_send_env;
char *send_env[MAX_SEND_ENV];
char *control_path;
int control_master;
2010-11-08 10:45:44 +00:00
int control_persist; /* ControlPersist flag */
int control_persist_timeout; /* ControlPersist timeout (seconds) */
2005-06-05 15:40:50 +00:00
int hash_known_hosts;
2006-03-22 19:46:12 +00:00
int tun_open; /* tun(4) */
int tun_local; /* force tun device (optional) */
int tun_remote; /* force tun device (optional) */
char *local_command;
int permit_local_command;
2008-07-23 09:33:08 +00:00
int visual_host_key;
2006-03-22 19:46:12 +00:00
2011-09-28 08:14:41 +00:00
int request_tty;
2013-09-18 17:27:38 +00:00
2014-01-30 10:56:49 +00:00
int proxy_use_fdpass;
int num_canonical_domains;
char *canonical_domains[MAX_CANON_DOMAINS];
int canonicalize_hostname;
int canonicalize_max_dots;
int canonicalize_fallback_local;
int num_permitted_cnames;
struct allowed_cname permitted_cnames[MAX_CANON_DOMAINS];
2015-07-02 13:15:34 +00:00
char *revoked_host_keys;
int fingerprint_hash;
int update_hostkeys; /* one of SSH_UPDATE_HOSTKEYS_* */
2015-08-26 09:25:17 +00:00
char *hostbased_key_types;
char *pubkey_key_types;
2015-07-02 13:15:34 +00:00
2017-03-02 00:11:32 +00:00
char *version_addendum; /* Appended to SSH banner */
2017-01-31 12:29:48 +00:00
char *jump_user;
char *jump_host;
int jump_port;
char *jump_extra;
2009-10-01 15:19:37 +00:00
char *ignored_unknown; /* Pattern list of unknown tokens to ignore */
2000-02-24 14:29:47 +00:00
} Options;
2014-01-30 10:56:49 +00:00
#define SSH_CANONICALISE_NO 0
#define SSH_CANONICALISE_YES 1
#define SSH_CANONICALISE_ALWAYS 2
2005-09-03 06:59:33 +00:00
#define SSHCTL_MASTER_NO 0
#define SSHCTL_MASTER_YES 1
#define SSHCTL_MASTER_AUTO 2
#define SSHCTL_MASTER_ASK 3
#define SSHCTL_MASTER_AUTO_ASK 4
2000-02-24 14:29:47 +00:00
2011-09-28 08:14:41 +00:00
#define REQUEST_TTY_AUTO 0
#define REQUEST_TTY_NO 1
#define REQUEST_TTY_YES 2
#define REQUEST_TTY_FORCE 3
#define SSHCONF_CHECKPERM 1 /* check permissions on config file */
#define SSHCONF_USERCONF 2 /* user provided config file not system */
2015-07-02 13:15:34 +00:00
#define SSHCONF_POSTCANON 4 /* After hostname canonicalisation */
2017-01-31 12:29:48 +00:00
#define SSHCONF_NEVERMATCH 8 /* Match/Host never matches; internal only */
2015-07-02 13:15:34 +00:00
#define SSH_UPDATE_HOSTKEYS_NO 0
#define SSH_UPDATE_HOSTKEYS_YES 1
#define SSH_UPDATE_HOSTKEYS_ASK 2
2002-03-18 09:55:03 +00:00
void initialize_options(Options *);
void fill_default_options(Options *);
2014-03-22 15:23:38 +00:00
void fill_default_options_for_canonicalization(Options *);
2015-07-02 13:15:34 +00:00
int process_config_line(Options *, struct passwd *, const char *,
const char *, char *, const char *, int, int *, int);
2014-01-30 10:56:49 +00:00
int read_config_file(const char *, struct passwd *, const char *,
2015-07-02 13:15:34 +00:00
const char *, Options *, int);
2015-01-05 16:09:55 +00:00
int parse_forward(struct Forward *, const char *, int, int);
2017-01-31 12:29:48 +00:00
int parse_jump(const char *, Options *, int);
2014-01-30 10:56:49 +00:00
int default_ssh_port(void);
2014-03-22 15:23:38 +00:00
int option_clear_or_none(const char *);
2015-07-02 13:15:34 +00:00
void dump_client_config(Options *o, const char *host);
2000-02-24 14:29:47 +00:00
2015-01-05 16:09:55 +00:00
void add_local_forward(Options *, const struct Forward *);
void add_remote_forward(Options *, const struct Forward *);
void add_identity_file(Options *, const char *, const char *, int);
2016-03-10 20:10:25 +00:00
void add_certificate_file(Options *, const char *, int);
2000-02-24 14:29:47 +00:00
#endif /* READCONF_H */