Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 1 | /* |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 2 | * Author: Tatu Ylonen <ylo@cs.hut.fi> |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 3 | * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland |
| 4 | * All rights reserved |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 5 | * Functions for reading the configuration file. |
Damien Miller | 4af5130 | 2000-04-16 11:18:38 +1000 | [diff] [blame] | 6 | * |
Damien Miller | e4340be | 2000-09-16 13:29:08 +1100 | [diff] [blame] | 7 | * 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 Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 12 | */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 13 | |
Ben Lindstrom | 95fb2dd | 2001-01-23 03:12:10 +0000 | [diff] [blame] | 14 | /* RCSID("$OpenBSD: readconf.h,v 1.25 2001/01/22 23:06:39 markus Exp $"); */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 15 | |
| 16 | #ifndef READCONF_H |
| 17 | #define READCONF_H |
| 18 | |
| 19 | /* Data structure for representing a forwarding request. */ |
| 20 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 21 | typedef struct { |
Damien Miller | aae6c61 | 1999-12-06 11:47:28 +1100 | [diff] [blame] | 22 | u_short port; /* Port to forward. */ |
| 23 | char *host; /* Host to connect. */ |
| 24 | u_short host_port; /* Port to connect on host. */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 25 | } Forward; |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 26 | /* Data structure for representing option data. */ |
| 27 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 28 | typedef struct { |
| 29 | int forward_agent; /* Forward authentication agent. */ |
| 30 | int forward_x11; /* Forward X11 display. */ |
Damien Miller | d3a1857 | 2000-06-07 19:55:44 +1000 | [diff] [blame] | 31 | char *xauth_location; /* Location for xauth program */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 32 | 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 Miller | 0bc1bd8 | 2000-11-13 22:57:25 +1100 | [diff] [blame] | 38 | int pubkey_authentication; /* Try ssh2 pubkey authentication. */ |
Ben Lindstrom | 95fb2dd | 2001-01-23 03:12:10 +0000 | [diff] [blame] | 39 | int challenge_reponse_authentication; |
| 40 | /* Try S/Key or TIS, authentication. */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 41 | #ifdef KRB4 |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 42 | int kerberos_authentication; /* Try Kerberos |
| 43 | * authentication. */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 44 | #endif |
| 45 | #ifdef AFS |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 46 | int kerberos_tgt_passing; /* Try Kerberos tgt passing. */ |
| 47 | int afs_token_passing; /* Try AFS token passing. */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 48 | #endif |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 49 | int password_authentication; /* Try password |
| 50 | * authentication. */ |
Damien Miller | 874d77b | 2000-10-14 16:23:11 +1100 | [diff] [blame] | 51 | int kbd_interactive_authentication; /* Try keyboard-interactive auth. */ |
| 52 | char *kbd_interactive_devices; /* Keyboard-interactive auth devices. */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 53 | 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 Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 63 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 64 | 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 Miller | 30c3d42 | 2000-05-09 11:02:59 +1000 | [diff] [blame] | 70 | char *ciphers; /* SSH2 ciphers in order of preference. */ |
Damien Miller | 7892879 | 2000-04-12 20:17:38 +1000 | [diff] [blame] | 71 | int protocol; /* Protocol in order of preference. */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 72 | char *hostname; /* Real host to connect. */ |
Ben Lindstrom | 4dccfa5 | 2000-12-28 16:40:05 +0000 | [diff] [blame] | 73 | char *host_key_alias; /* hostname alias for .ssh/known_hosts */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 74 | char *proxy_command; /* Proxy command for connecting the host. */ |
| 75 | char *user; /* User to log in as. */ |
| 76 | int escape_char; /* Escape character; -2 = none */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 77 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 78 | char *system_hostfile;/* Path for /etc/ssh_known_hosts. */ |
| 79 | char *user_hostfile; /* Path for $HOME/.ssh/known_hosts. */ |
Damien Miller | eba71ba | 2000-04-29 23:57:08 +1000 | [diff] [blame] | 80 | char *system_hostfile2; |
| 81 | char *user_hostfile2; |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 82 | |
Damien Miller | 0bc1bd8 | 2000-11-13 22:57:25 +1100 | [diff] [blame] | 83 | int num_identity_files; /* Number of files for RSA/DSA identities. */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 84 | char *identity_files[SSH_MAX_IDENTITY_FILES]; |
Damien Miller | 0bc1bd8 | 2000-11-13 22:57:25 +1100 | [diff] [blame] | 85 | int identity_files_type[SSH_MAX_IDENTITY_FILES]; |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 86 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 87 | /* Local TCP/IP forward requests. */ |
| 88 | int num_local_forwards; |
| 89 | Forward local_forwards[SSH_MAX_FORWARDS_PER_DIRECTION]; |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 90 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 91 | /* Remote TCP/IP forward requests. */ |
| 92 | int num_remote_forwards; |
| 93 | Forward remote_forwards[SSH_MAX_FORWARDS_PER_DIRECTION]; |
| 94 | } Options; |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 95 | |
| 96 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 97 | /* |
| 98 | * Initializes options to special values that indicate that they have not yet |
| 99 | * been set. Read_config_file will only set options with this value. Options |
| 100 | * are processed in the following order: command line, user config file, |
| 101 | * system config file. Last, fill_default_options is called. |
| 102 | */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 103 | void initialize_options(Options * options); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 104 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 105 | /* |
| 106 | * Called after processing other sources of option data, this fills those |
| 107 | * options for which no value has been specified with their default values. |
| 108 | */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 109 | void fill_default_options(Options * options); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 110 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 111 | /* |
| 112 | * Processes a single option line as used in the configuration files. This |
| 113 | * only sets those values that have not already been set. Returns 0 for legal |
| 114 | * options |
| 115 | */ |
Damien Miller | 4af5130 | 2000-04-16 11:18:38 +1000 | [diff] [blame] | 116 | int |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 117 | process_config_line(Options * options, const char *host, |
| 118 | char *line, const char *filename, int linenum, |
| 119 | int *activep); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 120 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 121 | /* |
| 122 | * Reads the config file and modifies the options accordingly. Options |
| 123 | * should already be initialized before this call. This never returns if |
| 124 | * there is an error. If the file does not exist, this returns immediately. |
| 125 | */ |
Damien Miller | 4af5130 | 2000-04-16 11:18:38 +1000 | [diff] [blame] | 126 | void |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 127 | read_config_file(const char *filename, const char *host, |
| 128 | Options * options); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 129 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 130 | /* |
| 131 | * Adds a local TCP/IP port forward to options. Never returns if there is an |
| 132 | * error. |
| 133 | */ |
Damien Miller | 4af5130 | 2000-04-16 11:18:38 +1000 | [diff] [blame] | 134 | void |
Damien Miller | aae6c61 | 1999-12-06 11:47:28 +1100 | [diff] [blame] | 135 | add_local_forward(Options * options, u_short port, const char *host, |
| 136 | u_short host_port); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 137 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 138 | /* |
| 139 | * Adds a remote TCP/IP port forward to options. Never returns if there is |
| 140 | * an error. |
| 141 | */ |
Damien Miller | 4af5130 | 2000-04-16 11:18:38 +1000 | [diff] [blame] | 142 | void |
Damien Miller | aae6c61 | 1999-12-06 11:47:28 +1100 | [diff] [blame] | 143 | add_remote_forward(Options * options, u_short port, const char *host, |
| 144 | u_short host_port); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 145 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 146 | #endif /* READCONF_H */ |