Annotation of src/usr.bin/ssh/readconf.h, Revision 1.144
1.144 ! djm 1: /* $OpenBSD: readconf.h,v 1.143 2021/07/23 04:00:59 djm Exp $ */
1.42 stevesk 2:
1.1 deraadt 3: /*
1.11 deraadt 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.
1.15 markus 8: *
1.21 deraadt 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".
1.11 deraadt 14: */
1.1 deraadt 15:
16: #ifndef READCONF_H
17: #define READCONF_H
1.27 markus 18:
1.1 deraadt 19: /* Data structure for representing option data. */
20:
1.98 djm 21: #define SSH_MAX_HOSTS_FILES 32
22: #define MAX_CANON_DOMAINS 32
1.102 millert 23: #define PATH_MAX_SUN (sizeof((struct sockaddr_un *)0)->sun_path)
1.98 djm 24:
25: struct allowed_cname {
26: char *source_list;
27: char *target_list;
28: };
1.62 djm 29:
1.11 deraadt 30: typedef struct {
31: int forward_agent; /* Forward authentication agent. */
1.131 djm 32: char *forward_agent_sock_path; /* Optional path of the agent. */
1.11 deraadt 33: int forward_x11; /* Forward X11 display. */
1.85 djm 34: int forward_x11_timeout; /* Expiration for Cookies */
1.56 markus 35: int forward_x11_trusted; /* Trust Forward X11 display. */
1.70 markus 36: int exit_on_forward_failure; /* Exit if bind(2) fails for -L/-R */
1.19 markus 37: char *xauth_location; /* Location for xauth program */
1.102 millert 38: struct ForwardOptions fwd_opts; /* forwarding options */
1.23 markus 39: int pubkey_authentication; /* Try ssh2 pubkey authentication. */
1.29 markus 40: int hostbased_authentication; /* ssh2's rhosts_rsa */
1.54 markus 41: int gss_authentication; /* Try GSS authentication */
42: int gss_deleg_creds; /* Delegate GSS credentials */
1.11 deraadt 43: int password_authentication; /* Try password
44: * authentication. */
1.22 markus 45: int kbd_interactive_authentication; /* Try keyboard-interactive auth. */
46: char *kbd_interactive_devices; /* Keyboard-interactive auth devices. */
1.11 deraadt 47: int batch_mode; /* Batch mode: do not ask for passwords. */
48: int check_host_ip; /* Also keep track of keys for IP address */
49: int strict_host_key_checking; /* Strict host key checking. */
50: int compression; /* Compress packets in both directions. */
1.58 markus 51: int tcp_keep_alive; /* Set SO_KEEPALIVE. */
1.88 djm 52: int ip_qos_interactive; /* IP ToS/DSCP/class for interactive */
53: int ip_qos_bulk; /* IP ToS/DSCP/class for bulk traffic */
1.118 dtucker 54: SyslogFacility log_facility; /* Facility for system logging. */
1.11 deraadt 55: LogLevel log_level; /* Level for logging. */
1.135 djm 56: u_int num_log_verbose; /* Verbose log overrides */
57: char **log_verbose;
1.11 deraadt 58: int port; /* Port to connect. */
1.51 djm 59: int address_family;
1.11 deraadt 60: int connection_attempts; /* Max attempts (seconds) before
61: * giving up */
1.50 djm 62: int connection_timeout; /* Max time (seconds) before
1.57 djm 63: * aborting connection attempt */
1.11 deraadt 64: int number_of_password_prompts; /* Max number of password
65: * prompts. */
1.18 markus 66: char *ciphers; /* SSH2 ciphers in order of preference. */
1.26 markus 67: char *macs; /* SSH2 macs in order of preference. */
1.30 markus 68: char *hostkeyalgorithms; /* SSH2 server key types in order of preference. */
1.87 djm 69: char *kex_algorithms; /* SSH2 kex methods in order of preference. */
1.128 djm 70: char *ca_sign_algorithms; /* Allowed CA signature algorithms */
1.11 deraadt 71: char *hostname; /* Real host to connect. */
1.24 markus 72: char *host_key_alias; /* hostname alias for .ssh/known_hosts */
1.11 deraadt 73: char *proxy_command; /* Proxy command for connecting the host. */
74: char *user; /* User to log in as. */
75: int escape_char; /* Escape character; -2 = none */
76:
1.90 djm 77: u_int num_system_hostfiles; /* Paths for /etc/ssh/ssh_known_hosts */
78: char *system_hostfiles[SSH_MAX_HOSTS_FILES];
79: u_int num_user_hostfiles; /* Path for $HOME/.ssh/known_hosts */
80: char *user_hostfiles[SSH_MAX_HOSTS_FILES];
1.28 markus 81: char *preferred_authentications;
1.31 markus 82: char *bind_address; /* local socket address for connection to sshd */
1.125 djm 83: char *bind_interface; /* local interface for bind address */
1.82 markus 84: char *pkcs11_provider; /* PKCS#11 provider */
1.130 djm 85: char *sk_provider; /* Security key provider */
1.48 jakob 86: int verify_host_key_dns; /* Verify host key using DNS */
1.11 deraadt 87:
1.23 markus 88: int num_identity_files; /* Number of files for RSA/DSA identities. */
1.11 deraadt 89: char *identity_files[SSH_MAX_IDENTITY_FILES];
1.92 dtucker 90: int identity_file_userprovided[SSH_MAX_IDENTITY_FILES];
1.106 djm 91: struct sshkey *identity_keys[SSH_MAX_IDENTITY_FILES];
1.11 deraadt 92:
1.111 djm 93: int num_certificate_files; /* Number of extra certificates for ssh. */
94: char *certificate_files[SSH_MAX_CERTIFICATE_FILES];
95: int certificate_file_userprovided[SSH_MAX_CERTIFICATE_FILES];
96: struct sshkey *certificates[SSH_MAX_CERTIFICATE_FILES];
1.112 jcs 97:
98: int add_keys_to_agent;
1.134 djm 99: int add_keys_to_agent_lifespan;
1.115 markus 100: char *identity_agent; /* Optional path to ssh-agent socket */
1.111 djm 101:
1.11 deraadt 102: /* Local TCP/IP forward requests. */
103: int num_local_forwards;
1.102 millert 104: struct Forward *local_forwards;
1.11 deraadt 105:
106: /* Remote TCP/IP forward requests. */
107: int num_remote_forwards;
1.102 millert 108: struct Forward *remote_forwards;
1.39 stevesk 109: int clear_forwardings;
1.140 markus 110:
111: /* Restrict remote dynamic forwarding */
112: char **permitted_remote_opens;
113: u_int num_permitted_remote_opens;
1.116 dtucker 114:
115: /* stdio forwarding (-W) host and port */
116: char *stdio_forward_host;
117: int stdio_forward_port;
1.44 markus 118:
119: int enable_ssh_keysign;
1.72 djm 120: int64_t rekey_limit;
1.94 dtucker 121: int rekey_interval;
1.40 markus 122: int no_host_authentication_for_localhost;
1.60 markus 123: int identities_only;
1.64 deraadt 124: int server_alive_interval;
1.59 markus 125: int server_alive_count_max;
1.62 djm 126:
127: int num_send_env;
1.126 djm 128: char **send_env;
129: int num_setenv;
130: char **setenv;
1.63 djm 131:
132: char *control_path;
133: int control_master;
1.86 djm 134: int control_persist; /* ControlPersist flag */
135: int control_persist_timeout; /* ControlPersist timeout (seconds) */
1.66 djm 136:
137: int hash_known_hosts;
1.68 reyk 138:
139: int tun_open; /* tun(4) */
140: int tun_local; /* force tun device (optional) */
141: int tun_remote; /* force tun device (optional) */
142:
143: char *local_command;
144: int permit_local_command;
1.122 bluhm 145: char *remote_command;
1.74 grunk 146: int visual_host_key;
1.80 reyk 147:
1.89 djm 148: int request_tty;
1.142 djm 149: int session_type;
1.143 djm 150: int stdin_null;
1.144 ! djm 151: int fork_after_authentication;
1.96 djm 152:
153: int proxy_use_fdpass;
1.95 djm 154:
1.98 djm 155: int num_canonical_domains;
156: char *canonical_domains[MAX_CANON_DOMAINS];
1.99 djm 157: int canonicalize_hostname;
158: int canonicalize_max_dots;
159: int canonicalize_fallback_local;
1.98 djm 160: int num_permitted_cnames;
161: struct allowed_cname permitted_cnames[MAX_CANON_DOMAINS];
1.104 djm 162:
163: char *revoked_host_keys;
1.105 djm 164:
1.107 djm 165: int fingerprint_hash;
166:
1.109 djm 167: int update_hostkeys; /* one of SSH_UPDATE_HOSTKEYS_* */
1.108 djm 168:
1.139 dtucker 169: char *hostbased_accepted_algos;
1.138 dtucker 170: char *pubkey_accepted_algos;
1.98 djm 171:
1.117 djm 172: char *jump_user;
173: char *jump_host;
174: int jump_port;
175: char *jump_extra;
1.137 djm 176:
177: char *known_hosts_command;
1.117 djm 178:
1.95 djm 179: char *ignored_unknown; /* Pattern list of unknown tokens to ignore */
1.11 deraadt 180: } Options;
1.98 djm 181:
182: #define SSH_CANONICALISE_NO 0
183: #define SSH_CANONICALISE_YES 1
184: #define SSH_CANONICALISE_ALWAYS 2
1.1 deraadt 185:
1.67 djm 186: #define SSHCTL_MASTER_NO 0
187: #define SSHCTL_MASTER_YES 1
188: #define SSHCTL_MASTER_AUTO 2
189: #define SSHCTL_MASTER_ASK 3
190: #define SSHCTL_MASTER_AUTO_ASK 4
1.89 djm 191:
192: #define REQUEST_TTY_AUTO 0
193: #define REQUEST_TTY_NO 1
194: #define REQUEST_TTY_YES 2
195: #define REQUEST_TTY_FORCE 3
1.142 djm 196:
197: #define SESSION_TYPE_NONE 0
198: #define SESSION_TYPE_SUBSYSTEM 1
199: #define SESSION_TYPE_DEFAULT 2
1.1 deraadt 200:
1.93 dtucker 201: #define SSHCONF_CHECKPERM 1 /* check permissions on config file */
202: #define SSHCONF_USERCONF 2 /* user provided config file not system */
1.129 djm 203: #define SSHCONF_FINAL 4 /* Final pass over config, after canon. */
1.114 djm 204: #define SSHCONF_NEVERMATCH 8 /* Match/Host never matches; internal only */
1.109 djm 205:
206: #define SSH_UPDATE_HOSTKEYS_NO 0
207: #define SSH_UPDATE_HOSTKEYS_YES 1
208: #define SSH_UPDATE_HOSTKEYS_ASK 2
1.123 djm 209:
210: #define SSH_STRICT_HOSTKEY_OFF 0
211: #define SSH_STRICT_HOSTKEY_NEW 1
212: #define SSH_STRICT_HOSTKEY_YES 2
213: #define SSH_STRICT_HOSTKEY_ASK 3
1.93 dtucker 214:
1.132 dtucker 215: const char *kex_default_pk_alg(void);
1.133 dtucker 216: char *ssh_connection_hash(const char *thishost, const char *host,
217: const char *portstr, const char *user);
1.35 markus 218: void initialize_options(Options *);
1.136 djm 219: int fill_default_options(Options *);
1.101 djm 220: void fill_default_options_for_canonicalization(Options *);
1.136 djm 221: void free_options(Options *o);
1.103 djm 222: int process_config_line(Options *, struct passwd *, const char *,
223: const char *, char *, const char *, int, int *, int);
1.97 djm 224: int read_config_file(const char *, struct passwd *, const char *,
1.129 djm 225: const char *, Options *, int, int *);
1.102 millert 226: int parse_forward(struct Forward *, const char *, int, int);
1.117 djm 227: int parse_jump(const char *, Options *, int);
1.124 millert 228: int parse_ssh_uri(const char *, char **, char **, int *);
1.97 djm 229: int default_ssh_port(void);
1.101 djm 230: int option_clear_or_none(const char *);
1.103 djm 231: void dump_client_config(Options *o, const char *host);
1.1 deraadt 232:
1.102 millert 233: void add_local_forward(Options *, const struct Forward *);
234: void add_remote_forward(Options *, const struct Forward *);
1.92 dtucker 235: void add_identity_file(Options *, const char *, const char *, int);
1.111 djm 236: void add_certificate_file(Options *, const char *, int);
1.1 deraadt 237:
1.11 deraadt 238: #endif /* READCONF_H */
![[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 [local] / src / usr.bin / ssh