Annotation of src/usr.bin/ssh/readconf.h, Revision 1.22.2.3
1.1 deraadt 1: /*
1.11 deraadt 2: * Author: Tatu Ylonen <ylo@cs.hut.fi>
3: * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
4: * All rights reserved
5: * Functions for reading the configuration file.
1.15 markus 6: *
1.21 deraadt 7: * As far as I am concerned, the code I have written for this software
8: * can be used freely for any purpose. Any derived versions of this
9: * software must be clearly marked as such, and if the derived work is
10: * incompatible with the protocol description in the RFC file, it must be
11: * called by a name other than "ssh" or "Secure Shell".
1.11 deraadt 12: */
1.1 deraadt 13:
1.22.2.3! jason 14: /* RCSID("$OpenBSD: readconf.h,v 1.28 2001/03/10 17:51:04 markus Exp $"); */
1.1 deraadt 15:
16: #ifndef READCONF_H
17: #define READCONF_H
18:
1.22.2.3! jason 19: #include "key.h"
! 20:
1.1 deraadt 21: /* Data structure for representing a forwarding request. */
22:
1.11 deraadt 23: typedef struct {
1.13 markus 24: u_short port; /* Port to forward. */
25: char *host; /* Host to connect. */
26: u_short host_port; /* Port to connect on host. */
1.11 deraadt 27: } Forward;
1.1 deraadt 28: /* Data structure for representing option data. */
29:
1.11 deraadt 30: typedef struct {
31: int forward_agent; /* Forward authentication agent. */
32: int forward_x11; /* Forward X11 display. */
1.19 markus 33: char *xauth_location; /* Location for xauth program */
1.11 deraadt 34: int gateway_ports; /* Allow remote connects to forwarded ports. */
35: int use_privileged_port; /* Don't use privileged port if false. */
36: int rhosts_authentication; /* Try rhosts authentication. */
37: int rhosts_rsa_authentication; /* Try rhosts with RSA
38: * authentication. */
39: int rsa_authentication; /* Try RSA authentication. */
1.22.2.1 jason 40: int pubkey_authentication; /* Try ssh2 pubkey authentication. */
41: int challenge_reponse_authentication;
42: /* Try S/Key or TIS, authentication. */
1.1 deraadt 43: #ifdef KRB4
1.11 deraadt 44: int kerberos_authentication; /* Try Kerberos
45: * authentication. */
1.1 deraadt 46: #endif
1.3 dugsong 47: #ifdef AFS
1.11 deraadt 48: int kerberos_tgt_passing; /* Try Kerberos tgt passing. */
49: int afs_token_passing; /* Try AFS token passing. */
1.1 deraadt 50: #endif
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.11 deraadt 55: int fallback_to_rsh;/* Use rsh if cannot connect with ssh. */
56: int use_rsh; /* Always use rsh (don\'t try ssh). */
57: int batch_mode; /* Batch mode: do not ask for passwords. */
58: int check_host_ip; /* Also keep track of keys for IP address */
59: int strict_host_key_checking; /* Strict host key checking. */
60: int compression; /* Compress packets in both directions. */
61: int compression_level; /* Compression level 1 (fast) to 9
62: * (best). */
63: int keepalives; /* Set SO_KEEPALIVE. */
64: LogLevel log_level; /* Level for logging. */
65:
66: int port; /* Port to connect. */
67: int connection_attempts; /* Max attempts (seconds) before
68: * giving up */
69: int number_of_password_prompts; /* Max number of password
70: * prompts. */
71: int cipher; /* Cipher to use. */
1.18 markus 72: char *ciphers; /* SSH2 ciphers in order of preference. */
1.22.2.1 jason 73: char *macs; /* SSH2 macs 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.22.2.1 jason 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:
81: char *system_hostfile;/* Path for /etc/ssh_known_hosts. */
82: char *user_hostfile; /* Path for $HOME/.ssh/known_hosts. */
1.16 markus 83: char *system_hostfile2;
84: char *user_hostfile2;
1.22.2.3! jason 85: char *preferred_authentications;
1.11 deraadt 86:
1.22.2.1 jason 87: int num_identity_files; /* Number of files for RSA/DSA identities. */
1.11 deraadt 88: char *identity_files[SSH_MAX_IDENTITY_FILES];
1.22.2.3! jason 89: Key *identity_keys[SSH_MAX_IDENTITY_FILES];
1.11 deraadt 90:
91: /* Local TCP/IP forward requests. */
92: int num_local_forwards;
93: Forward local_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
94:
95: /* Remote TCP/IP forward requests. */
96: int num_remote_forwards;
97: Forward remote_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
98: } Options;
1.1 deraadt 99:
100:
1.12 markus 101: /*
102: * Initializes options to special values that indicate that they have not yet
103: * been set. Read_config_file will only set options with this value. Options
104: * are processed in the following order: command line, user config file,
105: * system config file. Last, fill_default_options is called.
106: */
1.11 deraadt 107: void initialize_options(Options * options);
1.1 deraadt 108:
1.12 markus 109: /*
110: * Called after processing other sources of option data, this fills those
111: * options for which no value has been specified with their default values.
112: */
1.11 deraadt 113: void fill_default_options(Options * options);
1.1 deraadt 114:
1.12 markus 115: /*
116: * Processes a single option line as used in the configuration files. This
117: * only sets those values that have not already been set. Returns 0 for legal
118: * options
119: */
1.15 markus 120: int
1.11 deraadt 121: process_config_line(Options * options, const char *host,
122: char *line, const char *filename, int linenum,
123: int *activep);
1.1 deraadt 124:
1.12 markus 125: /*
126: * Reads the config file and modifies the options accordingly. Options
127: * should already be initialized before this call. This never returns if
128: * there is an error. If the file does not exist, this returns immediately.
129: */
1.15 markus 130: void
1.11 deraadt 131: read_config_file(const char *filename, const char *host,
132: Options * options);
1.1 deraadt 133:
1.12 markus 134: /*
135: * Adds a local TCP/IP port forward to options. Never returns if there is an
136: * error.
137: */
1.15 markus 138: void
1.13 markus 139: add_local_forward(Options * options, u_short port, const char *host,
140: u_short host_port);
1.1 deraadt 141:
1.12 markus 142: /*
143: * Adds a remote TCP/IP port forward to options. Never returns if there is
144: * an error.
145: */
1.15 markus 146: void
1.13 markus 147: add_remote_forward(Options * options, u_short port, const char *host,
148: u_short host_port);
1.1 deraadt 149:
1.11 deraadt 150: #endif /* READCONF_H */