Annotation of src/usr.bin/ssh/readconf.h, Revision 1.118
1.118 ! dtucker 1: /* $OpenBSD: readconf.h,v 1.117 2016/07/15 00:24:30 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.90 djm 21: #define MAX_SEND_ENV 256
1.98 djm 22: #define SSH_MAX_HOSTS_FILES 32
23: #define MAX_CANON_DOMAINS 32
1.102 millert 24: #define PATH_MAX_SUN (sizeof((struct sockaddr_un *)0)->sun_path)
1.98 djm 25:
26: struct allowed_cname {
27: char *source_list;
28: char *target_list;
29: };
1.62 djm 30:
1.11 deraadt 31: typedef struct {
32: int forward_agent; /* Forward authentication agent. */
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.11 deraadt 39: int use_privileged_port; /* Don't use privileged port if false. */
40: int rhosts_rsa_authentication; /* Try rhosts with RSA
41: * authentication. */
42: int rsa_authentication; /* Try RSA authentication. */
1.23 markus 43: int pubkey_authentication; /* Try ssh2 pubkey authentication. */
1.29 markus 44: int hostbased_authentication; /* ssh2's rhosts_rsa */
1.32 markus 45: int challenge_response_authentication;
1.25 markus 46: /* Try S/Key or TIS, authentication. */
1.54 markus 47: int gss_authentication; /* Try GSS authentication */
48: int gss_deleg_creds; /* Delegate GSS credentials */
1.11 deraadt 49: int password_authentication; /* Try password
50: * authentication. */
1.22 markus 51: int kbd_interactive_authentication; /* Try keyboard-interactive auth. */
52: char *kbd_interactive_devices; /* Keyboard-interactive auth devices. */
1.11 deraadt 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 compression_level; /* Compression level 1 (fast) to 9
58: * (best). */
1.58 markus 59: int tcp_keep_alive; /* Set SO_KEEPALIVE. */
1.88 djm 60: int ip_qos_interactive; /* IP ToS/DSCP/class for interactive */
61: int ip_qos_bulk; /* IP ToS/DSCP/class for bulk traffic */
1.118 ! dtucker 62: SyslogFacility log_facility; /* Facility for system logging. */
1.11 deraadt 63: LogLevel log_level; /* Level for logging. */
64:
65: int port; /* Port to connect. */
1.51 djm 66: int address_family;
1.11 deraadt 67: int connection_attempts; /* Max attempts (seconds) before
68: * giving up */
1.50 djm 69: int connection_timeout; /* Max time (seconds) before
1.57 djm 70: * aborting connection attempt */
1.11 deraadt 71: int number_of_password_prompts; /* Max number of password
72: * prompts. */
73: int cipher; /* Cipher to use. */
1.18 markus 74: char *ciphers; /* SSH2 ciphers in order of preference. */
1.26 markus 75: char *macs; /* SSH2 macs in order of preference. */
1.30 markus 76: char *hostkeyalgorithms; /* SSH2 server key types in order of preference. */
1.87 djm 77: char *kex_algorithms; /* SSH2 kex methods in order of preference. */
1.14 markus 78: int protocol; /* Protocol in order of preference. */
1.11 deraadt 79: char *hostname; /* Real host to connect. */
1.24 markus 80: char *host_key_alias; /* hostname alias for .ssh/known_hosts */
1.11 deraadt 81: char *proxy_command; /* Proxy command for connecting the host. */
82: char *user; /* User to log in as. */
83: int escape_char; /* Escape character; -2 = none */
84:
1.90 djm 85: u_int num_system_hostfiles; /* Paths for /etc/ssh/ssh_known_hosts */
86: char *system_hostfiles[SSH_MAX_HOSTS_FILES];
87: u_int num_user_hostfiles; /* Path for $HOME/.ssh/known_hosts */
88: char *user_hostfiles[SSH_MAX_HOSTS_FILES];
1.28 markus 89: char *preferred_authentications;
1.31 markus 90: char *bind_address; /* local socket address for connection to sshd */
1.82 markus 91: char *pkcs11_provider; /* PKCS#11 provider */
1.48 jakob 92: int verify_host_key_dns; /* Verify host key using DNS */
1.11 deraadt 93:
1.23 markus 94: int num_identity_files; /* Number of files for RSA/DSA identities. */
1.11 deraadt 95: char *identity_files[SSH_MAX_IDENTITY_FILES];
1.92 dtucker 96: int identity_file_userprovided[SSH_MAX_IDENTITY_FILES];
1.106 djm 97: struct sshkey *identity_keys[SSH_MAX_IDENTITY_FILES];
1.11 deraadt 98:
1.111 djm 99: int num_certificate_files; /* Number of extra certificates for ssh. */
100: char *certificate_files[SSH_MAX_CERTIFICATE_FILES];
101: int certificate_file_userprovided[SSH_MAX_CERTIFICATE_FILES];
102: struct sshkey *certificates[SSH_MAX_CERTIFICATE_FILES];
1.112 jcs 103:
104: int add_keys_to_agent;
1.115 markus 105: char *identity_agent; /* Optional path to ssh-agent socket */
1.111 djm 106:
1.11 deraadt 107: /* Local TCP/IP forward requests. */
108: int num_local_forwards;
1.102 millert 109: struct Forward *local_forwards;
1.11 deraadt 110:
111: /* Remote TCP/IP forward requests. */
112: int num_remote_forwards;
1.102 millert 113: struct Forward *remote_forwards;
1.39 stevesk 114: int clear_forwardings;
1.116 dtucker 115:
116: /* stdio forwarding (-W) host and port */
117: char *stdio_forward_host;
118: int stdio_forward_port;
1.44 markus 119:
120: int enable_ssh_keysign;
1.72 djm 121: int64_t rekey_limit;
1.94 dtucker 122: int rekey_interval;
1.40 markus 123: int no_host_authentication_for_localhost;
1.60 markus 124: int identities_only;
1.64 deraadt 125: int server_alive_interval;
1.59 markus 126: int server_alive_count_max;
1.62 djm 127:
128: int num_send_env;
129: char *send_env[MAX_SEND_ENV];
1.63 djm 130:
131: char *control_path;
132: int control_master;
1.86 djm 133: int control_persist; /* ControlPersist flag */
134: int control_persist_timeout; /* ControlPersist timeout (seconds) */
1.66 djm 135:
136: int hash_known_hosts;
1.68 reyk 137:
138: int tun_open; /* tun(4) */
139: int tun_local; /* force tun device (optional) */
140: int tun_remote; /* force tun device (optional) */
141:
142: char *local_command;
143: int permit_local_command;
1.74 grunk 144: int visual_host_key;
1.80 reyk 145:
1.89 djm 146: int request_tty;
1.96 djm 147:
148: int proxy_use_fdpass;
1.95 djm 149:
1.98 djm 150: int num_canonical_domains;
151: char *canonical_domains[MAX_CANON_DOMAINS];
1.99 djm 152: int canonicalize_hostname;
153: int canonicalize_max_dots;
154: int canonicalize_fallback_local;
1.98 djm 155: int num_permitted_cnames;
156: struct allowed_cname permitted_cnames[MAX_CANON_DOMAINS];
1.104 djm 157:
158: char *revoked_host_keys;
1.105 djm 159:
1.107 djm 160: int fingerprint_hash;
161:
1.109 djm 162: int update_hostkeys; /* one of SSH_UPDATE_HOSTKEYS_* */
1.108 djm 163:
1.110 markus 164: char *hostbased_key_types;
165: char *pubkey_key_types;
1.98 djm 166:
1.117 djm 167: char *jump_user;
168: char *jump_host;
169: int jump_port;
170: char *jump_extra;
171:
1.95 djm 172: char *ignored_unknown; /* Pattern list of unknown tokens to ignore */
1.11 deraadt 173: } Options;
1.98 djm 174:
175: #define SSH_CANONICALISE_NO 0
176: #define SSH_CANONICALISE_YES 1
177: #define SSH_CANONICALISE_ALWAYS 2
1.1 deraadt 178:
1.67 djm 179: #define SSHCTL_MASTER_NO 0
180: #define SSHCTL_MASTER_YES 1
181: #define SSHCTL_MASTER_AUTO 2
182: #define SSHCTL_MASTER_ASK 3
183: #define SSHCTL_MASTER_AUTO_ASK 4
1.89 djm 184:
185: #define REQUEST_TTY_AUTO 0
186: #define REQUEST_TTY_NO 1
187: #define REQUEST_TTY_YES 2
188: #define REQUEST_TTY_FORCE 3
1.1 deraadt 189:
1.93 dtucker 190: #define SSHCONF_CHECKPERM 1 /* check permissions on config file */
191: #define SSHCONF_USERCONF 2 /* user provided config file not system */
1.103 djm 192: #define SSHCONF_POSTCANON 4 /* After hostname canonicalisation */
1.114 djm 193: #define SSHCONF_NEVERMATCH 8 /* Match/Host never matches; internal only */
1.109 djm 194:
195: #define SSH_UPDATE_HOSTKEYS_NO 0
196: #define SSH_UPDATE_HOSTKEYS_YES 1
197: #define SSH_UPDATE_HOSTKEYS_ASK 2
1.93 dtucker 198:
1.35 markus 199: void initialize_options(Options *);
200: void fill_default_options(Options *);
1.101 djm 201: void fill_default_options_for_canonicalization(Options *);
1.103 djm 202: int process_config_line(Options *, struct passwd *, const char *,
203: const char *, char *, const char *, int, int *, int);
1.97 djm 204: int read_config_file(const char *, struct passwd *, const char *,
1.103 djm 205: const char *, Options *, int);
1.102 millert 206: int parse_forward(struct Forward *, const char *, int, int);
1.117 djm 207: int parse_jump(const char *, Options *, int);
1.97 djm 208: int default_ssh_port(void);
1.101 djm 209: int option_clear_or_none(const char *);
1.103 djm 210: void dump_client_config(Options *o, const char *host);
1.1 deraadt 211:
1.102 millert 212: void add_local_forward(Options *, const struct Forward *);
213: void add_remote_forward(Options *, const struct Forward *);
1.92 dtucker 214: void add_identity_file(Options *, const char *, const char *, int);
1.111 djm 215: void add_certificate_file(Options *, const char *, int);
1.1 deraadt 216:
1.11 deraadt 217: #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