readconf.h revision cd7d5faf5bbb52336a6f85578a90b31a648ac3fa
/*
* Author: Tatu Ylonen <ylo@cs.hut.fi>
* Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
* All rights reserved
* Functions for reading the configuration file.
*
* As far as I am concerned, the code I have written for this software
* can be used freely for any purpose. Any derived versions of this
* software must be clearly marked as such, and if the derived work is
* incompatible with the protocol description in the RFC file, it must be
* called by a name other than "ssh" or "Secure Shell".
*/
/*
* Copyright 2008 Sun Microsystems, Inc. All rights reserved.
* Use is subject to license terms.
*/
#ifndef _READCONF_H
#define _READCONF_H
/* $OpenBSD: readconf.h,v 1.43 2002/06/08 05:17:01 markus Exp $ */
#ifdef __cplusplus
extern "C" {
#endif
#include "key.h"
/*
* We accept only fixed amount of unknown options. Note that we must treat all
* options in different Host sections separately since we need to remember the
* line number. See IgnoreIfUnknown for more information.
*/
#define MAX_UNKNOWN_OPTIONS 64
/* Data structure for representing a forwarding request. */
typedef struct {
char *listen_host; /* Host (address) to listen on. */
char *connect_host; /* Host to connect. */
} Forward;
/* Data structure for representing option data. */
/* For postponed processing of option keywords. */
typedef struct {
char *keyword; /* option keyword name */
char *filename; /* config file it was found in */
int linenum; /* line number in the config file */
} StoredOption;
typedef struct {
int forward_agent; /* Forward authentication agent. */
int forward_x11; /* Forward X11 display. */
int forward_x11_trusted; /* Trust Forward X11 display. */
char *xauth_location; /* Location for xauth program */
int gateway_ports; /* Allow remote connects to forwarded ports. */
int use_privileged_port; /* Don't use privileged port if false. */
int rhosts_authentication; /* Try rhosts authentication. */
int rhosts_rsa_authentication; /* Try rhosts with RSA
* authentication. */
int rsa_authentication; /* Try RSA authentication. */
int pubkey_authentication; /* Try ssh2 pubkey authentication. */
int hostbased_authentication; /* ssh2's rhosts_rsa */
int fallback_to_rsh; /* Use rsh if cannot connect with ssh. */
int use_rsh; /* Always use rsh(don\'t try ssh). */
int kerberos_authentication; /* Try Kerberos authentication. */
#endif
int kerberos_tgt_passing; /* Try Kerberos TGT passing. */
#endif
#ifdef GSSAPI
int gss_keyex;
int gss_authentication;
int gss_deleg_creds;
#ifdef GSI
#endif /* GSI */
#endif /* GSSAPI */
#ifdef AFS
int afs_token_passing; /* Try AFS token passing. */
#endif
int password_authentication; /* Try password
* authentication. */
int kbd_interactive_authentication; /* Try keyboard-interactive auth. */
char *kbd_interactive_devices; /* Keyboard-interactive auth devices. */
int batch_mode; /* Batch mode: do not ask for passwords. */
int check_host_ip; /* Also keep track of keys for IP address */
int strict_host_key_checking; /* Strict host key checking. */
int compression; /* Compress packets in both directions. */
int compression_level; /* Compression level 1 (fast) to 9
* (best). */
int keepalives; /* Set SO_KEEPALIVE. */
int port; /* Port to connect. */
int connection_attempts; /* Max attempts (seconds) before
* giving up */
int connection_timeout; /* Max time (seconds) before
* aborting connection attempt */
int number_of_password_prompts; /* Max number of password
* prompts. */
int cipher; /* Cipher to use. */
char *ciphers; /* SSH2 ciphers in order of preference. */
char *macs; /* SSH2 macs in order of preference. */
char *hostkeyalgorithms; /* SSH2 server key types in order of preference. */
int protocol; /* Protocol in order of preference. */
char *hostname; /* Real host to connect. */
char *host_key_alias; /* hostname alias for .ssh/known_hosts */
char *proxy_command; /* Proxy command for connecting the host. */
char *user; /* User to log in as. */
int escape_char; /* Escape character; -2 = none */
char *system_hostfile;/* Path for /etc/ssh/ssh_known_hosts. */
char *user_hostfile; /* Path for $HOME/.ssh/known_hosts. */
char *system_hostfile2;
char *user_hostfile2;
char *preferred_authentications;
char *bind_address; /* local socket address for connection to sshd */
char *smartcard_device; /* Smartcard reader device */
int disable_banner; /* Disable display of banner */
/*
* Unknown options listed in IgnoreIfUnknown will not cause ssh to
* exit. So, we must store all unknown options here and can't process
* them before the command line options and all config files are read
* and IgnoreIfUnknown is properly set.
*/
char *ignore_if_unknown;
int unknown_opts_num;
int num_identity_files; /* Number of files for RSA/DSA identities. */
char *identity_files[SSH_MAX_IDENTITY_FILES];
int num_local_forwards;
int num_remote_forwards;
int clear_forwardings;
int hash_known_hosts;
int use_openssl_engine;
} Options;
void initialize_options(Options *);
void fill_default_options(Options *);
int read_config_file(const char *, const char *, Options *);
int parse_forward(int, Forward *, const char *);
int
process_config_line(Options *, const char *, char *, const char *, int, int *);
void process_unknown_options(Options *);
#ifdef __cplusplus
}
#endif
#endif /* _READCONF_H */