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