blob: bc3e8c1bb080512de11befe71643081ed6b4d72f [file] [log] [blame]
Damien Miller21771e22011-05-15 08:45:50 +10001/* $OpenBSD: readconf.h,v 1.89 2011/05/06 21:34:32 djm 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
19/* Data structure for representing a forwarding request. */
20
Damien Miller95def091999-11-25 00:26:21 +110021typedef struct {
Damien Millerf91ee4c2005-03-01 21:24:33 +110022 char *listen_host; /* Host (address) to listen on. */
Damien Miller3dc71ad2009-01-28 16:31:22 +110023 int listen_port; /* Port to forward. */
Damien Millerf91ee4c2005-03-01 21:24:33 +110024 char *connect_host; /* Host to connect. */
Damien Miller3dc71ad2009-01-28 16:31:22 +110025 int connect_port; /* Port to connect on connect_host. */
Damien Miller388f6fc2010-05-21 14:57:35 +100026 int allocated_port; /* Dynamically allocated listen port */
Damien Miller95def091999-11-25 00:26:21 +110027} Forward;
Damien Millerd4a8b7e1999-10-27 13:42:43 +100028/* Data structure for representing option data. */
29
Darren Tucker46bc0752004-05-02 22:11:30 +100030#define MAX_SEND_ENV 256
31
Damien Miller95def091999-11-25 00:26:21 +110032typedef struct {
33 int forward_agent; /* Forward authentication agent. */
34 int forward_x11; /* Forward X11 display. */
Damien Miller1ab6a512010-06-26 10:02:24 +100035 int forward_x11_timeout; /* Expiration for Cookies */
Darren Tucker0a118da2003-10-15 15:54:32 +100036 int forward_x11_trusted; /* Trust Forward X11 display. */
Darren Tuckere7d4b192006-07-12 22:17:10 +100037 int exit_on_forward_failure; /* Exit if bind(2) fails for -L/-R */
Damien Millerd3a18572000-06-07 19:55:44 +100038 char *xauth_location; /* Location for xauth program */
Damien Miller95def091999-11-25 00:26:21 +110039 int gateway_ports; /* Allow remote connects to forwarded ports. */
40 int use_privileged_port; /* Don't use privileged port if false. */
Damien Miller95def091999-11-25 00:26:21 +110041 int rhosts_rsa_authentication; /* Try rhosts with RSA
42 * authentication. */
43 int rsa_authentication; /* Try RSA authentication. */
Damien Miller0bc1bd82000-11-13 22:57:25 +110044 int pubkey_authentication; /* Try ssh2 pubkey authentication. */
Ben Lindstrom5eabda32001-04-12 23:34:34 +000045 int hostbased_authentication; /* ssh2's rhosts_rsa */
Ben Lindstrom551ea372001-06-05 18:56:16 +000046 int challenge_response_authentication;
Ben Lindstrom95fb2dd2001-01-23 03:12:10 +000047 /* Try S/Key or TIS, authentication. */
Darren Tucker0efd1552003-08-26 11:49:55 +100048 int gss_authentication; /* Try GSS authentication */
49 int gss_deleg_creds; /* Delegate GSS credentials */
Damien Miller95def091999-11-25 00:26:21 +110050 int password_authentication; /* Try password
51 * authentication. */
Damien Miller874d77b2000-10-14 16:23:11 +110052 int kbd_interactive_authentication; /* Try keyboard-interactive auth. */
53 char *kbd_interactive_devices; /* Keyboard-interactive auth devices. */
Damien Miller01ed2272008-11-05 16:20:46 +110054 int zero_knowledge_password_authentication; /* Try jpake */
Damien Miller95def091999-11-25 00:26:21 +110055 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). */
Damien Miller12c150e2003-12-17 16:31:10 +110061 int tcp_keep_alive; /* Set SO_KEEPALIVE. */
Damien Miller0dac6fb2010-11-20 15:19:38 +110062 int ip_qos_interactive; /* IP ToS/DSCP/class for interactive */
63 int ip_qos_bulk; /* IP ToS/DSCP/class for bulk traffic */
Damien Miller95def091999-11-25 00:26:21 +110064 LogLevel log_level; /* Level for logging. */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100065
Damien Miller95def091999-11-25 00:26:21 +110066 int port; /* Port to connect. */
Darren Tucker0a4f04b2003-07-03 20:37:47 +100067 int address_family;
Damien Miller95def091999-11-25 00:26:21 +110068 int connection_attempts; /* Max attempts (seconds) before
69 * giving up */
Damien Millerb78d5eb2003-05-16 11:39:04 +100070 int connection_timeout; /* Max time (seconds) before
Damien Millera8e06ce2003-11-21 23:48:55 +110071 * aborting connection attempt */
Damien Miller95def091999-11-25 00:26:21 +110072 int number_of_password_prompts; /* Max number of password
73 * prompts. */
74 int cipher; /* Cipher to use. */
Damien Miller30c3d422000-05-09 11:02:59 +100075 char *ciphers; /* SSH2 ciphers in order of preference. */
Ben Lindstrom06b33aa2001-02-15 03:01:59 +000076 char *macs; /* SSH2 macs in order of preference. */
Ben Lindstrom982dbbc2001-04-17 18:11:36 +000077 char *hostkeyalgorithms; /* SSH2 server key types in order of preference. */
Damien Millerd5f62bf2010-09-24 22:11:14 +100078 char *kex_algorithms; /* SSH2 kex methods in order of preference. */
Damien Miller78928792000-04-12 20:17:38 +100079 int protocol; /* Protocol in order of preference. */
Damien Miller95def091999-11-25 00:26:21 +110080 char *hostname; /* Real host to connect. */
Ben Lindstrom4dccfa52000-12-28 16:40:05 +000081 char *host_key_alias; /* hostname alias for .ssh/known_hosts */
Damien Miller95def091999-11-25 00:26:21 +110082 char *proxy_command; /* Proxy command for connecting the host. */
83 char *user; /* User to log in as. */
84 int escape_char; /* Escape character; -2 = none */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100085
Damien Millerafcc2252002-02-10 18:32:55 +110086 char *system_hostfile;/* Path for /etc/ssh/ssh_known_hosts. */
Damien Miller95def091999-11-25 00:26:21 +110087 char *user_hostfile; /* Path for $HOME/.ssh/known_hosts. */
Damien Millereba71ba2000-04-29 23:57:08 +100088 char *system_hostfile2;
89 char *user_hostfile2;
Ben Lindstromb9be60a2001-03-11 01:49:19 +000090 char *preferred_authentications;
Ben Lindstrome0f88042001-04-30 13:06:24 +000091 char *bind_address; /* local socket address for connection to sshd */
Damien Miller7ea845e2010-02-12 09:21:02 +110092 char *pkcs11_provider; /* PKCS#11 provider */
Damien Miller37876e92003-05-15 10:19:46 +100093 int verify_host_key_dns; /* Verify host key using DNS */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100094
Damien Miller0bc1bd82000-11-13 22:57:25 +110095 int num_identity_files; /* Number of files for RSA/DSA identities. */
Damien Miller95def091999-11-25 00:26:21 +110096 char *identity_files[SSH_MAX_IDENTITY_FILES];
Ben Lindstrom266dfdf2001-03-09 00:12:22 +000097 Key *identity_keys[SSH_MAX_IDENTITY_FILES];
Damien Millerd4a8b7e1999-10-27 13:42:43 +100098
Damien Miller95def091999-11-25 00:26:21 +110099 /* Local TCP/IP forward requests. */
100 int num_local_forwards;
Damien Miller232cfb12010-06-26 09:50:30 +1000101 Forward *local_forwards;
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000102
Damien Miller95def091999-11-25 00:26:21 +1100103 /* Remote TCP/IP forward requests. */
104 int num_remote_forwards;
Damien Miller232cfb12010-06-26 09:50:30 +1000105 Forward *remote_forwards;
Ben Lindstrom2b7a0e92001-09-20 00:57:55 +0000106 int clear_forwardings;
Ben Lindstromb6df73b2002-11-09 15:52:31 +0000107
108 int enable_ssh_keysign;
Damien Miller3dff1762008-02-10 22:25:52 +1100109 int64_t rekey_limit;
Ben Lindstrom3cecc9a2001-10-03 17:39:38 +0000110 int no_host_authentication_for_localhost;
Damien Millerbd394c32004-03-08 23:12:36 +1100111 int identities_only;
Darren Tuckerfc959702004-07-17 16:12:08 +1000112 int server_alive_interval;
Damien Miller509b0102003-12-17 16:33:10 +1100113 int server_alive_count_max;
Darren Tucker46bc0752004-05-02 22:11:30 +1000114
115 int num_send_env;
116 char *send_env[MAX_SEND_ENV];
Damien Miller0e220db2004-06-15 10:34:08 +1000117
118 char *control_path;
119 int control_master;
Damien Millere11e1ea2010-08-03 16:04:46 +1000120 int control_persist; /* ControlPersist flag */
121 int control_persist_timeout; /* ControlPersist timeout (seconds) */
Damien Millere1776152005-03-01 21:47:37 +1100122
123 int hash_known_hosts;
Damien Millerd27b9472005-12-13 19:29:02 +1100124
125 int tun_open; /* tun(4) */
126 int tun_local; /* force tun device (optional) */
127 int tun_remote; /* force tun device (optional) */
128
129 char *local_command;
130 int permit_local_command;
Damien Miller10288242008-06-30 00:04:03 +1000131 int visual_host_key;
Damien Millerd27b9472005-12-13 19:29:02 +1100132
Darren Tucker71e4d542009-07-06 07:12:27 +1000133 int use_roaming;
134
Damien Miller21771e22011-05-15 08:45:50 +1000135 int request_tty;
Damien Miller95def091999-11-25 00:26:21 +1100136} Options;
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000137
Damien Millerd14b1e72005-06-16 13:19:41 +1000138#define SSHCTL_MASTER_NO 0
139#define SSHCTL_MASTER_YES 1
140#define SSHCTL_MASTER_AUTO 2
141#define SSHCTL_MASTER_ASK 3
142#define SSHCTL_MASTER_AUTO_ASK 4
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000143
Damien Miller21771e22011-05-15 08:45:50 +1000144#define REQUEST_TTY_AUTO 0
145#define REQUEST_TTY_NO 1
146#define REQUEST_TTY_YES 2
147#define REQUEST_TTY_FORCE 3
148
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000149void initialize_options(Options *);
150void fill_default_options(Options *);
Damien Miller57a44762004-04-20 20:11:57 +1000151int read_config_file(const char *, const char *, Options *, int);
Damien Miller4bf648f2009-02-14 16:28:21 +1100152int parse_forward(Forward *, const char *, int, int);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000153
Damien Miller4af51302000-04-16 11:18:38 +1000154int
Ben Lindstrom16ae3d02001-07-04 04:02:36 +0000155process_config_line(Options *, const char *, char *, const char *, int, int *);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000156
Damien Millerf91ee4c2005-03-01 21:24:33 +1100157void add_local_forward(Options *, const Forward *);
158void add_remote_forward(Options *, const Forward *);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000159
Damien Miller95def091999-11-25 00:26:21 +1100160#endif /* READCONF_H */