Annotation of src/usr.bin/ssh/readconf.h, Revision 1.129
1.129 ! djm 1: /* $OpenBSD: readconf.h,v 1.128 2018/09/20 03:30:44 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. */
32: int forward_x11; /* Forward X11 display. */
1.85 djm 33: int forward_x11_timeout; /* Expiration for Cookies */
1.56 markus 34: int forward_x11_trusted; /* Trust Forward X11 display. */
1.70 markus 35: int exit_on_forward_failure; /* Exit if bind(2) fails for -L/-R */
1.19 markus 36: char *xauth_location; /* Location for xauth program */
1.102 millert 37: struct ForwardOptions fwd_opts; /* forwarding options */
1.23 markus 38: int pubkey_authentication; /* Try ssh2 pubkey authentication. */
1.29 markus 39: int hostbased_authentication; /* ssh2's rhosts_rsa */
1.32 markus 40: int challenge_response_authentication;
1.25 markus 41: /* Try S/Key or TIS, authentication. */
1.54 markus 42: int gss_authentication; /* Try GSS authentication */
43: int gss_deleg_creds; /* Delegate GSS credentials */
1.11 deraadt 44: int password_authentication; /* Try password
45: * authentication. */
1.22 markus 46: int kbd_interactive_authentication; /* Try keyboard-interactive auth. */
47: char *kbd_interactive_devices; /* Keyboard-interactive auth devices. */
1.11 deraadt 48: int batch_mode; /* Batch mode: do not ask for passwords. */
49: int check_host_ip; /* Also keep track of keys for IP address */
50: int strict_host_key_checking; /* Strict host key checking. */
51: int compression; /* Compress packets in both directions. */
1.58 markus 52: int tcp_keep_alive; /* Set SO_KEEPALIVE. */
1.88 djm 53: int ip_qos_interactive; /* IP ToS/DSCP/class for interactive */
54: int ip_qos_bulk; /* IP ToS/DSCP/class for bulk traffic */
1.118 dtucker 55: SyslogFacility log_facility; /* Facility for system logging. */
1.11 deraadt 56: LogLevel log_level; /* Level for logging. */
57:
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.48 jakob 85: int verify_host_key_dns; /* Verify host key using DNS */
1.11 deraadt 86:
1.23 markus 87: int num_identity_files; /* Number of files for RSA/DSA identities. */
1.11 deraadt 88: char *identity_files[SSH_MAX_IDENTITY_FILES];
1.92 dtucker 89: int identity_file_userprovided[SSH_MAX_IDENTITY_FILES];
1.106 djm 90: struct sshkey *identity_keys[SSH_MAX_IDENTITY_FILES];
1.11 deraadt 91:
1.111 djm 92: int num_certificate_files; /* Number of extra certificates for ssh. */
93: char *certificate_files[SSH_MAX_CERTIFICATE_FILES];
94: int certificate_file_userprovided[SSH_MAX_CERTIFICATE_FILES];
95: struct sshkey *certificates[SSH_MAX_CERTIFICATE_FILES];
1.112 jcs 96:
97: int add_keys_to_agent;
1.115 markus 98: char *identity_agent; /* Optional path to ssh-agent socket */
1.111 djm 99:
1.11 deraadt 100: /* Local TCP/IP forward requests. */
101: int num_local_forwards;
1.102 millert 102: struct Forward *local_forwards;
1.11 deraadt 103:
104: /* Remote TCP/IP forward requests. */
105: int num_remote_forwards;
1.102 millert 106: struct Forward *remote_forwards;
1.39 stevesk 107: int clear_forwardings;
1.116 dtucker 108:
109: /* stdio forwarding (-W) host and port */
110: char *stdio_forward_host;
111: int stdio_forward_port;
1.44 markus 112:
113: int enable_ssh_keysign;
1.72 djm 114: int64_t rekey_limit;
1.94 dtucker 115: int rekey_interval;
1.40 markus 116: int no_host_authentication_for_localhost;
1.60 markus 117: int identities_only;
1.64 deraadt 118: int server_alive_interval;
1.59 markus 119: int server_alive_count_max;
1.62 djm 120:
121: int num_send_env;
1.126 djm 122: char **send_env;
123: int num_setenv;
124: char **setenv;
1.63 djm 125:
126: char *control_path;
127: int control_master;
1.86 djm 128: int control_persist; /* ControlPersist flag */
129: int control_persist_timeout; /* ControlPersist timeout (seconds) */
1.66 djm 130:
131: int hash_known_hosts;
1.68 reyk 132:
133: int tun_open; /* tun(4) */
134: int tun_local; /* force tun device (optional) */
135: int tun_remote; /* force tun device (optional) */
136:
137: char *local_command;
138: int permit_local_command;
1.122 bluhm 139: char *remote_command;
1.74 grunk 140: int visual_host_key;
1.80 reyk 141:
1.89 djm 142: int request_tty;
1.96 djm 143:
144: int proxy_use_fdpass;
1.95 djm 145:
1.98 djm 146: int num_canonical_domains;
147: char *canonical_domains[MAX_CANON_DOMAINS];
1.99 djm 148: int canonicalize_hostname;
149: int canonicalize_max_dots;
150: int canonicalize_fallback_local;
1.98 djm 151: int num_permitted_cnames;
152: struct allowed_cname permitted_cnames[MAX_CANON_DOMAINS];
1.104 djm 153:
154: char *revoked_host_keys;
1.105 djm 155:
1.107 djm 156: int fingerprint_hash;
157:
1.109 djm 158: int update_hostkeys; /* one of SSH_UPDATE_HOSTKEYS_* */
1.108 djm 159:
1.110 markus 160: char *hostbased_key_types;
161: char *pubkey_key_types;
1.98 djm 162:
1.117 djm 163: char *jump_user;
164: char *jump_host;
165: int jump_port;
166: char *jump_extra;
167:
1.95 djm 168: char *ignored_unknown; /* Pattern list of unknown tokens to ignore */
1.11 deraadt 169: } Options;
1.98 djm 170:
171: #define SSH_CANONICALISE_NO 0
172: #define SSH_CANONICALISE_YES 1
173: #define SSH_CANONICALISE_ALWAYS 2
1.1 deraadt 174:
1.67 djm 175: #define SSHCTL_MASTER_NO 0
176: #define SSHCTL_MASTER_YES 1
177: #define SSHCTL_MASTER_AUTO 2
178: #define SSHCTL_MASTER_ASK 3
179: #define SSHCTL_MASTER_AUTO_ASK 4
1.89 djm 180:
181: #define REQUEST_TTY_AUTO 0
182: #define REQUEST_TTY_NO 1
183: #define REQUEST_TTY_YES 2
184: #define REQUEST_TTY_FORCE 3
1.1 deraadt 185:
1.93 dtucker 186: #define SSHCONF_CHECKPERM 1 /* check permissions on config file */
187: #define SSHCONF_USERCONF 2 /* user provided config file not system */
1.129 ! djm 188: #define SSHCONF_FINAL 4 /* Final pass over config, after canon. */
1.114 djm 189: #define SSHCONF_NEVERMATCH 8 /* Match/Host never matches; internal only */
1.109 djm 190:
191: #define SSH_UPDATE_HOSTKEYS_NO 0
192: #define SSH_UPDATE_HOSTKEYS_YES 1
193: #define SSH_UPDATE_HOSTKEYS_ASK 2
1.123 djm 194:
195: #define SSH_STRICT_HOSTKEY_OFF 0
196: #define SSH_STRICT_HOSTKEY_NEW 1
197: #define SSH_STRICT_HOSTKEY_YES 2
198: #define SSH_STRICT_HOSTKEY_ASK 3
1.93 dtucker 199:
1.35 markus 200: void initialize_options(Options *);
201: void fill_default_options(Options *);
1.101 djm 202: void fill_default_options_for_canonicalization(Options *);
1.103 djm 203: int process_config_line(Options *, struct passwd *, const char *,
204: const char *, char *, const char *, int, int *, int);
1.97 djm 205: int read_config_file(const char *, struct passwd *, const char *,
1.129 ! djm 206: const char *, Options *, int, int *);
1.102 millert 207: int parse_forward(struct Forward *, const char *, int, int);
1.117 djm 208: int parse_jump(const char *, Options *, int);
1.124 millert 209: int parse_ssh_uri(const char *, char **, char **, int *);
1.97 djm 210: int default_ssh_port(void);
1.101 djm 211: int option_clear_or_none(const char *);
1.103 djm 212: void dump_client_config(Options *o, const char *host);
1.1 deraadt 213:
1.102 millert 214: void add_local_forward(Options *, const struct Forward *);
215: void add_remote_forward(Options *, const struct Forward *);
1.92 dtucker 216: void add_identity_file(Options *, const char *, const char *, int);
1.111 djm 217: void add_certificate_file(Options *, const char *, int);
1.1 deraadt 218:
1.11 deraadt 219: #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