[openssh.git] / readconf.h

/* $OpenBSD: readconf.h,v 1.81 2010/01/09 23:04:13 dtucker Exp $ */

/*
 * 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.
 *
 * 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".
 */

#ifndef READCONF_H
#define READCONF_H

/* Data structure for representing a forwarding request. */

typedef struct {
	char	 *listen_host;		/* Host (address) to listen on. */
	int	  listen_port;		/* Port to forward. */
	char	 *connect_host;		/* Host to connect. */
	int	  connect_port;		/* Port to connect on connect_host. */
}       Forward;
/* Data structure for representing option data. */

#define MAX_SEND_ENV	256

typedef struct {
	int     forward_agent;	/* Forward authentication agent. */
	int     forward_x11;	/* Forward X11 display. */
	int     forward_x11_trusted;	/* Trust Forward X11 display. */
	int     exit_on_forward_failure;	/* Exit if bind(2) fails for -L/-R */
	char   *xauth_location;	/* Location for xauth program */
	int     gateway_ports;	/* Allow remote connects to forwarded ports. */
	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 */
	int     challenge_response_authentication;
					/* Try S/Key or TIS, authentication. */
	int     gss_authentication;	/* Try GSS authentication */
	int     gss_deleg_creds;	/* Delegate GSS credentials */
	int     password_authentication;	/* Try password
						 * authentication. */
	int     kbd_interactive_authentication; /* Try keyboard-interactive auth. */
	char	*kbd_interactive_devices; /* Keyboard-interactive auth devices. */
	int     zero_knowledge_password_authentication;	/* Try jpake */
	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). */
	int     tcp_keep_alive;	/* Set SO_KEEPALIVE. */
	LogLevel log_level;	/* Level for logging. */

	int     port;		/* Port to connect. */
	int     address_family;
	int     connection_attempts;	/* Max attempts (seconds) before
					 * giving up */
	int     connection_timeout;	/* Max time (seconds) before
					 * aborting connection attempt */
	int     number_of_password_prompts;	/* Max number of password
						 * prompts. */
	int     cipher;		/* Cipher to use. */
	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. */
	int	protocol;	/* Protocol in order of preference. */
	char   *hostname;	/* Real host to connect. */
	char   *host_key_alias;	/* hostname alias for .ssh/known_hosts */
	char   *proxy_command;	/* Proxy command for connecting the host. */
	char   *user;		/* User to log in as. */
	int     escape_char;	/* Escape character; -2 = none */

	char   *system_hostfile;/* Path for /etc/ssh/ssh_known_hosts. */
	char   *user_hostfile;	/* Path for $HOME/.ssh/known_hosts. */
	char   *system_hostfile2;
	char   *user_hostfile2;
	char   *preferred_authentications;
	char   *bind_address;	/* local socket address for connection to sshd */
	char   *smartcard_device; /* Smartcard reader device */
	int	verify_host_key_dns;	/* Verify host key using DNS */

	int     num_identity_files;	/* Number of files for RSA/DSA identities. */
	char   *identity_files[SSH_MAX_IDENTITY_FILES];
	Key    *identity_keys[SSH_MAX_IDENTITY_FILES];

	/* Local TCP/IP forward requests. */
	int     num_local_forwards;
	Forward local_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];

	/* Remote TCP/IP forward requests. */
	int     num_remote_forwards;
	Forward remote_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
	int	clear_forwardings;

	int	enable_ssh_keysign;
	int64_t rekey_limit;
	int	no_host_authentication_for_localhost;
	int	identities_only;
	int	server_alive_interval;
	int	server_alive_count_max;

	int     num_send_env;
	char   *send_env[MAX_SEND_ENV];

	char	*control_path;
	int	control_master;

	int	hash_known_hosts;

	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;
	int	visual_host_key;

	int	use_roaming;

}       Options;

#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

void     initialize_options(Options *);
void     fill_default_options(Options *);
int	 read_config_file(const char *, const char *, Options *, int);
int	 parse_forward(Forward *, const char *, int, int);

int
process_config_line(Options *, const char *, char *, const char *, int, int *);

void	 add_local_forward(Options *, const Forward *);
void	 add_remote_forward(Options *, const Forward *);

#endif				/* READCONF_H */
Commit	Line	Data
16d64584	1	/* $OpenBSD: readconf.h,v 1.81 2010/01/09 23:04:13 dtucker Exp $ */
93c3b6de	2
8efc0c15	3	/*
5260325f	4	* Author: Tatu Ylonen <ylo@cs.hut.fi>
5260325f	5	* Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5260325f	6	* All rights reserved
5260325f	7	* Functions for reading the configuration file.
6ae2364d	8	*
bcbf86ec	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".
5260325f	14	*/
8efc0c15	15
8efc0c15	16	#ifndef READCONF_H
	17	#define READCONF_H
	18
	19	/* Data structure for representing a forwarding request. */
	20
5260325f	21	typedef struct {
3867aa0a	22	char listen_host; / Host (address) to listen on. */
5134115d	23	int listen_port; /* Port to forward. */
3867aa0a	24	char connect_host; / Host to connect. */
5134115d	25	int connect_port; /* Port to connect on connect_host. */
5260325f	26	} Forward;
8efc0c15	27	/* Data structure for representing option data. */
8efc0c15	28
61a2c1da	29	#define MAX_SEND_ENV 256
61a2c1da	30
5260325f	31	typedef struct {
	32	int forward_agent; /* Forward authentication agent. */
	33	int forward_x11; /* Forward X11 display. */
d73a67d7	34	int forward_x11_trusted; /* Trust Forward X11 display. */
42ea6f5e	35	int exit_on_forward_failure; /* Exit if bind(2) fails for -L/-R */
fa649821	36	char xauth_location; / Location for xauth program */
5260325f	37	int gateway_ports; /* Allow remote connects to forwarded ports. */
5260325f	38	int use_privileged_port; /* Don't use privileged port if false. */
5260325f	39	int rhosts_rsa_authentication; /* Try rhosts with RSA
	40	* authentication. */
	41	int rsa_authentication; /* Try RSA authentication. */
fa08c86b	42	int pubkey_authentication; /* Try ssh2 pubkey authentication. */
8002af61	43	int hostbased_authentication; /* ssh2's rhosts_rsa */
5ba55ada	44	int challenge_response_authentication;
d464095c	45	/* Try S/Key or TIS, authentication. */
7364bd04	46	int gss_authentication; /* Try GSS authentication */
7364bd04	47	int gss_deleg_creds; /* Delegate GSS credentials */
5260325f	48	int password_authentication; /* Try password
5260325f	49	* authentication. */
94ec8c6b	50	int kbd_interactive_authentication; /* Try keyboard-interactive auth. */
94ec8c6b	51	char kbd_interactive_devices; / Keyboard-interactive auth devices. */
5adf6b9a	52	int zero_knowledge_password_authentication; /* Try jpake */
5260325f	53	int batch_mode; /* Batch mode: do not ask for passwords. */
	54	int check_host_ip; /* Also keep track of keys for IP address */
	55	int strict_host_key_checking; /* Strict host key checking. */
	56	int compression; /* Compress packets in both directions. */
	57	int compression_level; /* Compression level 1 (fast) to 9
	58	* (best). */
fd573618	59	int tcp_keep_alive; /* Set SO_KEEPALIVE. */
5260325f	60	LogLevel log_level; /* Level for logging. */
	61
	62	int port; /* Port to connect. */
1572b90f	63	int address_family;
5260325f	64	int connection_attempts; /* Max attempts (seconds) before
5260325f	65	* giving up */
09ab3296	66	int connection_timeout; /* Max time (seconds) before
aff51935	67	* aborting connection attempt */
5260325f	68	int number_of_password_prompts; /* Max number of password
	69	* prompts. */
	70	int cipher; /* Cipher to use. */
d0c832f3	71	char ciphers; / SSH2 ciphers in order of preference. */
b2552997	72	char macs; / SSH2 macs in order of preference. */
e961a8f9	73	char hostkeyalgorithms; / SSH2 server key types in order of preference. */
a8be9f80	74	int protocol; /* Protocol in order of preference. */
5260325f	75	char hostname; / Real host to connect. */
8abcdba4	76	char host_key_alias; / hostname alias for .ssh/known_hosts */
5260325f	77	char proxy_command; / Proxy command for connecting the host. */
	78	char user; / User to log in as. */
	79	int escape_char; /* Escape character; -2 = none */
	80
af98ced9	81	char system_hostfile;/ Path for /etc/ssh/ssh_known_hosts. */
5260325f	82	char user_hostfile; / Path for $HOME/.ssh/known_hosts. */
a306f2dd	83	char *system_hostfile2;
a306f2dd	84	char *user_hostfile2;
cab80f75	85	char *preferred_authentications;
3435f5a6	86	char bind_address; / local socket address for connection to sshd */
9ff6f66f	87	char smartcard_device; / Smartcard reader device */
21289cd0	88	int verify_host_key_dns; /* Verify host key using DNS */
5260325f	89
fa08c86b	90	int num_identity_files; /* Number of files for RSA/DSA identities. */
5260325f	91	char *identity_files[SSH_MAX_IDENTITY_FILES];
fee56204	92	Key *identity_keys[SSH_MAX_IDENTITY_FILES];
5260325f	93
	94	/* Local TCP/IP forward requests. */
	95	int num_local_forwards;
	96	Forward local_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
	97
	98	/* Remote TCP/IP forward requests. */
	99	int num_remote_forwards;
	100	Forward remote_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
e1c5bfaf	101	int clear_forwardings;
cc46e2ee	102
cc46e2ee	103	int enable_ssh_keysign;
fe771396	104	int64_t rekey_limit;
8bbc048a	105	int no_host_authentication_for_localhost;
3a065ed0	106	int identities_only;
f2107e97	107	int server_alive_interval;
5d8d32a3	108	int server_alive_count_max;
61a2c1da	109
	110	int num_send_env;
	111	char *send_env[MAX_SEND_ENV];
5e96b616	112
	113	char *control_path;
	114	int control_master;
5c63c2ab	115
5c63c2ab	116	int hash_known_hosts;
d20f3c9e	117
	118	int tun_open; /* tun(4) */
	119	int tun_local; /* force tun device (optional) */
	120	int tun_remote; /* force tun device (optional) */
	121
	122	char *local_command;
	123	int permit_local_command;
7b3999b8	124	int visual_host_key;
d20f3c9e	125
94c0aea4	126	int use_roaming;
94c0aea4	127
5260325f	128	} Options;
8efc0c15	129
9dfd96d6	130	#define SSHCTL_MASTER_NO 0
	131	#define SSHCTL_MASTER_YES 1
	132	#define SSHCTL_MASTER_AUTO 2
	133	#define SSHCTL_MASTER_ASK 3
	134	#define SSHCTL_MASTER_AUTO_ASK 4
8efc0c15	135
255cabd9	136	void initialize_options(Options *);
255cabd9	137	void fill_default_options(Options *);
9f6cab4b	138	int read_config_file(const char , const char , Options *, int);
17525a70	139	int parse_forward(Forward , const char , int, int);
8efc0c15	140
6ae2364d	141	int
2a1e4639	142	process_config_line(Options , const char , char , const char , int, int *);
8efc0c15	143
3867aa0a	144	void add_local_forward(Options , const Forward );
3867aa0a	145	void add_remote_forward(Options , const Forward );
8efc0c15	146
5260325f	147	#endif /* READCONF_H */