xref: /netbsd-src/crypto/external/bsd/openssh/dist/readconf.h (revision a5847cc334d9a7029f6352b847e9e8d71a0f9e0c)
1 /*	$NetBSD: readconf.h,v 1.6 2011/09/07 17:49:19 christos Exp $	*/
2 /* $OpenBSD: readconf.h,v 1.90 2011/05/24 07:15:47 djm Exp $ */
3 
4 /*
5  * Author: Tatu Ylonen <ylo@cs.hut.fi>
6  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
7  *                    All rights reserved
8  * Functions for reading the configuration file.
9  *
10  * As far as I am concerned, the code I have written for this software
11  * can be used freely for any purpose.  Any derived versions of this
12  * software must be clearly marked as such, and if the derived work is
13  * incompatible with the protocol description in the RFC file, it must be
14  * called by a name other than "ssh" or "Secure Shell".
15  */
16 
17 #ifndef READCONF_H
18 #define READCONF_H
19 
20 /* Data structure for representing a forwarding request. */
21 
22 typedef struct {
23 	char	 *listen_host;		/* Host (address) to listen on. */
24 	int	  listen_port;		/* Port to forward. */
25 	char	 *connect_host;		/* Host to connect. */
26 	int	  connect_port;		/* Port to connect on connect_host. */
27 	int	  allocated_port;	/* Dynamically allocated listen port */
28 }       Forward;
29 /* Data structure for representing option data. */
30 
31 #define MAX_SEND_ENV		256
32 #define SSH_MAX_HOSTS_FILES	256
33 
34 typedef struct {
35 	int     forward_agent;	/* Forward authentication agent. */
36 	int     forward_x11;	/* Forward X11 display. */
37 	int     forward_x11_timeout;	/* Expiration for Cookies */
38 	int     forward_x11_trusted;	/* Trust Forward X11 display. */
39 	int     exit_on_forward_failure;	/* Exit if bind(2) fails for -L/-R */
40 	char   *xauth_location;	/* Location for xauth program */
41 	int     gateway_ports;	/* Allow remote connects to forwarded ports. */
42 	int     use_privileged_port;	/* Don't use privileged port if false. */
43 	int     rhosts_rsa_authentication;	/* Try rhosts with RSA
44 						 * authentication. */
45 	int     rsa_authentication;	/* Try RSA authentication. */
46 	int     pubkey_authentication;	/* Try ssh2 pubkey authentication. */
47 	int     hostbased_authentication;	/* ssh2's rhosts_rsa */
48 	int     challenge_response_authentication;
49 #if defined(KRB4) || defined(KRB5)
50 	int     kerberos_authentication;	/* Try Kerberos authentication. */
51 #endif
52 #if defined(AFS) || defined(KRB5)
53 	int     kerberos_tgt_passing;	/* Try Kerberos TGT passing. */
54 #endif
55 #ifdef AFS
56 	int     afs_token_passing;	/* Try AFS token passing. */
57 #endif
58 					/* Try S/Key or TIS, authentication. */
59 	int     gss_authentication;	/* Try GSS authentication */
60 	int     gss_deleg_creds;	/* Delegate GSS credentials */
61 	int     password_authentication;	/* Try password
62 						 * authentication. */
63 	int     kbd_interactive_authentication; /* Try keyboard-interactive auth. */
64 	char	*kbd_interactive_devices; /* Keyboard-interactive auth devices. */
65 	int     zero_knowledge_password_authentication;	/* Try jpake */
66 	int     batch_mode;	/* Batch mode: do not ask for passwords. */
67 	int     check_host_ip;	/* Also keep track of keys for IP address */
68 	int     strict_host_key_checking;	/* Strict host key checking. */
69 	int     compression;	/* Compress packets in both directions. */
70 	int     compression_level;	/* Compression level 1 (fast) to 9
71 					 * (best). */
72 	int     tcp_keep_alive;	/* Set SO_KEEPALIVE. */
73 	int	ip_qos_interactive;	/* IP ToS/DSCP/class for interactive */
74 	int	ip_qos_bulk;		/* IP ToS/DSCP/class for bulk traffic */
75 	int     tcp_rcv_buf; /* user switch to set tcp recv buffer */
76 	int	tcp_rcv_buf_poll; /* Option to poll recv buf every window transfer */
77 	int 	hpn_disabled; 	 /* Switch to disable HPN buffer management */
78 	int	hpn_buffer_size; /* User definable size for HPN buffer window */
79 
80 	LogLevel log_level;	/* Level for logging. */
81 
82 	int     port;		/* Port to connect. */
83 	int     address_family;
84 	int     connection_attempts;	/* Max attempts (seconds) before
85 					 * giving up */
86 	int     connection_timeout;	/* Max time (seconds) before
87 					 * aborting connection attempt */
88 	int     number_of_password_prompts;	/* Max number of password
89 						 * prompts. */
90 	int     cipher;		/* Cipher to use. */
91 	char   *ciphers;	/* SSH2 ciphers in order of preference. */
92 	char   *macs;		/* SSH2 macs in order of preference. */
93 	char   *hostkeyalgorithms;	/* SSH2 server key types in order of preference. */
94 	char   *kex_algorithms;	/* SSH2 kex methods in order of preference. */
95 	int	protocol;	/* Protocol in order of preference. */
96 	char   *hostname;	/* Real host to connect. */
97 	char   *host_key_alias;	/* hostname alias for .ssh/known_hosts */
98 	char   *proxy_command;	/* Proxy command for connecting the host. */
99 	char   *user;		/* User to log in as. */
100 	int     escape_char;	/* Escape character; -2 = none */
101 
102 	u_int	num_system_hostfiles;	/* Paths for /etc/ssh/ssh_known_hosts */
103 	char   *system_hostfiles[SSH_MAX_HOSTS_FILES];
104 	u_int	num_user_hostfiles;	/* Path for $HOME/.ssh/known_hosts */
105 	char   *user_hostfiles[SSH_MAX_HOSTS_FILES];
106 	char   *preferred_authentications;
107 	char   *bind_address;	/* local socket address for connection to sshd */
108 	char   *pkcs11_provider; /* PKCS#11 provider */
109 	int	verify_host_key_dns;	/* Verify host key using DNS */
110 
111 	int     num_identity_files;	/* Number of files for RSA/DSA identities. */
112 	char   *identity_files[SSH_MAX_IDENTITY_FILES];
113 	Key    *identity_keys[SSH_MAX_IDENTITY_FILES];
114 
115 	/* Local TCP/IP forward requests. */
116 	int     num_local_forwards;
117 	Forward *local_forwards;
118 
119 	/* Remote TCP/IP forward requests. */
120 	int     num_remote_forwards;
121 	Forward *remote_forwards;
122 	int	clear_forwardings;
123 
124 	int	enable_ssh_keysign;
125 	int64_t rekey_limit;
126 	int     none_switch;    /* Use none cipher */
127 	int     none_enabled;   /* Allow none to be used */
128 	int	no_host_authentication_for_localhost;
129 	int	identities_only;
130 	int	server_alive_interval;
131 	int	server_alive_count_max;
132 
133 	int     num_send_env;
134 	char   *send_env[MAX_SEND_ENV];
135 
136 	char	*control_path;
137 	int	control_master;
138 	int     control_persist; /* ControlPersist flag */
139 	int     control_persist_timeout; /* ControlPersist timeout (seconds) */
140 
141 	int	hash_known_hosts;
142 
143 	int	tun_open;	/* tun(4) */
144 	int     tun_local;	/* force tun device (optional) */
145 	int     tun_remote;	/* force tun device (optional) */
146 
147 	char	*local_command;
148 	int	permit_local_command;
149 	int	visual_host_key;
150 
151 	int	use_roaming;
152 
153 	int	request_tty;
154 }       Options;
155 
156 #define SSHCTL_MASTER_NO	0
157 #define SSHCTL_MASTER_YES	1
158 #define SSHCTL_MASTER_AUTO	2
159 #define SSHCTL_MASTER_ASK	3
160 #define SSHCTL_MASTER_AUTO_ASK	4
161 
162 #define REQUEST_TTY_AUTO	0
163 #define REQUEST_TTY_NO		1
164 #define REQUEST_TTY_YES		2
165 #define REQUEST_TTY_FORCE	3
166 
167 void     initialize_options(Options *);
168 void     fill_default_options(Options *);
169 int	 read_config_file(const char *, const char *, Options *, int);
170 int	 parse_forward(Forward *, const char *, int, int);
171 
172 int
173 process_config_line(Options *, const char *, char *, const char *, int, int *);
174 
175 void	 add_local_forward(Options *, const Forward *);
176 void	 add_remote_forward(Options *, const Forward *);
177 
178 #endif				/* READCONF_H */
179