sshkey.h

   1 /* $OpenBSD: sshkey.h,v 1.5 2015/01/26 02:59:11 djm Exp $ */
   2
   3 /*
   4  * Copyright (c) 2000, 2001 Markus Friedl.  All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  */
  26 #ifndef SSHKEY_H
  27 #define SSHKEY_H
  28
  29 #include <sys/types.h>
  30
  31 #ifdef WITH_OPENSSL
  32 #include <openssl/rsa.h>
  33 #include <openssl/dsa.h>
  34 # ifdef OPENSSL_HAS_ECC
  35 #  include <openssl/ec.h>
  36 # else /* OPENSSL_HAS_ECC */
  37 #  define EC_KEY        void
  38 #  define EC_GROUP      void
  39 #  define EC_POINT      void
  40 # endif /* OPENSSL_HAS_ECC */
  41 #else /* WITH_OPENSSL */
  42 # define RSA            void
  43 # define DSA            void
  44 # define EC_KEY         void
  45 # define EC_GROUP       void
  46 # define EC_POINT       void
  47 #endif /* WITH_OPENSSL */
  48
  49 #define SSH_RSA_MINIMUM_MODULUS_SIZE    768
  50 #define SSH_KEY_MAX_SIGN_DATA_SIZE      (1 << 20)
  51
  52 struct sshbuf;
  53
  54 /* Key types */
  55 enum sshkey_types {
  56         KEY_RSA1,
  57         KEY_RSA,
  58         KEY_DSA,
  59         KEY_ECDSA,
  60         KEY_ED25519,
  61         KEY_RSA_CERT,
  62         KEY_DSA_CERT,
  63         KEY_ECDSA_CERT,
  64         KEY_ED25519_CERT,
  65         KEY_RSA_CERT_V00,
  66         KEY_DSA_CERT_V00,
  67         KEY_UNSPEC
  68 };
  69
  70 /* Default fingerprint hash */
  71 #define SSH_FP_HASH_DEFAULT     SSH_DIGEST_SHA256
  72
  73 /* Fingerprint representation formats */
  74 enum sshkey_fp_rep {
  75         SSH_FP_DEFAULT = 0,
  76         SSH_FP_HEX,
  77         SSH_FP_BASE64,
  78         SSH_FP_BUBBLEBABBLE,
  79         SSH_FP_RANDOMART
  80 };
  81
  82 /* key is stored in external hardware */
  83 #define SSHKEY_FLAG_EXT         0x0001
  84
  85 #define SSHKEY_CERT_MAX_PRINCIPALS      256
  86 /* XXX opaquify? */
  87 struct sshkey_cert {
  88         struct sshbuf   *certblob; /* Kept around for use on wire */
  89         u_int            type; /* SSH2_CERT_TYPE_USER or SSH2_CERT_TYPE_HOST */
  90         u_int64_t        serial;
  91         char            *key_id;
  92         u_int            nprincipals;
  93         char            **principals;
  94         u_int64_t        valid_after, valid_before;
  95         struct sshbuf   *critical;
  96         struct sshbuf   *extensions;
  97         struct sshkey   *signature_key;
  98 };
  99
 100 /* XXX opaquify? */
 101 struct sshkey {
 102         int      type;
 103         int      flags;
 104         RSA     *rsa;
 105         DSA     *dsa;
 106         int      ecdsa_nid;     /* NID of curve */
 107         EC_KEY  *ecdsa;
 108         u_char  *ed25519_sk;
 109         u_char  *ed25519_pk;
 110         struct sshkey_cert *cert;
 111 };
 112
 113 #define ED25519_SK_SZ   crypto_sign_ed25519_SECRETKEYBYTES
 114 #define ED25519_PK_SZ   crypto_sign_ed25519_PUBLICKEYBYTES
 115
 116 struct sshkey   *sshkey_new(int);
 117 int              sshkey_add_private(struct sshkey *);
 118 struct sshkey   *sshkey_new_private(int);
 119 void             sshkey_free(struct sshkey *);
 120 int              sshkey_demote(const struct sshkey *, struct sshkey **);
 121 int              sshkey_equal_public(const struct sshkey *,
 122     const struct sshkey *);
 123 int              sshkey_equal(const struct sshkey *, const struct sshkey *);
 124 char            *sshkey_fingerprint(const struct sshkey *,
 125     int, enum sshkey_fp_rep);
 126 int              sshkey_fingerprint_raw(const struct sshkey *k,
 127     int, u_char **retp, size_t *lenp);
 128 const char      *sshkey_type(const struct sshkey *);
 129 const char      *sshkey_cert_type(const struct sshkey *);
 130 int              sshkey_write(const struct sshkey *, FILE *);
 131 int              sshkey_read(struct sshkey *, char **);
 132 u_int            sshkey_size(const struct sshkey *);
 133
 134 int              sshkey_generate(int type, u_int bits, struct sshkey **keyp);
 135 int              sshkey_from_private(const struct sshkey *, struct sshkey **);
 136 int      sshkey_type_from_name(const char *);
 137 int      sshkey_is_cert(const struct sshkey *);
 138 int      sshkey_type_is_cert(int);
 139 int      sshkey_type_plain(int);
 140 int      sshkey_to_certified(struct sshkey *, int);
 141 int      sshkey_drop_cert(struct sshkey *);
 142 int      sshkey_certify(struct sshkey *, struct sshkey *);
 143 int      sshkey_cert_copy(const struct sshkey *, struct sshkey *);
 144 int      sshkey_cert_check_authority(const struct sshkey *, int, int,
 145     const char *, const char **);
 146 int      sshkey_cert_is_legacy(const struct sshkey *);
 147
 148 int              sshkey_ecdsa_nid_from_name(const char *);
 149 int              sshkey_curve_name_to_nid(const char *);
 150 const char *     sshkey_curve_nid_to_name(int);
 151 u_int            sshkey_curve_nid_to_bits(int);
 152 int              sshkey_ecdsa_bits_to_nid(int);
 153 int              sshkey_ecdsa_key_to_nid(EC_KEY *);
 154 int              sshkey_ec_nid_to_hash_alg(int nid);
 155 int              sshkey_ec_validate_public(const EC_GROUP *, const EC_POINT *);
 156 int              sshkey_ec_validate_private(const EC_KEY *);
 157 const char      *sshkey_ssh_name(const struct sshkey *);
 158 const char      *sshkey_ssh_name_plain(const struct sshkey *);
 159 int              sshkey_names_valid2(const char *, int);
 160 char            *key_alg_list(int, int);
 161
 162 int      sshkey_from_blob(const u_char *, size_t, struct sshkey **);
 163 int      sshkey_fromb(struct sshbuf *, struct sshkey **);
 164 int      sshkey_froms(struct sshbuf *, struct sshkey **);
 165 int      sshkey_to_blob(const struct sshkey *, u_char **, size_t *);
 166 int      sshkey_putb(const struct sshkey *, struct sshbuf *);
 167 int      sshkey_puts(const struct sshkey *, struct sshbuf *);
 168 int      sshkey_plain_to_blob(const struct sshkey *, u_char **, size_t *);
 169 int      sshkey_putb_plain(const struct sshkey *, struct sshbuf *);
 170
 171 int      sshkey_sign(const struct sshkey *, u_char **, size_t *,
 172     const u_char *, size_t, u_int);
 173 int      sshkey_verify(const struct sshkey *, const u_char *, size_t,
 174     const u_char *, size_t, u_int);
 175
 176 /* for debug */
 177 void    sshkey_dump_ec_point(const EC_GROUP *, const EC_POINT *);
 178 void    sshkey_dump_ec_key(const EC_KEY *);
 179
 180 /* private key parsing and serialisation */
 181 int     sshkey_private_serialize(const struct sshkey *key, struct sshbuf *buf);
 182 int     sshkey_private_deserialize(struct sshbuf *buf,  struct sshkey **keyp);
 183
 184 /* private key file format parsing and serialisation */
 185 int     sshkey_private_to_fileblob(struct sshkey *key, struct sshbuf *blob,
 186     const char *passphrase, const char *comment,
 187     int force_new_format, const char *new_format_cipher, int new_format_rounds);
 188 int     sshkey_parse_public_rsa1_fileblob(struct sshbuf *blob,
 189     struct sshkey **keyp, char **commentp);
 190 int     sshkey_parse_private_fileblob(struct sshbuf *buffer,
 191     const char *passphrase, const char *filename, struct sshkey **keyp,
 192     char **commentp);
 193 int     sshkey_parse_private_fileblob_type(struct sshbuf *blob, int type,
 194     const char *passphrase, struct sshkey **keyp, char **commentp);
 195
 196 #ifdef SSHKEY_INTERNAL
 197 int ssh_rsa_sign(const struct sshkey *key, u_char **sigp, size_t *lenp,
 198     const u_char *data, size_t datalen, u_int compat);
 199 int ssh_rsa_verify(const struct sshkey *key,
 200     const u_char *signature, size_t signaturelen,
 201     const u_char *data, size_t datalen, u_int compat);
 202 int ssh_dss_sign(const struct sshkey *key, u_char **sigp, size_t *lenp,
 203     const u_char *data, size_t datalen, u_int compat);
 204 int ssh_dss_verify(const struct sshkey *key,
 205     const u_char *signature, size_t signaturelen,
 206     const u_char *data, size_t datalen, u_int compat);
 207 int ssh_ecdsa_sign(const struct sshkey *key, u_char **sigp, size_t *lenp,
 208     const u_char *data, size_t datalen, u_int compat);
 209 int ssh_ecdsa_verify(const struct sshkey *key,
 210     const u_char *signature, size_t signaturelen,
 211     const u_char *data, size_t datalen, u_int compat);
 212 int ssh_ed25519_sign(const struct sshkey *key, u_char **sigp, size_t *lenp,
 213     const u_char *data, size_t datalen, u_int compat);
 214 int ssh_ed25519_verify(const struct sshkey *key,
 215     const u_char *signature, size_t signaturelen,
 216     const u_char *data, size_t datalen, u_int compat);
 217 #endif
 218
 219 #if !defined(WITH_OPENSSL)
 220 # undef RSA
 221 # undef DSA
 222 # undef EC_KEY
 223 # undef EC_GROUP
 224 # undef EC_POINT
 225 #elif !defined(OPENSSL_HAS_ECC)
 226 # undef EC_KEY
 227 # undef EC_GROUP
 228 # undef EC_POINT
 229 #endif
 230
 231 #endif /* SSHKEY_H */