Annotation of src/usr.bin/ssh/readconf.h, Revision 1.33
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.33 ! itojun 14: /* RCSID("$OpenBSD: readconf.h,v 1.32 2001/05/18 14:13:29 markus Exp $"); */
1.1 deraadt 15:
16: #ifndef READCONF_H
17: #define READCONF_H
18:
1.27 markus 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.23 markus 40: int pubkey_authentication; /* Try ssh2 pubkey authentication. */
1.29 markus 41: int hostbased_authentication; /* ssh2's rhosts_rsa */
1.32 markus 42: int challenge_response_authentication;
1.25 markus 43: /* Try S/Key or TIS, authentication. */
1.1 deraadt 44: #ifdef KRB4
1.11 deraadt 45: int kerberos_authentication; /* Try Kerberos
46: * authentication. */
1.1 deraadt 47: #endif
1.3 dugsong 48: #ifdef AFS
1.11 deraadt 49: int kerberos_tgt_passing; /* Try Kerberos tgt passing. */
50: int afs_token_passing; /* Try AFS token passing. */
1.1 deraadt 51: #endif
1.11 deraadt 52: int password_authentication; /* Try password
53: * authentication. */
1.22 markus 54: int kbd_interactive_authentication; /* Try keyboard-interactive auth. */
55: char *kbd_interactive_devices; /* Keyboard-interactive auth devices. */
1.11 deraadt 56: int fallback_to_rsh;/* Use rsh if cannot connect with ssh. */
57: int use_rsh; /* Always use rsh (don\'t try ssh). */
58: int batch_mode; /* Batch mode: do not ask for passwords. */
59: int check_host_ip; /* Also keep track of keys for IP address */
60: int strict_host_key_checking; /* Strict host key checking. */
61: int compression; /* Compress packets in both directions. */
62: int compression_level; /* Compression level 1 (fast) to 9
63: * (best). */
64: int keepalives; /* Set SO_KEEPALIVE. */
65: LogLevel log_level; /* Level for logging. */
66:
67: int port; /* Port to connect. */
68: int connection_attempts; /* Max attempts (seconds) before
69: * giving up */
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.14 markus 76: int protocol; /* Protocol in order of preference. */
1.11 deraadt 77: char *hostname; /* Real host to connect. */
1.24 markus 78: char *host_key_alias; /* hostname alias for .ssh/known_hosts */
1.11 deraadt 79: char *proxy_command; /* Proxy command for connecting the host. */
80: char *user; /* User to log in as. */
81: int escape_char; /* Escape character; -2 = none */
82:
83: char *system_hostfile;/* Path for /etc/ssh_known_hosts. */
84: char *user_hostfile; /* Path for $HOME/.ssh/known_hosts. */
1.16 markus 85: char *system_hostfile2;
86: char *user_hostfile2;
1.28 markus 87: char *preferred_authentications;
1.31 markus 88: char *bind_address; /* local socket address for connection to sshd */
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];
101: } Options;
1.1 deraadt 102:
103:
1.12 markus 104: /*
105: * Initializes options to special values that indicate that they have not yet
106: * been set. Read_config_file will only set options with this value. Options
107: * are processed in the following order: command line, user config file,
108: * system config file. Last, fill_default_options is called.
109: */
1.33 ! itojun 110: void initialize_options(Options *);
1.1 deraadt 111:
1.12 markus 112: /*
113: * Called after processing other sources of option data, this fills those
114: * options for which no value has been specified with their default values.
115: */
1.33 ! itojun 116: void fill_default_options(Options *);
1.1 deraadt 117:
1.12 markus 118: /*
119: * Processes a single option line as used in the configuration files. This
120: * only sets those values that have not already been set. Returns 0 for legal
121: * options
122: */
1.15 markus 123: int
1.33 ! itojun 124: process_config_line(Options *, const char *, char *, const char *, int, int *);
1.1 deraadt 125:
1.12 markus 126: /*
127: * Reads the config file and modifies the options accordingly. Options
128: * should already be initialized before this call. This never returns if
129: * there is an error. If the file does not exist, this returns immediately.
130: */
1.15 markus 131: void
1.33 ! itojun 132: read_config_file(const char *, const char *, 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.33 ! itojun 139: add_local_forward(Options *, u_short, const char *, u_short);
1.1 deraadt 140:
1.12 markus 141: /*
142: * Adds a remote TCP/IP port forward to options. Never returns if there is
143: * an error.
144: */
1.15 markus 145: void
1.33 ! itojun 146: add_remote_forward(Options *, u_short, const char *, u_short);
1.1 deraadt 147:
1.11 deraadt 148: #endif /* READCONF_H */