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