xref: /freebsd/crypto/openssh/readconf.h (revision 2be1a816b9ff69588e55be0a84cbe2a31efc0f2f)
1 /* $OpenBSD: readconf.h,v 1.71 2006/08/03 03:34:42 deraadt 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 	u_short	  listen_port;		/* Port to forward. */
24 	char	 *connect_host;		/* Host to connect. */
25 	u_short	  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 
31 typedef 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     batch_mode;	/* Batch mode: do not ask for passwords. */
53 	int     check_host_ip;	/* Also keep track of keys for IP address */
54 	int     strict_host_key_checking;	/* Strict host key checking. */
55 	int     compression;	/* Compress packets in both directions. */
56 	int     compression_level;	/* Compression level 1 (fast) to 9
57 					 * (best). */
58 	int     tcp_keep_alive;	/* Set SO_KEEPALIVE. */
59 	LogLevel log_level;	/* Level for logging. */
60 
61 	int     port;		/* Port to connect. */
62 	int     address_family;
63 	int     connection_attempts;	/* Max attempts (seconds) before
64 					 * giving up */
65 	int     connection_timeout;	/* Max time (seconds) before
66 					 * aborting connection attempt */
67 	int     number_of_password_prompts;	/* Max number of password
68 						 * prompts. */
69 	int     cipher;		/* Cipher to use. */
70 	char   *ciphers;	/* SSH2 ciphers in order of preference. */
71 	char   *macs;		/* SSH2 macs in order of preference. */
72 	char   *hostkeyalgorithms;	/* SSH2 server key types in order of preference. */
73 	int	protocol;	/* Protocol in order of preference. */
74 	char   *hostname;	/* Real host to connect. */
75 	char   *host_key_alias;	/* hostname alias for .ssh/known_hosts */
76 	char   *proxy_command;	/* Proxy command for connecting the host. */
77 	char   *user;		/* User to log in as. */
78 	int     escape_char;	/* Escape character; -2 = none */
79 
80 	char   *system_hostfile;/* Path for /etc/ssh/ssh_known_hosts. */
81 	char   *user_hostfile;	/* Path for $HOME/.ssh/known_hosts. */
82 	char   *system_hostfile2;
83 	char   *user_hostfile2;
84 	char   *preferred_authentications;
85 	char   *bind_address;	/* local socket address for connection to sshd */
86 	char   *smartcard_device; /* Smartcard reader device */
87 	int	verify_host_key_dns;	/* Verify host key using DNS */
88 
89 	int     num_identity_files;	/* Number of files for RSA/DSA identities. */
90 	char   *identity_files[SSH_MAX_IDENTITY_FILES];
91 	Key    *identity_keys[SSH_MAX_IDENTITY_FILES];
92 
93 	/* Local TCP/IP forward requests. */
94 	int     num_local_forwards;
95 	Forward local_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
96 
97 	/* Remote TCP/IP forward requests. */
98 	int     num_remote_forwards;
99 	Forward remote_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
100 	int	clear_forwardings;
101 
102 	int	enable_ssh_keysign;
103 	int	rekey_limit;
104 	int	no_host_authentication_for_localhost;
105 	int	identities_only;
106 	int	server_alive_interval;
107 	int	server_alive_count_max;
108 
109 	int     num_send_env;
110 	char   *send_env[MAX_SEND_ENV];
111 
112 	char	*control_path;
113 	int	control_master;
114 
115 	int	hash_known_hosts;
116 
117 	int	tun_open;	/* tun(4) */
118 	int     tun_local;	/* force tun device (optional) */
119 	int     tun_remote;	/* force tun device (optional) */
120 
121 	char	*local_command;
122 	int	permit_local_command;
123 
124 }       Options;
125 
126 #define SSHCTL_MASTER_NO	0
127 #define SSHCTL_MASTER_YES	1
128 #define SSHCTL_MASTER_AUTO	2
129 #define SSHCTL_MASTER_ASK	3
130 #define SSHCTL_MASTER_AUTO_ASK	4
131 
132 void     initialize_options(Options *);
133 void     fill_default_options(Options *);
134 int	 read_config_file(const char *, const char *, Options *, int);
135 int	 parse_forward(Forward *, const char *);
136 
137 int
138 process_config_line(Options *, const char *, char *, const char *, int, int *);
139 
140 void	 add_local_forward(Options *, const Forward *);
141 void	 add_remote_forward(Options *, const Forward *);
142 
143 #endif				/* READCONF_H */
144