Import OpenSSH-6.7p1.
[dragonfly.git] / crypto / openssh / readconf.h
1 /* $OpenBSD: readconf.h,v 1.102 2014/07/15 15:54:14 millert Exp $ */
2
3 /*
4  * Author: Tatu Ylonen <ylo@cs.hut.fi>
5  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
6  *                    All rights reserved
7  * Functions for reading the configuration file.
8  *
9  * As far as I am concerned, the code I have written for this software
10  * can be used freely for any purpose.  Any derived versions of this
11  * software must be clearly marked as such, and if the derived work is
12  * incompatible with the protocol description in the RFC file, it must be
13  * called by a name other than "ssh" or "Secure Shell".
14  */
15
16 #ifndef READCONF_H
17 #define READCONF_H
18
19 /* Data structure for representing option data. */
20
21 #define MAX_SEND_ENV            256
22 #define SSH_MAX_HOSTS_FILES     32
23 #define MAX_CANON_DOMAINS       32
24 #define PATH_MAX_SUN            (sizeof((struct sockaddr_un *)0)->sun_path)
25
26 struct allowed_cname {
27         char *source_list;
28         char *target_list;
29 };
30
31 typedef struct {
32         int     forward_agent;  /* Forward authentication agent. */
33         int     forward_x11;    /* Forward X11 display. */
34         int     forward_x11_timeout;    /* Expiration for Cookies */
35         int     forward_x11_trusted;    /* Trust Forward X11 display. */
36         int     exit_on_forward_failure;        /* Exit if bind(2) fails for -L/-R */
37         char   *xauth_location; /* Location for xauth program */
38         struct ForwardOptions fwd_opts; /* forwarding options */
39         int     use_privileged_port;    /* Don't use privileged port if false. */
40         int     rhosts_rsa_authentication;      /* Try rhosts with RSA
41                                                  * authentication. */
42         int     rsa_authentication;     /* Try RSA authentication. */
43         int     pubkey_authentication;  /* Try ssh2 pubkey authentication. */
44         int     hostbased_authentication;       /* ssh2's rhosts_rsa */
45         int     challenge_response_authentication;
46                                         /* Try S/Key or TIS, authentication. */
47         int     gss_authentication;     /* Try GSS authentication */
48         int     gss_deleg_creds;        /* Delegate GSS credentials */
49         int     password_authentication;        /* Try password
50                                                  * authentication. */
51         int     kbd_interactive_authentication; /* Try keyboard-interactive auth. */
52         char    *kbd_interactive_devices; /* Keyboard-interactive auth devices. */
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     tcp_keep_alive; /* Set SO_KEEPALIVE. */
60         int     ip_qos_interactive;     /* IP ToS/DSCP/class for interactive */
61         int     ip_qos_bulk;            /* IP ToS/DSCP/class for bulk traffic */
62         LogLevel log_level;     /* Level for logging. */
63
64         int     port;           /* Port to connect. */
65         int     address_family;
66         int     connection_attempts;    /* Max attempts (seconds) before
67                                          * giving up */
68         int     connection_timeout;     /* Max time (seconds) before
69                                          * aborting connection attempt */
70         int     number_of_password_prompts;     /* Max number of password
71                                                  * prompts. */
72         int     cipher;         /* Cipher to use. */
73         char   *ciphers;        /* SSH2 ciphers in order of preference. */
74         char   *macs;           /* SSH2 macs in order of preference. */
75         char   *hostkeyalgorithms;      /* SSH2 server key types in order of preference. */
76         char   *kex_algorithms; /* SSH2 kex methods in order of preference. */
77         int     protocol;       /* Protocol in order of preference. */
78         char   *hostname;       /* Real host to connect. */
79         char   *host_key_alias; /* hostname alias for .ssh/known_hosts */
80         char   *proxy_command;  /* Proxy command for connecting the host. */
81         char   *user;           /* User to log in as. */
82         int     escape_char;    /* Escape character; -2 = none */
83
84         u_int   num_system_hostfiles;   /* Paths for /etc/ssh/ssh_known_hosts */
85         char   *system_hostfiles[SSH_MAX_HOSTS_FILES];
86         u_int   num_user_hostfiles;     /* Path for $HOME/.ssh/known_hosts */
87         char   *user_hostfiles[SSH_MAX_HOSTS_FILES];
88         char   *preferred_authentications;
89         char   *bind_address;   /* local socket address for connection to sshd */
90         char   *pkcs11_provider; /* PKCS#11 provider */
91         int     verify_host_key_dns;    /* Verify host key using DNS */
92
93         int     num_identity_files;     /* Number of files for RSA/DSA identities. */
94         char   *identity_files[SSH_MAX_IDENTITY_FILES];
95         int    identity_file_userprovided[SSH_MAX_IDENTITY_FILES];
96         Key    *identity_keys[SSH_MAX_IDENTITY_FILES];
97
98         /* Local TCP/IP forward requests. */
99         int     num_local_forwards;
100         struct Forward *local_forwards;
101
102         /* Remote TCP/IP forward requests. */
103         int     num_remote_forwards;
104         struct Forward *remote_forwards;
105         int     clear_forwardings;
106
107         int     enable_ssh_keysign;
108         int64_t rekey_limit;
109         int     rekey_interval;
110         int     no_host_authentication_for_localhost;
111         int     identities_only;
112         int     server_alive_interval;
113         int     server_alive_count_max;
114
115         int     num_send_env;
116         char   *send_env[MAX_SEND_ENV];
117
118         char    *control_path;
119         int     control_master;
120         int     control_persist; /* ControlPersist flag */
121         int     control_persist_timeout; /* ControlPersist timeout (seconds) */
122
123         int     hash_known_hosts;
124
125         int     tun_open;       /* tun(4) */
126         int     tun_local;      /* force tun device (optional) */
127         int     tun_remote;     /* force tun device (optional) */
128
129         char    *local_command;
130         int     permit_local_command;
131         int     visual_host_key;
132
133         int     use_roaming;
134
135         int     request_tty;
136
137         int     proxy_use_fdpass;
138
139         int     num_canonical_domains;
140         char    *canonical_domains[MAX_CANON_DOMAINS];
141         int     canonicalize_hostname;
142         int     canonicalize_max_dots;
143         int     canonicalize_fallback_local;
144         int     num_permitted_cnames;
145         struct allowed_cname permitted_cnames[MAX_CANON_DOMAINS];
146
147         char    *ignored_unknown; /* Pattern list of unknown tokens to ignore */
148 }       Options;
149
150 #define SSH_CANONICALISE_NO     0
151 #define SSH_CANONICALISE_YES    1
152 #define SSH_CANONICALISE_ALWAYS 2
153
154 #define SSHCTL_MASTER_NO        0
155 #define SSHCTL_MASTER_YES       1
156 #define SSHCTL_MASTER_AUTO      2
157 #define SSHCTL_MASTER_ASK       3
158 #define SSHCTL_MASTER_AUTO_ASK  4
159
160 #define REQUEST_TTY_AUTO        0
161 #define REQUEST_TTY_NO          1
162 #define REQUEST_TTY_YES         2
163 #define REQUEST_TTY_FORCE       3
164
165 #define SSHCONF_CHECKPERM       1  /* check permissions on config file */
166 #define SSHCONF_USERCONF        2  /* user provided config file not system */
167
168 void     initialize_options(Options *);
169 void     fill_default_options(Options *);
170 void     fill_default_options_for_canonicalization(Options *);
171 int      process_config_line(Options *, struct passwd *, const char *, char *,
172     const char *, int, int *, int);
173 int      read_config_file(const char *, struct passwd *, const char *,
174     Options *, int);
175 int      parse_forward(struct Forward *, const char *, int, int);
176 int      default_ssh_port(void);
177 int      option_clear_or_none(const char *);
178
179 void     add_local_forward(Options *, const struct Forward *);
180 void     add_remote_forward(Options *, const struct Forward *);
181 void     add_identity_file(Options *, const char *, const char *, int);
182
183 #endif                          /* READCONF_H */