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.23 2000/11/12 19:50:37 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     skey_authentication;    /* Try S/Key or TIS authentication. */
  40 #ifdef KRB4
  41         int     kerberos_authentication;        /* Try Kerberos
  42                                                  * authentication. */
  43 #endif
  44 #ifdef AFS
  45         int     kerberos_tgt_passing;   /* Try Kerberos tgt passing. */
  46         int     afs_token_passing;      /* Try AFS token passing. */
  47 #endif
  48         int     password_authentication;        /* Try password
  49                                                  * authentication. */
  50         int     kbd_interactive_authentication; /* Try keyboard-interactive auth. */
  51         char    *kbd_interactive_devices; /* Keyboard-interactive auth devices. */
  52         int     fallback_to_rsh;/* Use rsh if cannot connect with ssh. */
  53         int     use_rsh;        /* Always use rsh (don\'t try ssh). */
  54         int     batch_mode;     /* Batch mode: do not ask for passwords. */
  55         int     check_host_ip;  /* Also keep track of keys for IP address */
  56         int     strict_host_key_checking;       /* Strict host key checking. */
  57         int     compression;    /* Compress packets in both directions. */
  58         int     compression_level;      /* Compression level 1 (fast) to 9
  59                                          * (best). */
  60         int     keepalives;     /* Set SO_KEEPALIVE. */
  61         LogLevel log_level;     /* Level for logging. */
  62
  63         int     port;           /* Port to connect. */
  64         int     connection_attempts;    /* Max attempts (seconds) before
  65                                          * giving up */
  66         int     number_of_password_prompts;     /* Max number of password
  67                                                  * prompts. */
  68         int     cipher;         /* Cipher to use. */
  69         char   *ciphers;        /* SSH2 ciphers in order of preference. */
  70         int     protocol;       /* Protocol in order of preference. */
  71         char   *hostname;       /* Real host to connect. */
  72         char   *proxy_command;  /* Proxy command for connecting the host. */
  73         char   *user;           /* User to log in as. */
  74         int     escape_char;    /* Escape character; -2 = none */
  75
  76         char   *system_hostfile;/* Path for /etc/ssh_known_hosts. */
  77         char   *user_hostfile;  /* Path for $HOME/.ssh/known_hosts. */
  78         char   *system_hostfile2;
  79         char   *user_hostfile2;
  80
  81         int     num_identity_files;     /* Number of files for RSA/DSA identities. */
  82         char   *identity_files[SSH_MAX_IDENTITY_FILES];
  83         int     identity_files_type[SSH_MAX_IDENTITY_FILES];
  84
  85         /* Local TCP/IP forward requests. */
  86         int     num_local_forwards;
  87         Forward local_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
  88
  89         /* Remote TCP/IP forward requests. */
  90         int     num_remote_forwards;
  91         Forward remote_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
  92 }       Options;
  93
  94
  95 /*
  96  * Initializes options to special values that indicate that they have not yet
  97  * been set.  Read_config_file will only set options with this value. Options
  98  * are processed in the following order: command line, user config file,
  99  * system config file.  Last, fill_default_options is called.
 100  */
 101 void    initialize_options(Options * options);
 102
 103 /*
 104  * Called after processing other sources of option data, this fills those
 105  * options for which no value has been specified with their default values.
 106  */
 107 void    fill_default_options(Options * options);
 108
 109 /*
 110  * Processes a single option line as used in the configuration files. This
 111  * only sets those values that have not already been set. Returns 0 for legal
 112  * options
 113  */
 114 int
 115 process_config_line(Options * options, const char *host,
 116     char *line, const char *filename, int linenum,
 117     int *activep);
 118
 119 /*
 120  * Reads the config file and modifies the options accordingly.  Options
 121  * should already be initialized before this call.  This never returns if
 122  * there is an error.  If the file does not exist, this returns immediately.
 123  */
 124 void
 125 read_config_file(const char *filename, const char *host,
 126     Options * options);
 127
 128 /*
 129  * Adds a local TCP/IP port forward to options.  Never returns if there is an
 130  * error.
 131  */
 132 void
 133 add_local_forward(Options * options, u_short port, const char *host,
 134     u_short host_port);
 135
 136 /*
 137  * Adds a remote TCP/IP port forward to options.  Never returns if there is
 138  * an error.
 139  */
 140 void
 141 add_remote_forward(Options * options, u_short port, const char *host,
 142     u_short host_port);
 143
 144 #endif                          /* READCONF_H */