Annotation of src/crypto/external/bsd/openssh/dist/readconf.h, Revision 1.23
1.14 christos 1: /* $NetBSD: readconf.h,v 1.13 2015/08/13 10:33:21 christos Exp $ */
1.23 ! christos 2: /* $OpenBSD: readconf.h,v 1.132 2020/01/23 02:46:49 dtucker Exp $ */
1.1 christos 3:
4: /*
5: * Author: Tatu Ylonen <ylo@cs.hut.fi>
6: * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
7: * All rights reserved
8: * Functions for reading the configuration file.
9: *
10: * As far as I am concerned, the code I have written for this software
11: * can be used freely for any purpose. Any derived versions of this
12: * software must be clearly marked as such, and if the derived work is
13: * incompatible with the protocol description in the RFC file, it must be
14: * called by a name other than "ssh" or "Secure Shell".
15: */
16:
17: #ifndef READCONF_H
18: #define READCONF_H
19:
20: /* Data structure for representing option data. */
21:
1.11 christos 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: };
1.1 christos 30:
31: typedef struct {
32: int forward_agent; /* Forward authentication agent. */
1.23 ! christos 33: char *forward_agent_sock_path; /* Optional path of the agent. */
1.1 christos 34: int forward_x11; /* Forward X11 display. */
1.4 adam 35: int forward_x11_timeout; /* Expiration for Cookies */
1.1 christos 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 */
1.11 christos 39: struct ForwardOptions fwd_opts; /* forwarding options */
1.1 christos 40: int pubkey_authentication; /* Try ssh2 pubkey authentication. */
41: int hostbased_authentication; /* ssh2's rhosts_rsa */
42: int challenge_response_authentication;
1.2 christos 43: #if defined(KRB4) || defined(KRB5)
44: int kerberos_authentication; /* Try Kerberos authentication. */
45: #endif
46: #if defined(AFS) || defined(KRB5)
47: int kerberos_tgt_passing; /* Try Kerberos TGT passing. */
48: #endif
49: #ifdef AFS
50: int afs_token_passing; /* Try AFS token passing. */
51: #endif
1.1 christos 52: /* Try S/Key or TIS, authentication. */
53: int gss_authentication; /* Try GSS authentication */
54: int gss_deleg_creds; /* Delegate GSS credentials */
55: int password_authentication; /* Try password
56: * authentication. */
57: int kbd_interactive_authentication; /* Try keyboard-interactive auth. */
58: char *kbd_interactive_devices; /* Keyboard-interactive auth devices. */
59: int batch_mode; /* Batch mode: do not ask for passwords. */
60: int check_host_ip; /* Also keep track of keys for IP address */
61: int strict_host_key_checking; /* Strict host key checking. */
62: int compression; /* Compress packets in both directions. */
63: int tcp_keep_alive; /* Set SO_KEEPALIVE. */
1.5 christos 64: int ip_qos_interactive; /* IP ToS/DSCP/class for interactive */
65: int ip_qos_bulk; /* IP ToS/DSCP/class for bulk traffic */
1.2 christos 66: int tcp_rcv_buf; /* user switch to set tcp recv buffer */
67: int tcp_rcv_buf_poll; /* Option to poll recv buf every window transfer */
68: int hpn_disabled; /* Switch to disable HPN buffer management */
69: int hpn_buffer_size; /* User definable size for HPN buffer window */
70:
1.19 christos 71: SyslogFacility log_facility; /* Facility for system logging. */
1.1 christos 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: char *ciphers; /* SSH2 ciphers in order of preference. */
83: char *macs; /* SSH2 macs in order of preference. */
84: char *hostkeyalgorithms; /* SSH2 server key types in order of preference. */
1.5 christos 85: char *kex_algorithms; /* SSH2 kex methods in order of preference. */
1.22 christos 86: char *ca_sign_algorithms; /* Allowed CA signature algorithms */
1.1 christos 87: char *hostname; /* Real host to connect. */
88: char *host_key_alias; /* hostname alias for .ssh/known_hosts */
89: char *proxy_command; /* Proxy command for connecting the host. */
90: char *user; /* User to log in as. */
91: int escape_char; /* Escape character; -2 = none */
92:
1.6 christos 93: u_int num_system_hostfiles; /* Paths for /etc/ssh/ssh_known_hosts */
94: char *system_hostfiles[SSH_MAX_HOSTS_FILES];
95: u_int num_user_hostfiles; /* Path for $HOME/.ssh/known_hosts */
96: char *user_hostfiles[SSH_MAX_HOSTS_FILES];
1.1 christos 97: char *preferred_authentications;
98: char *bind_address; /* local socket address for connection to sshd */
1.20 christos 99: char *bind_interface; /* local interface for bind address */
1.4 adam 100: char *pkcs11_provider; /* PKCS#11 provider */
1.23 ! christos 101: char *sk_provider; /* Security key provider */
1.1 christos 102: int verify_host_key_dns; /* Verify host key using DNS */
103:
104: int num_identity_files; /* Number of files for RSA/DSA identities. */
105: char *identity_files[SSH_MAX_IDENTITY_FILES];
1.9 mlelstv 106: int identity_file_userprovided[SSH_MAX_IDENTITY_FILES];
1.12 christos 107: struct sshkey *identity_keys[SSH_MAX_IDENTITY_FILES];
1.1 christos 108:
1.15 christos 109: int num_certificate_files; /* Number of extra certificates for ssh. */
110: char *certificate_files[SSH_MAX_CERTIFICATE_FILES];
111: int certificate_file_userprovided[SSH_MAX_CERTIFICATE_FILES];
112: struct sshkey *certificates[SSH_MAX_CERTIFICATE_FILES];
113:
114: int add_keys_to_agent;
1.16 christos 115: char *identity_agent; /* Optional path to ssh-agent socket */
1.15 christos 116:
1.1 christos 117: /* Local TCP/IP forward requests. */
118: int num_local_forwards;
1.11 christos 119: struct Forward *local_forwards;
1.1 christos 120:
121: /* Remote TCP/IP forward requests. */
122: int num_remote_forwards;
1.11 christos 123: struct Forward *remote_forwards;
1.1 christos 124: int clear_forwardings;
125:
1.16 christos 126: /* stdio forwarding (-W) host and port */
127: char *stdio_forward_host;
128: int stdio_forward_port;
129:
1.1 christos 130: int enable_ssh_keysign;
131: int64_t rekey_limit;
1.10 christos 132: int rekey_interval;
1.2 christos 133: int none_switch; /* Use none cipher */
134: int none_enabled; /* Allow none to be used */
1.1 christos 135: int no_host_authentication_for_localhost;
136: int identities_only;
137: int server_alive_interval;
138: int server_alive_count_max;
139:
140: int num_send_env;
1.21 christos 141: char **send_env;
142: int num_setenv;
143: char **setenv;
1.1 christos 144:
145: char *control_path;
146: int control_master;
1.4 adam 147: int control_persist; /* ControlPersist flag */
148: int control_persist_timeout; /* ControlPersist timeout (seconds) */
1.1 christos 149:
150: int hash_known_hosts;
151:
152: int tun_open; /* tun(4) */
153: int tun_local; /* force tun device (optional) */
154: int tun_remote; /* force tun device (optional) */
155:
156: char *local_command;
157: int permit_local_command;
1.19 christos 158: char *remote_command;
1.1 christos 159: int visual_host_key;
160:
1.6 christos 161: int request_tty;
1.7 tls 162: int send_version_first;
1.10 christos 163:
1.11 christos 164: int proxy_use_fdpass;
165:
166: int num_canonical_domains;
167: char *canonical_domains[MAX_CANON_DOMAINS];
168: int canonicalize_hostname;
169: int canonicalize_max_dots;
170: int canonicalize_fallback_local;
171: int num_permitted_cnames;
172: struct allowed_cname permitted_cnames[MAX_CANON_DOMAINS];
173:
1.12 christos 174: char *revoked_host_keys;
175:
176: int fingerprint_hash;
177:
178: int update_hostkeys; /* one of SSH_UPDATE_HOSTKEYS_* */
179:
1.13 christos 180: char *hostbased_key_types;
181: char *pubkey_key_types;
1.12 christos 182:
1.16 christos 183: char *jump_user;
184: char *jump_host;
185: int jump_port;
186: char *jump_extra;
187:
1.10 christos 188: char *ignored_unknown; /* Pattern list of unknown tokens to ignore */
1.1 christos 189: } Options;
190:
1.11 christos 191: #define SSH_CANONICALISE_NO 0
192: #define SSH_CANONICALISE_YES 1
193: #define SSH_CANONICALISE_ALWAYS 2
194:
1.1 christos 195: #define SSHCTL_MASTER_NO 0
196: #define SSHCTL_MASTER_YES 1
197: #define SSHCTL_MASTER_AUTO 2
198: #define SSHCTL_MASTER_ASK 3
199: #define SSHCTL_MASTER_AUTO_ASK 4
200:
1.6 christos 201: #define REQUEST_TTY_AUTO 0
202: #define REQUEST_TTY_NO 1
203: #define REQUEST_TTY_YES 2
204: #define REQUEST_TTY_FORCE 3
205:
1.9 mlelstv 206: #define SSHCONF_CHECKPERM 1 /* check permissions on config file */
207: #define SSHCONF_USERCONF 2 /* user provided config file not system */
1.22 christos 208: #define SSHCONF_FINAL 4 /* Final pass over config, after canon. */
1.16 christos 209: #define SSHCONF_NEVERMATCH 8 /* Match/Host never matches; internal only */
1.12 christos 210:
211: #define SSH_UPDATE_HOSTKEYS_NO 0
212: #define SSH_UPDATE_HOSTKEYS_YES 1
213: #define SSH_UPDATE_HOSTKEYS_ASK 2
1.9 mlelstv 214:
1.19 christos 215: #define SSH_STRICT_HOSTKEY_OFF 0
216: #define SSH_STRICT_HOSTKEY_NEW 1
217: #define SSH_STRICT_HOSTKEY_YES 2
218: #define SSH_STRICT_HOSTKEY_ASK 3
219:
1.23 ! christos 220: const char *kex_default_pk_alg(void);
1.1 christos 221: void initialize_options(Options *);
222: void fill_default_options(Options *);
1.11 christos 223: void fill_default_options_for_canonicalization(Options *);
1.12 christos 224: int process_config_line(Options *, struct passwd *, const char *,
225: const char *, char *, const char *, int, int *, int);
1.11 christos 226: int read_config_file(const char *, struct passwd *, const char *,
1.22 christos 227: const char *, Options *, int, int *);
1.11 christos 228: int parse_forward(struct Forward *, const char *, int, int);
1.16 christos 229: int parse_jump(const char *, Options *, int);
1.20 christos 230: int parse_ssh_uri(const char *, char **, char **, int *);
1.11 christos 231: int default_ssh_port(void);
232: int option_clear_or_none(const char *);
1.12 christos 233: void dump_client_config(Options *o, const char *host);
1.1 christos 234:
1.11 christos 235: void add_local_forward(Options *, const struct Forward *);
236: void add_remote_forward(Options *, const struct Forward *);
1.9 mlelstv 237: void add_identity_file(Options *, const char *, const char *, int);
1.15 christos 238: void add_certificate_file(Options *, const char *, int);
1.1 christos 239:
240: #endif /* READCONF_H */
CVSweb <webmaster@jp.NetBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to readconf.h CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [cvs.NetBSD.org] / src / crypto / external / bsd / openssh / dist