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

/*	$OpenBSD: readconf.h,v 1.68 2005/12/06 22:38:27 reyk 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

#include "key.h"

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

typedef struct {
	char	 *listen_host;		/* Host (address) to listen on. */
	u_short	  listen_port;		/* Port to forward. */
	char	 *connect_host;		/* Host to connect. */
	u_short	  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. */
	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;
	int     gss_deleg_creds;	/* Delegate GSS credentials */
	int	gss_trust_dns;		/* Trust DNS for GSS canonicalization */
	int     password_authentication;	/* Try password
						 * authentication. */
	int     kbd_interactive_authentication; /* Try keyboard-interactive auth. */
	char	*kbd_interactive_devices; /* Keyboard-interactive auth devices. */
	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 */
	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;
	int	rekey_limit;
	int	none_switch;
	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;

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