]>
Commit | Line | Data |
---|---|---|
8efc0c15 | 1 | /* |
5260325f | 2 | * Author: Tatu Ylonen <ylo@cs.hut.fi> |
5260325f | 3 | * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland |
4 | * All rights reserved | |
5260325f | 5 | * Functions for reading the configuration file. |
6ae2364d | 6 | * |
bcbf86ec | 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". | |
5260325f | 12 | */ |
8efc0c15 | 13 | |
fee56204 | 14 | /* RCSID("$OpenBSD: readconf.h,v 1.27 2001/03/08 21:42:32 markus Exp $"); */ |
8efc0c15 | 15 | |
16 | #ifndef READCONF_H | |
17 | #define READCONF_H | |
18 | ||
fee56204 | 19 | #include "key.h" |
20 | ||
8efc0c15 | 21 | /* Data structure for representing a forwarding request. */ |
22 | ||
5260325f | 23 | typedef struct { |
57112b5a | 24 | u_short port; /* Port to forward. */ |
25 | char *host; /* Host to connect. */ | |
26 | u_short host_port; /* Port to connect on host. */ | |
5260325f | 27 | } Forward; |
8efc0c15 | 28 | /* Data structure for representing option data. */ |
29 | ||
5260325f | 30 | typedef struct { |
31 | int forward_agent; /* Forward authentication agent. */ | |
32 | int forward_x11; /* Forward X11 display. */ | |
fa649821 | 33 | char *xauth_location; /* Location for xauth program */ |
5260325f | 34 | 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. */ | |
fa08c86b | 40 | int pubkey_authentication; /* Try ssh2 pubkey authentication. */ |
d464095c | 41 | int challenge_reponse_authentication; |
42 | /* Try S/Key or TIS, authentication. */ | |
8efc0c15 | 43 | #ifdef KRB4 |
5260325f | 44 | int kerberos_authentication; /* Try Kerberos |
45 | * authentication. */ | |
8efc0c15 | 46 | #endif |
47 | #ifdef AFS | |
5260325f | 48 | int kerberos_tgt_passing; /* Try Kerberos tgt passing. */ |
49 | int afs_token_passing; /* Try AFS token passing. */ | |
8efc0c15 | 50 | #endif |
5260325f | 51 | int password_authentication; /* Try password |
52 | * authentication. */ | |
94ec8c6b | 53 | int kbd_interactive_authentication; /* Try keyboard-interactive auth. */ |
54 | char *kbd_interactive_devices; /* Keyboard-interactive auth devices. */ | |
5260325f | 55 | int fallback_to_rsh;/* Use rsh if cannot connect with ssh. */ |
56 | int use_rsh; /* Always use rsh (don\'t try ssh). */ | |
57 | int batch_mode; /* Batch mode: do not ask for passwords. */ | |
58 | int check_host_ip; /* Also keep track of keys for IP address */ | |
59 | int strict_host_key_checking; /* Strict host key checking. */ | |
60 | int compression; /* Compress packets in both directions. */ | |
61 | int compression_level; /* Compression level 1 (fast) to 9 | |
62 | * (best). */ | |
63 | int keepalives; /* Set SO_KEEPALIVE. */ | |
64 | LogLevel log_level; /* Level for logging. */ | |
65 | ||
66 | int port; /* Port to connect. */ | |
67 | int connection_attempts; /* Max attempts (seconds) before | |
68 | * giving up */ | |
69 | int number_of_password_prompts; /* Max number of password | |
70 | * prompts. */ | |
71 | int cipher; /* Cipher to use. */ | |
d0c832f3 | 72 | char *ciphers; /* SSH2 ciphers in order of preference. */ |
b2552997 | 73 | char *macs; /* SSH2 macs in order of preference. */ |
a8be9f80 | 74 | int protocol; /* Protocol in order of preference. */ |
5260325f | 75 | char *hostname; /* Real host to connect. */ |
8abcdba4 | 76 | char *host_key_alias; /* hostname alias for .ssh/known_hosts */ |
5260325f | 77 | char *proxy_command; /* Proxy command for connecting the host. */ |
78 | char *user; /* User to log in as. */ | |
79 | int escape_char; /* Escape character; -2 = none */ | |
80 | ||
81 | char *system_hostfile;/* Path for /etc/ssh_known_hosts. */ | |
82 | char *user_hostfile; /* Path for $HOME/.ssh/known_hosts. */ | |
a306f2dd | 83 | char *system_hostfile2; |
84 | char *user_hostfile2; | |
5260325f | 85 | |
fa08c86b | 86 | int num_identity_files; /* Number of files for RSA/DSA identities. */ |
5260325f | 87 | char *identity_files[SSH_MAX_IDENTITY_FILES]; |
fee56204 | 88 | Key *identity_keys[SSH_MAX_IDENTITY_FILES]; |
5260325f | 89 | |
90 | /* Local TCP/IP forward requests. */ | |
91 | int num_local_forwards; | |
92 | Forward local_forwards[SSH_MAX_FORWARDS_PER_DIRECTION]; | |
93 | ||
94 | /* Remote TCP/IP forward requests. */ | |
95 | int num_remote_forwards; | |
96 | Forward remote_forwards[SSH_MAX_FORWARDS_PER_DIRECTION]; | |
97 | } Options; | |
8efc0c15 | 98 | |
99 | ||
aa3378df | 100 | /* |
101 | * Initializes options to special values that indicate that they have not yet | |
102 | * been set. Read_config_file will only set options with this value. Options | |
103 | * are processed in the following order: command line, user config file, | |
104 | * system config file. Last, fill_default_options is called. | |
105 | */ | |
5260325f | 106 | void initialize_options(Options * options); |
8efc0c15 | 107 | |
aa3378df | 108 | /* |
109 | * Called after processing other sources of option data, this fills those | |
110 | * options for which no value has been specified with their default values. | |
111 | */ | |
5260325f | 112 | void fill_default_options(Options * options); |
8efc0c15 | 113 | |
aa3378df | 114 | /* |
115 | * Processes a single option line as used in the configuration files. This | |
116 | * only sets those values that have not already been set. Returns 0 for legal | |
117 | * options | |
118 | */ | |
6ae2364d | 119 | int |
5260325f | 120 | process_config_line(Options * options, const char *host, |
121 | char *line, const char *filename, int linenum, | |
122 | int *activep); | |
8efc0c15 | 123 | |
aa3378df | 124 | /* |
125 | * Reads the config file and modifies the options accordingly. Options | |
126 | * should already be initialized before this call. This never returns if | |
127 | * there is an error. If the file does not exist, this returns immediately. | |
128 | */ | |
6ae2364d | 129 | void |
5260325f | 130 | read_config_file(const char *filename, const char *host, |
131 | Options * options); | |
8efc0c15 | 132 | |
aa3378df | 133 | /* |
134 | * Adds a local TCP/IP port forward to options. Never returns if there is an | |
135 | * error. | |
136 | */ | |
6ae2364d | 137 | void |
57112b5a | 138 | add_local_forward(Options * options, u_short port, const char *host, |
139 | u_short host_port); | |
8efc0c15 | 140 | |
aa3378df | 141 | /* |
142 | * Adds a remote TCP/IP port forward to options. Never returns if there is | |
143 | * an error. | |
144 | */ | |
6ae2364d | 145 | void |
57112b5a | 146 | add_remote_forward(Options * options, u_short port, const char *host, |
147 | u_short host_port); | |
8efc0c15 | 148 | |
5260325f | 149 | #endif /* READCONF_H */ |