Grid Community Toolkit  6.2.1567772254 (tag: v6.2.20190906)
readconf.h
1 /* $OpenBSD: readconf.h,v 1.117 2016/07/15 00:24:30 djm Exp $ */
2 
3 /*
4  * Author: Tatu Ylonen <[email protected]>
5  * Copyright (c) 1995 Tatu Ylonen <[email protected]>, Espoo, Finland
6  * All rights reserved
7  * Functions for reading the configuration file.
8  *
9  * As far as I am concerned, the code I have written for this software
10  * can be used freely for any purpose. Any derived versions of this
11  * software must be clearly marked as such, and if the derived work is
12  * incompatible with the protocol description in the RFC file, it must be
13  * called by a name other than "ssh" or "Secure Shell".
14  */
15 
16 #ifndef READCONF_H
17 #define READCONF_H
18 
19 /* Data structure for representing option data. */
20 
21 #define MAX_SEND_ENV 256
22 #define SSH_MAX_HOSTS_FILES 32
23 #define MAX_CANON_DOMAINS 32
24 #define PATH_MAX_SUN (sizeof((struct sockaddr_un *)0)->sun_path)
25 
26 struct allowed_cname {
27  char *source_list;
28  char *target_list;
29 };
30 
31 typedef struct {
32  int forward_agent; /* Forward authentication agent. */
33  int forward_x11; /* Forward X11 display. */
34  int forward_x11_timeout; /* Expiration for Cookies */
35  int forward_x11_trusted; /* Trust Forward X11 display. */
36  int exit_on_forward_failure; /* Exit if bind(2) fails for -L/-R */
37  char *xauth_location; /* Location for xauth program */
38  struct ForwardOptions fwd_opts; /* forwarding options */
39  int use_privileged_port; /* Don't use privileged port if false. */
40  int rhosts_rsa_authentication; /* Try rhosts with RSA
41  * authentication. */
42  int rsa_authentication; /* Try RSA authentication. */
43  int pubkey_authentication; /* Try ssh2 pubkey authentication. */
44  int hostbased_authentication; /* ssh2's rhosts_rsa */
45  int challenge_response_authentication;
46  /* Try S/Key or TIS, authentication. */
47  int gss_authentication; /* Try GSS authentication */
48  int gss_keyex; /* Try GSS key exchange */
49  int gss_deleg_creds; /* Delegate GSS credentials */
50  int gss_trust_dns; /* Trust DNS for GSS canonicalization */
51  int gss_renewal_rekey; /* Credential renewal forces rekey */
52  char *gss_client_identity; /* Principal to initiate GSSAPI with */
53  char *gss_server_identity; /* GSSAPI target principal */
54  int password_authentication; /* Try password
55  * authentication. */
56  int kbd_interactive_authentication; /* Try keyboard-interactive auth. */
57  char *kbd_interactive_devices; /* Keyboard-interactive auth devices. */
58  int batch_mode; /* Batch mode: do not ask for passwords. */
59  int check_host_ip; /* Also keep track of keys for IP address */
60  int strict_host_key_checking; /* Strict host key checking. */
61  int compression; /* Compress packets in both directions. */
62  int compression_level; /* Compression level 1 (fast) to 9
63  * (best). */
64  int tcp_keep_alive; /* Set SO_KEEPALIVE. */
65  int tcp_rcv_buf; /* user switch to set tcp recv buffer */
66  int tcp_rcv_buf_poll; /* Option to poll recv buf every window transfer */
67  int hpn_disabled; /* Switch to disable HPN buffer management */
68  int audit_disabled; /* disable SSHD instrumentation */
69  int hpn_buffer_size; /* User definable size for HPN buffer window */
70  int ip_qos_interactive; /* IP ToS/DSCP/class for interactive */
71  int ip_qos_bulk; /* IP ToS/DSCP/class for bulk traffic */
72  LogLevel log_level; /* Level for logging. */
73 
74  int port; /* Port to connect. */
75  int address_family;
76  int connection_attempts; /* Max attempts (seconds) before
77  * giving up */
78  int connection_timeout; /* Max time (seconds) before
79  * aborting connection attempt */
80  int number_of_password_prompts; /* Max number of password
81  * prompts. */
82  int cipher; /* Cipher to use. */
83  char *ciphers; /* SSH2 ciphers in order of preference. */
84  char *macs; /* SSH2 macs in order of preference. */
85  char *hostkeyalgorithms; /* SSH2 server key types in order of preference. */
86  char *kex_algorithms; /* SSH2 kex methods in order of preference. */
87  int protocol; /* Protocol in order of preference. */
88  char *hostname; /* Real host to connect. */
89  char *host_key_alias; /* hostname alias for .ssh/known_hosts */
90  char *proxy_command; /* Proxy command for connecting the host. */
91  char *user; /* User to log in as. */
92  int implicit; /* Login user was not specified.
93  Server may choose based on authctxt. */
94  int escape_char; /* Escape character; -2 = none */
95 
96  u_int num_system_hostfiles; /* Paths for /etc/ssh/ssh_known_hosts */
97  char *system_hostfiles[SSH_MAX_HOSTS_FILES];
98  u_int num_user_hostfiles; /* Path for $HOME/.ssh/known_hosts */
99  char *user_hostfiles[SSH_MAX_HOSTS_FILES];
100  char *preferred_authentications;
101  char *bind_address; /* local socket address for connection to sshd */
102  char *pkcs11_provider; /* PKCS#11 provider */
103  int verify_host_key_dns; /* Verify host key using DNS */
104 
105  int num_identity_files; /* Number of files for RSA/DSA identities. */
106  char *identity_files[SSH_MAX_IDENTITY_FILES];
107  int identity_file_userprovided[SSH_MAX_IDENTITY_FILES];
108  struct sshkey *identity_keys[SSH_MAX_IDENTITY_FILES];
109 
110  int num_certificate_files; /* Number of extra certificates for ssh. */
111  char *certificate_files[SSH_MAX_CERTIFICATE_FILES];
112  int certificate_file_userprovided[SSH_MAX_CERTIFICATE_FILES];
113  struct sshkey *certificates[SSH_MAX_CERTIFICATE_FILES];
114 
115  int add_keys_to_agent;
116  char *identity_agent; /* Optional path to ssh-agent socket */
117 
118  /* Local TCP/IP forward requests. */
119  int num_local_forwards;
120  struct Forward *local_forwards;
121 
122  /* Remote TCP/IP forward requests. */
123  int num_remote_forwards;
124  struct Forward *remote_forwards;
125  int clear_forwardings;
126 
127  /* stdio forwarding (-W) host and port */
128  char *stdio_forward_host;
129  int stdio_forward_port;
130 
131  int enable_ssh_keysign;
132  int64_t rekey_limit;
133  int none_switch; /* Use none cipher */
134  int none_enabled; /* Allow none to be used */
135  int disable_multithreaded; /*disable multithreaded aes-ctr*/
136  int rekey_interval;
137 
138  int no_host_authentication_for_localhost;
139  int identities_only;
140  int server_alive_interval;
141  int server_alive_count_max;
142 
143  int num_send_env;
144  char *send_env[MAX_SEND_ENV];
145 
146  char *control_path;
147  int control_master;
148  int control_persist; /* ControlPersist flag */
149  int control_persist_timeout; /* ControlPersist timeout (seconds) */
150 
151  int hash_known_hosts;
152 
153  int tun_open; /* tun(4) */
154  int tun_local; /* force tun device (optional) */
155  int tun_remote; /* force tun device (optional) */
156 
157  char *local_command;
158  int permit_local_command;
159  int visual_host_key;
160 
161  int request_tty;
162 
163  int proxy_use_fdpass;
164 
165  int num_canonical_domains;
166  char *canonical_domains[MAX_CANON_DOMAINS];
167  int canonicalize_hostname;
168  int canonicalize_max_dots;
169  int canonicalize_fallback_local;
170  int num_permitted_cnames;
171  struct allowed_cname permitted_cnames[MAX_CANON_DOMAINS];
172 
173  char *revoked_host_keys;
174 
175  int fingerprint_hash;
176 
177  int update_hostkeys; /* one of SSH_UPDATE_HOSTKEYS_* */
178 
179  char *hostbased_key_types;
180  char *pubkey_key_types;
181 
182  char *jump_user;
183  char *jump_host;
184  int jump_port;
185  char *jump_extra;
186 
187  char *ignored_unknown; /* Pattern list of unknown tokens to ignore */
188 } Options;
189 
190 #define SSH_CANONICALISE_NO 0
191 #define SSH_CANONICALISE_YES 1
192 #define SSH_CANONICALISE_ALWAYS 2
193 
194 #define SSHCTL_MASTER_NO 0
195 #define SSHCTL_MASTER_YES 1
196 #define SSHCTL_MASTER_AUTO 2
197 #define SSHCTL_MASTER_ASK 3
198 #define SSHCTL_MASTER_AUTO_ASK 4
199 
200 #define REQUEST_TTY_AUTO 0
201 #define REQUEST_TTY_NO 1
202 #define REQUEST_TTY_YES 2
203 #define REQUEST_TTY_FORCE 3
204 
205 #define SSHCONF_CHECKPERM 1 /* check permissions on config file */
206 #define SSHCONF_USERCONF 2 /* user provided config file not system */
207 #define SSHCONF_POSTCANON 4 /* After hostname canonicalisation */
208 #define SSHCONF_NEVERMATCH 8 /* Match/Host never matches; internal only */
209 
210 #define SSH_UPDATE_HOSTKEYS_NO 0
211 #define SSH_UPDATE_HOSTKEYS_YES 1
212 #define SSH_UPDATE_HOSTKEYS_ASK 2
213 
214 void initialize_options(Options *);
215 void fill_default_options(Options *);
216 void fill_default_options_for_canonicalization(Options *);
217 int process_config_line(Options *, struct passwd *, const char *,
218  const char *, char *, const char *, int, int *, int);
219 int read_config_file(const char *, struct passwd *, const char *,
220  const char *, Options *, int);
221 int parse_forward(struct Forward *, const char *, int, int);
222 int parse_jump(const char *, Options *, int);
223 int default_ssh_port(void);
224 int option_clear_or_none(const char *);
225 void dump_client_config(Options *o, const char *host);
226 
227 void add_local_forward(Options *, const struct Forward *);
228 void add_remote_forward(Options *, const struct Forward *);
229 void add_identity_file(Options *, const char *, const char *, int);
230 void add_certificate_file(Options *, const char *, int);
231 
232 #endif /* READCONF_H */
Generated by   doxygen 1.8.15