crypto/openssh/readconf.h

   1 /* $OpenBSD: readconf.h,v 1.95 2013/05/16 04:27:50 djm 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 /* Data structure for representing a forwarding request. */
  21
  22 typedef struct {
  23         char     *listen_host;          /* Host (address) to listen on. */
  24         int       listen_port;          /* Port to forward. */
  25         char     *connect_host;         /* Host to connect. */
  26         int       connect_port;         /* Port to connect on connect_host. */
  27         int       allocated_port;       /* Dynamically allocated listen port */
  28         int       handle;               /* Handle for dynamic listen ports */
  29 }       Forward;
  30 /* Data structure for representing option data. */
  31
  32 #define MAX_SEND_ENV            256
  33 #define SSH_MAX_HOSTS_FILES     256
  34
  35 typedef struct {
  36         int     forward_agent;  /* Forward authentication agent. */
  37         int     forward_x11;    /* Forward X11 display. */
  38         int     forward_x11_timeout;    /* Expiration for Cookies */
  39         int     forward_x11_trusted;    /* Trust Forward X11 display. */
  40         int     exit_on_forward_failure;        /* Exit if bind(2) fails for -L/-R */
  41         char   *xauth_location; /* Location for xauth program */
  42         int     gateway_ports;  /* Allow remote connects to forwarded ports. */
  43         int     use_privileged_port;    /* Don't use privileged port if false. */
  44         int     rhosts_rsa_authentication;      /* Try rhosts with RSA
  45                                                  * authentication. */
  46         int     rsa_authentication;     /* Try RSA authentication. */
  47         int     pubkey_authentication;  /* Try ssh2 pubkey authentication. */
  48         int     hostbased_authentication;       /* ssh2's rhosts_rsa */
  49         int     challenge_response_authentication;
  50                                         /* Try S/Key or TIS, authentication. */
  51         int     gss_authentication;     /* Try GSS authentication */
  52         int     gss_deleg_creds;        /* Delegate GSS credentials */
  53         int     password_authentication;        /* Try password
  54                                                  * authentication. */
  55         int     kbd_interactive_authentication; /* Try keyboard-interactive auth. */
  56         char    *kbd_interactive_devices; /* Keyboard-interactive auth devices. */
  57         int     zero_knowledge_password_authentication; /* Try jpake */
  58         int     batch_mode;     /* Batch mode: do not ask for passwords. */
  59         int     check_host_ip;  /* Also keep track of keys for IP address */
  60         int     strict_host_key_checking;       /* Strict host key checking. */
  61         int     compression;    /* Compress packets in both directions. */
  62         int     compression_level;      /* Compression level 1 (fast) to 9
  63                                          * (best). */
  64         int     tcp_keep_alive; /* Set SO_KEEPALIVE. */
  65         int     ip_qos_interactive;     /* IP ToS/DSCP/class for interactive */
  66         int     ip_qos_bulk;            /* IP ToS/DSCP/class for bulk traffic */
  67         LogLevel log_level;     /* Level for logging. */
  68
  69         int     port;           /* Port to connect. */
  70         int     address_family;
  71         int     connection_attempts;    /* Max attempts (seconds) before
  72                                          * giving up */
  73         int     connection_timeout;     /* Max time (seconds) before
  74                                          * aborting connection attempt */
  75         int     number_of_password_prompts;     /* Max number of password
  76                                                  * prompts. */
  77         int     cipher;         /* Cipher to use. */
  78         char   *ciphers;        /* SSH2 ciphers in order of preference. */
  79         char   *macs;           /* SSH2 macs in order of preference. */
  80         char   *hostkeyalgorithms;      /* SSH2 server key types in order of preference. */
  81         char   *kex_algorithms; /* SSH2 kex methods in order of preference. */
  82         int     protocol;       /* Protocol in order of preference. */
  83         char   *hostname;       /* Real host to connect. */
  84         char   *host_key_alias; /* hostname alias for .ssh/known_hosts */
  85         char   *proxy_command;  /* Proxy command for connecting the host. */
  86         char   *user;           /* User to log in as. */
  87         int     escape_char;    /* Escape character; -2 = none */
  88
  89         u_int   num_system_hostfiles;   /* Paths for /etc/ssh/ssh_known_hosts */
  90         char   *system_hostfiles[SSH_MAX_HOSTS_FILES];
  91         u_int   num_user_hostfiles;     /* Path for $HOME/.ssh/known_hosts */
  92         char   *user_hostfiles[SSH_MAX_HOSTS_FILES];
  93         char   *preferred_authentications;
  94         char   *bind_address;   /* local socket address for connection to sshd */
  95         char   *pkcs11_provider; /* PKCS#11 provider */
  96         int     verify_host_key_dns;    /* Verify host key using DNS */
  97
  98         int     num_identity_files;     /* Number of files for RSA/DSA identities. */
  99         char   *identity_files[SSH_MAX_IDENTITY_FILES];
 100         int    identity_file_userprovided[SSH_MAX_IDENTITY_FILES];
 101         Key    *identity_keys[SSH_MAX_IDENTITY_FILES];
 102
 103         /* Local TCP/IP forward requests. */
 104         int     num_local_forwards;
 105         Forward *local_forwards;
 106
 107         /* Remote TCP/IP forward requests. */
 108         int     num_remote_forwards;
 109         Forward *remote_forwards;
 110         int     clear_forwardings;
 111
 112         int     enable_ssh_keysign;
 113         int64_t rekey_limit;
 114         int     rekey_interval;
 115         int     no_host_authentication_for_localhost;
 116         int     identities_only;
 117         int     server_alive_interval;
 118         int     server_alive_count_max;
 119
 120         int     num_send_env;
 121         char   *send_env[MAX_SEND_ENV];
 122
 123         char    *control_path;
 124         int     control_master;
 125         int     control_persist; /* ControlPersist flag */
 126         int     control_persist_timeout; /* ControlPersist timeout (seconds) */
 127
 128         int     hash_known_hosts;
 129
 130         int     tun_open;       /* tun(4) */
 131         int     tun_local;      /* force tun device (optional) */
 132         int     tun_remote;     /* force tun device (optional) */
 133
 134         char    *local_command;
 135         int     permit_local_command;
 136         int     visual_host_key;
 137
 138         int     use_roaming;
 139
 140         int     request_tty;
 141
 142         char    *ignored_unknown; /* Pattern list of unknown tokens to ignore */
 143
 144         char   *version_addendum;       /* Appended to SSH banner */
 145
 146         int     hpn_disabled;   /* Switch to disable HPN buffer management. */
 147         int     hpn_buffer_size;        /* User definable size for HPN buffer
 148                                          * window. */
 149         int     tcp_rcv_buf_poll;       /* Option to poll recv buf every window
 150                                          * transfer. */
 151         int     tcp_rcv_buf;    /* User switch to set tcp recv buffer. */
 152
 153 #ifdef  NONE_CIPHER_ENABLED
 154         int     none_enabled;   /* Allow none to be used */
 155         int     none_switch;    /* Use none cipher */
 156 #endif
 157 }       Options;
 158
 159 #define SSHCTL_MASTER_NO        0
 160 #define SSHCTL_MASTER_YES       1
 161 #define SSHCTL_MASTER_AUTO      2
 162 #define SSHCTL_MASTER_ASK       3
 163 #define SSHCTL_MASTER_AUTO_ASK  4
 164
 165 #define REQUEST_TTY_AUTO        0
 166 #define REQUEST_TTY_NO          1
 167 #define REQUEST_TTY_YES         2
 168 #define REQUEST_TTY_FORCE       3
 169
 170 #define SSHCONF_CHECKPERM       1  /* check permissions on config file */
 171 #define SSHCONF_USERCONF        2  /* user provided config file not system */
 172
 173 void     initialize_options(Options *);
 174 void     fill_default_options(Options *);
 175 int      read_config_file(const char *, const char *, Options *, int);
 176 int      parse_forward(Forward *, const char *, int, int);
 177
 178 int
 179 process_config_line(Options *, const char *, char *, const char *, int, int *,
 180     int);
 181
 182 void     add_local_forward(Options *, const Forward *);
 183 void     add_remote_forward(Options *, const Forward *);
 184 void     add_identity_file(Options *, const char *, const char *, int);
 185
 186 #endif                          /* READCONF_H */