readconf.h

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