xref: /freebsd/crypto/openssh/readconf.h (revision daf1cffce2e07931f27c6c6998652e90df6ba87e)
1 /*
2  *
3  * readconf.h
4  *
5  * Author: Tatu Ylonen <ylo@cs.hut.fi>
6  *
7  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
8  *                    All rights reserved
9  *
10  * Created: Sat Apr 22 00:25:29 1995 ylo
11  *
12  * Functions for reading the configuration file.
13  *
14  * $FreeBSD$
15  */
16 
17 /* RCSID("$Id: readconf.h,v 1.13 1999/12/01 13:59:15 markus Exp $"); */
18 
19 #ifndef READCONF_H
20 #define READCONF_H
21 
22 /* Data structure for representing a forwarding request. */
23 
24 typedef struct {
25 	u_short	  port;		/* Port to forward. */
26 	char	 *host;		/* Host to connect. */
27 	u_short	  host_port;	/* Port to connect on host. */
28 }       Forward;
29 /* Data structure for representing option data. */
30 
31 typedef struct {
32 	int     forward_agent;	/* Forward authentication agent. */
33 	int     forward_x11;	/* Forward X11 display. */
34 	int     gateway_ports;	/* Allow remote connects to forwarded ports. */
35 	int     use_privileged_port;	/* Don't use privileged port if false. */
36 	int     rhosts_authentication;	/* Try rhosts authentication. */
37 	int     rhosts_rsa_authentication;	/* Try rhosts with RSA
38 						 * authentication. */
39 	int     rsa_authentication;	/* Try RSA authentication. */
40 	int     skey_authentication;	/* Try S/Key or TIS authentication. */
41 #ifdef KRB4
42 	int     krb4_authentication;		/* Try Kerberos v4
43 						 * authentication. */
44 #endif
45 
46 #ifdef KRB5
47 	int	krb5_authentication;
48 	int	krb5_tgt_passing;
49 #endif /* KRB5 */
50 
51 #ifdef AFS
52 	int     krb4_tgt_passing;	/* Try Kerberos v4 tgt passing. */
53 	int     afs_token_passing;	/* Try AFS token passing. */
54 #endif
55 	int     password_authentication;	/* Try password
56 						 * authentication. */
57 	int     fallback_to_rsh;/* Use rsh if cannot connect with ssh. */
58 	int     use_rsh;	/* Always use rsh (don\'t try ssh). */
59 	int     batch_mode;	/* Batch mode: do not ask for passwords. */
60 	int     check_host_ip;	/* Also keep track of keys for IP address */
61 	int     strict_host_key_checking;	/* Strict host key checking. */
62 	int     compression;	/* Compress packets in both directions. */
63 	int     compression_level;	/* Compression level 1 (fast) to 9
64 					 * (best). */
65 	int     keepalives;	/* Set SO_KEEPALIVE. */
66 	LogLevel log_level;	/* Level for logging. */
67 
68 	int     port;		/* Port to connect. */
69 	int     connection_attempts;	/* Max attempts (seconds) before
70 					 * giving up */
71 	int     number_of_password_prompts;	/* Max number of password
72 						 * prompts. */
73 	int     cipher;		/* Cipher to use. */
74 	char   *hostname;	/* Real host to connect. */
75 	char   *proxy_command;	/* Proxy command for connecting the host. */
76 	char   *user;		/* User to log in as. */
77 	int     escape_char;	/* Escape character; -2 = none */
78 
79 	char   *system_hostfile;/* Path for /etc/ssh_known_hosts. */
80 	char   *user_hostfile;	/* Path for $HOME/.ssh/known_hosts. */
81 
82 	int     num_identity_files;	/* Number of files for RSA identities. */
83 	char   *identity_files[SSH_MAX_IDENTITY_FILES];
84 
85 	/* Local TCP/IP forward requests. */
86 	int     num_local_forwards;
87 	Forward local_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
88 
89 	/* Remote TCP/IP forward requests. */
90 	int     num_remote_forwards;
91 	Forward remote_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
92 }       Options;
93 
94 
95 /*
96  * Initializes options to special values that indicate that they have not yet
97  * been set.  Read_config_file will only set options with this value. Options
98  * are processed in the following order: command line, user config file,
99  * system config file.  Last, fill_default_options is called.
100  */
101 void    initialize_options(Options * options);
102 
103 /*
104  * Called after processing other sources of option data, this fills those
105  * options for which no value has been specified with their default values.
106  */
107 void    fill_default_options(Options * options);
108 
109 /*
110  * Processes a single option line as used in the configuration files. This
111  * only sets those values that have not already been set. Returns 0 for legal
112  * options
113  */
114 int
115 process_config_line(Options * options, const char *host,
116     char *line, const char *filename, int linenum,
117     int *activep);
118 
119 /*
120  * Reads the config file and modifies the options accordingly.  Options
121  * should already be initialized before this call.  This never returns if
122  * there is an error.  If the file does not exist, this returns immediately.
123  */
124 void
125 read_config_file(const char *filename, const char *host,
126     Options * options);
127 
128 /*
129  * Adds a local TCP/IP port forward to options.  Never returns if there is an
130  * error.
131  */
132 void
133 add_local_forward(Options * options, u_short port, const char *host,
134     u_short host_port);
135 
136 /*
137  * Adds a remote TCP/IP port forward to options.  Never returns if there is
138  * an error.
139  */
140 void
141 add_remote_forward(Options * options, u_short port, const char *host,
142     u_short host_port);
143 
144 #endif				/* READCONF_H */
145