Annotation of src/usr.bin/ssh/readconf.h, Revision 1.16
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.16 ! markus 16: /* RCSID("$Id: readconf.h,v 1.15 2000/04/14 10:30:32 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. */
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. */
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. */
53: int check_host_ip; /* Also keep track of keys for IP address */
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
57: * (best). */
58: int keepalives; /* Set SO_KEEPALIVE. */
59: LogLevel log_level; /* Level for logging. */
60:
61: int port; /* Port to connect. */
62: int connection_attempts; /* Max attempts (seconds) before
63: * giving up */
64: int number_of_password_prompts; /* Max number of password
65: * prompts. */
66: int cipher; /* Cipher to use. */
1.14 markus 67: char *ciphers; /* Ciphers in order of preference. */
68: int protocol; /* Protocol in order of preference. */
1.11 deraadt 69: char *hostname; /* Real host to connect. */
70: char *proxy_command; /* Proxy command for connecting the host. */
71: char *user; /* User to log in as. */
72: int escape_char; /* Escape character; -2 = none */
73:
74: char *system_hostfile;/* Path for /etc/ssh_known_hosts. */
75: char *user_hostfile; /* Path for $HOME/.ssh/known_hosts. */
1.16 ! markus 76: char *system_hostfile2;
! 77: char *user_hostfile2;
1.11 deraadt 78:
79: int num_identity_files; /* Number of files for RSA identities. */
1.16 ! markus 80: int num_identity_files2; /* DSA identities. */
1.11 deraadt 81: char *identity_files[SSH_MAX_IDENTITY_FILES];
1.16 ! markus 82: char *identity_files2[SSH_MAX_IDENTITY_FILES];
1.11 deraadt 83:
84: /* Local TCP/IP forward requests. */
85: int num_local_forwards;
86: Forward local_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
87:
88: /* Remote TCP/IP forward requests. */
89: int num_remote_forwards;
90: Forward remote_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
91: } Options;
1.1 deraadt 92:
93:
1.12 markus 94: /*
95: * Initializes options to special values that indicate that they have not yet
96: * been set. Read_config_file will only set options with this value. Options
97: * are processed in the following order: command line, user config file,
98: * system config file. Last, fill_default_options is called.
99: */
1.11 deraadt 100: void initialize_options(Options * options);
1.1 deraadt 101:
1.12 markus 102: /*
103: * Called after processing other sources of option data, this fills those
104: * options for which no value has been specified with their default values.
105: */
1.11 deraadt 106: void fill_default_options(Options * options);
1.1 deraadt 107:
1.12 markus 108: /*
109: * Processes a single option line as used in the configuration files. This
110: * only sets those values that have not already been set. Returns 0 for legal
111: * options
112: */
1.15 markus 113: int
1.11 deraadt 114: process_config_line(Options * options, const char *host,
115: char *line, const char *filename, int linenum,
116: int *activep);
1.1 deraadt 117:
1.12 markus 118: /*
119: * Reads the config file and modifies the options accordingly. Options
120: * should already be initialized before this call. This never returns if
121: * there is an error. If the file does not exist, this returns immediately.
122: */
1.15 markus 123: void
1.11 deraadt 124: read_config_file(const char *filename, const char *host,
125: Options * options);
1.1 deraadt 126:
1.12 markus 127: /*
128: * Adds a local TCP/IP port forward to options. Never returns if there is an
129: * error.
130: */
1.15 markus 131: void
1.13 markus 132: add_local_forward(Options * options, u_short port, const char *host,
133: u_short host_port);
1.1 deraadt 134:
1.12 markus 135: /*
136: * Adds a remote TCP/IP port forward to options. Never returns if there is
137: * an error.
138: */
1.15 markus 139: void
1.13 markus 140: add_remote_forward(Options * options, u_short port, const char *host,
141: u_short host_port);
1.1 deraadt 142:
1.11 deraadt 143: #endif /* READCONF_H */