Annotation of src/usr.bin/ssh/readconf.h, Revision 1.10
1.1 deraadt 1: /*
2:
3: readconf.h
4:
5: Author: Tatu Ylonen <ylo@cs.hut.fi>
6:
7: Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
8: All rights reserved
9:
10: Created: Sat Apr 22 00:25:29 1995 ylo
11:
12: Functions for reading the configuration file.
13:
14: */
15:
1.10 ! markus 16: /* RCSID("$Id: readconf.h,v 1.9 1999/11/14 21:45:07 markus Exp $"); */
1.1 deraadt 17:
18: #ifndef READCONF_H
19: #define READCONF_H
20:
21: /* Data structure for representing a forwarding request. */
22:
23: typedef struct
24: {
25: int port; /* Port to forward. */
26: char *host; /* Host to connect. */
27: int host_port; /* Port to connect on host. */
28: } Forward;
29:
30: /* Data structure for representing option data. */
31:
32: typedef struct
33: {
34: int forward_agent; /* Forward authentication agent. */
35: int forward_x11; /* Forward X11 display. */
1.2 deraadt 36: int gateway_ports; /* Allow remote connects to forwarded ports. */
1.7 markus 37: int use_privileged_port; /* Don't use privileged port if false. */
1.1 deraadt 38: int rhosts_authentication; /* Try rhosts authentication. */
39: int rhosts_rsa_authentication;/* Try rhosts with RSA authentication. */
40: int rsa_authentication; /* Try RSA authentication. */
1.10 ! markus 41: int skey_authentication; /* Try S/Key or TIS authentication. */
1.1 deraadt 42: #ifdef KRB4
43: int kerberos_authentication; /* Try Kerberos authentication. */
44: #endif
1.3 dugsong 45: #ifdef AFS
1.1 deraadt 46: int kerberos_tgt_passing; /* Try Kerberos tgt passing. */
47: int afs_token_passing; /* Try AFS token passing. */
48: #endif
49: int password_authentication; /* Try password authentication. */
50: int fallback_to_rsh; /* Use rsh if cannot connect with ssh. */
51: int use_rsh; /* Always use rsh (don\'t try ssh). */
52: int batch_mode; /* Batch mode: do not ask for passwords. */
1.5 provos 53: int check_host_ip; /* Also keep track of keys for IP address */
1.1 deraadt 54: int strict_host_key_checking; /* Strict host key checking. */
55: int compression; /* Compress packets in both directions. */
56: int compression_level; /* Compression level 1 (fast) to 9 (best). */
57: int keepalives; /* Set SO_KEEPALIVE. */
1.8 markus 58: LogLevel log_level; /* Level for logging. */
1.1 deraadt 59:
60: int port; /* Port to connect. */
61: int connection_attempts; /* Max attempts (seconds) before giving up */
1.6 dugsong 62: int number_of_password_prompts; /* Max number of password prompts. */
1.1 deraadt 63: int cipher; /* Cipher to use. */
64: char *hostname; /* Real host to connect. */
65: char *proxy_command; /* Proxy command for connecting the host. */
66: char *user; /* User to log in as. */
67: int escape_char; /* Escape character; -2 = none */
68:
69: char *system_hostfile; /* Path for /etc/ssh_known_hosts. */
70: char *user_hostfile; /* Path for $HOME/.ssh/known_hosts. */
71:
72: int num_identity_files; /* Number of files for RSA identities. */
73: char *identity_files[SSH_MAX_IDENTITY_FILES];
74:
75: /* Local TCP/IP forward requests. */
76: int num_local_forwards;
77: Forward local_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
78:
79: /* Remote TCP/IP forward requests. */
80: int num_remote_forwards;
81: Forward remote_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
82: } Options;
83:
84:
85: /* Initializes options to special values that indicate that they have not
86: yet been set. Read_config_file will only set options with this value.
87: Options are processed in the following order: command line, user config
88: file, system config file. Last, fill_default_options is called. */
89: void initialize_options(Options *options);
90:
91: /* Called after processing other sources of option data, this fills those
92: options for which no value has been specified with their default values. */
93: void fill_default_options(Options *options);
94:
95: /* Processes a single option line as used in the configuration files.
1.9 markus 96: This only sets those values that have not already been set.
97: Returns 0 for legal options */
98: int process_config_line(Options *options, const char *host,
1.1 deraadt 99: char *line, const char *filename, int linenum,
100: int *activep);
101:
102: /* Reads the config file and modifies the options accordingly. Options should
103: already be initialized before this call. This never returns if there
104: is an error. If the file does not exist, this returns immediately. */
105: void read_config_file(const char *filename, const char *host,
106: Options *options);
107:
108: /* Adds a local TCP/IP port forward to options. Never returns if there
109: is an error. */
110: void add_local_forward(Options *options, int port, const char *host,
111: int host_port);
112:
113: /* Adds a remote TCP/IP port forward to options. Never returns if there
114: is an error. */
115: void add_remote_forward(Options *options, int port, const char *host,
116: int host_port);
117:
118:
119: #endif /* READCONF_H */