[gssapi-openssh.git] / openssh / readconf.h

/* $OpenBSD: readconf.h,v 1.79 2009/06/27 09:35:06 andreas 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_keyex;		/* Try GSS key exchange */
	int     gss_deleg_creds;	/* Delegate GSS credentials */
	int	gss_trust_dns;		/* Trust DNS for GSS canonicalization */
	int	gss_renewal_rekey;	/* Credential renewal forces rekey */
	char    *gss_client_identity;   /* Principal to initiate GSSAPI with */
	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. */
        int     tcp_rcv_buf; /* user switch to set tcp recv buffer */
	int	tcp_rcv_buf_poll; /* Option to poll recv buf every window transfer */
	int 	hpn_disabled; 	 /* Switch to disable HPN buffer management */
	int	hpn_buffer_size; /* User definable size for HPN buffer window */

	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    implicit;	/* Login user was not specified.
				   Server may choose based on authctxt. */
	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     none_switch;    /* Use none cipher */
	int     none_enabled;   /* Allow none to be used */
	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
b5afdff5	1	/* $OpenBSD: readconf.h,v 1.79 2009/06/27 09:35:06 andreas Exp $ */
1e608e42	2
3c0ef626	3	/*
	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	* 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
3c0ef626	16	#ifndef READCONF_H
	17	#define READCONF_H
	18
3c0ef626	19	/* Data structure for representing a forwarding request. */
	20
	21	typedef struct {
dfddba3d	22	char listen_host; / Host (address) to listen on. */
5262cbfb	23	int listen_port; /* Port to forward. */
dfddba3d	24	char connect_host; / Host to connect. */
5262cbfb	25	int connect_port; /* Port to connect on connect_host. */
3c0ef626	26	} Forward;
	27	/* Data structure for representing option data. */
	28
7e82606e	29	#define MAX_SEND_ENV 256
7e82606e	30
3c0ef626	31	typedef struct {
	32	int forward_agent; /* Forward authentication agent. */
	33	int forward_x11; /* Forward X11 display. */
540d72c3	34	int forward_x11_trusted; /* Trust Forward X11 display. */
30460aeb	35	int exit_on_forward_failure; /* Exit if bind(2) fails for -L/-R */
3c0ef626	36	char xauth_location; / Location for xauth program */
	37	int gateway_ports; /* Allow remote connects to forwarded ports. */
	38	int use_privileged_port; /* Don't use privileged port if false. */
3c0ef626	39	int rhosts_rsa_authentication; /* Try rhosts with RSA
	40	* authentication. */
	41	int rsa_authentication; /* Try RSA authentication. */
	42	int pubkey_authentication; /* Try ssh2 pubkey authentication. */
	43	int hostbased_authentication; /* ssh2's rhosts_rsa */
	44	int challenge_response_authentication;
	45	/* Try S/Key or TIS, authentication. */
7cac2b65	46	int gss_authentication; /* Try GSS authentication */
f97edba6	47	int gss_keyex; /* Try GSS key exchange */
7cac2b65	48	int gss_deleg_creds; /* Delegate GSS credentials */
fe4ad273	49	int gss_trust_dns; /* Trust DNS for GSS canonicalization */
f97edba6	50	int gss_renewal_rekey; /* Credential renewal forces rekey */
f97edba6	51	char gss_client_identity; / Principal to initiate GSSAPI with */
3c0ef626	52	int password_authentication; /* Try password
	53	* authentication. */
	54	int kbd_interactive_authentication; /* Try keyboard-interactive auth. */
	55	char kbd_interactive_devices; / Keyboard-interactive auth devices. */
5262cbfb	56	int zero_knowledge_password_authentication; /* Try jpake */
3c0ef626	57	int batch_mode; /* Batch mode: do not ask for passwords. */
	58	int check_host_ip; /* Also keep track of keys for IP address */
	59	int strict_host_key_checking; /* Strict host key checking. */
	60	int compression; /* Compress packets in both directions. */
	61	int compression_level; /* Compression level 1 (fast) to 9
	62	* (best). */
540d72c3	63	int tcp_keep_alive; /* Set SO_KEEPALIVE. */
473db5ab	64	int tcp_rcv_buf; /* user switch to set tcp recv buffer */
a7213e65	65	int tcp_rcv_buf_poll; /* Option to poll recv buf every window transfer */
	66	int hpn_disabled; /* Switch to disable HPN buffer management */
	67	int hpn_buffer_size; /* User definable size for HPN buffer window */
	68
3c0ef626	69	LogLevel log_level; /* Level for logging. */
	70
	71	int port; /* Port to connect. */
7cac2b65	72	int address_family;
3c0ef626	73	int connection_attempts; /* Max attempts (seconds) before
3c0ef626	74	* giving up */
7cac2b65	75	int connection_timeout; /* Max time (seconds) before
540d72c3	76	* aborting connection attempt */
3c0ef626	77	int number_of_password_prompts; /* Max number of password
	78	* prompts. */
	79	int cipher; /* Cipher to use. */
	80	char ciphers; / SSH2 ciphers in order of preference. */
	81	char macs; / SSH2 macs in order of preference. */
	82	char hostkeyalgorithms; / SSH2 server key types in order of preference. */
	83	int protocol; /* Protocol in order of preference. */
	84	char hostname; / Real host to connect. */
	85	char host_key_alias; / hostname alias for .ssh/known_hosts */
	86	char proxy_command; / Proxy command for connecting the host. */
	87	char user; / User to log in as. */
68378849	88	int implicit; /* Login user was not specified.
68378849	89	Server may choose based on authctxt. */
3c0ef626	90	int escape_char; /* Escape character; -2 = none */
3c0ef626	91
1e608e42	92	char system_hostfile;/ Path for /etc/ssh/ssh_known_hosts. */
3c0ef626	93	char user_hostfile; / Path for $HOME/.ssh/known_hosts. */
	94	char *system_hostfile2;
	95	char *user_hostfile2;
	96	char *preferred_authentications;
	97	char bind_address; / local socket address for connection to sshd */
	98	char smartcard_device; / Smartcard reader device */
7cac2b65	99	int verify_host_key_dns; /* Verify host key using DNS */
3c0ef626	100
	101	int num_identity_files; /* Number of files for RSA/DSA identities. */
	102	char *identity_files[SSH_MAX_IDENTITY_FILES];
	103	Key *identity_keys[SSH_MAX_IDENTITY_FILES];
	104
	105	/* Local TCP/IP forward requests. */
	106	int num_local_forwards;
	107	Forward local_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
	108
	109	/* Remote TCP/IP forward requests. */
	110	int num_remote_forwards;
	111	Forward remote_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
	112	int clear_forwardings;
bfe49944	113
bfe49944	114	int enable_ssh_keysign;
e74dc197	115	int64_t rekey_limit;
d3057ca4	116	int none_switch; /* Use none cipher */
d3057ca4	117	int none_enabled; /* Allow none to be used */
3c0ef626	118	int no_host_authentication_for_localhost;
12a403af	119	int identities_only;
7e82606e	120	int server_alive_interval;
540d72c3	121	int server_alive_count_max;
7e82606e	122
	123	int num_send_env;
	124	char *send_env[MAX_SEND_ENV];
	125
	126	char *control_path;
	127	int control_master;
dfddba3d	128
dfddba3d	129	int hash_known_hosts;
08822d99	130
	131	int tun_open; /* tun(4) */
	132	int tun_local; /* force tun device (optional) */
	133	int tun_remote; /* force tun device (optional) */
	134
	135	char *local_command;
	136	int permit_local_command;
5156b1a1	137	int visual_host_key;
08822d99	138
b5afdff5	139	int use_roaming;
b5afdff5	140
3c0ef626	141	} Options;
3c0ef626	142
2ce0bfe4	143	#define SSHCTL_MASTER_NO 0
	144	#define SSHCTL_MASTER_YES 1
	145	#define SSHCTL_MASTER_AUTO 2
	146	#define SSHCTL_MASTER_ASK 3
	147	#define SSHCTL_MASTER_AUTO_ASK 4
3c0ef626	148
	149	void initialize_options(Options *);
	150	void fill_default_options(Options *);
7e82606e	151	int read_config_file(const char , const char , Options *, int);
5262cbfb	152	int parse_forward(Forward , const char , int, int);
3c0ef626	153
	154	int
	155	process_config_line(Options , const char , char , const char , int, int *);
	156
dfddba3d	157	void add_local_forward(Options , const Forward );
dfddba3d	158	void add_remote_forward(Options , const Forward );
3c0ef626	159
3c0ef626	160	#endif /* READCONF_H */