Grid Community Toolkit  6.2.1629922860 (tag: v6.2.20210826)
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
readconf.h
1 /* $OpenBSD: readconf.h,v 1.140 2021/02/15 20:43:15 markus Exp $ */
2 
3 /*
4  * Author: Tatu Ylonen <ylo@cs.hut.fi>
5  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, 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 SSH_MAX_HOSTS_FILES 32
22 #define MAX_CANON_DOMAINS 32
23 #define PATH_MAX_SUN (sizeof((struct sockaddr_un *)0)->sun_path)
24 
25 struct allowed_cname {
26  char *source_list;
27  char *target_list;
28 };
29 
30 typedef struct {
31  int forward_agent; /* Forward authentication agent. */
32  char *forward_agent_sock_path; /* Optional path of the 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 pubkey_authentication; /* Try ssh2 pubkey authentication. */
40  int hostbased_authentication; /* ssh2's rhosts_rsa */
41  int challenge_response_authentication;
42  /* Try S/Key or TIS, authentication. */
43  int gss_authentication; /* Try GSS authentication */
44  int gss_keyex; /* Try GSS key exchange */
45  int gss_deleg_creds; /* Delegate GSS credentials */
46  int gss_trust_dns; /* Trust DNS for GSS canonicalization */
47  int gss_renewal_rekey; /* Credential renewal forces rekey */
48  char *gss_client_identity; /* Principal to initiate GSSAPI with */
49  char *gss_server_identity; /* GSSAPI target principal */
50  char *gss_kex_algorithms; /* GSSAPI kex methods to be offered by client. */
51  int password_authentication; /* Try password
52  * authentication. */
53  int kbd_interactive_authentication; /* Try keyboard-interactive auth. */
54  char *kbd_interactive_devices; /* Keyboard-interactive auth devices. */
55  int batch_mode; /* Batch mode: do not ask for passwords. */
56  int check_host_ip; /* Also keep track of keys for IP address */
57  int strict_host_key_checking; /* Strict host key checking. */
58  int compression; /* Compress packets in both directions. */
59  int tcp_keep_alive; /* Set SO_KEEPALIVE. */
60  int tcp_rcv_buf; /* user switch to set tcp recv buffer */
61  int tcp_rcv_buf_poll; /* Option to poll recv buf every window transfer */
62  int hpn_disabled; /* Switch to disable HPN buffer management */
63  int hpn_buffer_size; /* User definable size for HPN buffer window */
64  int ip_qos_interactive; /* IP ToS/DSCP/class for interactive */
65  int ip_qos_bulk; /* IP ToS/DSCP/class for bulk traffic */
66  SyslogFacility log_facility; /* Facility for system logging. */
67  LogLevel log_level; /* Level for logging. */
68  u_int num_log_verbose; /* Verbose log overrides */
69  char **log_verbose;
70  int port; /* Port to connect. */
71  int address_family;
72  int connection_attempts; /* Max attempts (seconds) before
73  * giving up */
74  int connection_timeout; /* Max time (seconds) before
75  * aborting connection attempt */
76  int number_of_password_prompts; /* Max number of password
77  * prompts. */
78  char *ciphers; /* SSH2 ciphers in order of preference. */
79  char *macs; /* SSH2 macs in order of preference. */
80  char *hostkeyalgorithms; /* SSH2 server key types in order of preference. */
81  char *kex_algorithms; /* SSH2 kex methods in order of preference. */
82  char *ca_sign_algorithms; /* Allowed CA signature algorithms */
83  char *hostname; /* Real host to connect. */
84  char *host_key_alias; /* hostname alias for .ssh/known_hosts */
85  char *proxy_command; /* Proxy command for connecting the host. */
86  char *user; /* User to log in as. */
87  int implicit; /* Login user was not specified.
88  Server may choose based on authctxt. */
89  int escape_char; /* Escape character; -2 = none */
90 
91  u_int num_system_hostfiles; /* Paths for /etc/ssh/ssh_known_hosts */
92  char *system_hostfiles[SSH_MAX_HOSTS_FILES];
93  u_int num_user_hostfiles; /* Path for $HOME/.ssh/known_hosts */
94  char *user_hostfiles[SSH_MAX_HOSTS_FILES];
95  char *preferred_authentications;
96  char *bind_address; /* local socket address for connection to sshd */
97  char *bind_interface; /* local interface for bind address */
98  char *pkcs11_provider; /* PKCS#11 provider */
99  char *sk_provider; /* Security key provider */
100  int verify_host_key_dns; /* Verify host key using DNS */
101 
102  int num_identity_files; /* Number of files for RSA/DSA identities. */
103  char *identity_files[SSH_MAX_IDENTITY_FILES];
104  int identity_file_userprovided[SSH_MAX_IDENTITY_FILES];
105  struct sshkey *identity_keys[SSH_MAX_IDENTITY_FILES];
106 
107  int num_certificate_files; /* Number of extra certificates for ssh. */
108  char *certificate_files[SSH_MAX_CERTIFICATE_FILES];
109  int certificate_file_userprovided[SSH_MAX_CERTIFICATE_FILES];
110  struct sshkey *certificates[SSH_MAX_CERTIFICATE_FILES];
111 
112  int add_keys_to_agent;
113  int add_keys_to_agent_lifespan;
114  char *identity_agent; /* Optional path to ssh-agent socket */
115 
116  /* Local TCP/IP forward requests. */
117  int num_local_forwards;
118  struct Forward *local_forwards;
119 
120  /* Remote TCP/IP forward requests. */
121  int num_remote_forwards;
122  struct Forward *remote_forwards;
123  int clear_forwardings;
124 
125  /* Restrict remote dynamic forwarding */
126  char **permitted_remote_opens;
127  u_int num_permitted_remote_opens;
128 
129  /* stdio forwarding (-W) host and port */
130  char *stdio_forward_host;
131  int stdio_forward_port;
132 
133  int enable_ssh_keysign;
134  int64_t rekey_limit;
135  int none_switch; /* Use none cipher */
136  int none_enabled; /* Allow none to be used */
137  int nonemac_enabled; /* Allow none to be used */
138  int disable_multithreaded; /*disable multithreaded aes-ctr*/
139  int rekey_interval;
140 
141  int no_host_authentication_for_localhost;
142  int identities_only;
143  int server_alive_interval;
144  int server_alive_count_max;
145 
146  int num_send_env;
147  char **send_env;
148  int num_setenv;
149  char **setenv;
150 
151  char *control_path;
152  int control_master;
153  int control_persist; /* ControlPersist flag */
154  int control_persist_timeout; /* ControlPersist timeout (seconds) */
155 
156  int hash_known_hosts;
157 
158  int tun_open; /* tun(4) */
159  int tun_local; /* force tun device (optional) */
160  int tun_remote; /* force tun device (optional) */
161 
162  char *local_command;
163  int permit_local_command;
164  char *remote_command;
165  int visual_host_key;
166 
167  int request_tty;
168 
169  int proxy_use_fdpass;
170 
171  int num_canonical_domains;
172  char *canonical_domains[MAX_CANON_DOMAINS];
173  int canonicalize_hostname;
174  int canonicalize_max_dots;
175  int canonicalize_fallback_local;
176  int num_permitted_cnames;
177  struct allowed_cname permitted_cnames[MAX_CANON_DOMAINS];
178 
179  char *revoked_host_keys;
180 
181  int fingerprint_hash;
182 
183  int update_hostkeys; /* one of SSH_UPDATE_HOSTKEYS_* */
184 
185  char *hostbased_accepted_algos;
186  char *pubkey_accepted_algos;
187 
188  char *jump_user;
189  char *jump_host;
190  int jump_port;
191  char *jump_extra;
192 
193  char *known_hosts_command;
194 
195  char *ignored_unknown; /* Pattern list of unknown tokens to ignore */
196 } Options;
197 
198 #define SSH_CANONICALISE_NO 0
199 #define SSH_CANONICALISE_YES 1
200 #define SSH_CANONICALISE_ALWAYS 2
201 
202 #define SSHCTL_MASTER_NO 0
203 #define SSHCTL_MASTER_YES 1
204 #define SSHCTL_MASTER_AUTO 2
205 #define SSHCTL_MASTER_ASK 3
206 #define SSHCTL_MASTER_AUTO_ASK 4
207 
208 #define REQUEST_TTY_AUTO 0
209 #define REQUEST_TTY_NO 1
210 #define REQUEST_TTY_YES 2
211 #define REQUEST_TTY_FORCE 3
212 
213 #define SSHCONF_CHECKPERM 1 /* check permissions on config file */
214 #define SSHCONF_USERCONF 2 /* user provided config file not system */
215 #define SSHCONF_FINAL 4 /* Final pass over config, after canon. */
216 #define SSHCONF_NEVERMATCH 8 /* Match/Host never matches; internal only */
217 
218 #define SSH_UPDATE_HOSTKEYS_NO 0
219 #define SSH_UPDATE_HOSTKEYS_YES 1
220 #define SSH_UPDATE_HOSTKEYS_ASK 2
221 
222 #define SSH_STRICT_HOSTKEY_OFF 0
223 #define SSH_STRICT_HOSTKEY_NEW 1
224 #define SSH_STRICT_HOSTKEY_YES 2
225 #define SSH_STRICT_HOSTKEY_ASK 3
226 
227 const char *kex_default_pk_alg(void);
228 char *ssh_connection_hash(const char *thishost, const char *host,
229  const char *portstr, const char *user);
230 void initialize_options(Options *);
231 int fill_default_options(Options *);
232 void fill_default_options_for_canonicalization(Options *);
233 void free_options(Options *o);
234 int process_config_line(Options *, struct passwd *, const char *,
235  const char *, char *, const char *, int, int *, int);
236 int read_config_file(const char *, struct passwd *, const char *,
237  const char *, Options *, int, int *);
238 int parse_forward(struct Forward *, const char *, int, int);
239 int parse_jump(const char *, Options *, int);
240 int parse_ssh_uri(const char *, char **, char **, int *);
241 int default_ssh_port(void);
242 int option_clear_or_none(const char *);
243 void dump_client_config(Options *o, const char *host);
244 
245 void add_local_forward(Options *, const struct Forward *);
246 void add_remote_forward(Options *, const struct Forward *);
247 void add_identity_file(Options *, const char *, const char *, int);
248 void add_certificate_file(Options *, const char *, int);
249 
250 #endif /* READCONF_H */
Generated by   doxygen 1.8.5