blob: 991e20091e57966fe4214a714618333c783dc973 [file] [log] [blame]
Damien Miller2aa0ab42003-05-15 12:05:28 +10001/* $OpenBSD: readconf.h,v 1.49 2003/05/15 01:48:10 jakob 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 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 int kerberos_authentication; /* Try Kerberos authentication. */
Ben Lindstromec95ed92001-07-04 04:21:14 +000045 int kerberos_tgt_passing; /* Try Kerberos TGT passing. */
Damien Miller95def091999-11-25 00:26:21 +110046 int afs_token_passing; /* Try AFS token passing. */
Damien Miller95def091999-11-25 00:26:21 +110047 int password_authentication; /* Try password
48 * authentication. */
Damien Miller874d77b2000-10-14 16:23:11 +110049 int kbd_interactive_authentication; /* Try keyboard-interactive auth. */
50 char *kbd_interactive_devices; /* Keyboard-interactive auth devices. */
Damien Miller95def091999-11-25 00:26:21 +110051 int batch_mode; /* Batch mode: do not ask for passwords. */
52 int check_host_ip; /* Also keep track of keys for IP address */
53 int strict_host_key_checking; /* Strict host key checking. */
54 int compression; /* Compress packets in both directions. */
55 int compression_level; /* Compression level 1 (fast) to 9
56 * (best). */
57 int keepalives; /* Set SO_KEEPALIVE. */
58 LogLevel log_level; /* Level for logging. */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100059
Damien Miller95def091999-11-25 00:26:21 +110060 int port; /* Port to connect. */
61 int connection_attempts; /* Max attempts (seconds) before
62 * giving up */
63 int number_of_password_prompts; /* Max number of password
64 * prompts. */
65 int cipher; /* Cipher to use. */
Damien Miller30c3d422000-05-09 11:02:59 +100066 char *ciphers; /* SSH2 ciphers in order of preference. */
Ben Lindstrom06b33aa2001-02-15 03:01:59 +000067 char *macs; /* SSH2 macs in order of preference. */
Ben Lindstrom982dbbc2001-04-17 18:11:36 +000068 char *hostkeyalgorithms; /* SSH2 server key types in order of preference. */
Damien Miller78928792000-04-12 20:17:38 +100069 int protocol; /* Protocol in order of preference. */
Damien Miller95def091999-11-25 00:26:21 +110070 char *hostname; /* Real host to connect. */
Ben Lindstrom4dccfa52000-12-28 16:40:05 +000071 char *host_key_alias; /* hostname alias for .ssh/known_hosts */
Damien Miller95def091999-11-25 00:26:21 +110072 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 Millerafcc2252002-02-10 18:32:55 +110076 char *system_hostfile;/* Path for /etc/ssh/ssh_known_hosts. */
Damien Miller95def091999-11-25 00:26:21 +110077 char *user_hostfile; /* Path for $HOME/.ssh/known_hosts. */
Damien Millereba71ba2000-04-29 23:57:08 +100078 char *system_hostfile2;
79 char *user_hostfile2;
Ben Lindstromb9be60a2001-03-11 01:49:19 +000080 char *preferred_authentications;
Ben Lindstrome0f88042001-04-30 13:06:24 +000081 char *bind_address; /* local socket address for connection to sshd */
Ben Lindstromf7db3bb2001-08-06 21:35:51 +000082 char *smartcard_device; /* Smartcard reader device */
Damien Miller37876e92003-05-15 10:19:46 +100083 int verify_host_key_dns; /* Verify host key using DNS */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100084
Damien Miller0bc1bd82000-11-13 22:57:25 +110085 int num_identity_files; /* Number of files for RSA/DSA identities. */
Damien Miller95def091999-11-25 00:26:21 +110086 char *identity_files[SSH_MAX_IDENTITY_FILES];
Ben Lindstrom266dfdf2001-03-09 00:12:22 +000087 Key *identity_keys[SSH_MAX_IDENTITY_FILES];
Damien Millerd4a8b7e1999-10-27 13:42:43 +100088
Damien Miller95def091999-11-25 00:26:21 +110089 /* Local TCP/IP forward requests. */
90 int num_local_forwards;
91 Forward local_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
Damien Millerd4a8b7e1999-10-27 13:42:43 +100092
Damien Miller95def091999-11-25 00:26:21 +110093 /* Remote TCP/IP forward requests. */
94 int num_remote_forwards;
95 Forward remote_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
Ben Lindstrom2b7a0e92001-09-20 00:57:55 +000096 int clear_forwardings;
Ben Lindstromb6df73b2002-11-09 15:52:31 +000097
98 int enable_ssh_keysign;
Damien Millera5539d22003-04-09 20:50:06 +100099 int rekey_limit;
Ben Lindstrom3cecc9a2001-10-03 17:39:38 +0000100 int no_host_authentication_for_localhost;
Damien Miller95def091999-11-25 00:26:21 +1100101} Options;
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000102
103
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000104void initialize_options(Options *);
105void fill_default_options(Options *);
Ben Lindstromedc0cf22001-09-12 18:32:20 +0000106int read_config_file(const char *, const char *, Options *);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000107
Damien Miller4af51302000-04-16 11:18:38 +1000108int
Ben Lindstrom16ae3d02001-07-04 04:02:36 +0000109process_config_line(Options *, const char *, char *, const char *, int, int *);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000110
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000111void add_local_forward(Options *, u_short, const char *, u_short);
112void add_remote_forward(Options *, u_short, const char *, u_short);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000113
Damien Miller95def091999-11-25 00:26:21 +1100114#endif /* READCONF_H */