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 | * |
| 3 | * readconf.h |
| 4 | * |
| 5 | * Author: Tatu Ylonen <ylo@cs.hut.fi> |
| 6 | * |
| 7 | * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland |
| 8 | * All rights reserved |
| 9 | * |
| 10 | * Created: Sat Apr 22 00:25:29 1995 ylo |
| 11 | * |
| 12 | * Functions for reading the configuration file. |
| 13 | * |
| 14 | */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 15 | |
Damien Miller | 7892879 | 2000-04-12 20:17:38 +1000 | [diff] [blame] | 16 | /* RCSID("$Id: readconf.h,v 1.7 2000/04/12 10:17:40 damien Exp $"); */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 17 | |
| 18 | #ifndef READCONF_H |
| 19 | #define READCONF_H |
| 20 | |
| 21 | /* Data structure for representing a forwarding request. */ |
| 22 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 23 | typedef struct { |
Damien Miller | aae6c61 | 1999-12-06 11:47:28 +1100 | [diff] [blame] | 24 | u_short port; /* Port to forward. */ |
| 25 | char *host; /* Host to connect. */ |
| 26 | u_short host_port; /* Port to connect on host. */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 27 | } Forward; |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 28 | /* Data structure for representing option data. */ |
| 29 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 30 | typedef struct { |
| 31 | int forward_agent; /* Forward authentication agent. */ |
| 32 | int forward_x11; /* Forward X11 display. */ |
| 33 | int gateway_ports; /* Allow remote connects to forwarded ports. */ |
| 34 | int use_privileged_port; /* Don't use privileged port if false. */ |
| 35 | int rhosts_authentication; /* Try rhosts authentication. */ |
| 36 | int rhosts_rsa_authentication; /* Try rhosts with RSA |
| 37 | * authentication. */ |
| 38 | int rsa_authentication; /* Try RSA authentication. */ |
| 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 | 7892879 | 2000-04-12 20:17:38 +1000 | [diff] [blame] | 67 | char *ciphers; /* Ciphers in order of preference. */ |
| 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 | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 76 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 77 | int num_identity_files; /* Number of files for RSA identities. */ |
| 78 | char *identity_files[SSH_MAX_IDENTITY_FILES]; |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 79 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 80 | /* Local TCP/IP forward requests. */ |
| 81 | int num_local_forwards; |
| 82 | Forward local_forwards[SSH_MAX_FORWARDS_PER_DIRECTION]; |
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 | /* Remote TCP/IP forward requests. */ |
| 85 | int num_remote_forwards; |
| 86 | Forward remote_forwards[SSH_MAX_FORWARDS_PER_DIRECTION]; |
| 87 | } Options; |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 88 | |
| 89 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 90 | /* |
| 91 | * Initializes options to special values that indicate that they have not yet |
| 92 | * been set. Read_config_file will only set options with this value. Options |
| 93 | * are processed in the following order: command line, user config file, |
| 94 | * system config file. Last, fill_default_options is called. |
| 95 | */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 96 | void initialize_options(Options * options); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 97 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 98 | /* |
| 99 | * Called after processing other sources of option data, this fills those |
| 100 | * options for which no value has been specified with their default values. |
| 101 | */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 102 | void fill_default_options(Options * options); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 103 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 104 | /* |
| 105 | * Processes a single option line as used in the configuration files. This |
| 106 | * only sets those values that have not already been set. Returns 0 for legal |
| 107 | * options |
| 108 | */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 109 | int |
| 110 | process_config_line(Options * options, const char *host, |
| 111 | char *line, const char *filename, int linenum, |
| 112 | int *activep); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 113 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 114 | /* |
| 115 | * Reads the config file and modifies the options accordingly. Options |
| 116 | * should already be initialized before this call. This never returns if |
| 117 | * there is an error. If the file does not exist, this returns immediately. |
| 118 | */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 119 | void |
| 120 | read_config_file(const char *filename, const char *host, |
| 121 | Options * options); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 122 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 123 | /* |
| 124 | * Adds a local TCP/IP port forward to options. Never returns if there is an |
| 125 | * error. |
| 126 | */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 127 | void |
Damien Miller | aae6c61 | 1999-12-06 11:47:28 +1100 | [diff] [blame] | 128 | add_local_forward(Options * options, u_short port, const char *host, |
| 129 | u_short host_port); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 130 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 131 | /* |
| 132 | * Adds a remote TCP/IP port forward to options. Never returns if there is |
| 133 | * an error. |
| 134 | */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 135 | void |
Damien Miller | aae6c61 | 1999-12-06 11:47:28 +1100 | [diff] [blame] | 136 | add_remote_forward(Options * options, u_short port, const char *host, |
| 137 | u_short host_port); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 138 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 139 | #endif /* READCONF_H */ |