[openssh.git] / readconf.h

/*
 * 
 * readconf.h
 * 
 * Author: Tatu Ylonen <ylo@cs.hut.fi>
 * 
 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
 *                    All rights reserved
 * 
 * Created: Sat Apr 22 00:25:29 1995 ylo
 * 
 * Functions for reading the configuration file.
 * 
 */

/* RCSID("$Id$"); */

#ifndef READCONF_H
#define READCONF_H

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

typedef struct {
	u_short	  port;		/* Port to forward. */
	char	 *host;		/* Host to connect. */
	u_short	  host_port;	/* Port to connect on host. */
}       Forward;
/* Data structure for representing option data. */

typedef struct {
	int     forward_agent;	/* Forward authentication agent. */
	int     forward_x11;	/* Forward X11 display. */
	int     gateway_ports;	/* Allow remote connects to forwarded ports. */
	int     use_privileged_port;	/* Don't use privileged port if false. */
	int     rhosts_authentication;	/* Try rhosts authentication. */
	int     rhosts_rsa_authentication;	/* Try rhosts with RSA
						 * authentication. */
	int     rsa_authentication;	/* Try RSA authentication. */
	int     skey_authentication;	/* Try S/Key or TIS authentication. */
#ifdef KRB4
	int     kerberos_authentication;	/* Try Kerberos
						 * authentication. */
#endif
#ifdef AFS
	int     kerberos_tgt_passing;	/* Try Kerberos tgt passing. */
	int     afs_token_passing;	/* Try AFS token passing. */
#endif
	int     password_authentication;	/* Try password
						 * authentication. */
	int     fallback_to_rsh;/* Use rsh if cannot connect with ssh. */
	int     use_rsh;	/* Always use rsh (don\'t try ssh). */
	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     keepalives;	/* Set SO_KEEPALIVE. */
	LogLevel log_level;	/* Level for logging. */

	int     port;		/* Port to connect. */
	int     connection_attempts;	/* Max attempts (seconds) before
					 * giving up */
	int     number_of_password_prompts;	/* Max number of password
						 * prompts. */
	int     cipher;		/* Cipher to use. */
	char   *ciphers;	/* Ciphers in order of preference. */
	int	protocol;	/* Protocol in order of preference. */
	char   *hostname;	/* Real host to connect. */
	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_known_hosts. */
	char   *user_hostfile;	/* Path for $HOME/.ssh/known_hosts. */

	int     num_identity_files;	/* Number of files for RSA identities. */
	char   *identity_files[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];
}       Options;


/*
 * Initializes options to special values that indicate that they have not yet
 * been set.  Read_config_file will only set options with this value. Options
 * are processed in the following order: command line, user config file,
 * system config file.  Last, fill_default_options is called.
 */
void    initialize_options(Options * options);

/*
 * Called after processing other sources of option data, this fills those
 * options for which no value has been specified with their default values.
 */
void    fill_default_options(Options * options);

/*
 * Processes a single option line as used in the configuration files. This
 * only sets those values that have not already been set. Returns 0 for legal
 * options
 */
int 
process_config_line(Options * options, const char *host,
    char *line, const char *filename, int linenum,
    int *activep);

/*
 * Reads the config file and modifies the options accordingly.  Options
 * should already be initialized before this call.  This never returns if
 * there is an error.  If the file does not exist, this returns immediately.
 */
void 
read_config_file(const char *filename, const char *host,
    Options * options);

/*
 * Adds a local TCP/IP port forward to options.  Never returns if there is an
 * error.
 */
void 
add_local_forward(Options * options, u_short port, const char *host,
    u_short host_port);

/*
 * Adds a remote TCP/IP port forward to options.  Never returns if there is
 * an error.
 */
void 
add_remote_forward(Options * options, u_short port, const char *host,
    u_short host_port);

#endif				/* READCONF_H */
Commit	Line	Data
8efc0c15	1	/*
5260325f	2	*
	3	* readconf.h
	4	*
	5	* Author: Tatu Ylonen <ylo@cs.hut.fi>
	6	*
	7	* Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
	8	* All rights reserved
	9	*
	10	* Created: Sat Apr 22 00:25:29 1995 ylo
	11	*
	12	* Functions for reading the configuration file.
	13	*
	14	*/
8efc0c15	15
	16	/* RCSID("$Id$"); */
	17
	18	#ifndef READCONF_H
	19	#define READCONF_H
	20
	21	/* Data structure for representing a forwarding request. */
	22
5260325f	23	typedef struct {
57112b5a	24	u_short port; /* Port to forward. */
	25	char host; / Host to connect. */
	26	u_short host_port; /* Port to connect on host. */
5260325f	27	} Forward;
8efc0c15	28	/* Data structure for representing option data. */
8efc0c15	29
5260325f	30	typedef struct {
	31	int forward_agent; /* Forward authentication agent. */
	32	int forward_x11; /* Forward X11 display. */
	33	int gateway_ports; /* Allow remote connects to forwarded ports. */
	34	int use_privileged_port; /* Don't use privileged port if false. */
	35	int rhosts_authentication; /* Try rhosts authentication. */
	36	int rhosts_rsa_authentication; /* Try rhosts with RSA
	37	* authentication. */
	38	int rsa_authentication; /* Try RSA authentication. */
	39	int skey_authentication; /* Try S/Key or TIS authentication. */
8efc0c15	40	#ifdef KRB4
5260325f	41	int kerberos_authentication; /* Try Kerberos
5260325f	42	* authentication. */
8efc0c15	43	#endif
8efc0c15	44	#ifdef AFS
5260325f	45	int kerberos_tgt_passing; /* Try Kerberos tgt passing. */
5260325f	46	int afs_token_passing; /* Try AFS token passing. */
8efc0c15	47	#endif
5260325f	48	int password_authentication; /* Try password
	49	* authentication. */
	50	int fallback_to_rsh;/* Use rsh if cannot connect with ssh. */
	51	int use_rsh; /* Always use rsh (don\'t try ssh). */
	52	int batch_mode; /* Batch mode: do not ask for passwords. */
	53	int check_host_ip; /* Also keep track of keys for IP address */
	54	int strict_host_key_checking; /* Strict host key checking. */
	55	int compression; /* Compress packets in both directions. */
	56	int compression_level; /* Compression level 1 (fast) to 9
	57	* (best). */
	58	int keepalives; /* Set SO_KEEPALIVE. */
	59	LogLevel log_level; /* Level for logging. */
	60
	61	int port; /* Port to connect. */
	62	int connection_attempts; /* Max attempts (seconds) before
	63	* giving up */
	64	int number_of_password_prompts; /* Max number of password
	65	* prompts. */
	66	int cipher; /* Cipher to use. */
a8be9f80	67	char ciphers; / Ciphers in order of preference. */
a8be9f80	68	int protocol; /* Protocol in order of preference. */
5260325f	69	char hostname; / Real host to connect. */
	70	char proxy_command; / Proxy command for connecting the host. */
	71	char user; / User to log in as. */
	72	int escape_char; /* Escape character; -2 = none */
	73
	74	char system_hostfile;/ Path for /etc/ssh_known_hosts. */
	75	char user_hostfile; / Path for $HOME/.ssh/known_hosts. */
	76
	77	int num_identity_files; /* Number of files for RSA identities. */
	78	char *identity_files[SSH_MAX_IDENTITY_FILES];
	79
	80	/* Local TCP/IP forward requests. */
	81	int num_local_forwards;
	82	Forward local_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
	83
	84	/* Remote TCP/IP forward requests. */
	85	int num_remote_forwards;
	86	Forward remote_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
	87	} Options;
8efc0c15	88
8efc0c15	89
aa3378df	90	/*
	91	* Initializes options to special values that indicate that they have not yet
	92	* been set. Read_config_file will only set options with this value. Options
	93	* are processed in the following order: command line, user config file,
	94	* system config file. Last, fill_default_options is called.
	95	*/
5260325f	96	void initialize_options(Options * options);
8efc0c15	97
aa3378df	98	/*
	99	* Called after processing other sources of option data, this fills those
	100	* options for which no value has been specified with their default values.
	101	*/
5260325f	102	void fill_default_options(Options * options);
8efc0c15	103
aa3378df	104	/*
	105	* Processes a single option line as used in the configuration files. This
	106	* only sets those values that have not already been set. Returns 0 for legal
	107	* options
	108	*/
5260325f	109	int
	110	process_config_line(Options * options, const char *host,
	111	char line, const char filename, int linenum,
	112	int *activep);
8efc0c15	113
aa3378df	114	/*
	115	* Reads the config file and modifies the options accordingly. Options
	116	* should already be initialized before this call. This never returns if
	117	* there is an error. If the file does not exist, this returns immediately.
	118	*/
5260325f	119	void
	120	read_config_file(const char filename, const char host,
	121	Options * options);
8efc0c15	122
aa3378df	123	/*
	124	* Adds a local TCP/IP port forward to options. Never returns if there is an
	125	* error.
	126	*/
5260325f	127	void
57112b5a	128	add_local_forward(Options * options, u_short port, const char *host,
57112b5a	129	u_short host_port);
8efc0c15	130
aa3378df	131	/*
	132	* Adds a remote TCP/IP port forward to options. Never returns if there is
	133	* an error.
	134	*/
5260325f	135	void
57112b5a	136	add_remote_forward(Options * options, u_short port, const char *host,
57112b5a	137	u_short host_port);
8efc0c15	138
5260325f	139	#endif /* READCONF_H */