readconf.h revision 204917 
1/* $OpenBSD: readconf.h,v 1.82 2010/02/08 10:50:20 markus Exp $ */
2
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
16#ifndef READCONF_H
17#define READCONF_H
18
19/* Data structure for representing a forwarding request. */
20
21typedef struct {
22	char	 *listen_host;		/* Host (address) to listen on. */
23	int	  listen_port;		/* Port to forward. */
24	char	 *connect_host;		/* Host to connect. */
25	int	  connect_port;		/* Port to connect on connect_host. */
26}       Forward;
27/* Data structure for representing option data. */
28
29#define MAX_SEND_ENV	256
30
31typedef struct {
32	int     forward_agent;	/* Forward authentication agent. */
33	int     forward_x11;	/* Forward X11 display. */
34	int     forward_x11_trusted;	/* Trust Forward X11 display. */
35	int     exit_on_forward_failure;	/* Exit if bind(2) fails for -L/-R */
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. */
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. */
46	int     gss_authentication;	/* Try GSS authentication */
47	int     gss_deleg_creds;	/* Delegate GSS credentials */
48	int     password_authentication;	/* Try password
49						 * authentication. */
50	int     kbd_interactive_authentication; /* Try keyboard-interactive auth. */
51	char	*kbd_interactive_devices; /* Keyboard-interactive auth devices. */
52	int     zero_knowledge_password_authentication;	/* Try jpake */
53	int     batch_mode;	/* Batch mode: do not ask for passwords. */
54	int     check_host_ip;	/* Also keep track of keys for IP address */
55	int     strict_host_key_checking;	/* Strict host key checking. */
56	int     compression;	/* Compress packets in both directions. */
57	int     compression_level;	/* Compression level 1 (fast) to 9
58					 * (best). */
59	int     tcp_keep_alive;	/* Set SO_KEEPALIVE. */
60	LogLevel log_level;	/* Level for logging. */
61
62	int     port;		/* Port to connect. */
63	int     address_family;
64	int     connection_attempts;	/* Max attempts (seconds) before
65					 * giving up */
66	int     connection_timeout;	/* Max time (seconds) before
67					 * aborting connection attempt */
68	int     number_of_password_prompts;	/* Max number of password
69						 * prompts. */
70	int     cipher;		/* Cipher to use. */
71	char   *ciphers;	/* SSH2 ciphers in order of preference. */
72	char   *macs;		/* SSH2 macs in order of preference. */
73	char   *hostkeyalgorithms;	/* SSH2 server key types in order of preference. */
74	int	protocol;	/* Protocol in order of preference. */
75	char   *hostname;	/* Real host to connect. */
76	char   *host_key_alias;	/* hostname alias for .ssh/known_hosts */
77	char   *proxy_command;	/* Proxy command for connecting the host. */
78	char   *user;		/* User to log in as. */
79	int     escape_char;	/* Escape character; -2 = none */
80
81	char   *system_hostfile;/* Path for /etc/ssh/ssh_known_hosts. */
82	char   *user_hostfile;	/* Path for $HOME/.ssh/known_hosts. */
83	char   *system_hostfile2;
84	char   *user_hostfile2;
85	char   *preferred_authentications;
86	char   *bind_address;	/* local socket address for connection to sshd */
87	char   *pkcs11_provider; /* PKCS#11 provider */
88	int	verify_host_key_dns;	/* Verify host key using DNS */
89
90	int     num_identity_files;	/* Number of files for RSA/DSA identities. */
91	char   *identity_files[SSH_MAX_IDENTITY_FILES];
92	Key    *identity_keys[SSH_MAX_IDENTITY_FILES];
93
94	/* Local TCP/IP forward requests. */
95	int     num_local_forwards;
96	Forward local_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
97
98	/* Remote TCP/IP forward requests. */
99	int     num_remote_forwards;
100	Forward remote_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
101	int	clear_forwardings;
102
103	int	enable_ssh_keysign;
104	int64_t rekey_limit;
105	int	no_host_authentication_for_localhost;
106	int	identities_only;
107	int	server_alive_interval;
108	int	server_alive_count_max;
109
110	int     num_send_env;
111	char   *send_env[MAX_SEND_ENV];
112
113	char	*control_path;
114	int	control_master;
115
116	int	hash_known_hosts;
117
118	int	tun_open;	/* tun(4) */
119	int     tun_local;	/* force tun device (optional) */
120	int     tun_remote;	/* force tun device (optional) */
121
122	char	*local_command;
123	int	permit_local_command;
124	int	visual_host_key;
125
126	int	use_roaming;
127
128}       Options;
129
130#define SSHCTL_MASTER_NO	0
131#define SSHCTL_MASTER_YES	1
132#define SSHCTL_MASTER_AUTO	2
133#define SSHCTL_MASTER_ASK	3
134#define SSHCTL_MASTER_AUTO_ASK	4
135
136void     initialize_options(Options *);
137void     fill_default_options(Options *);
138int	 read_config_file(const char *, const char *, Options *, int);
139int	 parse_forward(Forward *, const char *, int, int);
140
141int
142process_config_line(Options *, const char *, char *, const char *, int, int *);
143
144void	 add_local_forward(Options *, const Forward *);
145void	 add_remote_forward(Options *, const Forward *);
146
147#endif				/* READCONF_H */
148