Annotation of src/usr.bin/ssh/readconf.h, Revision 1.78
1.78 ! djm 1: /* $OpenBSD: readconf.h,v 1.77 2009/01/22 10:02:34 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.11 deraadt 26: } Forward;
1.1 deraadt 27: /* Data structure for representing option data. */
28:
1.62 djm 29: #define MAX_SEND_ENV 256
30:
1.11 deraadt 31: typedef struct {
32: int forward_agent; /* Forward authentication agent. */
33: int forward_x11; /* Forward X11 display. */
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.11 deraadt 37: int gateway_ports; /* Allow remote connects to forwarded ports. */
38: int use_privileged_port; /* Don't use privileged port if false. */
39: int rhosts_rsa_authentication; /* Try rhosts with RSA
40: * authentication. */
41: int rsa_authentication; /* Try RSA authentication. */
1.23 markus 42: int pubkey_authentication; /* Try ssh2 pubkey authentication. */
1.29 markus 43: int hostbased_authentication; /* ssh2's rhosts_rsa */
1.32 markus 44: int challenge_response_authentication;
1.25 markus 45: /* Try S/Key or TIS, authentication. */
1.54 markus 46: int gss_authentication; /* Try GSS authentication */
47: int gss_deleg_creds; /* Delegate GSS credentials */
1.11 deraadt 48: int password_authentication; /* Try password
49: * authentication. */
1.22 markus 50: int kbd_interactive_authentication; /* Try keyboard-interactive auth. */
51: char *kbd_interactive_devices; /* Keyboard-interactive auth devices. */
1.76 djm 52: int zero_knowledge_password_authentication; /* Try jpake */
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.11 deraadt 60: LogLevel log_level; /* Level for logging. */
61:
62: int port; /* Port to connect. */
1.51 djm 63: int address_family;
1.11 deraadt 64: int connection_attempts; /* Max attempts (seconds) before
65: * giving up */
1.50 djm 66: int connection_timeout; /* Max time (seconds) before
1.57 djm 67: * aborting connection attempt */
1.11 deraadt 68: int number_of_password_prompts; /* Max number of password
69: * prompts. */
70: int cipher; /* Cipher to use. */
1.18 markus 71: char *ciphers; /* SSH2 ciphers in order of preference. */
1.26 markus 72: char *macs; /* SSH2 macs in order of preference. */
1.30 markus 73: char *hostkeyalgorithms; /* SSH2 server key types in order of preference. */
1.14 markus 74: int protocol; /* Protocol in order of preference. */
1.11 deraadt 75: char *hostname; /* Real host to connect. */
1.24 markus 76: char *host_key_alias; /* hostname alias for .ssh/known_hosts */
1.11 deraadt 77: char *proxy_command; /* Proxy command for connecting the host. */
78: char *user; /* User to log in as. */
79: int escape_char; /* Escape character; -2 = none */
80:
1.41 deraadt 81: char *system_hostfile;/* Path for /etc/ssh/ssh_known_hosts. */
1.11 deraadt 82: char *user_hostfile; /* Path for $HOME/.ssh/known_hosts. */
1.16 markus 83: char *system_hostfile2;
84: char *user_hostfile2;
1.28 markus 85: char *preferred_authentications;
1.31 markus 86: char *bind_address; /* local socket address for connection to sshd */
1.37 markus 87: char *smartcard_device; /* Smartcard reader device */
1.48 jakob 88: int verify_host_key_dns; /* Verify host key using DNS */
1.11 deraadt 89:
1.23 markus 90: int num_identity_files; /* Number of files for RSA/DSA identities. */
1.11 deraadt 91: char *identity_files[SSH_MAX_IDENTITY_FILES];
1.27 markus 92: Key *identity_keys[SSH_MAX_IDENTITY_FILES];
1.11 deraadt 93:
94: /* Local TCP/IP forward requests. */
95: int num_local_forwards;
96: Forward local_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
97:
98: /* Remote TCP/IP forward requests. */
99: int num_remote_forwards;
100: Forward remote_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
1.39 stevesk 101: int clear_forwardings;
1.44 markus 102:
103: int enable_ssh_keysign;
1.72 djm 104: int64_t rekey_limit;
1.40 markus 105: int no_host_authentication_for_localhost;
1.60 markus 106: int identities_only;
1.64 deraadt 107: int server_alive_interval;
1.59 markus 108: int server_alive_count_max;
1.62 djm 109:
110: int num_send_env;
111: char *send_env[MAX_SEND_ENV];
1.63 djm 112:
113: char *control_path;
114: int control_master;
1.66 djm 115:
116: int hash_known_hosts;
1.68 reyk 117:
118: int tun_open; /* tun(4) */
119: int tun_local; /* force tun device (optional) */
120: int tun_remote; /* force tun device (optional) */
121:
122: char *local_command;
123: int permit_local_command;
1.74 grunk 124: int visual_host_key;
1.68 reyk 125:
1.11 deraadt 126: } Options;
1.1 deraadt 127:
1.67 djm 128: #define SSHCTL_MASTER_NO 0
129: #define SSHCTL_MASTER_YES 1
130: #define SSHCTL_MASTER_AUTO 2
131: #define SSHCTL_MASTER_ASK 3
132: #define SSHCTL_MASTER_AUTO_ASK 4
1.1 deraadt 133:
1.35 markus 134: void initialize_options(Options *);
135: void fill_default_options(Options *);
1.61 djm 136: int read_config_file(const char *, const char *, Options *, int);
1.78 ! djm 137: int parse_forward(Forward *, const char *, int, int);
1.35 markus 138:
1.15 markus 139: int
1.33 itojun 140: process_config_line(Options *, const char *, char *, const char *, int, int *);
1.1 deraadt 141:
1.65 djm 142: void add_local_forward(Options *, const Forward *);
143: void add_remote_forward(Options *, const Forward *);
1.1 deraadt 144:
1.11 deraadt 145: #endif /* READCONF_H */