xref: /netbsd-src/crypto/external/bsd/openssh/dist/readconf.h (revision 6fc217346bb51c463d3a5a2a7883cb56515cd6d7)
1 /*	$NetBSD: readconf.h,v 1.3 2009/12/27 01:40:47 christos Exp $	*/
2 /* $OpenBSD: readconf.h,v 1.79 2009/06/27 09:35:06 andreas 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 }       Forward;
28 /* Data structure for representing option data. */
29 
30 #define MAX_SEND_ENV	256
31 
32 typedef struct {
33 	int     forward_agent;	/* Forward authentication agent. */
34 	int     forward_x11;	/* Forward X11 display. */
35 	int     forward_x11_trusted;	/* Trust Forward X11 display. */
36 	int     exit_on_forward_failure;	/* Exit if bind(2) fails for -L/-R */
37 	char   *xauth_location;	/* Location for xauth program */
38 	int     gateway_ports;	/* Allow remote connects to forwarded ports. */
39 	int     use_privileged_port;	/* Don't use privileged port if false. */
40 	int     rhosts_rsa_authentication;	/* Try rhosts with RSA
41 						 * authentication. */
42 	int     rsa_authentication;	/* Try RSA authentication. */
43 	int     pubkey_authentication;	/* Try ssh2 pubkey authentication. */
44 	int     hostbased_authentication;	/* ssh2's rhosts_rsa */
45 	int     challenge_response_authentication;
46 #if defined(KRB4) || defined(KRB5)
47 	int     kerberos_authentication;	/* Try Kerberos authentication. */
48 #endif
49 #if defined(AFS) || defined(KRB5)
50 	int     kerberos_tgt_passing;	/* Try Kerberos TGT passing. */
51 #endif
52 #ifdef AFS
53 	int     afs_token_passing;	/* Try AFS token passing. */
54 #endif
55 					/* Try S/Key or TIS, authentication. */
56 	int     gss_authentication;	/* Try GSS authentication */
57 	int     gss_deleg_creds;	/* Delegate GSS credentials */
58 	int     password_authentication;	/* Try password
59 						 * authentication. */
60 	int     kbd_interactive_authentication; /* Try keyboard-interactive auth. */
61 	char	*kbd_interactive_devices; /* Keyboard-interactive auth devices. */
62 	int     zero_knowledge_password_authentication;	/* Try jpake */
63 	int     batch_mode;	/* Batch mode: do not ask for passwords. */
64 	int     check_host_ip;	/* Also keep track of keys for IP address */
65 	int     strict_host_key_checking;	/* Strict host key checking. */
66 	int     compression;	/* Compress packets in both directions. */
67 	int     compression_level;	/* Compression level 1 (fast) to 9
68 					 * (best). */
69 	int     tcp_keep_alive;	/* Set SO_KEEPALIVE. */
70 	int     tcp_rcv_buf; /* user switch to set tcp recv buffer */
71 	int	tcp_rcv_buf_poll; /* Option to poll recv buf every window transfer */
72 	int 	hpn_disabled; 	 /* Switch to disable HPN buffer management */
73 	int	hpn_buffer_size; /* User definable size for HPN buffer window */
74 
75 	LogLevel log_level;	/* Level for logging. */
76 
77 	int     port;		/* Port to connect. */
78 	int     address_family;
79 	int     connection_attempts;	/* Max attempts (seconds) before
80 					 * giving up */
81 	int     connection_timeout;	/* Max time (seconds) before
82 					 * aborting connection attempt */
83 	int     number_of_password_prompts;	/* Max number of password
84 						 * prompts. */
85 	int     cipher;		/* Cipher to use. */
86 	char   *ciphers;	/* SSH2 ciphers in order of preference. */
87 	char   *macs;		/* SSH2 macs in order of preference. */
88 	char   *hostkeyalgorithms;	/* SSH2 server key types in order of preference. */
89 	int	protocol;	/* Protocol in order of preference. */
90 	char   *hostname;	/* Real host to connect. */
91 	char   *host_key_alias;	/* hostname alias for .ssh/known_hosts */
92 	char   *proxy_command;	/* Proxy command for connecting the host. */
93 	char   *user;		/* User to log in as. */
94 	int     escape_char;	/* Escape character; -2 = none */
95 
96 	char   *system_hostfile;/* Path for /etc/ssh/ssh_known_hosts. */
97 	char   *user_hostfile;	/* Path for $HOME/.ssh/known_hosts. */
98 	char   *system_hostfile2;
99 	char   *user_hostfile2;
100 	char   *preferred_authentications;
101 	char   *bind_address;	/* local socket address for connection to sshd */
102 	char   *smartcard_device; /* Smartcard reader device */
103 	int	verify_host_key_dns;	/* Verify host key using DNS */
104 
105 	int     num_identity_files;	/* Number of files for RSA/DSA identities. */
106 	char   *identity_files[SSH_MAX_IDENTITY_FILES];
107 	Key    *identity_keys[SSH_MAX_IDENTITY_FILES];
108 
109 	/* Local TCP/IP forward requests. */
110 	int     num_local_forwards;
111 	Forward local_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
112 
113 	/* Remote TCP/IP forward requests. */
114 	int     num_remote_forwards;
115 	Forward remote_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
116 	int	clear_forwardings;
117 
118 	int	enable_ssh_keysign;
119 	int64_t rekey_limit;
120 	int     none_switch;    /* Use none cipher */
121 	int     none_enabled;   /* Allow none to be used */
122 	int	no_host_authentication_for_localhost;
123 	int	identities_only;
124 	int	server_alive_interval;
125 	int	server_alive_count_max;
126 
127 	int     num_send_env;
128 	char   *send_env[MAX_SEND_ENV];
129 
130 	char	*control_path;
131 	int	control_master;
132 
133 	int	hash_known_hosts;
134 
135 	int	tun_open;	/* tun(4) */
136 	int     tun_local;	/* force tun device (optional) */
137 	int     tun_remote;	/* force tun device (optional) */
138 
139 	char	*local_command;
140 	int	permit_local_command;
141 	int	visual_host_key;
142 
143 	int	use_roaming;
144 
145 }       Options;
146 
147 #define SSHCTL_MASTER_NO	0
148 #define SSHCTL_MASTER_YES	1
149 #define SSHCTL_MASTER_AUTO	2
150 #define SSHCTL_MASTER_ASK	3
151 #define SSHCTL_MASTER_AUTO_ASK	4
152 
153 void     initialize_options(Options *);
154 void     fill_default_options(Options *);
155 int	 read_config_file(const char *, const char *, Options *, int);
156 int	 parse_forward(Forward *, const char *, int, int);
157 
158 int
159 process_config_line(Options *, const char *, char *, const char *, int, int *);
160 
161 void	 add_local_forward(Options *, const Forward *);
162 void	 add_remote_forward(Options *, const Forward *);
163 
164 #endif				/* READCONF_H */
165