xref: /freebsd/crypto/openssh/readconf.h (revision 884a2a699669ec61e2366e3e358342dbc94be24a)
1 /* $OpenBSD: readconf.h,v 1.88 2010/11/13 23:27:50 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 
21 typedef 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 
32 typedef 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 	int	ip_qos_interactive;	/* IP ToS/DSCP/class for interactive */
63 	int	ip_qos_bulk;		/* IP ToS/DSCP/class for bulk traffic */
64 	LogLevel log_level;	/* Level for logging. */
65 
66 	int     port;		/* Port to connect. */
67 	int     address_family;
68 	int     connection_attempts;	/* Max attempts (seconds) before
69 					 * giving up */
70 	int     connection_timeout;	/* Max time (seconds) before
71 					 * aborting connection attempt */
72 	int     number_of_password_prompts;	/* Max number of password
73 						 * prompts. */
74 	int     cipher;		/* Cipher to use. */
75 	char   *ciphers;	/* SSH2 ciphers in order of preference. */
76 	char   *macs;		/* SSH2 macs in order of preference. */
77 	char   *hostkeyalgorithms;	/* SSH2 server key types in order of preference. */
78 	char   *kex_algorithms;	/* SSH2 kex methods in order of preference. */
79 	int	protocol;	/* Protocol in order of preference. */
80 	char   *hostname;	/* Real host to connect. */
81 	char   *host_key_alias;	/* hostname alias for .ssh/known_hosts */
82 	char   *proxy_command;	/* Proxy command for connecting the host. */
83 	char   *user;		/* User to log in as. */
84 	int     escape_char;	/* Escape character; -2 = none */
85 
86 	char   *system_hostfile;/* Path for /etc/ssh/ssh_known_hosts. */
87 	char   *user_hostfile;	/* Path for $HOME/.ssh/known_hosts. */
88 	char   *system_hostfile2;
89 	char   *user_hostfile2;
90 	char   *preferred_authentications;
91 	char   *bind_address;	/* local socket address for connection to sshd */
92 	char   *pkcs11_provider; /* PKCS#11 provider */
93 	int	verify_host_key_dns;	/* Verify host key using DNS */
94 
95 	int     num_identity_files;	/* Number of files for RSA/DSA identities. */
96 	char   *identity_files[SSH_MAX_IDENTITY_FILES];
97 	Key    *identity_keys[SSH_MAX_IDENTITY_FILES];
98 
99 	/* Local TCP/IP forward requests. */
100 	int     num_local_forwards;
101 	Forward *local_forwards;
102 
103 	/* Remote TCP/IP forward requests. */
104 	int     num_remote_forwards;
105 	Forward *remote_forwards;
106 	int	clear_forwardings;
107 
108 	int	enable_ssh_keysign;
109 	int64_t rekey_limit;
110 	int	no_host_authentication_for_localhost;
111 	int	identities_only;
112 	int	server_alive_interval;
113 	int	server_alive_count_max;
114 
115 	int     num_send_env;
116 	char   *send_env[MAX_SEND_ENV];
117 
118 	char	*control_path;
119 	int	control_master;
120 	int     control_persist; /* ControlPersist flag */
121 	int     control_persist_timeout; /* ControlPersist timeout (seconds) */
122 
123 	int	hash_known_hosts;
124 
125 	int	tun_open;	/* tun(4) */
126 	int     tun_local;	/* force tun device (optional) */
127 	int     tun_remote;	/* force tun device (optional) */
128 
129 	char	*local_command;
130 	int	permit_local_command;
131 	int	visual_host_key;
132 
133 	int	use_roaming;
134 
135 }       Options;
136 
137 #define SSHCTL_MASTER_NO	0
138 #define SSHCTL_MASTER_YES	1
139 #define SSHCTL_MASTER_AUTO	2
140 #define SSHCTL_MASTER_ASK	3
141 #define SSHCTL_MASTER_AUTO_ASK	4
142 
143 void     initialize_options(Options *);
144 void     fill_default_options(Options *);
145 int	 read_config_file(const char *, const char *, Options *, int);
146 int	 parse_forward(Forward *, const char *, int, int);
147 
148 int
149 process_config_line(Options *, const char *, char *, const char *, int, int *);
150 
151 void	 add_local_forward(Options *, const Forward *);
152 void	 add_remote_forward(Options *, const Forward *);
153 
154 #endif				/* READCONF_H */
155