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