blob: 09f051401e7cd099e0b298217f0c2401ee5bbb85 [file] [log] [blame]
Damien Millerd4a8b7e1999-10-27 13:42:43 +10001/*
Damien Miller95def091999-11-25 00:26:21 +11002 *
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 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100015
Damien Milleraae6c611999-12-06 11:47:28 +110016/* RCSID("$Id: readconf.h,v 1.6 1999/12/06 00:47:29 damien Exp $"); */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100017
18#ifndef READCONF_H
19#define READCONF_H
20
21/* Data structure for representing a forwarding request. */
22
Damien Miller95def091999-11-25 00:26:21 +110023typedef struct {
Damien Milleraae6c611999-12-06 11:47:28 +110024 u_short port; /* Port to forward. */
25 char *host; /* Host to connect. */
26 u_short host_port; /* Port to connect on host. */
Damien Miller95def091999-11-25 00:26:21 +110027} Forward;
Damien Millerd4a8b7e1999-10-27 13:42:43 +100028/* Data structure for representing option data. */
29
Damien Miller95def091999-11-25 00:26:21 +110030typedef struct {
31 int forward_agent; /* Forward authentication agent. */
32 int forward_x11; /* Forward X11 display. */
33 int gateway_ports; /* Allow remote connects to forwarded ports. */
34 int use_privileged_port; /* Don't use privileged port if false. */
35 int rhosts_authentication; /* Try rhosts authentication. */
36 int rhosts_rsa_authentication; /* Try rhosts with RSA
37 * authentication. */
38 int rsa_authentication; /* Try RSA authentication. */
39 int skey_authentication; /* Try S/Key or TIS authentication. */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100040#ifdef KRB4
Damien Miller95def091999-11-25 00:26:21 +110041 int kerberos_authentication; /* Try Kerberos
42 * authentication. */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100043#endif
44#ifdef AFS
Damien Miller95def091999-11-25 00:26:21 +110045 int kerberos_tgt_passing; /* Try Kerberos tgt passing. */
46 int afs_token_passing; /* Try AFS token passing. */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100047#endif
Damien Miller95def091999-11-25 00:26:21 +110048 int password_authentication; /* Try password
49 * authentication. */
50 int fallback_to_rsh;/* Use rsh if cannot connect with ssh. */
51 int use_rsh; /* Always use rsh (don\'t try ssh). */
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 keepalives; /* Set SO_KEEPALIVE. */
59 LogLevel log_level; /* Level for logging. */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100060
Damien Miller95def091999-11-25 00:26:21 +110061 int port; /* Port to connect. */
62 int connection_attempts; /* Max attempts (seconds) before
63 * giving up */
64 int number_of_password_prompts; /* Max number of password
65 * prompts. */
66 int cipher; /* Cipher to use. */
67 char *hostname; /* Real host to connect. */
68 char *proxy_command; /* Proxy command for connecting the host. */
69 char *user; /* User to log in as. */
70 int escape_char; /* Escape character; -2 = none */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100071
Damien Miller95def091999-11-25 00:26:21 +110072 char *system_hostfile;/* Path for /etc/ssh_known_hosts. */
73 char *user_hostfile; /* Path for $HOME/.ssh/known_hosts. */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100074
Damien Miller95def091999-11-25 00:26:21 +110075 int num_identity_files; /* Number of files for RSA identities. */
76 char *identity_files[SSH_MAX_IDENTITY_FILES];
Damien Millerd4a8b7e1999-10-27 13:42:43 +100077
Damien Miller95def091999-11-25 00:26:21 +110078 /* Local TCP/IP forward requests. */
79 int num_local_forwards;
80 Forward local_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
Damien Millerd4a8b7e1999-10-27 13:42:43 +100081
Damien Miller95def091999-11-25 00:26:21 +110082 /* Remote TCP/IP forward requests. */
83 int num_remote_forwards;
84 Forward remote_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
85} Options;
Damien Millerd4a8b7e1999-10-27 13:42:43 +100086
87
Damien Miller5428f641999-11-25 11:54:57 +110088/*
89 * Initializes options to special values that indicate that they have not yet
90 * been set. Read_config_file will only set options with this value. Options
91 * are processed in the following order: command line, user config file,
92 * system config file. Last, fill_default_options is called.
93 */
Damien Miller95def091999-11-25 00:26:21 +110094void initialize_options(Options * options);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100095
Damien Miller5428f641999-11-25 11:54:57 +110096/*
97 * Called after processing other sources of option data, this fills those
98 * options for which no value has been specified with their default values.
99 */
Damien Miller95def091999-11-25 00:26:21 +1100100void fill_default_options(Options * options);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000101
Damien Miller5428f641999-11-25 11:54:57 +1100102/*
103 * Processes a single option line as used in the configuration files. This
104 * only sets those values that have not already been set. Returns 0 for legal
105 * options
106 */
Damien Miller95def091999-11-25 00:26:21 +1100107int
108process_config_line(Options * options, const char *host,
109 char *line, const char *filename, int linenum,
110 int *activep);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000111
Damien Miller5428f641999-11-25 11:54:57 +1100112/*
113 * Reads the config file and modifies the options accordingly. Options
114 * should already be initialized before this call. This never returns if
115 * there is an error. If the file does not exist, this returns immediately.
116 */
Damien Miller95def091999-11-25 00:26:21 +1100117void
118read_config_file(const char *filename, const char *host,
119 Options * options);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000120
Damien Miller5428f641999-11-25 11:54:57 +1100121/*
122 * Adds a local TCP/IP port forward to options. Never returns if there is an
123 * error.
124 */
Damien Miller95def091999-11-25 00:26:21 +1100125void
Damien Milleraae6c611999-12-06 11:47:28 +1100126add_local_forward(Options * options, u_short port, const char *host,
127 u_short host_port);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000128
Damien Miller5428f641999-11-25 11:54:57 +1100129/*
130 * Adds a remote TCP/IP port forward to options. Never returns if there is
131 * an error.
132 */
Damien Miller95def091999-11-25 00:26:21 +1100133void
Damien Milleraae6c611999-12-06 11:47:28 +1100134add_remote_forward(Options * options, u_short port, const char *host,
135 u_short host_port);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000136
Damien Miller95def091999-11-25 00:26:21 +1100137#endif /* READCONF_H */