Annotation of src/usr.bin/ssh/readconf.h, Revision 1.100
1.100 ! djm 1: /* $OpenBSD: readconf.h,v 1.99 2013/10/16 22:49:38 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 a forwarding request. */
20:
1.11 deraadt 21: typedef struct {
1.65 djm 22: char *listen_host; /* Host (address) to listen on. */
1.77 djm 23: int listen_port; /* Port to forward. */
1.65 djm 24: char *connect_host; /* Host to connect. */
1.77 djm 25: int connect_port; /* Port to connect on connect_host. */
1.83 markus 26: int allocated_port; /* Dynamically allocated listen port */
1.91 markus 27: int handle; /* Handle for dynamic listen ports */
1.11 deraadt 28: } Forward;
1.1 deraadt 29: /* Data structure for representing option data. */
30:
1.90 djm 31: #define MAX_SEND_ENV 256
1.98 djm 32: #define SSH_MAX_HOSTS_FILES 32
33: #define MAX_CANON_DOMAINS 32
34:
35: struct allowed_cname {
36: char *source_list;
37: char *target_list;
38: };
1.62 djm 39:
1.11 deraadt 40: typedef struct {
41: int forward_agent; /* Forward authentication agent. */
42: int forward_x11; /* Forward X11 display. */
1.85 djm 43: int forward_x11_timeout; /* Expiration for Cookies */
1.56 markus 44: int forward_x11_trusted; /* Trust Forward X11 display. */
1.70 markus 45: int exit_on_forward_failure; /* Exit if bind(2) fails for -L/-R */
1.19 markus 46: char *xauth_location; /* Location for xauth program */
1.11 deraadt 47: int gateway_ports; /* Allow remote connects to forwarded ports. */
48: int use_privileged_port; /* Don't use privileged port if false. */
49: int rhosts_rsa_authentication; /* Try rhosts with RSA
50: * authentication. */
51: int rsa_authentication; /* Try RSA authentication. */
1.23 markus 52: int pubkey_authentication; /* Try ssh2 pubkey authentication. */
1.29 markus 53: int hostbased_authentication; /* ssh2's rhosts_rsa */
1.32 markus 54: int challenge_response_authentication;
1.25 markus 55: /* Try S/Key or TIS, authentication. */
1.54 markus 56: int gss_authentication; /* Try GSS authentication */
57: int gss_deleg_creds; /* Delegate GSS credentials */
1.11 deraadt 58: int password_authentication; /* Try password
59: * authentication. */
1.22 markus 60: int kbd_interactive_authentication; /* Try keyboard-interactive auth. */
61: char *kbd_interactive_devices; /* Keyboard-interactive auth devices. */
1.11 deraadt 62: int batch_mode; /* Batch mode: do not ask for passwords. */
63: int check_host_ip; /* Also keep track of keys for IP address */
64: int strict_host_key_checking; /* Strict host key checking. */
65: int compression; /* Compress packets in both directions. */
66: int compression_level; /* Compression level 1 (fast) to 9
67: * (best). */
1.58 markus 68: int tcp_keep_alive; /* Set SO_KEEPALIVE. */
1.88 djm 69: int ip_qos_interactive; /* IP ToS/DSCP/class for interactive */
70: int ip_qos_bulk; /* IP ToS/DSCP/class for bulk traffic */
1.11 deraadt 71: LogLevel log_level; /* Level for logging. */
72:
73: int port; /* Port to connect. */
1.51 djm 74: int address_family;
1.11 deraadt 75: int connection_attempts; /* Max attempts (seconds) before
76: * giving up */
1.50 djm 77: int connection_timeout; /* Max time (seconds) before
1.57 djm 78: * aborting connection attempt */
1.11 deraadt 79: int number_of_password_prompts; /* Max number of password
80: * prompts. */
81: int cipher; /* Cipher to use. */
1.18 markus 82: char *ciphers; /* SSH2 ciphers in order of preference. */
1.26 markus 83: char *macs; /* SSH2 macs in order of preference. */
1.30 markus 84: char *hostkeyalgorithms; /* SSH2 server key types in order of preference. */
1.87 djm 85: char *kex_algorithms; /* SSH2 kex methods in order of preference. */
1.14 markus 86: int protocol; /* Protocol in order of preference. */
1.11 deraadt 87: char *hostname; /* Real host to connect. */
1.24 markus 88: char *host_key_alias; /* hostname alias for .ssh/known_hosts */
1.11 deraadt 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.90 djm 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.28 markus 97: char *preferred_authentications;
1.31 markus 98: char *bind_address; /* local socket address for connection to sshd */
1.82 markus 99: char *pkcs11_provider; /* PKCS#11 provider */
1.48 jakob 100: int verify_host_key_dns; /* Verify host key using DNS */
1.11 deraadt 101:
1.23 markus 102: int num_identity_files; /* Number of files for RSA/DSA identities. */
1.11 deraadt 103: char *identity_files[SSH_MAX_IDENTITY_FILES];
1.92 dtucker 104: int identity_file_userprovided[SSH_MAX_IDENTITY_FILES];
1.27 markus 105: Key *identity_keys[SSH_MAX_IDENTITY_FILES];
1.11 deraadt 106:
107: /* Local TCP/IP forward requests. */
108: int num_local_forwards;
1.84 djm 109: Forward *local_forwards;
1.11 deraadt 110:
111: /* Remote TCP/IP forward requests. */
112: int num_remote_forwards;
1.84 djm 113: Forward *remote_forwards;
1.39 stevesk 114: int clear_forwardings;
1.44 markus 115:
116: int enable_ssh_keysign;
1.72 djm 117: int64_t rekey_limit;
1.94 dtucker 118: int rekey_interval;
1.40 markus 119: int no_host_authentication_for_localhost;
1.60 markus 120: int identities_only;
1.64 deraadt 121: int server_alive_interval;
1.59 markus 122: int server_alive_count_max;
1.62 djm 123:
124: int num_send_env;
125: char *send_env[MAX_SEND_ENV];
1.63 djm 126:
127: char *control_path;
128: int control_master;
1.86 djm 129: int control_persist; /* ControlPersist flag */
130: int control_persist_timeout; /* ControlPersist timeout (seconds) */
1.66 djm 131:
132: int hash_known_hosts;
1.68 reyk 133:
134: int tun_open; /* tun(4) */
135: int tun_local; /* force tun device (optional) */
136: int tun_remote; /* force tun device (optional) */
137:
138: char *local_command;
139: int permit_local_command;
1.74 grunk 140: int visual_host_key;
1.79 andreas 141:
142: int use_roaming;
1.80 reyk 143:
1.89 djm 144: int request_tty;
1.96 djm 145:
146: int proxy_use_fdpass;
1.95 djm 147:
1.98 djm 148: int num_canonical_domains;
149: char *canonical_domains[MAX_CANON_DOMAINS];
1.99 djm 150: int canonicalize_hostname;
151: int canonicalize_max_dots;
152: int canonicalize_fallback_local;
1.98 djm 153: int num_permitted_cnames;
154: struct allowed_cname permitted_cnames[MAX_CANON_DOMAINS];
155:
1.95 djm 156: char *ignored_unknown; /* Pattern list of unknown tokens to ignore */
1.11 deraadt 157: } Options;
1.98 djm 158:
159: #define SSH_CANONICALISE_NO 0
160: #define SSH_CANONICALISE_YES 1
161: #define SSH_CANONICALISE_ALWAYS 2
1.1 deraadt 162:
1.67 djm 163: #define SSHCTL_MASTER_NO 0
164: #define SSHCTL_MASTER_YES 1
165: #define SSHCTL_MASTER_AUTO 2
166: #define SSHCTL_MASTER_ASK 3
167: #define SSHCTL_MASTER_AUTO_ASK 4
1.89 djm 168:
169: #define REQUEST_TTY_AUTO 0
170: #define REQUEST_TTY_NO 1
171: #define REQUEST_TTY_YES 2
172: #define REQUEST_TTY_FORCE 3
1.1 deraadt 173:
1.93 dtucker 174: #define SSHCONF_CHECKPERM 1 /* check permissions on config file */
175: #define SSHCONF_USERCONF 2 /* user provided config file not system */
176:
1.35 markus 177: void initialize_options(Options *);
178: void fill_default_options(Options *);
1.97 djm 179: int process_config_line(Options *, struct passwd *, const char *, char *,
180: const char *, int, int *, int);
181: int read_config_file(const char *, struct passwd *, const char *,
182: Options *, int);
1.78 djm 183: int parse_forward(Forward *, const char *, int, int);
1.97 djm 184: int default_ssh_port(void);
1.1 deraadt 185:
1.65 djm 186: void add_local_forward(Options *, const Forward *);
187: void add_remote_forward(Options *, const Forward *);
1.92 dtucker 188: void add_identity_file(Options *, const char *, const char *, int);
1.1 deraadt 189:
1.11 deraadt 190: #endif /* READCONF_H */