Home | History | Annotate | Download | only in openssh
      1 /* $OpenBSD: readconf.h,v 1.90 2011/05/24 07:15:47 djm Exp $ */
      2 
      3 /*
      4  * Author: Tatu Ylonen <ylo (at) cs.hut.fi>
      5  * Copyright (c) 1995 Tatu Ylonen <ylo (at) cs.hut.fi>, Espoo, Finland
      6  *                    All rights reserved
      7  * Functions for reading the configuration file.
      8  *
      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".
     14  */
     15 
     16 #ifndef READCONF_H
     17 #define READCONF_H
     18 
     19 /* Data structure for representing a forwarding request. */
     20 
     21 typedef struct {
     22 	char	 *listen_host;		/* Host (address) to listen on. */
     23 	int	  listen_port;		/* Port to forward. */
     24 	char	 *connect_host;		/* Host to connect. */
     25 	int	  connect_port;		/* Port to connect on connect_host. */
     26 	int	  allocated_port;	/* Dynamically allocated listen port */
     27 }       Forward;
     28 /* Data structure for representing option data. */
     29 
     30 #define MAX_SEND_ENV		256
     31 #define SSH_MAX_HOSTS_FILES	256
     32 
     33 typedef struct {
     34 	int     forward_agent;	/* Forward authentication agent. */
     35 	int     forward_x11;	/* Forward X11 display. */
     36 	int     forward_x11_timeout;	/* Expiration for Cookies */
     37 	int     forward_x11_trusted;	/* Trust Forward X11 display. */
     38 	int     exit_on_forward_failure;	/* Exit if bind(2) fails for -L/-R */
     39 	char   *xauth_location;	/* Location for xauth program */
     40 	int     gateway_ports;	/* Allow remote connects to forwarded ports. */
     41 	int     use_privileged_port;	/* Don't use privileged port if false. */
     42 	int     rhosts_rsa_authentication;	/* Try rhosts with RSA
     43 						 * authentication. */
     44 	int     rsa_authentication;	/* Try RSA authentication. */
     45 	int     pubkey_authentication;	/* Try ssh2 pubkey authentication. */
     46 	int     hostbased_authentication;	/* ssh2's rhosts_rsa */
     47 	int     challenge_response_authentication;
     48 					/* Try S/Key or TIS, authentication. */
     49 	int     gss_authentication;	/* Try GSS authentication */
     50 	int     gss_deleg_creds;	/* Delegate GSS credentials */
     51 	int     password_authentication;	/* Try password
     52 						 * authentication. */
     53 	int     kbd_interactive_authentication; /* Try keyboard-interactive auth. */
     54 	char	*kbd_interactive_devices; /* Keyboard-interactive auth devices. */
     55 	int     zero_knowledge_password_authentication;	/* Try jpake */
     56 	int     batch_mode;	/* Batch mode: do not ask for passwords. */
     57 	int     check_host_ip;	/* Also keep track of keys for IP address */
     58 	int     strict_host_key_checking;	/* Strict host key checking. */
     59 	int     compression;	/* Compress packets in both directions. */
     60 	int     compression_level;	/* Compression level 1 (fast) to 9
     61 					 * (best). */
     62 	int     tcp_keep_alive;	/* Set SO_KEEPALIVE. */
     63 	int	ip_qos_interactive;	/* IP ToS/DSCP/class for interactive */
     64 	int	ip_qos_bulk;		/* IP ToS/DSCP/class for bulk traffic */
     65 	LogLevel log_level;	/* Level for logging. */
     66 
     67 	int     port;		/* Port to connect. */
     68 	int     address_family;
     69 	int     connection_attempts;	/* Max attempts (seconds) before
     70 					 * giving up */
     71 	int     connection_timeout;	/* Max time (seconds) before
     72 					 * aborting connection attempt */
     73 	int     number_of_password_prompts;	/* Max number of password
     74 						 * prompts. */
     75 	int     cipher;		/* Cipher to use. */
     76 	char   *ciphers;	/* SSH2 ciphers in order of preference. */
     77 	char   *macs;		/* SSH2 macs in order of preference. */
     78 	char   *hostkeyalgorithms;	/* SSH2 server key types in order of preference. */
     79 	char   *kex_algorithms;	/* SSH2 kex methods in order of preference. */
     80 	int	protocol;	/* Protocol in order of preference. */
     81 	char   *hostname;	/* Real host to connect. */
     82 	char   *host_key_alias;	/* hostname alias for .ssh/known_hosts */
     83 	char   *proxy_command;	/* Proxy command for connecting the host. */
     84 	char   *user;		/* User to log in as. */
     85 	int     escape_char;	/* Escape character; -2 = none */
     86 
     87 	u_int	num_system_hostfiles;	/* Paths for /etc/ssh/ssh_known_hosts */
     88 	char   *system_hostfiles[SSH_MAX_HOSTS_FILES];
     89 	u_int	num_user_hostfiles;	/* Path for $HOME/.ssh/known_hosts */
     90 	char   *user_hostfiles[SSH_MAX_HOSTS_FILES];
     91 	char   *preferred_authentications;
     92 	char   *bind_address;	/* local socket address for connection to sshd */
     93 	char   *pkcs11_provider; /* PKCS#11 provider */
     94 	int	verify_host_key_dns;	/* Verify host key using DNS */
     95 
     96 	int     num_identity_files;	/* Number of files for RSA/DSA identities. */
     97 	char   *identity_files[SSH_MAX_IDENTITY_FILES];
     98 	Key    *identity_keys[SSH_MAX_IDENTITY_FILES];
     99 
    100 	/* Local TCP/IP forward requests. */
    101 	int     num_local_forwards;
    102 	Forward *local_forwards;
    103 
    104 	/* Remote TCP/IP forward requests. */
    105 	int     num_remote_forwards;
    106 	Forward *remote_forwards;
    107 	int	clear_forwardings;
    108 
    109 	int	enable_ssh_keysign;
    110 	int64_t rekey_limit;
    111 	int	no_host_authentication_for_localhost;
    112 	int	identities_only;
    113 	int	server_alive_interval;
    114 	int	server_alive_count_max;
    115 
    116 	int     num_send_env;
    117 	char   *send_env[MAX_SEND_ENV];
    118 
    119 	char	*control_path;
    120 	int	control_master;
    121 	int     control_persist; /* ControlPersist flag */
    122 	int     control_persist_timeout; /* ControlPersist timeout (seconds) */
    123 
    124 	int	hash_known_hosts;
    125 
    126 	int	tun_open;	/* tun(4) */
    127 	int     tun_local;	/* force tun device (optional) */
    128 	int     tun_remote;	/* force tun device (optional) */
    129 
    130 	char	*local_command;
    131 	int	permit_local_command;
    132 	int	visual_host_key;
    133 
    134 	int	use_roaming;
    135 
    136 	int	request_tty;
    137 }       Options;
    138 
    139 #define SSHCTL_MASTER_NO	0
    140 #define SSHCTL_MASTER_YES	1
    141 #define SSHCTL_MASTER_AUTO	2
    142 #define SSHCTL_MASTER_ASK	3
    143 #define SSHCTL_MASTER_AUTO_ASK	4
    144 
    145 #define REQUEST_TTY_AUTO	0
    146 #define REQUEST_TTY_NO		1
    147 #define REQUEST_TTY_YES		2
    148 #define REQUEST_TTY_FORCE	3
    149 
    150 void     initialize_options(Options *);
    151 void     fill_default_options(Options *);
    152 int	 read_config_file(const char *, const char *, Options *, int);
    153 int	 parse_forward(Forward *, const char *, int, int);
    154 
    155 int
    156 process_config_line(Options *, const char *, char *, const char *, int, int *);
    157 
    158 void	 add_local_forward(Options *, const Forward *);
    159 void	 add_remote_forward(Options *, const Forward *);
    160 
    161 #endif				/* READCONF_H */
    162