xref: /freebsd/crypto/openssh/readconf.h (revision ee2ea5ceafed78a5bd9810beb9e3ca927180c226)
1 /*	$OpenBSD: readconf.h,v 1.42 2002/03/04 17:27:39 stevesk Exp $	*/
2 /*	$FreeBSD$	*/
3 
4 /*
5  * Author: Tatu Ylonen <ylo@cs.hut.fi>
6  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
7  *                    All rights reserved
8  * Functions for reading the configuration file.
9  *
10  * As far as I am concerned, the code I have written for this software
11  * can be used freely for any purpose.  Any derived versions of this
12  * software must be clearly marked as such, and if the derived work is
13  * incompatible with the protocol description in the RFC file, it must be
14  * called by a name other than "ssh" or "Secure Shell".
15  */
16 
17 #ifndef READCONF_H
18 #define READCONF_H
19 
20 #include "key.h"
21 
22 /* Data structure for representing a forwarding request. */
23 
24 typedef struct {
25 	u_short	  port;		/* Port to forward. */
26 	char	 *host;		/* Host to connect. */
27 	u_short	  host_port;	/* Port to connect on host. */
28 }       Forward;
29 /* Data structure for representing option data. */
30 
31 typedef struct {
32 	int     forward_agent;	/* Forward authentication agent. */
33 	int     forward_x11;	/* Forward X11 display. */
34 	char   *xauth_location;	/* Location for xauth program */
35 	int     gateway_ports;	/* Allow remote connects to forwarded ports. */
36 	int     use_privileged_port;	/* Don't use privileged port if false. */
37 	int     rhosts_authentication;	/* Try rhosts authentication. */
38 	int     rhosts_rsa_authentication;	/* Try rhosts with RSA
39 						 * authentication. */
40 	int     rsa_authentication;	/* Try RSA authentication. */
41 	int     pubkey_authentication;	/* Try ssh2 pubkey authentication. */
42 	int     hostbased_authentication;	/* ssh2's rhosts_rsa */
43 	int     challenge_response_authentication;
44 					/* Try S/Key or TIS, authentication. */
45 #if defined(KRB4) || defined(KRB5)
46 	int     kerberos_authentication;	/* Try Kerberos authentication. */
47 #endif
48 #if defined(AFS) || defined(KRB5)
49 	int     kerberos_tgt_passing;	/* Try Kerberos TGT passing. */
50 #endif
51 #ifdef AFS
52 	int     afs_token_passing;	/* Try AFS token passing. */
53 #endif
54 	int     password_authentication;	/* Try password
55 						 * authentication. */
56 	int     kbd_interactive_authentication; /* Try keyboard-interactive auth. */
57 	char	*kbd_interactive_devices; /* Keyboard-interactive auth devices. */
58 	int     fallback_to_rsh;/* Use rsh if cannot connect with ssh. */
59 	int     use_rsh;	/* Always use rsh (don\'t try ssh). */
60 	int     batch_mode;	/* Batch mode: do not ask for passwords. */
61 	int     check_host_ip;	/* Also keep track of keys for IP address */
62 	int     strict_host_key_checking;	/* Strict host key checking. */
63 	int     compression;	/* Compress packets in both directions. */
64 	int     compression_level;	/* Compression level 1 (fast) to 9
65 					 * (best). */
66 	int     keepalives;	/* Set SO_KEEPALIVE. */
67 	LogLevel log_level;	/* Level for logging. */
68 
69 	int     port;		/* Port to connect. */
70 	int     connection_attempts;	/* Max attempts (seconds) before
71 					 * giving up */
72 	int     number_of_password_prompts;	/* Max number of password
73 						 * prompts. */
74 	int     cipher;		/* Cipher to use. */
75 	char   *ciphers;	/* SSH2 ciphers in order of preference. */
76 	char   *macs;		/* SSH2 macs in order of preference. */
77 	char   *hostkeyalgorithms;	/* SSH2 server key types in order of preference. */
78 	int	protocol;	/* Protocol in order of preference. */
79 	char   *hostname;	/* Real host to connect. */
80 	char   *host_key_alias;	/* hostname alias for .ssh/known_hosts */
81 	char   *proxy_command;	/* Proxy command for connecting the host. */
82 	char   *user;		/* User to log in as. */
83 	int     escape_char;	/* Escape character; -2 = none */
84 
85 	char   *system_hostfile;/* Path for /etc/ssh/ssh_known_hosts. */
86 	char   *user_hostfile;	/* Path for $HOME/.ssh/known_hosts. */
87 	char   *system_hostfile2;
88 	char   *user_hostfile2;
89 	char   *preferred_authentications;
90 	char   *bind_address;	/* local socket address for connection to sshd */
91 	char   *smartcard_device; /* Smartcard reader device */
92 
93 	int     num_identity_files;	/* Number of files for RSA/DSA identities. */
94 	char   *identity_files[SSH_MAX_IDENTITY_FILES];
95 	Key    *identity_keys[SSH_MAX_IDENTITY_FILES];
96 
97 	/* Local TCP/IP forward requests. */
98 	int     num_local_forwards;
99 	Forward local_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
100 
101 	/* Remote TCP/IP forward requests. */
102 	int     num_remote_forwards;
103 	Forward remote_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
104 	int	clear_forwardings;
105 	int	no_host_authentication_for_localhost;
106 }       Options;
107 
108 
109 void     initialize_options(Options *);
110 void     fill_default_options(Options *);
111 int	 read_config_file(const char *, const char *, Options *);
112 
113 int
114 process_config_line(Options *, const char *, char *, const char *, int, int *);
115 
116 void	 add_local_forward(Options *, u_short, const char *, u_short);
117 void	 add_remote_forward(Options *, u_short, const char *, u_short);
118 
119 #endif				/* READCONF_H */
120