blob: e94213fa1770c4ce9214f10082a69e17250ff930 [file] [log] [blame]
Damien Millerd4a8b7e1999-10-27 13:42:43 +10001/*
Damien Miller95def091999-11-25 00:26:21 +11002 * Author: Tatu Ylonen <ylo@cs.hut.fi>
Damien Miller95def091999-11-25 00:26:21 +11003 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
4 * All rights reserved
Damien Miller95def091999-11-25 00:26:21 +11005 * Functions for reading the configuration file.
Damien Miller4af51302000-04-16 11:18:38 +10006 *
Damien Millere4340be2000-09-16 13:29:08 +11007 * As far as I am concerned, the code I have written for this software
8 * can be used freely for any purpose. Any derived versions of this
9 * software must be clearly marked as such, and if the derived work is
10 * incompatible with the protocol description in the RFC file, it must be
11 * called by a name other than "ssh" or "Secure Shell".
Damien Miller95def091999-11-25 00:26:21 +110012 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100013
Damien Miller874d77b2000-10-14 16:23:11 +110014/* RCSID("$OpenBSD: readconf.h,v 1.22 2000/10/11 20:14:39 markus Exp $"); */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100015
16#ifndef READCONF_H
17#define READCONF_H
18
19/* Data structure for representing a forwarding request. */
20
Damien Miller95def091999-11-25 00:26:21 +110021typedef struct {
Damien Milleraae6c611999-12-06 11:47:28 +110022 u_short port; /* Port to forward. */
23 char *host; /* Host to connect. */
24 u_short host_port; /* Port to connect on host. */
Damien Miller95def091999-11-25 00:26:21 +110025} Forward;
Damien Millerd4a8b7e1999-10-27 13:42:43 +100026/* Data structure for representing option data. */
27
Damien Miller95def091999-11-25 00:26:21 +110028typedef struct {
29 int forward_agent; /* Forward authentication agent. */
30 int forward_x11; /* Forward X11 display. */
Damien Millerd3a18572000-06-07 19:55:44 +100031 char *xauth_location; /* Location for xauth program */
Damien Miller95def091999-11-25 00:26:21 +110032 int gateway_ports; /* Allow remote connects to forwarded ports. */
33 int use_privileged_port; /* Don't use privileged port if false. */
34 int rhosts_authentication; /* Try rhosts authentication. */
35 int rhosts_rsa_authentication; /* Try rhosts with RSA
36 * authentication. */
37 int rsa_authentication; /* Try RSA authentication. */
Damien Millere247cc42000-05-07 12:03:14 +100038 int dsa_authentication; /* Try DSA authentication. */
Damien Miller95def091999-11-25 00:26:21 +110039 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. */
Damien Miller874d77b2000-10-14 16:23:11 +110050 int kbd_interactive_authentication; /* Try keyboard-interactive auth. */
51 char *kbd_interactive_devices; /* Keyboard-interactive auth devices. */
Damien Miller95def091999-11-25 00:26:21 +110052 int fallback_to_rsh;/* Use rsh if cannot connect with ssh. */
53 int use_rsh; /* Always use rsh (don\'t try ssh). */
54 int batch_mode; /* Batch mode: do not ask for passwords. */
55 int check_host_ip; /* Also keep track of keys for IP address */
56 int strict_host_key_checking; /* Strict host key checking. */
57 int compression; /* Compress packets in both directions. */
58 int compression_level; /* Compression level 1 (fast) to 9
59 * (best). */
60 int keepalives; /* Set SO_KEEPALIVE. */
61 LogLevel log_level; /* Level for logging. */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100062
Damien Miller95def091999-11-25 00:26:21 +110063 int port; /* Port to connect. */
64 int connection_attempts; /* Max attempts (seconds) before
65 * giving up */
66 int number_of_password_prompts; /* Max number of password
67 * prompts. */
68 int cipher; /* Cipher to use. */
Damien Miller30c3d422000-05-09 11:02:59 +100069 char *ciphers; /* SSH2 ciphers in order of preference. */
Damien Miller78928792000-04-12 20:17:38 +100070 int protocol; /* Protocol in order of preference. */
Damien Miller95def091999-11-25 00:26:21 +110071 char *hostname; /* Real host to connect. */
72 char *proxy_command; /* Proxy command for connecting the host. */
73 char *user; /* User to log in as. */
74 int escape_char; /* Escape character; -2 = none */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100075
Damien Miller95def091999-11-25 00:26:21 +110076 char *system_hostfile;/* Path for /etc/ssh_known_hosts. */
77 char *user_hostfile; /* Path for $HOME/.ssh/known_hosts. */
Damien Millereba71ba2000-04-29 23:57:08 +100078 char *system_hostfile2;
79 char *user_hostfile2;
Damien Millerd4a8b7e1999-10-27 13:42:43 +100080
Damien Miller95def091999-11-25 00:26:21 +110081 int num_identity_files; /* Number of files for RSA identities. */
Damien Millereba71ba2000-04-29 23:57:08 +100082 int num_identity_files2; /* DSA identities. */
Damien Miller95def091999-11-25 00:26:21 +110083 char *identity_files[SSH_MAX_IDENTITY_FILES];
Damien Millereba71ba2000-04-29 23:57:08 +100084 char *identity_files2[SSH_MAX_IDENTITY_FILES];
Damien Millerd4a8b7e1999-10-27 13:42:43 +100085
Damien Miller95def091999-11-25 00:26:21 +110086 /* Local TCP/IP forward requests. */
87 int num_local_forwards;
88 Forward local_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
Damien Millerd4a8b7e1999-10-27 13:42:43 +100089
Damien Miller95def091999-11-25 00:26:21 +110090 /* Remote TCP/IP forward requests. */
91 int num_remote_forwards;
92 Forward remote_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
93} Options;
Damien Millerd4a8b7e1999-10-27 13:42:43 +100094
95
Damien Miller5428f641999-11-25 11:54:57 +110096/*
97 * Initializes options to special values that indicate that they have not yet
98 * been set. Read_config_file will only set options with this value. Options
99 * are processed in the following order: command line, user config file,
100 * system config file. Last, fill_default_options is called.
101 */
Damien Miller95def091999-11-25 00:26:21 +1100102void initialize_options(Options * options);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000103
Damien Miller5428f641999-11-25 11:54:57 +1100104/*
105 * Called after processing other sources of option data, this fills those
106 * options for which no value has been specified with their default values.
107 */
Damien Miller95def091999-11-25 00:26:21 +1100108void fill_default_options(Options * options);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000109
Damien Miller5428f641999-11-25 11:54:57 +1100110/*
111 * Processes a single option line as used in the configuration files. This
112 * only sets those values that have not already been set. Returns 0 for legal
113 * options
114 */
Damien Miller4af51302000-04-16 11:18:38 +1000115int
Damien Miller95def091999-11-25 00:26:21 +1100116process_config_line(Options * options, const char *host,
117 char *line, const char *filename, int linenum,
118 int *activep);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000119
Damien Miller5428f641999-11-25 11:54:57 +1100120/*
121 * Reads the config file and modifies the options accordingly. Options
122 * should already be initialized before this call. This never returns if
123 * there is an error. If the file does not exist, this returns immediately.
124 */
Damien Miller4af51302000-04-16 11:18:38 +1000125void
Damien Miller95def091999-11-25 00:26:21 +1100126read_config_file(const char *filename, const char *host,
127 Options * options);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000128
Damien Miller5428f641999-11-25 11:54:57 +1100129/*
130 * Adds a local TCP/IP port forward to options. Never returns if there is an
131 * error.
132 */
Damien Miller4af51302000-04-16 11:18:38 +1000133void
Damien Milleraae6c611999-12-06 11:47:28 +1100134add_local_forward(Options * options, u_short port, const char *host,
135 u_short host_port);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000136
Damien Miller5428f641999-11-25 11:54:57 +1100137/*
138 * Adds a remote TCP/IP port forward to options. Never returns if there is
139 * an error.
140 */
Damien Miller4af51302000-04-16 11:18:38 +1000141void
Damien Milleraae6c611999-12-06 11:47:28 +1100142add_remote_forward(Options * options, u_short port, const char *host,
143 u_short host_port);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000144
Damien Miller95def091999-11-25 00:26:21 +1100145#endif /* READCONF_H */