blob: 4565b2c2cedabd42cc95334be089295a45368135 [file] [log] [blame]
Damien Millerd27b9472005-12-13 19:29:02 +11001/* $OpenBSD: readconf.h,v 1.68 2005/12/06 22:38:27 reyk Exp $ */
Ben Lindstrom05764b92002-03-05 01:53:02 +00002
Damien Millerd4a8b7e1999-10-27 13:42:43 +10003/*
Damien Miller95def091999-11-25 00:26:21 +11004 * Author: Tatu Ylonen <ylo@cs.hut.fi>
Damien Miller95def091999-11-25 00:26:21 +11005 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
6 * All rights reserved
Damien Miller95def091999-11-25 00:26:21 +11007 * Functions for reading the configuration file.
Damien Miller4af51302000-04-16 11:18:38 +10008 *
Damien Millere4340be2000-09-16 13:29:08 +11009 * 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".
Damien Miller95def091999-11-25 00:26:21 +110014 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100015
Damien Millerd4a8b7e1999-10-27 13:42:43 +100016#ifndef READCONF_H
17#define READCONF_H
18
Ben Lindstrom266dfdf2001-03-09 00:12:22 +000019#include "key.h"
20
Damien Millerd4a8b7e1999-10-27 13:42:43 +100021/* Data structure for representing a forwarding request. */
22
Damien Miller95def091999-11-25 00:26:21 +110023typedef struct {
Damien Millerf91ee4c2005-03-01 21:24:33 +110024 char *listen_host; /* Host (address) to listen on. */
25 u_short listen_port; /* Port to forward. */
26 char *connect_host; /* Host to connect. */
27 u_short connect_port; /* Port to connect on connect_host. */
Damien Miller95def091999-11-25 00:26:21 +110028} Forward;
Damien Millerd4a8b7e1999-10-27 13:42:43 +100029/* Data structure for representing option data. */
30
Darren Tucker46bc0752004-05-02 22:11:30 +100031#define MAX_SEND_ENV 256
32
Damien Miller95def091999-11-25 00:26:21 +110033typedef struct {
34 int forward_agent; /* Forward authentication agent. */
35 int forward_x11; /* Forward X11 display. */
Darren Tucker0a118da2003-10-15 15:54:32 +100036 int forward_x11_trusted; /* Trust Forward X11 display. */
Damien Millerd3a18572000-06-07 19:55:44 +100037 char *xauth_location; /* Location for xauth program */
Damien Miller95def091999-11-25 00:26:21 +110038 int gateway_ports; /* Allow remote connects to forwarded ports. */
39 int use_privileged_port; /* Don't use privileged port if false. */
Damien Miller95def091999-11-25 00:26:21 +110040 int rhosts_rsa_authentication; /* Try rhosts with RSA
41 * authentication. */
42 int rsa_authentication; /* Try RSA authentication. */
Damien Miller0bc1bd82000-11-13 22:57:25 +110043 int pubkey_authentication; /* Try ssh2 pubkey authentication. */
Ben Lindstrom5eabda32001-04-12 23:34:34 +000044 int hostbased_authentication; /* ssh2's rhosts_rsa */
Ben Lindstrom551ea372001-06-05 18:56:16 +000045 int challenge_response_authentication;
Ben Lindstrom95fb2dd2001-01-23 03:12:10 +000046 /* Try S/Key or TIS, authentication. */
Darren Tucker0efd1552003-08-26 11:49:55 +100047 int gss_authentication; /* Try GSS authentication */
48 int gss_deleg_creds; /* Delegate GSS credentials */
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 batch_mode; /* Batch mode: do not ask for passwords. */
54 int check_host_ip; /* Also keep track of keys for IP address */
55 int strict_host_key_checking; /* Strict host key checking. */
56 int compression; /* Compress packets in both directions. */
57 int compression_level; /* Compression level 1 (fast) to 9
58 * (best). */
Damien Miller12c150e2003-12-17 16:31:10 +110059 int tcp_keep_alive; /* Set SO_KEEPALIVE. */
Damien Miller95def091999-11-25 00:26:21 +110060 LogLevel log_level; /* Level for logging. */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100061
Damien Miller95def091999-11-25 00:26:21 +110062 int port; /* Port to connect. */
Darren Tucker0a4f04b2003-07-03 20:37:47 +100063 int address_family;
Damien Miller95def091999-11-25 00:26:21 +110064 int connection_attempts; /* Max attempts (seconds) before
65 * giving up */
Damien Millerb78d5eb2003-05-16 11:39:04 +100066 int connection_timeout; /* Max time (seconds) before
Damien Millera8e06ce2003-11-21 23:48:55 +110067 * aborting connection attempt */
Damien Miller95def091999-11-25 00:26:21 +110068 int number_of_password_prompts; /* Max number of password
69 * prompts. */
70 int cipher; /* Cipher to use. */
Damien Miller30c3d422000-05-09 11:02:59 +100071 char *ciphers; /* SSH2 ciphers in order of preference. */
Ben Lindstrom06b33aa2001-02-15 03:01:59 +000072 char *macs; /* SSH2 macs in order of preference. */
Ben Lindstrom982dbbc2001-04-17 18:11:36 +000073 char *hostkeyalgorithms; /* SSH2 server key types in order of preference. */
Damien Miller78928792000-04-12 20:17:38 +100074 int protocol; /* Protocol in order of preference. */
Damien Miller95def091999-11-25 00:26:21 +110075 char *hostname; /* Real host to connect. */
Ben Lindstrom4dccfa52000-12-28 16:40:05 +000076 char *host_key_alias; /* hostname alias for .ssh/known_hosts */
Damien Miller95def091999-11-25 00:26:21 +110077 char *proxy_command; /* Proxy command for connecting the host. */
78 char *user; /* User to log in as. */
79 int escape_char; /* Escape character; -2 = none */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100080
Damien Millerafcc2252002-02-10 18:32:55 +110081 char *system_hostfile;/* Path for /etc/ssh/ssh_known_hosts. */
Damien Miller95def091999-11-25 00:26:21 +110082 char *user_hostfile; /* Path for $HOME/.ssh/known_hosts. */
Damien Millereba71ba2000-04-29 23:57:08 +100083 char *system_hostfile2;
84 char *user_hostfile2;
Ben Lindstromb9be60a2001-03-11 01:49:19 +000085 char *preferred_authentications;
Ben Lindstrome0f88042001-04-30 13:06:24 +000086 char *bind_address; /* local socket address for connection to sshd */
Ben Lindstromf7db3bb2001-08-06 21:35:51 +000087 char *smartcard_device; /* Smartcard reader device */
Damien Miller37876e92003-05-15 10:19:46 +100088 int verify_host_key_dns; /* Verify host key using DNS */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100089
Damien Miller0bc1bd82000-11-13 22:57:25 +110090 int num_identity_files; /* Number of files for RSA/DSA identities. */
Damien Miller95def091999-11-25 00:26:21 +110091 char *identity_files[SSH_MAX_IDENTITY_FILES];
Ben Lindstrom266dfdf2001-03-09 00:12:22 +000092 Key *identity_keys[SSH_MAX_IDENTITY_FILES];
Damien Millerd4a8b7e1999-10-27 13:42:43 +100093
Damien Miller95def091999-11-25 00:26:21 +110094 /* Local TCP/IP forward requests. */
95 int num_local_forwards;
96 Forward local_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
Damien Millerd4a8b7e1999-10-27 13:42:43 +100097
Damien Miller95def091999-11-25 00:26:21 +110098 /* Remote TCP/IP forward requests. */
99 int num_remote_forwards;
100 Forward remote_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
Ben Lindstrom2b7a0e92001-09-20 00:57:55 +0000101 int clear_forwardings;
Ben Lindstromb6df73b2002-11-09 15:52:31 +0000102
103 int enable_ssh_keysign;
Damien Millera5539d22003-04-09 20:50:06 +1000104 int rekey_limit;
Ben Lindstrom3cecc9a2001-10-03 17:39:38 +0000105 int no_host_authentication_for_localhost;
Damien Millerbd394c32004-03-08 23:12:36 +1100106 int identities_only;
Darren Tuckerfc959702004-07-17 16:12:08 +1000107 int server_alive_interval;
Damien Miller509b0102003-12-17 16:33:10 +1100108 int server_alive_count_max;
Darren Tucker46bc0752004-05-02 22:11:30 +1000109
110 int num_send_env;
111 char *send_env[MAX_SEND_ENV];
Damien Miller0e220db2004-06-15 10:34:08 +1000112
113 char *control_path;
114 int control_master;
Damien Millere1776152005-03-01 21:47:37 +1100115
116 int hash_known_hosts;
Damien Millerd27b9472005-12-13 19:29:02 +1100117
118 int tun_open; /* tun(4) */
119 int tun_local; /* force tun device (optional) */
120 int tun_remote; /* force tun device (optional) */
121
122 char *local_command;
123 int permit_local_command;
124
Damien Miller95def091999-11-25 00:26:21 +1100125} Options;
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000126
Damien Millerd14b1e72005-06-16 13:19:41 +1000127#define SSHCTL_MASTER_NO 0
128#define SSHCTL_MASTER_YES 1
129#define SSHCTL_MASTER_AUTO 2
130#define SSHCTL_MASTER_ASK 3
131#define SSHCTL_MASTER_AUTO_ASK 4
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000132
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000133void initialize_options(Options *);
134void fill_default_options(Options *);
Damien Miller57a44762004-04-20 20:11:57 +1000135int read_config_file(const char *, const char *, Options *, int);
Damien Millerf91ee4c2005-03-01 21:24:33 +1100136int parse_forward(Forward *, const char *);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000137
Damien Miller4af51302000-04-16 11:18:38 +1000138int
Ben Lindstrom16ae3d02001-07-04 04:02:36 +0000139process_config_line(Options *, const char *, char *, const char *, int, int *);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000140
Damien Millerf91ee4c2005-03-01 21:24:33 +1100141void add_local_forward(Options *, const Forward *);
142void add_remote_forward(Options *, const Forward *);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000143
Damien Miller95def091999-11-25 00:26:21 +1100144#endif /* READCONF_H */