readconf.h

   1 /*
   2  * Author: Tatu Ylonen <ylo@cs.hut.fi>
   3  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
   4  *                    All rights reserved
   5  * Functions for reading the configuration file.
   6  *
   7  * As far as I am concerned, the code I have written for this software
   8  * can be used freely for any purpose.  Any derived versions of this
   9  * software must be clearly marked as such, and if the derived work is
  10  * incompatible with the protocol description in the RFC file, it must be
  11  * called by a name other than "ssh" or "Secure Shell".
  12  */
  13
  14 /* RCSID("$OpenBSD: readconf.h,v 1.25 2001/01/22 23:06:39 markus Exp $"); */
  15
  16 #ifndef READCONF_H
  17 #define READCONF_H
  18
  19 /* Data structure for representing a forwarding request. */
  20
  21 typedef struct {
  22         u_short   port;         /* Port to forward. */
  23         char     *host;         /* Host to connect. */
  24         u_short   host_port;    /* Port to connect on host. */
  25 }       Forward;
  26 /* Data structure for representing option data. */
  27
  28 typedef struct {
  29         int     forward_agent;  /* Forward authentication agent. */
  30         int     forward_x11;    /* Forward X11 display. */
  31         char   *xauth_location; /* Location for xauth program */
  32         int     gateway_ports;  /* Allow remote connects to forwarded ports. */
  33         int     use_privileged_port;    /* Don't use privileged port if false. */
  34         int     rhosts_authentication;  /* Try rhosts authentication. */
  35         int     rhosts_rsa_authentication;      /* Try rhosts with RSA
  36                                                  * authentication. */
  37         int     rsa_authentication;     /* Try RSA authentication. */
  38         int     pubkey_authentication;  /* Try ssh2 pubkey authentication. */
  39         int     challenge_reponse_authentication;
  40                                         /* Try S/Key or TIS, authentication. */
  41 #ifdef KRB4
  42         int     kerberos_authentication;        /* Try Kerberos
  43                                                  * authentication. */
  44 #endif
  45 #ifdef AFS
  46         int     kerberos_tgt_passing;   /* Try Kerberos tgt passing. */
  47         int     afs_token_passing;      /* Try AFS token passing. */
  48 #endif
  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     fallback_to_rsh;/* Use rsh if cannot connect with ssh. */
  54         int     use_rsh;        /* Always use rsh (don\'t try ssh). */
  55         int     batch_mode;     /* Batch mode: do not ask for passwords. */
  56         int     check_host_ip;  /* Also keep track of keys for IP address */
  57         int     strict_host_key_checking;       /* Strict host key checking. */
  58         int     compression;    /* Compress packets in both directions. */
  59         int     compression_level;      /* Compression level 1 (fast) to 9
  60                                          * (best). */
  61         int     keepalives;     /* Set SO_KEEPALIVE. */
  62         LogLevel log_level;     /* Level for logging. */
  63
  64         int     port;           /* Port to connect. */
  65         int     connection_attempts;    /* Max attempts (seconds) before
  66                                          * giving up */
  67         int     number_of_password_prompts;     /* Max number of password
  68                                                  * prompts. */
  69         int     cipher;         /* Cipher to use. */
  70         char   *ciphers;        /* SSH2 ciphers in order of preference. */
  71         int     protocol;       /* Protocol in order of preference. */
  72         char   *hostname;       /* Real host to connect. */
  73         char   *host_key_alias; /* hostname alias for .ssh/known_hosts */
  74         char   *proxy_command;  /* Proxy command for connecting the host. */
  75         char   *user;           /* User to log in as. */
  76         int     escape_char;    /* Escape character; -2 = none */
  77
  78         char   *system_hostfile;/* Path for /etc/ssh_known_hosts. */
  79         char   *user_hostfile;  /* Path for $HOME/.ssh/known_hosts. */
  80         char   *system_hostfile2;
  81         char   *user_hostfile2;
  82
  83         int     num_identity_files;     /* Number of files for RSA/DSA identities. */
  84         char   *identity_files[SSH_MAX_IDENTITY_FILES];
  85         int     identity_files_type[SSH_MAX_IDENTITY_FILES];
  86
  87         /* Local TCP/IP forward requests. */
  88         int     num_local_forwards;
  89         Forward local_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
  90
  91         /* Remote TCP/IP forward requests. */
  92         int     num_remote_forwards;
  93         Forward remote_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
  94 }       Options;
  95
  96
  97 /*
  98  * Initializes options to special values that indicate that they have not yet
  99  * been set.  Read_config_file will only set options with this value. Options
 100  * are processed in the following order: command line, user config file,
 101  * system config file.  Last, fill_default_options is called.
 102  */
 103 void    initialize_options(Options * options);
 104
 105 /*
 106  * Called after processing other sources of option data, this fills those
 107  * options for which no value has been specified with their default values.
 108  */
 109 void    fill_default_options(Options * options);
 110
 111 /*
 112  * Processes a single option line as used in the configuration files. This
 113  * only sets those values that have not already been set. Returns 0 for legal
 114  * options
 115  */
 116 int
 117 process_config_line(Options * options, const char *host,
 118     char *line, const char *filename, int linenum,
 119     int *activep);
 120
 121 /*
 122  * Reads the config file and modifies the options accordingly.  Options
 123  * should already be initialized before this call.  This never returns if
 124  * there is an error.  If the file does not exist, this returns immediately.
 125  */
 126 void
 127 read_config_file(const char *filename, const char *host,
 128     Options * options);
 129
 130 /*
 131  * Adds a local TCP/IP port forward to options.  Never returns if there is an
 132  * error.
 133  */
 134 void
 135 add_local_forward(Options * options, u_short port, const char *host,
 136     u_short host_port);
 137
 138 /*
 139  * Adds a remote TCP/IP port forward to options.  Never returns if there is
 140  * an error.
 141  */
 142 void
 143 add_remote_forward(Options * options, u_short port, const char *host,
 144     u_short host_port);
 145
 146 #endif                          /* READCONF_H */