readconf.h revision 215116 
1/* $OpenBSD: readconf.h,v 1.86 2010/07/19 09:15:12 djm 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	int	  allocated_port;	/* Dynamically allocated listen port */
27}       Forward;
28/* Data structure for representing option data. */
29
30#define MAX_SEND_ENV	256
31
32typedef struct {
33	int     forward_agent;	/* Forward authentication agent. */
34	int     forward_x11;	/* Forward X11 display. */
35	int     forward_x11_timeout;	/* Expiration for Cookies */
36	int     forward_x11_trusted;	/* Trust Forward X11 display. */
37	int     exit_on_forward_failure;	/* Exit if bind(2) fails for -L/-R */
38	char   *xauth_location;	/* Location for xauth program */
39	int     gateway_ports;	/* Allow remote connects to forwarded ports. */
40	int     use_privileged_port;	/* Don't use privileged port if false. */
41	int     rhosts_rsa_authentication;	/* Try rhosts with RSA
42						 * authentication. */
43	int     rsa_authentication;	/* Try RSA authentication. */
44	int     pubkey_authentication;	/* Try ssh2 pubkey authentication. */
45	int     hostbased_authentication;	/* ssh2's rhosts_rsa */
46	int     challenge_response_authentication;
47					/* Try S/Key or TIS, authentication. */
48	int     gss_authentication;	/* Try GSS authentication */
49	int     gss_deleg_creds;	/* Delegate GSS credentials */
50	int     password_authentication;	/* Try password
51						 * authentication. */
52	int     kbd_interactive_authentication; /* Try keyboard-interactive auth. */
53	char	*kbd_interactive_devices; /* Keyboard-interactive auth devices. */
54	int     zero_knowledge_password_authentication;	/* Try jpake */
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). */
61	int     tcp_keep_alive;	/* Set SO_KEEPALIVE. */
62	LogLevel log_level;	/* Level for logging. */
63
64	int     port;		/* Port to connect. */
65	int     address_family;
66	int     connection_attempts;	/* Max attempts (seconds) before
67					 * giving up */
68	int     connection_timeout;	/* Max time (seconds) before
69					 * aborting connection attempt */
70	int     number_of_password_prompts;	/* Max number of password
71						 * prompts. */
72	int     cipher;		/* Cipher to use. */
73	char   *ciphers;	/* SSH2 ciphers in order of preference. */
74	char   *macs;		/* SSH2 macs in order of preference. */
75	char   *hostkeyalgorithms;	/* SSH2 server key types in order of preference. */
76	int	protocol;	/* Protocol in order of preference. */
77	char   *hostname;	/* Real host to connect. */
78	char   *host_key_alias;	/* hostname alias for .ssh/known_hosts */
79	char   *proxy_command;	/* Proxy command for connecting the host. */
80	char   *user;		/* User to log in as. */
81	int     escape_char;	/* Escape character; -2 = none */
82
83	char   *system_hostfile;/* Path for /etc/ssh/ssh_known_hosts. */
84	char   *user_hostfile;	/* Path for $HOME/.ssh/known_hosts. */
85	char   *system_hostfile2;
86	char   *user_hostfile2;
87	char   *preferred_authentications;
88	char   *bind_address;	/* local socket address for connection to sshd */
89	char   *pkcs11_provider; /* PKCS#11 provider */
90	int	verify_host_key_dns;	/* Verify host key using DNS */
91
92	int     num_identity_files;	/* Number of files for RSA/DSA identities. */
93	char   *identity_files[SSH_MAX_IDENTITY_FILES];
94	Key    *identity_keys[SSH_MAX_IDENTITY_FILES];
95
96	/* Local TCP/IP forward requests. */
97	int     num_local_forwards;
98	Forward *local_forwards;
99
100	/* Remote TCP/IP forward requests. */
101	int     num_remote_forwards;
102	Forward *remote_forwards;
103	int	clear_forwardings;
104
105	int	enable_ssh_keysign;
106	int64_t rekey_limit;
107	int	no_host_authentication_for_localhost;
108	int	identities_only;
109	int	server_alive_interval;
110	int	server_alive_count_max;
111
112	int     num_send_env;
113	char   *send_env[MAX_SEND_ENV];
114
115	char	*control_path;
116	int	control_master;
117	int     control_persist; /* ControlPersist flag */
118	int     control_persist_timeout; /* ControlPersist timeout (seconds) */
119
120	int	hash_known_hosts;
121
122	int	tun_open;	/* tun(4) */
123	int     tun_local;	/* force tun device (optional) */
124	int     tun_remote;	/* force tun device (optional) */
125
126	char	*local_command;
127	int	permit_local_command;
128	int	visual_host_key;
129
130	int	use_roaming;
131
132}       Options;
133
134#define SSHCTL_MASTER_NO	0
135#define SSHCTL_MASTER_YES	1
136#define SSHCTL_MASTER_AUTO	2
137#define SSHCTL_MASTER_ASK	3
138#define SSHCTL_MASTER_AUTO_ASK	4
139
140void     initialize_options(Options *);
141void     fill_default_options(Options *);
142int	 read_config_file(const char *, const char *, Options *, int);
143int	 parse_forward(Forward *, const char *, int, int);
144
145int
146process_config_line(Options *, const char *, char *, const char *, int, int *);
147
148void	 add_local_forward(Options *, const Forward *);
149void	 add_remote_forward(Options *, const Forward *);
150
151#endif				/* READCONF_H */
152