Annotation of src/usr.bin/ssh/readconf.h, Revision 1.90
1.90 ! djm 1: /* $OpenBSD: readconf.h,v 1.89 2011/05/06 21:34:32 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.11 deraadt 27: } Forward;
1.1 deraadt 28: /* Data structure for representing option data. */
29:
1.90 ! djm 30: #define MAX_SEND_ENV 256
! 31: #define SSH_MAX_HOSTS_FILES 256
1.62 djm 32:
1.11 deraadt 33: typedef struct {
34: int forward_agent; /* Forward authentication agent. */
35: int forward_x11; /* Forward X11 display. */
1.85 djm 36: int forward_x11_timeout; /* Expiration for Cookies */
1.56 markus 37: int forward_x11_trusted; /* Trust Forward X11 display. */
1.70 markus 38: int exit_on_forward_failure; /* Exit if bind(2) fails for -L/-R */
1.19 markus 39: char *xauth_location; /* Location for xauth program */
1.11 deraadt 40: int gateway_ports; /* Allow remote connects to forwarded ports. */
41: int use_privileged_port; /* Don't use privileged port if false. */
42: int rhosts_rsa_authentication; /* Try rhosts with RSA
43: * authentication. */
44: int rsa_authentication; /* Try RSA authentication. */
1.23 markus 45: int pubkey_authentication; /* Try ssh2 pubkey authentication. */
1.29 markus 46: int hostbased_authentication; /* ssh2's rhosts_rsa */
1.32 markus 47: int challenge_response_authentication;
1.25 markus 48: /* Try S/Key or TIS, authentication. */
1.54 markus 49: int gss_authentication; /* Try GSS authentication */
50: int gss_deleg_creds; /* Delegate GSS credentials */
1.11 deraadt 51: int password_authentication; /* Try password
52: * authentication. */
1.22 markus 53: int kbd_interactive_authentication; /* Try keyboard-interactive auth. */
54: char *kbd_interactive_devices; /* Keyboard-interactive auth devices. */
1.76 djm 55: int zero_knowledge_password_authentication; /* Try jpake */
1.11 deraadt 56: int batch_mode; /* Batch mode: do not ask for passwords. */
57: int check_host_ip; /* Also keep track of keys for IP address */
58: int strict_host_key_checking; /* Strict host key checking. */
59: int compression; /* Compress packets in both directions. */
60: int compression_level; /* Compression level 1 (fast) to 9
61: * (best). */
1.58 markus 62: int tcp_keep_alive; /* Set SO_KEEPALIVE. */
1.88 djm 63: int ip_qos_interactive; /* IP ToS/DSCP/class for interactive */
64: int ip_qos_bulk; /* IP ToS/DSCP/class for bulk traffic */
1.11 deraadt 65: LogLevel log_level; /* Level for logging. */
66:
67: int port; /* Port to connect. */
1.51 djm 68: int address_family;
1.11 deraadt 69: int connection_attempts; /* Max attempts (seconds) before
70: * giving up */
1.50 djm 71: int connection_timeout; /* Max time (seconds) before
1.57 djm 72: * aborting connection attempt */
1.11 deraadt 73: int number_of_password_prompts; /* Max number of password
74: * prompts. */
75: int cipher; /* Cipher to use. */
1.18 markus 76: char *ciphers; /* SSH2 ciphers in order of preference. */
1.26 markus 77: char *macs; /* SSH2 macs in order of preference. */
1.30 markus 78: char *hostkeyalgorithms; /* SSH2 server key types in order of preference. */
1.87 djm 79: char *kex_algorithms; /* SSH2 kex methods in order of preference. */
1.14 markus 80: int protocol; /* Protocol in order of preference. */
1.11 deraadt 81: char *hostname; /* Real host to connect. */
1.24 markus 82: char *host_key_alias; /* hostname alias for .ssh/known_hosts */
1.11 deraadt 83: char *proxy_command; /* Proxy command for connecting the host. */
84: char *user; /* User to log in as. */
85: int escape_char; /* Escape character; -2 = none */
86:
1.90 ! djm 87: u_int num_system_hostfiles; /* Paths for /etc/ssh/ssh_known_hosts */
! 88: char *system_hostfiles[SSH_MAX_HOSTS_FILES];
! 89: u_int num_user_hostfiles; /* Path for $HOME/.ssh/known_hosts */
! 90: char *user_hostfiles[SSH_MAX_HOSTS_FILES];
1.28 markus 91: char *preferred_authentications;
1.31 markus 92: char *bind_address; /* local socket address for connection to sshd */
1.82 markus 93: char *pkcs11_provider; /* PKCS#11 provider */
1.48 jakob 94: int verify_host_key_dns; /* Verify host key using DNS */
1.11 deraadt 95:
1.23 markus 96: int num_identity_files; /* Number of files for RSA/DSA identities. */
1.11 deraadt 97: char *identity_files[SSH_MAX_IDENTITY_FILES];
1.27 markus 98: Key *identity_keys[SSH_MAX_IDENTITY_FILES];
1.11 deraadt 99:
100: /* Local TCP/IP forward requests. */
101: int num_local_forwards;
1.84 djm 102: Forward *local_forwards;
1.11 deraadt 103:
104: /* Remote TCP/IP forward requests. */
105: int num_remote_forwards;
1.84 djm 106: Forward *remote_forwards;
1.39 stevesk 107: int clear_forwardings;
1.44 markus 108:
109: int enable_ssh_keysign;
1.72 djm 110: int64_t rekey_limit;
1.40 markus 111: int no_host_authentication_for_localhost;
1.60 markus 112: int identities_only;
1.64 deraadt 113: int server_alive_interval;
1.59 markus 114: int server_alive_count_max;
1.62 djm 115:
116: int num_send_env;
117: char *send_env[MAX_SEND_ENV];
1.63 djm 118:
119: char *control_path;
120: int control_master;
1.86 djm 121: int control_persist; /* ControlPersist flag */
122: int control_persist_timeout; /* ControlPersist timeout (seconds) */
1.66 djm 123:
124: int hash_known_hosts;
1.68 reyk 125:
126: int tun_open; /* tun(4) */
127: int tun_local; /* force tun device (optional) */
128: int tun_remote; /* force tun device (optional) */
129:
130: char *local_command;
131: int permit_local_command;
1.74 grunk 132: int visual_host_key;
1.79 andreas 133:
134: int use_roaming;
1.80 reyk 135:
1.89 djm 136: int request_tty;
1.11 deraadt 137: } Options;
1.1 deraadt 138:
1.67 djm 139: #define SSHCTL_MASTER_NO 0
140: #define SSHCTL_MASTER_YES 1
141: #define SSHCTL_MASTER_AUTO 2
142: #define SSHCTL_MASTER_ASK 3
143: #define SSHCTL_MASTER_AUTO_ASK 4
1.89 djm 144:
145: #define REQUEST_TTY_AUTO 0
146: #define REQUEST_TTY_NO 1
147: #define REQUEST_TTY_YES 2
148: #define REQUEST_TTY_FORCE 3
1.1 deraadt 149:
1.35 markus 150: void initialize_options(Options *);
151: void fill_default_options(Options *);
1.61 djm 152: int read_config_file(const char *, const char *, Options *, int);
1.78 djm 153: int parse_forward(Forward *, const char *, int, int);
1.35 markus 154:
1.15 markus 155: int
1.33 itojun 156: process_config_line(Options *, const char *, char *, const char *, int, int *);
1.1 deraadt 157:
1.65 djm 158: void add_local_forward(Options *, const Forward *);
159: void add_remote_forward(Options *, const Forward *);
1.1 deraadt 160:
1.11 deraadt 161: #endif /* READCONF_H */