readconf.h revision 69591
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.22 2000/10/11 20:14:39 markus Exp $"); */ 15/* $FreeBSD: head/crypto/openssh/readconf.h 69591 2000-12-05 02:55:12Z green $ */ 16 17#ifndef READCONF_H 18#define READCONF_H 19 20/* Data structure for representing a forwarding request. */ 21 22typedef struct { 23 u_short port; /* Port to forward. */ 24 char *host; /* Host to connect. */ 25 u_short host_port; /* Port to connect on host. */ 26} Forward; 27/* Data structure for representing option data. */ 28 29typedef struct { 30 int forward_agent; /* Forward authentication agent. */ 31 int forward_x11; /* Forward X11 display. */ 32 char *xauth_location; /* Location for xauth program */ 33 int gateway_ports; /* Allow remote connects to forwarded ports. */ 34 int use_privileged_port; /* Don't use privileged port if false. */ 35 int rhosts_authentication; /* Try rhosts authentication. */ 36 int rhosts_rsa_authentication; /* Try rhosts with RSA 37 * authentication. */ 38 int rsa_authentication; /* Try RSA authentication. */ 39 int dsa_authentication; /* Try DSA authentication. */ 40 int skey_authentication; /* Try S/Key or TIS authentication. */ 41#ifdef KRB4 42 int krb4_authentication; /* Try Kerberos v4 43 * authentication. */ 44#endif 45 46#ifdef KRB5 47 int krb5_authentication; 48 int krb5_tgt_passing; 49#endif /* KRB5 */ 50 51#ifdef AFS 52 int krb4_tgt_passing; /* Try Kerberos v4 tgt passing. */ 53 int afs_token_passing; /* Try AFS token passing. */ 54#endif 55 int password_authentication; /* Try password 56 * authentication. */ 57 int kbd_interactive_authentication; /* Try keyboard-interactive auth. */ 58 char *kbd_interactive_devices; /* Keyboard-interactive auth devices. */ 59 int fallback_to_rsh;/* Use rsh if cannot connect with ssh. */ 60 int use_rsh; /* Always use rsh (don\'t try ssh). */ 61 int batch_mode; /* Batch mode: do not ask for passwords. */ 62 int check_host_ip; /* Also keep track of keys for IP address */ 63 int strict_host_key_checking; /* Strict host key checking. */ 64 int compression; /* Compress packets in both directions. */ 65 int compression_level; /* Compression level 1 (fast) to 9 66 * (best). */ 67 int keepalives; /* Set SO_KEEPALIVE. */ 68 LogLevel log_level; /* Level for logging. */ 69 70 int port; /* Port to connect. */ 71 int connection_attempts; /* Max attempts (seconds) before 72 * giving up */ 73 int number_of_password_prompts; /* Max number of password 74 * prompts. */ 75 int cipher; /* Cipher to use. */ 76 char *ciphers; /* SSH2 ciphers in order of preference. */ 77 int protocol; /* Protocol in order of preference. */ 78 char *hostname; /* Real host to connect. */ 79 char *proxy_command; /* Proxy command for connecting the host. */ 80 char *user; /* User to log in as. */ 81 int escape_char; /* Escape character; -2 = none */ 82 83 char *system_hostfile;/* Path for /etc/ssh_known_hosts. */ 84 char *user_hostfile; /* Path for $HOME/.ssh/known_hosts. */ 85 char *system_hostfile2; 86 char *user_hostfile2; 87 88 int num_identity_files; /* Number of files for RSA identities. */ 89 int num_identity_files2; /* DSA identities. */ 90 char *identity_files[SSH_MAX_IDENTITY_FILES]; 91 char *identity_files2[SSH_MAX_IDENTITY_FILES]; 92 93 /* Local TCP/IP forward requests. */ 94 int num_local_forwards; 95 Forward local_forwards[SSH_MAX_FORWARDS_PER_DIRECTION]; 96 97 /* Remote TCP/IP forward requests. */ 98 int num_remote_forwards; 99 Forward remote_forwards[SSH_MAX_FORWARDS_PER_DIRECTION]; 100} Options; 101 102 103/* 104 * Initializes options to special values that indicate that they have not yet 105 * been set. Read_config_file will only set options with this value. Options 106 * are processed in the following order: command line, user config file, 107 * system config file. Last, fill_default_options is called. 108 */ 109void initialize_options(Options * options); 110 111/* 112 * Called after processing other sources of option data, this fills those 113 * options for which no value has been specified with their default values. 114 */ 115void fill_default_options(Options * options); 116 117/* 118 * Processes a single option line as used in the configuration files. This 119 * only sets those values that have not already been set. Returns 0 for legal 120 * options 121 */ 122int 123process_config_line(Options * options, const char *host, 124 char *line, const char *filename, int linenum, 125 int *activep); 126 127/* 128 * Reads the config file and modifies the options accordingly. Options 129 * should already be initialized before this call. This never returns if 130 * there is an error. If the file does not exist, this returns immediately. 131 */ 132void 133read_config_file(const char *filename, const char *host, 134 Options * options); 135 136/* 137 * Adds a local TCP/IP port forward to options. Never returns if there is an 138 * error. 139 */ 140void 141add_local_forward(Options * options, u_short port, const char *host, 142 u_short host_port); 143 144/* 145 * Adds a remote TCP/IP port forward to options. Never returns if there is 146 * an error. 147 */ 148void 149add_remote_forward(Options * options, u_short port, const char *host, 150 u_short host_port); 151 152#endif /* READCONF_H */ 153