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 | |
Damien Miller | e4340be | 2000-09-16 13:29:08 +1100 | [diff] [blame] | 14 | /* RCSID("$OpenBSD: readconf.h,v 1.21 2000/09/07 20:27:53 deraadt 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 | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 38 | int dsa_authentication; /* Try DSA authentication. */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 39 | int skey_authentication; /* Try S/Key or TIS authentication. */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 40 | #ifdef KRB4 |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 41 | int kerberos_authentication; /* Try Kerberos |
| 42 | * authentication. */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 43 | #endif |
| 44 | #ifdef AFS |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 45 | int kerberos_tgt_passing; /* Try Kerberos tgt passing. */ |
| 46 | int afs_token_passing; /* Try AFS token passing. */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 47 | #endif |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 48 | int password_authentication; /* Try password |
| 49 | * authentication. */ |
| 50 | int fallback_to_rsh;/* Use rsh if cannot connect with ssh. */ |
| 51 | int use_rsh; /* Always use rsh (don\'t try ssh). */ |
| 52 | int batch_mode; /* Batch mode: do not ask for passwords. */ |
| 53 | int check_host_ip; /* Also keep track of keys for IP address */ |
| 54 | int strict_host_key_checking; /* Strict host key checking. */ |
| 55 | int compression; /* Compress packets in both directions. */ |
| 56 | int compression_level; /* Compression level 1 (fast) to 9 |
| 57 | * (best). */ |
| 58 | int keepalives; /* Set SO_KEEPALIVE. */ |
| 59 | LogLevel log_level; /* Level for logging. */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 60 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 61 | int port; /* Port to connect. */ |
| 62 | int connection_attempts; /* Max attempts (seconds) before |
| 63 | * giving up */ |
| 64 | int number_of_password_prompts; /* Max number of password |
| 65 | * prompts. */ |
| 66 | int cipher; /* Cipher to use. */ |
Damien Miller | 30c3d42 | 2000-05-09 11:02:59 +1000 | [diff] [blame] | 67 | char *ciphers; /* SSH2 ciphers in order of preference. */ |
Damien Miller | 7892879 | 2000-04-12 20:17:38 +1000 | [diff] [blame] | 68 | int protocol; /* Protocol in order of preference. */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 69 | char *hostname; /* Real host to connect. */ |
| 70 | char *proxy_command; /* Proxy command for connecting the host. */ |
| 71 | char *user; /* User to log in as. */ |
| 72 | int escape_char; /* Escape character; -2 = none */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 73 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 74 | char *system_hostfile;/* Path for /etc/ssh_known_hosts. */ |
| 75 | char *user_hostfile; /* Path for $HOME/.ssh/known_hosts. */ |
Damien Miller | eba71ba | 2000-04-29 23:57:08 +1000 | [diff] [blame] | 76 | char *system_hostfile2; |
| 77 | char *user_hostfile2; |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 78 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 79 | int num_identity_files; /* Number of files for RSA identities. */ |
Damien Miller | eba71ba | 2000-04-29 23:57:08 +1000 | [diff] [blame] | 80 | int num_identity_files2; /* DSA identities. */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 81 | char *identity_files[SSH_MAX_IDENTITY_FILES]; |
Damien Miller | eba71ba | 2000-04-29 23:57:08 +1000 | [diff] [blame] | 82 | char *identity_files2[SSH_MAX_IDENTITY_FILES]; |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 83 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 84 | /* Local TCP/IP forward requests. */ |
| 85 | int num_local_forwards; |
| 86 | Forward local_forwards[SSH_MAX_FORWARDS_PER_DIRECTION]; |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 87 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 88 | /* Remote TCP/IP forward requests. */ |
| 89 | int num_remote_forwards; |
| 90 | Forward remote_forwards[SSH_MAX_FORWARDS_PER_DIRECTION]; |
| 91 | } Options; |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 92 | |
| 93 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 94 | /* |
| 95 | * Initializes options to special values that indicate that they have not yet |
| 96 | * been set. Read_config_file will only set options with this value. Options |
| 97 | * are processed in the following order: command line, user config file, |
| 98 | * system config file. Last, fill_default_options is called. |
| 99 | */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 100 | void initialize_options(Options * options); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 101 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 102 | /* |
| 103 | * Called after processing other sources of option data, this fills those |
| 104 | * options for which no value has been specified with their default values. |
| 105 | */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 106 | void fill_default_options(Options * options); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 107 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 108 | /* |
| 109 | * Processes a single option line as used in the configuration files. This |
| 110 | * only sets those values that have not already been set. Returns 0 for legal |
| 111 | * options |
| 112 | */ |
Damien Miller | 4af5130 | 2000-04-16 11:18:38 +1000 | [diff] [blame] | 113 | int |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 114 | process_config_line(Options * options, const char *host, |
| 115 | char *line, const char *filename, int linenum, |
| 116 | int *activep); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 117 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 118 | /* |
| 119 | * Reads the config file and modifies the options accordingly. Options |
| 120 | * should already be initialized before this call. This never returns if |
| 121 | * there is an error. If the file does not exist, this returns immediately. |
| 122 | */ |
Damien Miller | 4af5130 | 2000-04-16 11:18:38 +1000 | [diff] [blame] | 123 | void |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 124 | read_config_file(const char *filename, const char *host, |
| 125 | Options * options); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 126 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 127 | /* |
| 128 | * Adds a local TCP/IP port forward to options. Never returns if there is an |
| 129 | * error. |
| 130 | */ |
Damien Miller | 4af5130 | 2000-04-16 11:18:38 +1000 | [diff] [blame] | 131 | void |
Damien Miller | aae6c61 | 1999-12-06 11:47:28 +1100 | [diff] [blame] | 132 | add_local_forward(Options * options, u_short port, const char *host, |
| 133 | u_short host_port); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 134 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 135 | /* |
| 136 | * Adds a remote TCP/IP port forward to options. Never returns if there is |
| 137 | * an error. |
| 138 | */ |
Damien Miller | 4af5130 | 2000-04-16 11:18:38 +1000 | [diff] [blame] | 139 | void |
Damien Miller | aae6c61 | 1999-12-06 11:47:28 +1100 | [diff] [blame] | 140 | add_remote_forward(Options * options, u_short port, const char *host, |
| 141 | u_short host_port); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 142 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 143 | #endif /* READCONF_H */ |