[BACK]Return to readconf.h CVS log [TXT][DIR] Up to [local] / src / usr.bin / ssh

Annotation of src/usr.bin/ssh/readconf.h, Revision 1.111

1.111   ! djm         1: /* $OpenBSD: readconf.h,v 1.110 2015/07/10 06:21:53 markus Exp $ */
1.42      stevesk     2:
1.1       deraadt     3: /*
1.11      deraadt     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.
1.15      markus      8:  *
1.21      deraadt     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".
1.11      deraadt    14:  */
1.1       deraadt    15:
                     16: #ifndef READCONF_H
                     17: #define READCONF_H
1.27      markus     18:
1.1       deraadt    19: /* Data structure for representing option data. */
                     20:
1.90      djm        21: #define MAX_SEND_ENV           256
1.98      djm        22: #define SSH_MAX_HOSTS_FILES    32
                     23: #define MAX_CANON_DOMAINS      32
1.102     millert    24: #define PATH_MAX_SUN           (sizeof((struct sockaddr_un *)0)->sun_path)
1.98      djm        25:
                     26: struct allowed_cname {
                     27:        char *source_list;
                     28:        char *target_list;
                     29: };
1.62      djm        30:
1.11      deraadt    31: typedef struct {
                     32:        int     forward_agent;  /* Forward authentication agent. */
                     33:        int     forward_x11;    /* Forward X11 display. */
1.85      djm        34:        int     forward_x11_timeout;    /* Expiration for Cookies */
1.56      markus     35:        int     forward_x11_trusted;    /* Trust Forward X11 display. */
1.70      markus     36:        int     exit_on_forward_failure;        /* Exit if bind(2) fails for -L/-R */
1.19      markus     37:        char   *xauth_location; /* Location for xauth program */
1.102     millert    38:        struct ForwardOptions fwd_opts; /* forwarding options */
1.11      deraadt    39:        int     use_privileged_port;    /* Don't use privileged port if false. */
                     40:        int     rhosts_rsa_authentication;      /* Try rhosts with RSA
                     41:                                                 * authentication. */
                     42:        int     rsa_authentication;     /* Try RSA authentication. */
1.23      markus     43:        int     pubkey_authentication;  /* Try ssh2 pubkey authentication. */
1.29      markus     44:        int     hostbased_authentication;       /* ssh2's rhosts_rsa */
1.32      markus     45:        int     challenge_response_authentication;
1.25      markus     46:                                        /* Try S/Key or TIS, authentication. */
1.54      markus     47:        int     gss_authentication;     /* Try GSS authentication */
                     48:        int     gss_deleg_creds;        /* Delegate GSS credentials */
1.11      deraadt    49:        int     password_authentication;        /* Try password
                     50:                                                 * authentication. */
1.22      markus     51:        int     kbd_interactive_authentication; /* Try keyboard-interactive auth. */
                     52:        char    *kbd_interactive_devices; /* Keyboard-interactive auth devices. */
1.11      deraadt    53:        int     batch_mode;     /* Batch mode: do not ask for passwords. */
                     54:        int     check_host_ip;  /* Also keep track of keys for IP address */
                     55:        int     strict_host_key_checking;       /* Strict host key checking. */
                     56:        int     compression;    /* Compress packets in both directions. */
                     57:        int     compression_level;      /* Compression level 1 (fast) to 9
                     58:                                         * (best). */
1.58      markus     59:        int     tcp_keep_alive; /* Set SO_KEEPALIVE. */
1.88      djm        60:        int     ip_qos_interactive;     /* IP ToS/DSCP/class for interactive */
                     61:        int     ip_qos_bulk;            /* IP ToS/DSCP/class for bulk traffic */
1.11      deraadt    62:        LogLevel log_level;     /* Level for logging. */
                     63:
                     64:        int     port;           /* Port to connect. */
1.51      djm        65:        int     address_family;
1.11      deraadt    66:        int     connection_attempts;    /* Max attempts (seconds) before
                     67:                                         * giving up */
1.50      djm        68:        int     connection_timeout;     /* Max time (seconds) before
1.57      djm        69:                                         * aborting connection attempt */
1.11      deraadt    70:        int     number_of_password_prompts;     /* Max number of password
                     71:                                                 * prompts. */
                     72:        int     cipher;         /* Cipher to use. */
1.18      markus     73:        char   *ciphers;        /* SSH2 ciphers in order of preference. */
1.26      markus     74:        char   *macs;           /* SSH2 macs in order of preference. */
1.30      markus     75:        char   *hostkeyalgorithms;      /* SSH2 server key types in order of preference. */
1.87      djm        76:        char   *kex_algorithms; /* SSH2 kex methods in order of preference. */
1.14      markus     77:        int     protocol;       /* Protocol in order of preference. */
1.11      deraadt    78:        char   *hostname;       /* Real host to connect. */
1.24      markus     79:        char   *host_key_alias; /* hostname alias for .ssh/known_hosts */
1.11      deraadt    80:        char   *proxy_command;  /* Proxy command for connecting the host. */
                     81:        char   *user;           /* User to log in as. */
                     82:        int     escape_char;    /* Escape character; -2 = none */
                     83:
1.90      djm        84:        u_int   num_system_hostfiles;   /* Paths for /etc/ssh/ssh_known_hosts */
                     85:        char   *system_hostfiles[SSH_MAX_HOSTS_FILES];
                     86:        u_int   num_user_hostfiles;     /* Path for $HOME/.ssh/known_hosts */
                     87:        char   *user_hostfiles[SSH_MAX_HOSTS_FILES];
1.28      markus     88:        char   *preferred_authentications;
1.31      markus     89:        char   *bind_address;   /* local socket address for connection to sshd */
1.82      markus     90:        char   *pkcs11_provider; /* PKCS#11 provider */
1.48      jakob      91:        int     verify_host_key_dns;    /* Verify host key using DNS */
1.11      deraadt    92:
1.23      markus     93:        int     num_identity_files;     /* Number of files for RSA/DSA identities. */
1.11      deraadt    94:        char   *identity_files[SSH_MAX_IDENTITY_FILES];
1.92      dtucker    95:        int    identity_file_userprovided[SSH_MAX_IDENTITY_FILES];
1.106     djm        96:        struct sshkey *identity_keys[SSH_MAX_IDENTITY_FILES];
1.11      deraadt    97:
1.111   ! djm        98:        int     num_certificate_files; /* Number of extra certificates for ssh. */
        !            99:        char    *certificate_files[SSH_MAX_CERTIFICATE_FILES];
        !           100:        int     certificate_file_userprovided[SSH_MAX_CERTIFICATE_FILES];
        !           101:        struct sshkey *certificates[SSH_MAX_CERTIFICATE_FILES];
        !           102:
1.11      deraadt   103:        /* Local TCP/IP forward requests. */
                    104:        int     num_local_forwards;
1.102     millert   105:        struct Forward *local_forwards;
1.11      deraadt   106:
                    107:        /* Remote TCP/IP forward requests. */
                    108:        int     num_remote_forwards;
1.102     millert   109:        struct Forward *remote_forwards;
1.39      stevesk   110:        int     clear_forwardings;
1.44      markus    111:
                    112:        int     enable_ssh_keysign;
1.72      djm       113:        int64_t rekey_limit;
1.94      dtucker   114:        int     rekey_interval;
1.40      markus    115:        int     no_host_authentication_for_localhost;
1.60      markus    116:        int     identities_only;
1.64      deraadt   117:        int     server_alive_interval;
1.59      markus    118:        int     server_alive_count_max;
1.62      djm       119:
                    120:        int     num_send_env;
                    121:        char   *send_env[MAX_SEND_ENV];
1.63      djm       122:
                    123:        char    *control_path;
                    124:        int     control_master;
1.86      djm       125:        int     control_persist; /* ControlPersist flag */
                    126:        int     control_persist_timeout; /* ControlPersist timeout (seconds) */
1.66      djm       127:
                    128:        int     hash_known_hosts;
1.68      reyk      129:
                    130:        int     tun_open;       /* tun(4) */
                    131:        int     tun_local;      /* force tun device (optional) */
                    132:        int     tun_remote;     /* force tun device (optional) */
                    133:
                    134:        char    *local_command;
                    135:        int     permit_local_command;
1.74      grunk     136:        int     visual_host_key;
1.79      andreas   137:
                    138:        int     use_roaming;
1.80      reyk      139:
1.89      djm       140:        int     request_tty;
1.96      djm       141:
                    142:        int     proxy_use_fdpass;
1.95      djm       143:
1.98      djm       144:        int     num_canonical_domains;
                    145:        char    *canonical_domains[MAX_CANON_DOMAINS];
1.99      djm       146:        int     canonicalize_hostname;
                    147:        int     canonicalize_max_dots;
                    148:        int     canonicalize_fallback_local;
1.98      djm       149:        int     num_permitted_cnames;
                    150:        struct allowed_cname permitted_cnames[MAX_CANON_DOMAINS];
1.104     djm       151:
                    152:        char    *revoked_host_keys;
1.105     djm       153:
1.107     djm       154:        int      fingerprint_hash;
                    155:
1.109     djm       156:        int      update_hostkeys; /* one of SSH_UPDATE_HOSTKEYS_* */
1.108     djm       157:
1.110     markus    158:        char   *hostbased_key_types;
                    159:        char   *pubkey_key_types;
1.98      djm       160:
1.95      djm       161:        char    *ignored_unknown; /* Pattern list of unknown tokens to ignore */
1.11      deraadt   162: }       Options;
1.98      djm       163:
                    164: #define SSH_CANONICALISE_NO    0
                    165: #define SSH_CANONICALISE_YES   1
                    166: #define SSH_CANONICALISE_ALWAYS        2
1.1       deraadt   167:
1.67      djm       168: #define SSHCTL_MASTER_NO       0
                    169: #define SSHCTL_MASTER_YES      1
                    170: #define SSHCTL_MASTER_AUTO     2
                    171: #define SSHCTL_MASTER_ASK      3
                    172: #define SSHCTL_MASTER_AUTO_ASK 4
1.89      djm       173:
                    174: #define REQUEST_TTY_AUTO       0
                    175: #define REQUEST_TTY_NO         1
                    176: #define REQUEST_TTY_YES                2
                    177: #define REQUEST_TTY_FORCE      3
1.1       deraadt   178:
1.93      dtucker   179: #define SSHCONF_CHECKPERM      1  /* check permissions on config file */
                    180: #define SSHCONF_USERCONF       2  /* user provided config file not system */
1.103     djm       181: #define SSHCONF_POSTCANON      4  /* After hostname canonicalisation */
1.109     djm       182:
                    183: #define SSH_UPDATE_HOSTKEYS_NO 0
                    184: #define SSH_UPDATE_HOSTKEYS_YES        1
                    185: #define SSH_UPDATE_HOSTKEYS_ASK        2
1.93      dtucker   186:
1.35      markus    187: void     initialize_options(Options *);
                    188: void     fill_default_options(Options *);
1.101     djm       189: void    fill_default_options_for_canonicalization(Options *);
1.103     djm       190: int     process_config_line(Options *, struct passwd *, const char *,
                    191:     const char *, char *, const char *, int, int *, int);
1.97      djm       192: int     read_config_file(const char *, struct passwd *, const char *,
1.103     djm       193:     const char *, Options *, int);
1.102     millert   194: int     parse_forward(struct Forward *, const char *, int, int);
1.97      djm       195: int     default_ssh_port(void);
1.101     djm       196: int     option_clear_or_none(const char *);
1.103     djm       197: void    dump_client_config(Options *o, const char *host);
1.1       deraadt   198:
1.102     millert   199: void    add_local_forward(Options *, const struct Forward *);
                    200: void    add_remote_forward(Options *, const struct Forward *);
1.92      dtucker   201: void    add_identity_file(Options *, const char *, const char *, int);
1.111   ! djm       202: void    add_certificate_file(Options *, const char *, int);
1.1       deraadt   203:
1.11      deraadt   204: #endif                         /* READCONF_H */