[openssh.git] / readconf.h

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

/* RCSID("$OpenBSD: readconf.h,v 1.23 2000/11/12 19:50:37 markus Exp $"); */

#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. */
	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_authentication;	/* Try rhosts authentication. */
	int     rhosts_rsa_authentication;	/* Try rhosts with RSA
						 * authentication. */
	int     rsa_authentication;	/* Try RSA authentication. */
	int     pubkey_authentication;	/* Try ssh2 pubkey 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     kbd_interactive_authentication; /* Try keyboard-interactive auth. */
	char	*kbd_interactive_devices; /* Keyboard-interactive auth devices. */
	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;	/* SSH2 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. */
	char   *system_hostfile2;
	char   *user_hostfile2;

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