blob: 575b2646da9f00bf995ed1d53adcf0a4b52ceba6 [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
Ben Lindstrom06b33aa2001-02-15 03:01:59 +000014/* RCSID("$OpenBSD: readconf.h,v 1.26 2001/02/11 12:59:25 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 Miller0bc1bd82000-11-13 22:57:25 +110038 int pubkey_authentication; /* Try ssh2 pubkey authentication. */
Ben Lindstrom95fb2dd2001-01-23 03:12:10 +000039 int challenge_reponse_authentication;
40 /* Try S/Key or TIS, authentication. */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100041#ifdef KRB4
Damien Miller95def091999-11-25 00:26:21 +110042 int kerberos_authentication; /* Try Kerberos
43 * authentication. */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100044#endif
45#ifdef AFS
Damien Miller95def091999-11-25 00:26:21 +110046 int kerberos_tgt_passing; /* Try Kerberos tgt passing. */
47 int afs_token_passing; /* Try AFS token passing. */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100048#endif
Damien Miller95def091999-11-25 00:26:21 +110049 int password_authentication; /* Try password
50 * authentication. */
Damien Miller874d77b2000-10-14 16:23:11 +110051 int kbd_interactive_authentication; /* Try keyboard-interactive auth. */
52 char *kbd_interactive_devices; /* Keyboard-interactive auth devices. */
Damien Miller95def091999-11-25 00:26:21 +110053 int fallback_to_rsh;/* Use rsh if cannot connect with ssh. */
54 int use_rsh; /* Always use rsh (don\'t try ssh). */
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 keepalives; /* Set SO_KEEPALIVE. */
62 LogLevel log_level; /* Level for logging. */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100063
Damien Miller95def091999-11-25 00:26:21 +110064 int port; /* Port to connect. */
65 int connection_attempts; /* Max attempts (seconds) before
66 * giving up */
67 int number_of_password_prompts; /* Max number of password
68 * prompts. */
69 int cipher; /* Cipher to use. */
Damien Miller30c3d422000-05-09 11:02:59 +100070 char *ciphers; /* SSH2 ciphers in order of preference. */
Ben Lindstrom06b33aa2001-02-15 03:01:59 +000071 char *macs; /* SSH2 macs in order of preference. */
Damien Miller78928792000-04-12 20:17:38 +100072 int protocol; /* Protocol in order of preference. */
Damien Miller95def091999-11-25 00:26:21 +110073 char *hostname; /* Real host to connect. */
Ben Lindstrom4dccfa52000-12-28 16:40:05 +000074 char *host_key_alias; /* hostname alias for .ssh/known_hosts */
Damien Miller95def091999-11-25 00:26:21 +110075 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 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100078
Damien Miller95def091999-11-25 00:26:21 +110079 char *system_hostfile;/* Path for /etc/ssh_known_hosts. */
80 char *user_hostfile; /* Path for $HOME/.ssh/known_hosts. */
Damien Millereba71ba2000-04-29 23:57:08 +100081 char *system_hostfile2;
82 char *user_hostfile2;
Damien Millerd4a8b7e1999-10-27 13:42:43 +100083
Damien Miller0bc1bd82000-11-13 22:57:25 +110084 int num_identity_files; /* Number of files for RSA/DSA identities. */
Damien Miller95def091999-11-25 00:26:21 +110085 char *identity_files[SSH_MAX_IDENTITY_FILES];
Damien Miller0bc1bd82000-11-13 22:57:25 +110086 int identity_files_type[SSH_MAX_IDENTITY_FILES];
Damien Millerd4a8b7e1999-10-27 13:42:43 +100087
Damien Miller95def091999-11-25 00:26:21 +110088 /* Local TCP/IP forward requests. */
89 int num_local_forwards;
90 Forward local_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
Damien Millerd4a8b7e1999-10-27 13:42:43 +100091
Damien Miller95def091999-11-25 00:26:21 +110092 /* Remote TCP/IP forward requests. */
93 int num_remote_forwards;
94 Forward remote_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
95} Options;
Damien Millerd4a8b7e1999-10-27 13:42:43 +100096
97
Damien Miller5428f641999-11-25 11:54:57 +110098/*
99 * Initializes options to special values that indicate that they have not yet
100 * been set. Read_config_file will only set options with this value. Options
101 * are processed in the following order: command line, user config file,
102 * system config file. Last, fill_default_options is called.
103 */
Damien Miller95def091999-11-25 00:26:21 +1100104void initialize_options(Options * options);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000105
Damien Miller5428f641999-11-25 11:54:57 +1100106/*
107 * Called after processing other sources of option data, this fills those
108 * options for which no value has been specified with their default values.
109 */
Damien Miller95def091999-11-25 00:26:21 +1100110void fill_default_options(Options * options);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000111
Damien Miller5428f641999-11-25 11:54:57 +1100112/*
113 * Processes a single option line as used in the configuration files. This
114 * only sets those values that have not already been set. Returns 0 for legal
115 * options
116 */
Damien Miller4af51302000-04-16 11:18:38 +1000117int
Damien Miller95def091999-11-25 00:26:21 +1100118process_config_line(Options * options, const char *host,
119 char *line, const char *filename, int linenum,
120 int *activep);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000121
Damien Miller5428f641999-11-25 11:54:57 +1100122/*
123 * Reads the config file and modifies the options accordingly. Options
124 * should already be initialized before this call. This never returns if
125 * there is an error. If the file does not exist, this returns immediately.
126 */
Damien Miller4af51302000-04-16 11:18:38 +1000127void
Damien Miller95def091999-11-25 00:26:21 +1100128read_config_file(const char *filename, const char *host,
129 Options * options);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000130
Damien Miller5428f641999-11-25 11:54:57 +1100131/*
132 * Adds a local TCP/IP port forward to options. Never returns if there is an
133 * error.
134 */
Damien Miller4af51302000-04-16 11:18:38 +1000135void
Damien Milleraae6c611999-12-06 11:47:28 +1100136add_local_forward(Options * options, u_short port, const char *host,
137 u_short host_port);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000138
Damien Miller5428f641999-11-25 11:54:57 +1100139/*
140 * Adds a remote TCP/IP port forward to options. Never returns if there is
141 * an error.
142 */
Damien Miller4af51302000-04-16 11:18:38 +1000143void
Damien Milleraae6c611999-12-06 11:47:28 +1100144add_remote_forward(Options * options, u_short port, const char *host,
145 u_short host_port);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000146
Damien Miller95def091999-11-25 00:26:21 +1100147#endif /* READCONF_H */