Annotation of src/usr.bin/ssh/readconf.h, Revision 1.24
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.24 ! markus 14: /* RCSID("$OpenBSD: readconf.h,v 1.23 2000/11/12 19:50:37 markus Exp $"); */
1.1 deraadt 15:
16: #ifndef READCONF_H
17: #define READCONF_H
18:
19: /* Data structure for representing a forwarding request. */
20:
1.11 deraadt 21: typedef struct {
1.13 markus 22: u_short port; /* Port to forward. */
23: char *host; /* Host to connect. */
24: u_short host_port; /* Port to connect on host. */
1.11 deraadt 25: } Forward;
1.1 deraadt 26: /* Data structure for representing option data. */
27:
1.11 deraadt 28: typedef struct {
29: int forward_agent; /* Forward authentication agent. */
30: int forward_x11; /* Forward X11 display. */
1.19 markus 31: char *xauth_location; /* Location for xauth program */
1.11 deraadt 32: int gateway_ports; /* Allow remote connects to forwarded ports. */
33: int use_privileged_port; /* Don't use privileged port if false. */
34: int rhosts_authentication; /* Try rhosts authentication. */
35: int rhosts_rsa_authentication; /* Try rhosts with RSA
36: * authentication. */
37: int rsa_authentication; /* Try RSA authentication. */
1.23 markus 38: int pubkey_authentication; /* Try ssh2 pubkey authentication. */
1.11 deraadt 39: int skey_authentication; /* Try S/Key or TIS authentication. */
1.1 deraadt 40: #ifdef KRB4
1.11 deraadt 41: int kerberos_authentication; /* Try Kerberos
42: * authentication. */
1.1 deraadt 43: #endif
1.3 dugsong 44: #ifdef AFS
1.11 deraadt 45: int kerberos_tgt_passing; /* Try Kerberos tgt passing. */
46: int afs_token_passing; /* Try AFS token passing. */
1.1 deraadt 47: #endif
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.11 deraadt 52: int fallback_to_rsh;/* Use rsh if cannot connect with ssh. */
53: int use_rsh; /* Always use rsh (don\'t try ssh). */
54: int batch_mode; /* Batch mode: do not ask for passwords. */
55: int check_host_ip; /* Also keep track of keys for IP address */
56: int strict_host_key_checking; /* Strict host key checking. */
57: int compression; /* Compress packets in both directions. */
58: int compression_level; /* Compression level 1 (fast) to 9
59: * (best). */
60: int keepalives; /* Set SO_KEEPALIVE. */
61: LogLevel log_level; /* Level for logging. */
62:
63: int port; /* Port to connect. */
64: int connection_attempts; /* Max attempts (seconds) before
65: * giving up */
66: int number_of_password_prompts; /* Max number of password
67: * prompts. */
68: int cipher; /* Cipher to use. */
1.18 markus 69: char *ciphers; /* SSH2 ciphers in order of preference. */
1.14 markus 70: int protocol; /* Protocol in order of preference. */
1.11 deraadt 71: char *hostname; /* Real host to connect. */
1.24 ! markus 72: char *host_key_alias; /* hostname alias for .ssh/known_hosts */
1.11 deraadt 73: char *proxy_command; /* Proxy command for connecting the host. */
74: char *user; /* User to log in as. */
75: int escape_char; /* Escape character; -2 = none */
76:
77: char *system_hostfile;/* Path for /etc/ssh_known_hosts. */
78: char *user_hostfile; /* Path for $HOME/.ssh/known_hosts. */
1.16 markus 79: char *system_hostfile2;
80: char *user_hostfile2;
1.11 deraadt 81:
1.23 markus 82: int num_identity_files; /* Number of files for RSA/DSA identities. */
1.11 deraadt 83: char *identity_files[SSH_MAX_IDENTITY_FILES];
1.23 markus 84: int identity_files_type[SSH_MAX_IDENTITY_FILES];
1.11 deraadt 85:
86: /* Local TCP/IP forward requests. */
87: int num_local_forwards;
88: Forward local_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
89:
90: /* Remote TCP/IP forward requests. */
91: int num_remote_forwards;
92: Forward remote_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
93: } Options;
1.1 deraadt 94:
95:
1.12 markus 96: /*
97: * Initializes options to special values that indicate that they have not yet
98: * been set. Read_config_file will only set options with this value. Options
99: * are processed in the following order: command line, user config file,
100: * system config file. Last, fill_default_options is called.
101: */
1.11 deraadt 102: void initialize_options(Options * options);
1.1 deraadt 103:
1.12 markus 104: /*
105: * Called after processing other sources of option data, this fills those
106: * options for which no value has been specified with their default values.
107: */
1.11 deraadt 108: void fill_default_options(Options * options);
1.1 deraadt 109:
1.12 markus 110: /*
111: * Processes a single option line as used in the configuration files. This
112: * only sets those values that have not already been set. Returns 0 for legal
113: * options
114: */
1.15 markus 115: int
1.11 deraadt 116: process_config_line(Options * options, const char *host,
117: char *line, const char *filename, int linenum,
118: int *activep);
1.1 deraadt 119:
1.12 markus 120: /*
121: * Reads the config file and modifies the options accordingly. Options
122: * should already be initialized before this call. This never returns if
123: * there is an error. If the file does not exist, this returns immediately.
124: */
1.15 markus 125: void
1.11 deraadt 126: read_config_file(const char *filename, const char *host,
127: Options * options);
1.1 deraadt 128:
1.12 markus 129: /*
130: * Adds a local TCP/IP port forward to options. Never returns if there is an
131: * error.
132: */
1.15 markus 133: void
1.13 markus 134: add_local_forward(Options * options, u_short port, const char *host,
135: u_short host_port);
1.1 deraadt 136:
1.12 markus 137: /*
138: * Adds a remote TCP/IP port forward to options. Never returns if there is
139: * an error.
140: */
1.15 markus 141: void
1.13 markus 142: add_remote_forward(Options * options, u_short port, const char *host,
143: u_short host_port);
1.1 deraadt 144:
1.11 deraadt 145: #endif /* READCONF_H */