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