[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.38 2001/09/03 20:58:33 stevesk Exp $"); */

#ifndef READCONF_H
#define READCONF_H

#include "key.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     hostbased_authentication;	/* ssh2's rhosts_rsa */
	int     challenge_response_authentication;
					/* Try S/Key or TIS, authentication. */
#if defined(KRB4) || defined(KRB5)
	int     kerberos_authentication;	/* Try Kerberos authentication. */
#endif
#if defined(AFS) || defined(KRB5)
	int     kerberos_tgt_passing;	/* Try Kerberos TGT passing. */
#endif
#ifdef AFS
	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. */
	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_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     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];
}       Options;


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

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

void	 add_local_forward(Options *, u_short, const char *, u_short);
void	 add_remote_forward(Options *, u_short, const char *, u_short);

#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
93111dfa	14	/* RCSID("$OpenBSD: readconf.h,v 1.38 2001/09/03 20:58:33 stevesk Exp $"); */
8efc0c15	15
	16	#ifndef READCONF_H
	17	#define READCONF_H
	18
fee56204	19	#include "key.h"
fee56204	20
8efc0c15	21	/* Data structure for representing a forwarding request. */
8efc0c15	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. */
fa649821	33	char xauth_location; / Location for xauth program */
5260325f	34	int gateway_ports; /* Allow remote connects to forwarded ports. */
	35	int use_privileged_port; /* Don't use privileged port if false. */
	36	int rhosts_authentication; /* Try rhosts authentication. */
	37	int rhosts_rsa_authentication; /* Try rhosts with RSA
	38	* authentication. */
	39	int rsa_authentication; /* Try RSA authentication. */
fa08c86b	40	int pubkey_authentication; /* Try ssh2 pubkey authentication. */
8002af61	41	int hostbased_authentication; /* ssh2's rhosts_rsa */
5ba55ada	42	int challenge_response_authentication;
d464095c	43	/* Try S/Key or TIS, authentication. */
ced49be2	44	#if defined(KRB4) \|\| defined(KRB5)
	45	int kerberos_authentication; /* Try Kerberos authentication. */
	46	#endif
	47	#if defined(AFS) \|\| defined(KRB5)
	48	int kerberos_tgt_passing; /* Try Kerberos TGT passing. */
8efc0c15	49	#endif
8efc0c15	50	#ifdef AFS
5260325f	51	int afs_token_passing; /* Try AFS token passing. */
8efc0c15	52	#endif
5260325f	53	int password_authentication; /* Try password
5260325f	54	* authentication. */
94ec8c6b	55	int kbd_interactive_authentication; /* Try keyboard-interactive auth. */
94ec8c6b	56	char kbd_interactive_devices; / Keyboard-interactive auth devices. */
5260325f	57	int fallback_to_rsh;/* Use rsh if cannot connect with ssh. */
	58	int use_rsh; /* Always use rsh (don\'t try ssh). */
	59	int batch_mode; /* Batch mode: do not ask for passwords. */
	60	int check_host_ip; /* Also keep track of keys for IP address */
	61	int strict_host_key_checking; /* Strict host key checking. */
	62	int compression; /* Compress packets in both directions. */
	63	int compression_level; /* Compression level 1 (fast) to 9
	64	* (best). */
	65	int keepalives; /* Set SO_KEEPALIVE. */
	66	LogLevel log_level; /* Level for logging. */
	67
	68	int port; /* Port to connect. */
	69	int connection_attempts; /* Max attempts (seconds) before
	70	* giving up */
	71	int number_of_password_prompts; /* Max number of password
	72	* prompts. */
	73	int cipher; /* Cipher to use. */
d0c832f3	74	char ciphers; / SSH2 ciphers in order of preference. */
b2552997	75	char macs; / SSH2 macs in order of preference. */
e961a8f9	76	char hostkeyalgorithms; / SSH2 server key types in order of preference. */
a8be9f80	77	int protocol; /* Protocol in order of preference. */
5260325f	78	char hostname; / Real host to connect. */
8abcdba4	79	char host_key_alias; / hostname alias for .ssh/known_hosts */
5260325f	80	char proxy_command; / Proxy command for connecting the host. */
	81	char user; / User to log in as. */
	82	int escape_char; /* Escape character; -2 = none */
	83
	84	char system_hostfile;/ Path for /etc/ssh_known_hosts. */
	85	char user_hostfile; / Path for $HOME/.ssh/known_hosts. */
a306f2dd	86	char *system_hostfile2;
a306f2dd	87	char *user_hostfile2;
cab80f75	88	char *preferred_authentications;
3435f5a6	89	char bind_address; / local socket address for connection to sshd */
9ff6f66f	90	char smartcard_device; / Smartcard reader device */
5260325f	91
fa08c86b	92	int num_identity_files; /* Number of files for RSA/DSA identities. */
5260325f	93	char *identity_files[SSH_MAX_IDENTITY_FILES];
fee56204	94	Key *identity_keys[SSH_MAX_IDENTITY_FILES];
5260325f	95
	96	/* Local TCP/IP forward requests. */
	97	int num_local_forwards;
	98	Forward local_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
	99
	100	/* Remote TCP/IP forward requests. */
	101	int num_remote_forwards;
	102	Forward remote_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
	103	} Options;
8efc0c15	104
8efc0c15	105
255cabd9	106	void initialize_options(Options *);
255cabd9	107	void fill_default_options(Options *);
93111dfa	108	int read_config_file(const char , const char , Options *);
8efc0c15	109
6ae2364d	110	int
2a1e4639	111	process_config_line(Options , const char , char , const char , int, int *);
8efc0c15	112
255cabd9	113	void add_local_forward(Options , u_short, const char , u_short);
255cabd9	114	void add_remote_forward(Options , u_short, const char , u_short);
8efc0c15	115
5260325f	116	#endif /* READCONF_H */