blob: 25ffa4668b4f482ff70389e88640a98e84709e42 [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 Lindstrom3cecc9a2001-10-03 17:39:38 +000014/* RCSID("$OpenBSD: readconf.h,v 1.40 2001/10/01 21:51:16 markus Exp $"); */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100015
16#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 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. */
Damien Millerd3a18572000-06-07 19:55:44 +100033 char *xauth_location; /* Location for xauth program */
Damien Miller95def091999-11-25 00:26:21 +110034 int gateway_ports; /* Allow remote connects to forwarded ports. */
35 int use_privileged_port; /* Don't use privileged port if false. */
36 int rhosts_authentication; /* Try rhosts authentication. */
37 int rhosts_rsa_authentication; /* Try rhosts with RSA
38 * authentication. */
39 int rsa_authentication; /* Try RSA authentication. */
Damien Miller0bc1bd82000-11-13 22:57:25 +110040 int pubkey_authentication; /* Try ssh2 pubkey authentication. */
Ben Lindstrom5eabda32001-04-12 23:34:34 +000041 int hostbased_authentication; /* ssh2's rhosts_rsa */
Ben Lindstrom551ea372001-06-05 18:56:16 +000042 int challenge_response_authentication;
Ben Lindstrom95fb2dd2001-01-23 03:12:10 +000043 /* Try S/Key or TIS, authentication. */
Ben Lindstromec95ed92001-07-04 04:21:14 +000044#if defined(KRB4) || defined(KRB5)
45 int kerberos_authentication; /* Try Kerberos authentication. */
46#endif
47#if defined(AFS) || defined(KRB5)
48 int kerberos_tgt_passing; /* Try Kerberos TGT passing. */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100049#endif
50#ifdef AFS
Damien Miller95def091999-11-25 00:26:21 +110051 int afs_token_passing; /* Try AFS token passing. */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100052#endif
Damien Miller95def091999-11-25 00:26:21 +110053 int password_authentication; /* Try password
54 * authentication. */
Damien Miller874d77b2000-10-14 16:23:11 +110055 int kbd_interactive_authentication; /* Try keyboard-interactive auth. */
56 char *kbd_interactive_devices; /* Keyboard-interactive auth devices. */
Damien Miller95def091999-11-25 00:26:21 +110057 int fallback_to_rsh;/* Use rsh if cannot connect with ssh. */
58 int use_rsh; /* Always use rsh (don\'t try ssh). */
59 int batch_mode; /* Batch mode: do not ask for passwords. */
60 int check_host_ip; /* Also keep track of keys for IP address */
61 int strict_host_key_checking; /* Strict host key checking. */
62 int compression; /* Compress packets in both directions. */
63 int compression_level; /* Compression level 1 (fast) to 9
64 * (best). */
65 int keepalives; /* Set SO_KEEPALIVE. */
66 LogLevel log_level; /* Level for logging. */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100067
Damien Miller95def091999-11-25 00:26:21 +110068 int port; /* Port to connect. */
69 int connection_attempts; /* Max attempts (seconds) before
70 * giving up */
71 int number_of_password_prompts; /* Max number of password
72 * prompts. */
73 int cipher; /* Cipher to use. */
Damien Miller30c3d422000-05-09 11:02:59 +100074 char *ciphers; /* SSH2 ciphers in order of preference. */
Ben Lindstrom06b33aa2001-02-15 03:01:59 +000075 char *macs; /* SSH2 macs in order of preference. */
Ben Lindstrom982dbbc2001-04-17 18:11:36 +000076 char *hostkeyalgorithms; /* SSH2 server key types in order of preference. */
Damien Miller78928792000-04-12 20:17:38 +100077 int protocol; /* Protocol in order of preference. */
Damien Miller95def091999-11-25 00:26:21 +110078 char *hostname; /* Real host to connect. */
Ben Lindstrom4dccfa52000-12-28 16:40:05 +000079 char *host_key_alias; /* hostname alias for .ssh/known_hosts */
Damien Miller95def091999-11-25 00:26:21 +110080 char *proxy_command; /* Proxy command for connecting the host. */
81 char *user; /* User to log in as. */
82 int escape_char; /* Escape character; -2 = none */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100083
Damien Miller95def091999-11-25 00:26:21 +110084 char *system_hostfile;/* Path for /etc/ssh_known_hosts. */
85 char *user_hostfile; /* Path for $HOME/.ssh/known_hosts. */
Damien Millereba71ba2000-04-29 23:57:08 +100086 char *system_hostfile2;
87 char *user_hostfile2;
Ben Lindstromb9be60a2001-03-11 01:49:19 +000088 char *preferred_authentications;
Ben Lindstrome0f88042001-04-30 13:06:24 +000089 char *bind_address; /* local socket address for connection to sshd */
Ben Lindstromf7db3bb2001-08-06 21:35:51 +000090 char *smartcard_device; /* Smartcard reader device */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100091
Damien Miller0bc1bd82000-11-13 22:57:25 +110092 int num_identity_files; /* Number of files for RSA/DSA identities. */
Damien Miller95def091999-11-25 00:26:21 +110093 char *identity_files[SSH_MAX_IDENTITY_FILES];
Ben Lindstrom266dfdf2001-03-09 00:12:22 +000094 Key *identity_keys[SSH_MAX_IDENTITY_FILES];
Damien Millerd4a8b7e1999-10-27 13:42:43 +100095
Damien Miller95def091999-11-25 00:26:21 +110096 /* Local TCP/IP forward requests. */
97 int num_local_forwards;
98 Forward local_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
Damien Millerd4a8b7e1999-10-27 13:42:43 +100099
Damien Miller95def091999-11-25 00:26:21 +1100100 /* Remote TCP/IP forward requests. */
101 int num_remote_forwards;
102 Forward remote_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
Ben Lindstrom2b7a0e92001-09-20 00:57:55 +0000103 int clear_forwardings;
Ben Lindstrom3cecc9a2001-10-03 17:39:38 +0000104 int no_host_authentication_for_localhost;
Damien Miller95def091999-11-25 00:26:21 +1100105} Options;
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000106
107
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000108void initialize_options(Options *);
109void fill_default_options(Options *);
Ben Lindstromedc0cf22001-09-12 18:32:20 +0000110int read_config_file(const char *, const char *, Options *);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000111
Damien Miller4af51302000-04-16 11:18:38 +1000112int
Ben Lindstrom16ae3d02001-07-04 04:02:36 +0000113process_config_line(Options *, const char *, char *, const char *, int, int *);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000114
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000115void add_local_forward(Options *, u_short, const char *, u_short);
116void add_remote_forward(Options *, u_short, const char *, u_short);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000117
Damien Miller95def091999-11-25 00:26:21 +1100118#endif /* READCONF_H */