Return to hostfile.h CVS log

Up to [local] / src / usr.bin / ssh

Annotation of src/usr.bin/ssh/hostfile.h, Revision 1.23

1.23    ! djm         1: /* $OpenBSD: hostfile.h,v 1.22 2015/01/18 21:40:24 djm Exp $ */
1.6       niklas      2:
1.3       deraadt     3: /*
1.4       markus      4:  * Author: Tatu Ylonen <ylo@cs.hut.fi>
                      5:  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
                      6:  *                    All rights reserved
1.3       deraadt     7:  *
1.4       markus      8:  * As far as I am concerned, the code I have written for this software
                      9:  * can be used freely for any purpose.  Any derived versions of this
                     10:  * software must be clearly marked as such, and if the derived work is
                     11:  * incompatible with the protocol description in the RFC file, it must be
                     12:  * called by a name other than "ssh" or "Secure Shell".
1.3       deraadt    13:  */
1.1       markus     14: #ifndef HOSTFILE_H
                     15: #define HOSTFILE_H
1.7       itojun     16:
1.1       markus     17: typedef enum {
1.18      djm        18:        HOST_OK, HOST_NEW, HOST_CHANGED, HOST_REVOKED, HOST_FOUND
1.1       markus     19: }       HostStatus;
1.5       markus     20:
1.19      djm        21: typedef enum {
                     22:        MRK_ERROR, MRK_NONE, MRK_REVOKE, MRK_CA
                     23: }      HostkeyMarker;
                     24:
                     25: struct hostkey_entry {
                     26:        char *host;
                     27:        char *file;
                     28:        u_long line;
1.21      djm        29:        struct sshkey *key;
1.19      djm        30:        HostkeyMarker marker;
                     31: };
                     32: struct hostkeys;
                     33:
                     34: struct hostkeys *init_hostkeys(void);
                     35: void    load_hostkeys(struct hostkeys *, const char *, const char *);
                     36: void    free_hostkeys(struct hostkeys *);
                     37:
1.21      djm        38: HostStatus check_key_in_hostkeys(struct hostkeys *, struct sshkey *,
1.19      djm        39:     const struct hostkey_entry **);
                     40: int     lookup_key_in_hostkeys_by_type(struct hostkeys *, int,
                     41:     const struct hostkey_entry **);
                     42:
1.21      djm        43: int     hostfile_read_key(char **, u_int *, struct sshkey *);
                     44: int     add_host_to_hostfile(const char *, const char *,
                     45:     const struct sshkey *, int);
1.23    ! djm        46:
        !            47: int     hostfile_replace_entries(const char *filename, const char *host,
        !            48:     struct sshkey **keys, size_t nkeys, int store_hash, int quiet);
1.15      djm        49:
                     50: #define HASH_MAGIC     "|1|"
                     51: #define HASH_DELIM     '|'
1.17      djm        52:
                     53: #define CA_MARKER      "@cert-authority"
1.18      djm        54: #define REVOKE_MARKER  "@revoked"
1.15      djm        55:
                     56: char   *host_hash(const char *, const char *, u_int);
1.22      djm        57:
                     58: /*
                     59:  * Iterate through a hostkeys file, optionally parsing keys and matching
                     60:  * hostnames. Allows access to the raw keyfile lines to allow
                     61:  * streaming edits to the file to take place.
                     62:  */
                     63: #define HKF_WANT_MATCH_HOST    (1)     /* return only matching hosts */
                     64: #define HKF_WANT_PARSE_KEY     (1<<1)  /* need key parsed */
                     65:
                     66: #define HKF_STATUS_OK          1       /* Line parsed, didn't match host */
                     67: #define HKF_STATUS_INVALID     2       /* line had parse error */
                     68: #define HKF_STATUS_COMMENT     3       /* valid line contained no key */
                     69: #define HKF_STATUS_HOST_MATCHED        4       /* hostname matched */
                     70:
                     71: /*
                     72:  * The callback function receives this as an argument for each matching
                     73:  * hostkey line. The callback may "steal" the 'key' field by setting it to NULL.
                     74:  * If a parse error occurred, then "hosts" and subsequent options may be NULL.
                     75:  */
                     76: struct hostkey_foreach_line {
                     77:        const char *path; /* Path of file */
                     78:        u_long linenum; /* Line number */
                     79:        int status;     /* One of HKF_STATUS_* */
                     80:        char *line;     /* Entire key line; mutable by callback */
                     81:        int marker;     /* CA/revocation markers; indicated by MRK_* value */
                     82:        const char *hosts; /* Raw hosts text, may be hashed or list multiple */
                     83:        int was_hashed; /* Non-zero if hostname was hashed */
                     84:        const char *rawkey; /* Text of key and any comment following it */
                     85:        struct sshkey *key; /* Key, if parsed ok and HKF_WANT_MATCH_HOST set */
                     86:        const char *comment; /* Any comment following the key */
                     87: };
                     88:
                     89: /*
                     90:  * Callback fires for each line (or matching line if a HKF_WANT_* option
                     91:  * is set). The foreach loop will terminate if the callback returns a non-
                     92:  * zero exit status.
                     93:  */
                     94: typedef int hostkeys_foreach_fn(struct hostkey_foreach_line *l, void *ctx);
                     95:
                     96: int hostkeys_foreach(const char *path, hostkeys_foreach_fn *callback, void *ctx,
                     97:     const char *host, u_int options);
1.1       markus     98:
                     99: #endif