crypto/openssh/readconf.h

   1 /*      $OpenBSD: readconf.h,v 1.43 2002/06/08 05:17:01 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 #include "key.h"
  20
  21 /* Data structure for representing a forwarding request. */
  22
  23 typedef struct {
  24         u_short   port;         /* Port to forward. */
  25         char     *host;         /* Host to connect. */
  26         u_short   host_port;    /* Port to connect on host. */
  27 }       Forward;
  28 /* Data structure for representing option data. */
  29
  30 typedef struct {
  31         int     forward_agent;  /* Forward authentication agent. */
  32         int     forward_x11;    /* Forward X11 display. */
  33         char   *xauth_location; /* Location for xauth program */
  34         int     gateway_ports;  /* Allow remote connects to forwarded ports. */
  35         int     use_privileged_port;    /* Don't use privileged port if false. */
  36         int     rhosts_authentication;  /* Try rhosts authentication. */
  37         int     rhosts_rsa_authentication;      /* Try rhosts with RSA
  38                                                  * authentication. */
  39         int     rsa_authentication;     /* Try RSA authentication. */
  40         int     pubkey_authentication;  /* Try ssh2 pubkey authentication. */
  41         int     hostbased_authentication;       /* ssh2's rhosts_rsa */
  42         int     challenge_response_authentication;
  43                                         /* Try S/Key or TIS, authentication. */
  44 #if defined(KRB4) || defined(KRB5)
  45         int     kerberos_authentication;        /* Try Kerberos authentication. */
  46 #endif
  47 #if defined(AFS) || defined(KRB5)
  48         int     kerberos_tgt_passing;   /* Try Kerberos TGT passing. */
  49 #endif
  50 #ifdef AFS
  51         int     afs_token_passing;      /* Try AFS token passing. */
  52 #endif
  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     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     keepalives;     /* Set SO_KEEPALIVE. */
  64         LogLevel log_level;     /* Level for logging. */
  65
  66         int     port;           /* Port to connect. */
  67         int     connection_attempts;    /* Max attempts (seconds) before
  68                                          * giving up */
  69         int     number_of_password_prompts;     /* Max number of password
  70                                                  * prompts. */
  71         int     cipher;         /* Cipher to use. */
  72         char   *ciphers;        /* SSH2 ciphers in order of preference. */
  73         char   *macs;           /* SSH2 macs in order of preference. */
  74         char   *hostkeyalgorithms;      /* SSH2 server key types in order of preference. */
  75         int     protocol;       /* Protocol in order of preference. */
  76         char   *hostname;       /* Real host to connect. */
  77         char   *host_key_alias; /* hostname alias for .ssh/known_hosts */
  78         char   *proxy_command;  /* Proxy command for connecting the host. */
  79         char   *user;           /* User to log in as. */
  80         int     escape_char;    /* Escape character; -2 = none */
  81
  82         char   *system_hostfile;/* Path for /etc/ssh/ssh_known_hosts. */
  83         char   *user_hostfile;  /* Path for $HOME/.ssh/known_hosts. */
  84         char   *system_hostfile2;
  85         char   *user_hostfile2;
  86         char   *preferred_authentications;
  87         char   *bind_address;   /* local socket address for connection to sshd */
  88         char   *smartcard_device; /* Smartcard reader device */
  89
  90         int     num_identity_files;     /* Number of files for RSA/DSA identities. */
  91         char   *identity_files[SSH_MAX_IDENTITY_FILES];
  92         Key    *identity_keys[SSH_MAX_IDENTITY_FILES];
  93
  94         /* Local TCP/IP forward requests. */
  95         int     num_local_forwards;
  96         Forward local_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
  97
  98         /* Remote TCP/IP forward requests. */
  99         int     num_remote_forwards;
 100         Forward remote_forwards[SSH_MAX_FORWARDS_PER_DIRECTION];
 101         int     clear_forwardings;
 102         int     no_host_authentication_for_localhost;
 103 }       Options;
 104
 105
 106 void     initialize_options(Options *);
 107 void     fill_default_options(Options *);
 108 int      read_config_file(const char *, const char *, Options *);
 109
 110 int
 111 process_config_line(Options *, const char *, char *, const char *, int, int *);
 112
 113 void     add_local_forward(Options *, u_short, const char *, u_short);
 114 void     add_remote_forward(Options *, u_short, const char *, u_short);
 115
 116 #endif                          /* READCONF_H */