Annotation of src/usr.bin/ssh/readconf.h, Revision 1.17
1.1 deraadt 1: /*
1.15 markus 2: *
1.11 deraadt 3: * readconf.h
1.15 markus 4: *
1.11 deraadt 5: * Author: Tatu Ylonen <ylo@cs.hut.fi>
1.15 markus 6: *
1.11 deraadt 7: * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
8: * All rights reserved
1.15 markus 9: *
1.11 deraadt 10: * Created: Sat Apr 22 00:25:29 1995 ylo
1.15 markus 11: *
1.11 deraadt 12: * Functions for reading the configuration file.
1.15 markus 13: *
1.11 deraadt 14: */
1.1 deraadt 15:
1.17 ! markus 16: /* RCSID("$Id: readconf.h,v 1.16 2000/04/26 20:56:29 markus Exp $"); */
1.1 deraadt 17:
18: #ifndef READCONF_H
19: #define READCONF_H
20:
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. */
33: int gateway_ports; /* Allow remote connects to forwarded ports. */
34: int use_privileged_port; /* Don't use privileged port if false. */
35: int rhosts_authentication; /* Try rhosts authentication. */
36: int rhosts_rsa_authentication; /* Try rhosts with RSA
37: * authentication. */
38: int rsa_authentication; /* Try RSA authentication. */
1.17 ! markus 39: int dsa_authentication; /* Try DSA authentication. */
1.11 deraadt 40: int skey_authentication; /* Try S/Key or TIS authentication. */
1.1 deraadt 41: #ifdef KRB4
1.11 deraadt 42: int kerberos_authentication; /* Try Kerberos
43: * authentication. */
1.1 deraadt 44: #endif
1.3 dugsong 45: #ifdef AFS
1.11 deraadt 46: int kerberos_tgt_passing; /* Try Kerberos tgt passing. */
47: int afs_token_passing; /* Try AFS token passing. */
1.1 deraadt 48: #endif
1.11 deraadt 49: int password_authentication; /* Try password
50: * authentication. */
51: int fallback_to_rsh;/* Use rsh if cannot connect with ssh. */
52: int use_rsh; /* Always use rsh (don\'t try ssh). */
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). */
59: int keepalives; /* Set SO_KEEPALIVE. */
60: LogLevel log_level; /* Level for logging. */
61:
62: int port; /* Port to connect. */
63: int connection_attempts; /* Max attempts (seconds) before
64: * giving up */
65: int number_of_password_prompts; /* Max number of password
66: * prompts. */
67: int cipher; /* Cipher to use. */
1.14 markus 68: char *ciphers; /* Ciphers in order of preference. */
69: int protocol; /* Protocol in order of preference. */
1.11 deraadt 70: char *hostname; /* Real host to connect. */
71: char *proxy_command; /* Proxy command for connecting the host. */
72: char *user; /* User to log in as. */
73: int escape_char; /* Escape character; -2 = none */
74:
75: char *system_hostfile;/* Path for /etc/ssh_known_hosts. */
76: char *user_hostfile; /* Path for $HOME/.ssh/known_hosts. */
1.16 markus 77: char *system_hostfile2;
78: char *user_hostfile2;
1.11 deraadt 79:
80: int num_identity_files; /* Number of files for RSA identities. */
1.16 markus 81: int num_identity_files2; /* DSA identities. */
1.11 deraadt 82: char *identity_files[SSH_MAX_IDENTITY_FILES];
1.16 markus 83: char *identity_files2[SSH_MAX_IDENTITY_FILES];
1.11 deraadt 84:
85: /* Local TCP/IP forward requests. */
86: int num_local_forwards;
87: Forward local_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
88:
89: /* Remote TCP/IP forward requests. */
90: int num_remote_forwards;
91: Forward remote_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
92: } Options;
1.1 deraadt 93:
94:
1.12 markus 95: /*
96: * Initializes options to special values that indicate that they have not yet
97: * been set. Read_config_file will only set options with this value. Options
98: * are processed in the following order: command line, user config file,
99: * system config file. Last, fill_default_options is called.
100: */
1.11 deraadt 101: void initialize_options(Options * options);
1.1 deraadt 102:
1.12 markus 103: /*
104: * Called after processing other sources of option data, this fills those
105: * options for which no value has been specified with their default values.
106: */
1.11 deraadt 107: void fill_default_options(Options * options);
1.1 deraadt 108:
1.12 markus 109: /*
110: * Processes a single option line as used in the configuration files. This
111: * only sets those values that have not already been set. Returns 0 for legal
112: * options
113: */
1.15 markus 114: int
1.11 deraadt 115: process_config_line(Options * options, const char *host,
116: char *line, const char *filename, int linenum,
117: int *activep);
1.1 deraadt 118:
1.12 markus 119: /*
120: * Reads the config file and modifies the options accordingly. Options
121: * should already be initialized before this call. This never returns if
122: * there is an error. If the file does not exist, this returns immediately.
123: */
1.15 markus 124: void
1.11 deraadt 125: read_config_file(const char *filename, const char *host,
126: Options * options);
1.1 deraadt 127:
1.12 markus 128: /*
129: * Adds a local TCP/IP port forward to options. Never returns if there is an
130: * error.
131: */
1.15 markus 132: void
1.13 markus 133: add_local_forward(Options * options, u_short port, const char *host,
134: u_short host_port);
1.1 deraadt 135:
1.12 markus 136: /*
137: * Adds a remote TCP/IP port forward to options. Never returns if there is
138: * an error.
139: */
1.15 markus 140: void
1.13 markus 141: add_remote_forward(Options * options, u_short port, const char *host,
142: u_short host_port);
1.1 deraadt 143:
1.11 deraadt 144: #endif /* READCONF_H */