1 /* $OpenBSD: sshkey.c,v 1.64 2018/03/22 07:05:48 markus Exp $ */
3 * Copyright (c) 2000, 2001 Markus Friedl. All rights reserved.
4 * Copyright (c) 2008 Alexander von Gernler. All rights reserved.
5 * Copyright (c) 2010,2011 Damien Miller. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 #include <sys/types.h>
31 #include <netinet/in.h>
34 #include <openssl/evp.h>
35 #include <openssl/err.h>
36 #include <openssl/pem.h>
39 #include "crypto_api.h"
48 #endif /* HAVE_UTIL_H */
56 #define SSHKEY_INTERNAL
58 #include "sshkey-xmss.h"
61 #include "xmss_fast.h"
63 /* openssh private key file format */
64 #define MARK_BEGIN "-----BEGIN OPENSSH PRIVATE KEY-----\n"
65 #define MARK_END "-----END OPENSSH PRIVATE KEY-----\n"
66 #define MARK_BEGIN_LEN (sizeof(MARK_BEGIN) - 1)
67 #define MARK_END_LEN (sizeof(MARK_END) - 1)
68 #define KDFNAME "bcrypt"
69 #define AUTH_MAGIC "openssh-key-v1"
71 #define DEFAULT_CIPHERNAME "aes256-ctr"
72 #define DEFAULT_ROUNDS 16
74 /* Version identification string for SSH v1 identity files. */
75 #define LEGACY_BEGIN "SSH PRIVATE KEY FILE FORMAT 1.1\n"
77 int sshkey_private_serialize_opt(const struct sshkey *key,
78 struct sshbuf *buf, enum sshkey_serialize_rep);
79 static int sshkey_from_blob_internal(struct sshbuf *buf,
80 struct sshkey **keyp, int allow_cert);
82 /* Supported key types */
85 const char *shortname;
91 static const struct keytype keytypes[] = {
92 { "ssh-ed25519", "ED25519", KEY_ED25519, 0, 0, 0 },
93 { "ssh-ed25519-cert-v01@openssh.com", "ED25519-CERT",
94 KEY_ED25519_CERT, 0, 1, 0 },
96 { "ssh-xmss@openssh.com", "XMSS", KEY_XMSS, 0, 0, 0 },
97 { "ssh-xmss-cert-v01@openssh.com", "XMSS-CERT",
98 KEY_XMSS_CERT, 0, 1, 0 },
99 #endif /* WITH_XMSS */
101 { "ssh-rsa", "RSA", KEY_RSA, 0, 0, 0 },
102 { "rsa-sha2-256", "RSA", KEY_RSA, 0, 0, 1 },
103 { "rsa-sha2-512", "RSA", KEY_RSA, 0, 0, 1 },
104 { "ssh-dss", "DSA", KEY_DSA, 0, 0, 0 },
105 # ifdef OPENSSL_HAS_ECC
106 { "ecdsa-sha2-nistp256", "ECDSA", KEY_ECDSA, NID_X9_62_prime256v1, 0, 0 },
107 { "ecdsa-sha2-nistp384", "ECDSA", KEY_ECDSA, NID_secp384r1, 0, 0 },
108 # ifdef OPENSSL_HAS_NISTP521
109 { "ecdsa-sha2-nistp521", "ECDSA", KEY_ECDSA, NID_secp521r1, 0, 0 },
110 # endif /* OPENSSL_HAS_NISTP521 */
111 # endif /* OPENSSL_HAS_ECC */
112 { "ssh-rsa-cert-v01@openssh.com", "RSA-CERT", KEY_RSA_CERT, 0, 1, 0 },
113 { "ssh-dss-cert-v01@openssh.com", "DSA-CERT", KEY_DSA_CERT, 0, 1, 0 },
114 # ifdef OPENSSL_HAS_ECC
115 { "ecdsa-sha2-nistp256-cert-v01@openssh.com", "ECDSA-CERT",
116 KEY_ECDSA_CERT, NID_X9_62_prime256v1, 1, 0 },
117 { "ecdsa-sha2-nistp384-cert-v01@openssh.com", "ECDSA-CERT",
118 KEY_ECDSA_CERT, NID_secp384r1, 1, 0 },
119 # ifdef OPENSSL_HAS_NISTP521
120 { "ecdsa-sha2-nistp521-cert-v01@openssh.com", "ECDSA-CERT",
121 KEY_ECDSA_CERT, NID_secp521r1, 1, 0 },
122 # endif /* OPENSSL_HAS_NISTP521 */
123 # endif /* OPENSSL_HAS_ECC */
124 #endif /* WITH_OPENSSL */
125 { NULL, NULL, -1, -1, 0, 0 }
129 sshkey_type(const struct sshkey *k)
131 const struct keytype *kt;
133 for (kt = keytypes; kt->type != -1; kt++) {
134 if (kt->type == k->type)
135 return kt->shortname;
141 sshkey_ssh_name_from_type_nid(int type, int nid)
143 const struct keytype *kt;
145 for (kt = keytypes; kt->type != -1; kt++) {
146 if (kt->type == type && (kt->nid == 0 || kt->nid == nid))
149 return "ssh-unknown";
153 sshkey_type_is_cert(int type)
155 const struct keytype *kt;
157 for (kt = keytypes; kt->type != -1; kt++) {
158 if (kt->type == type)
165 sshkey_ssh_name(const struct sshkey *k)
167 return sshkey_ssh_name_from_type_nid(k->type, k->ecdsa_nid);
171 sshkey_ssh_name_plain(const struct sshkey *k)
173 return sshkey_ssh_name_from_type_nid(sshkey_type_plain(k->type),
178 sshkey_type_from_name(const char *name)
180 const struct keytype *kt;
182 for (kt = keytypes; kt->type != -1; kt++) {
183 /* Only allow shortname matches for plain key types */
184 if ((kt->name != NULL && strcmp(name, kt->name) == 0) ||
185 (!kt->cert && strcasecmp(kt->shortname, name) == 0))
192 sshkey_ecdsa_nid_from_name(const char *name)
194 const struct keytype *kt;
196 for (kt = keytypes; kt->type != -1; kt++) {
197 if (kt->type != KEY_ECDSA && kt->type != KEY_ECDSA_CERT)
199 if (kt->name != NULL && strcmp(name, kt->name) == 0)
206 sshkey_alg_list(int certs_only, int plain_only, int include_sigonly, char sep)
208 char *tmp, *ret = NULL;
209 size_t nlen, rlen = 0;
210 const struct keytype *kt;
212 for (kt = keytypes; kt->type != -1; kt++) {
213 if (kt->name == NULL)
215 if (!include_sigonly && kt->sigonly)
217 if ((certs_only && !kt->cert) || (plain_only && kt->cert))
221 nlen = strlen(kt->name);
222 if ((tmp = realloc(ret, rlen + nlen + 2)) == NULL) {
227 memcpy(ret + rlen, kt->name, nlen + 1);
234 sshkey_names_valid2(const char *names, int allow_wildcard)
237 const struct keytype *kt;
240 if (names == NULL || strcmp(names, "") == 0)
242 if ((s = cp = strdup(names)) == NULL)
244 for ((p = strsep(&cp, ",")); p && *p != '\0';
245 (p = strsep(&cp, ","))) {
246 type = sshkey_type_from_name(p);
247 if (type == KEY_UNSPEC) {
248 if (allow_wildcard) {
250 * Try matching key types against the string.
251 * If any has a positive or negative match then
252 * the component is accepted.
254 for (kt = keytypes; kt->type != -1; kt++) {
255 if (match_pattern_list(kt->name,
271 sshkey_size(const struct sshkey *k)
277 return BN_num_bits(k->rsa->n);
280 return BN_num_bits(k->dsa->p);
283 return sshkey_curve_nid_to_bits(k->ecdsa_nid);
284 #endif /* WITH_OPENSSL */
286 case KEY_ED25519_CERT:
289 return 256; /* XXX */
295 sshkey_type_is_valid_ca(int type)
310 sshkey_is_cert(const struct sshkey *k)
314 return sshkey_type_is_cert(k->type);
317 /* Return the cert-less equivalent to a certified key type */
319 sshkey_type_plain(int type)
328 case KEY_ED25519_CERT:
338 /* XXX: these are really begging for a table-driven approach */
340 sshkey_curve_name_to_nid(const char *name)
342 if (strcmp(name, "nistp256") == 0)
343 return NID_X9_62_prime256v1;
344 else if (strcmp(name, "nistp384") == 0)
345 return NID_secp384r1;
346 # ifdef OPENSSL_HAS_NISTP521
347 else if (strcmp(name, "nistp521") == 0)
348 return NID_secp521r1;
349 # endif /* OPENSSL_HAS_NISTP521 */
355 sshkey_curve_nid_to_bits(int nid)
358 case NID_X9_62_prime256v1:
362 # ifdef OPENSSL_HAS_NISTP521
365 # endif /* OPENSSL_HAS_NISTP521 */
372 sshkey_ecdsa_bits_to_nid(int bits)
376 return NID_X9_62_prime256v1;
378 return NID_secp384r1;
379 # ifdef OPENSSL_HAS_NISTP521
381 return NID_secp521r1;
382 # endif /* OPENSSL_HAS_NISTP521 */
389 sshkey_curve_nid_to_name(int nid)
392 case NID_X9_62_prime256v1:
396 # ifdef OPENSSL_HAS_NISTP521
399 # endif /* OPENSSL_HAS_NISTP521 */
406 sshkey_ec_nid_to_hash_alg(int nid)
408 int kbits = sshkey_curve_nid_to_bits(nid);
413 /* RFC5656 section 6.2.1 */
415 return SSH_DIGEST_SHA256;
416 else if (kbits <= 384)
417 return SSH_DIGEST_SHA384;
419 return SSH_DIGEST_SHA512;
421 #endif /* WITH_OPENSSL */
424 cert_free(struct sshkey_cert *cert)
430 sshbuf_free(cert->certblob);
431 sshbuf_free(cert->critical);
432 sshbuf_free(cert->extensions);
434 for (i = 0; i < cert->nprincipals; i++)
435 free(cert->principals[i]);
436 free(cert->principals);
437 sshkey_free(cert->signature_key);
438 freezero(cert, sizeof(*cert));
441 static struct sshkey_cert *
444 struct sshkey_cert *cert;
446 if ((cert = calloc(1, sizeof(*cert))) == NULL)
448 if ((cert->certblob = sshbuf_new()) == NULL ||
449 (cert->critical = sshbuf_new()) == NULL ||
450 (cert->extensions = sshbuf_new()) == NULL) {
455 cert->principals = NULL;
456 cert->signature_key = NULL;
467 #endif /* WITH_OPENSSL */
469 if ((k = calloc(1, sizeof(*k))) == NULL)
477 k->ed25519_sk = NULL;
478 k->ed25519_pk = NULL;
485 if ((rsa = RSA_new()) == NULL ||
486 (rsa->n = BN_new()) == NULL ||
487 (rsa->e = BN_new()) == NULL) {
496 if ((dsa = DSA_new()) == NULL ||
497 (dsa->p = BN_new()) == NULL ||
498 (dsa->q = BN_new()) == NULL ||
499 (dsa->g = BN_new()) == NULL ||
500 (dsa->pub_key = BN_new()) == NULL) {
509 /* Cannot do anything until we know the group */
511 #endif /* WITH_OPENSSL */
513 case KEY_ED25519_CERT:
516 /* no need to prealloc */
525 if (sshkey_is_cert(k)) {
526 if ((k->cert = cert_new()) == NULL) {
536 sshkey_add_private(struct sshkey *k)
542 #define bn_maybe_alloc_failed(p) (p == NULL && (p = BN_new()) == NULL)
543 if (bn_maybe_alloc_failed(k->rsa->d) ||
544 bn_maybe_alloc_failed(k->rsa->iqmp) ||
545 bn_maybe_alloc_failed(k->rsa->q) ||
546 bn_maybe_alloc_failed(k->rsa->p) ||
547 bn_maybe_alloc_failed(k->rsa->dmq1) ||
548 bn_maybe_alloc_failed(k->rsa->dmp1))
549 return SSH_ERR_ALLOC_FAIL;
553 if (bn_maybe_alloc_failed(k->dsa->priv_key))
554 return SSH_ERR_ALLOC_FAIL;
556 #undef bn_maybe_alloc_failed
559 /* Cannot do anything until we know the group */
561 #endif /* WITH_OPENSSL */
563 case KEY_ED25519_CERT:
566 /* no need to prealloc */
571 return SSH_ERR_INVALID_ARGUMENT;
577 sshkey_new_private(int type)
579 struct sshkey *k = sshkey_new(type);
583 if (sshkey_add_private(k) != 0) {
591 sshkey_free(struct sshkey *k)
607 # ifdef OPENSSL_HAS_ECC
610 EC_KEY_free(k->ecdsa);
613 # endif /* OPENSSL_HAS_ECC */
614 #endif /* WITH_OPENSSL */
616 case KEY_ED25519_CERT:
617 freezero(k->ed25519_pk, ED25519_PK_SZ);
618 k->ed25519_pk = NULL;
619 freezero(k->ed25519_sk, ED25519_SK_SZ);
620 k->ed25519_sk = NULL;
625 freezero(k->xmss_pk, sshkey_xmss_pklen(k));
627 freezero(k->xmss_sk, sshkey_xmss_sklen(k));
629 sshkey_xmss_free_state(k);
632 free(k->xmss_filename);
633 k->xmss_filename = NULL;
635 #endif /* WITH_XMSS */
641 if (sshkey_is_cert(k))
643 freezero(k, sizeof(*k));
647 cert_compare(struct sshkey_cert *a, struct sshkey_cert *b)
649 if (a == NULL && b == NULL)
651 if (a == NULL || b == NULL)
653 if (sshbuf_len(a->certblob) != sshbuf_len(b->certblob))
655 if (timingsafe_bcmp(sshbuf_ptr(a->certblob), sshbuf_ptr(b->certblob),
656 sshbuf_len(a->certblob)) != 0)
662 * Compare public portions of key only, allowing comparisons between
663 * certificates and plain keys too.
666 sshkey_equal_public(const struct sshkey *a, const struct sshkey *b)
668 #if defined(WITH_OPENSSL) && defined(OPENSSL_HAS_ECC)
670 #endif /* WITH_OPENSSL && OPENSSL_HAS_ECC */
672 if (a == NULL || b == NULL ||
673 sshkey_type_plain(a->type) != sshkey_type_plain(b->type))
680 return a->rsa != NULL && b->rsa != NULL &&
681 BN_cmp(a->rsa->e, b->rsa->e) == 0 &&
682 BN_cmp(a->rsa->n, b->rsa->n) == 0;
685 return a->dsa != NULL && b->dsa != NULL &&
686 BN_cmp(a->dsa->p, b->dsa->p) == 0 &&
687 BN_cmp(a->dsa->q, b->dsa->q) == 0 &&
688 BN_cmp(a->dsa->g, b->dsa->g) == 0 &&
689 BN_cmp(a->dsa->pub_key, b->dsa->pub_key) == 0;
690 # ifdef OPENSSL_HAS_ECC
693 if (a->ecdsa == NULL || b->ecdsa == NULL ||
694 EC_KEY_get0_public_key(a->ecdsa) == NULL ||
695 EC_KEY_get0_public_key(b->ecdsa) == NULL)
697 if ((bnctx = BN_CTX_new()) == NULL)
699 if (EC_GROUP_cmp(EC_KEY_get0_group(a->ecdsa),
700 EC_KEY_get0_group(b->ecdsa), bnctx) != 0 ||
701 EC_POINT_cmp(EC_KEY_get0_group(a->ecdsa),
702 EC_KEY_get0_public_key(a->ecdsa),
703 EC_KEY_get0_public_key(b->ecdsa), bnctx) != 0) {
709 # endif /* OPENSSL_HAS_ECC */
710 #endif /* WITH_OPENSSL */
712 case KEY_ED25519_CERT:
713 return a->ed25519_pk != NULL && b->ed25519_pk != NULL &&
714 memcmp(a->ed25519_pk, b->ed25519_pk, ED25519_PK_SZ) == 0;
718 return a->xmss_pk != NULL && b->xmss_pk != NULL &&
719 sshkey_xmss_pklen(a) == sshkey_xmss_pklen(b) &&
720 memcmp(a->xmss_pk, b->xmss_pk, sshkey_xmss_pklen(a)) == 0;
721 #endif /* WITH_XMSS */
729 sshkey_equal(const struct sshkey *a, const struct sshkey *b)
731 if (a == NULL || b == NULL || a->type != b->type)
733 if (sshkey_is_cert(a)) {
734 if (!cert_compare(a->cert, b->cert))
737 return sshkey_equal_public(a, b);
741 to_blob_buf(const struct sshkey *key, struct sshbuf *b, int force_plain,
742 enum sshkey_serialize_rep opts)
744 int type, ret = SSH_ERR_INTERNAL_ERROR;
745 const char *typename;
748 return SSH_ERR_INVALID_ARGUMENT;
750 if (sshkey_is_cert(key)) {
751 if (key->cert == NULL)
752 return SSH_ERR_EXPECTED_CERT;
753 if (sshbuf_len(key->cert->certblob) == 0)
754 return SSH_ERR_KEY_LACKS_CERTBLOB;
756 type = force_plain ? sshkey_type_plain(key->type) : key->type;
757 typename = sshkey_ssh_name_from_type_nid(type, key->ecdsa_nid);
764 #endif /* WITH_OPENSSL */
765 case KEY_ED25519_CERT:
768 #endif /* WITH_XMSS */
769 /* Use the existing blob */
770 /* XXX modified flag? */
771 if ((ret = sshbuf_putb(b, key->cert->certblob)) != 0)
776 if (key->dsa == NULL)
777 return SSH_ERR_INVALID_ARGUMENT;
778 if ((ret = sshbuf_put_cstring(b, typename)) != 0 ||
779 (ret = sshbuf_put_bignum2(b, key->dsa->p)) != 0 ||
780 (ret = sshbuf_put_bignum2(b, key->dsa->q)) != 0 ||
781 (ret = sshbuf_put_bignum2(b, key->dsa->g)) != 0 ||
782 (ret = sshbuf_put_bignum2(b, key->dsa->pub_key)) != 0)
785 # ifdef OPENSSL_HAS_ECC
787 if (key->ecdsa == NULL)
788 return SSH_ERR_INVALID_ARGUMENT;
789 if ((ret = sshbuf_put_cstring(b, typename)) != 0 ||
790 (ret = sshbuf_put_cstring(b,
791 sshkey_curve_nid_to_name(key->ecdsa_nid))) != 0 ||
792 (ret = sshbuf_put_eckey(b, key->ecdsa)) != 0)
797 if (key->rsa == NULL)
798 return SSH_ERR_INVALID_ARGUMENT;
799 if ((ret = sshbuf_put_cstring(b, typename)) != 0 ||
800 (ret = sshbuf_put_bignum2(b, key->rsa->e)) != 0 ||
801 (ret = sshbuf_put_bignum2(b, key->rsa->n)) != 0)
804 #endif /* WITH_OPENSSL */
806 if (key->ed25519_pk == NULL)
807 return SSH_ERR_INVALID_ARGUMENT;
808 if ((ret = sshbuf_put_cstring(b, typename)) != 0 ||
809 (ret = sshbuf_put_string(b,
810 key->ed25519_pk, ED25519_PK_SZ)) != 0)
815 if (key->xmss_name == NULL || key->xmss_pk == NULL ||
816 sshkey_xmss_pklen(key) == 0)
817 return SSH_ERR_INVALID_ARGUMENT;
818 if ((ret = sshbuf_put_cstring(b, typename)) != 0 ||
819 (ret = sshbuf_put_cstring(b, key->xmss_name)) != 0 ||
820 (ret = sshbuf_put_string(b,
821 key->xmss_pk, sshkey_xmss_pklen(key))) != 0 ||
822 (ret = sshkey_xmss_serialize_pk_info(key, b, opts)) != 0)
825 #endif /* WITH_XMSS */
827 return SSH_ERR_KEY_TYPE_UNKNOWN;
833 sshkey_putb(const struct sshkey *key, struct sshbuf *b)
835 return to_blob_buf(key, b, 0, SSHKEY_SERIALIZE_DEFAULT);
839 sshkey_puts_opts(const struct sshkey *key, struct sshbuf *b,
840 enum sshkey_serialize_rep opts)
845 if ((tmp = sshbuf_new()) == NULL)
846 return SSH_ERR_ALLOC_FAIL;
847 r = to_blob_buf(key, tmp, 0, opts);
849 r = sshbuf_put_stringb(b, tmp);
855 sshkey_puts(const struct sshkey *key, struct sshbuf *b)
857 return sshkey_puts_opts(key, b, SSHKEY_SERIALIZE_DEFAULT);
861 sshkey_putb_plain(const struct sshkey *key, struct sshbuf *b)
863 return to_blob_buf(key, b, 1, SSHKEY_SERIALIZE_DEFAULT);
867 to_blob(const struct sshkey *key, u_char **blobp, size_t *lenp, int force_plain,
868 enum sshkey_serialize_rep opts)
870 int ret = SSH_ERR_INTERNAL_ERROR;
872 struct sshbuf *b = NULL;
878 if ((b = sshbuf_new()) == NULL)
879 return SSH_ERR_ALLOC_FAIL;
880 if ((ret = to_blob_buf(key, b, force_plain, opts)) != 0)
886 if ((*blobp = malloc(len)) == NULL) {
887 ret = SSH_ERR_ALLOC_FAIL;
890 memcpy(*blobp, sshbuf_ptr(b), len);
899 sshkey_to_blob(const struct sshkey *key, u_char **blobp, size_t *lenp)
901 return to_blob(key, blobp, lenp, 0, SSHKEY_SERIALIZE_DEFAULT);
905 sshkey_plain_to_blob(const struct sshkey *key, u_char **blobp, size_t *lenp)
907 return to_blob(key, blobp, lenp, 1, SSHKEY_SERIALIZE_DEFAULT);
911 sshkey_fingerprint_raw(const struct sshkey *k, int dgst_alg,
912 u_char **retp, size_t *lenp)
914 u_char *blob = NULL, *ret = NULL;
916 int r = SSH_ERR_INTERNAL_ERROR;
922 if (ssh_digest_bytes(dgst_alg) == 0) {
923 r = SSH_ERR_INVALID_ARGUMENT;
926 if ((r = to_blob(k, &blob, &blob_len, 1, SSHKEY_SERIALIZE_DEFAULT))
929 if ((ret = calloc(1, SSH_DIGEST_MAX_LENGTH)) == NULL) {
930 r = SSH_ERR_ALLOC_FAIL;
933 if ((r = ssh_digest_memory(dgst_alg, blob, blob_len,
934 ret, SSH_DIGEST_MAX_LENGTH)) != 0)
942 *lenp = ssh_digest_bytes(dgst_alg);
947 explicit_bzero(blob, blob_len);
954 fingerprint_b64(const char *alg, u_char *dgst_raw, size_t dgst_raw_len)
957 size_t plen = strlen(alg) + 1;
958 size_t rlen = ((dgst_raw_len + 2) / 3) * 4 + plen + 1;
961 if (dgst_raw_len > 65536 || (ret = calloc(1, rlen)) == NULL)
963 strlcpy(ret, alg, rlen);
964 strlcat(ret, ":", rlen);
965 if (dgst_raw_len == 0)
967 if ((r = b64_ntop(dgst_raw, dgst_raw_len,
968 ret + plen, rlen - plen)) == -1) {
972 /* Trim padding characters from end */
973 ret[strcspn(ret, "=")] = '\0';
978 fingerprint_hex(const char *alg, u_char *dgst_raw, size_t dgst_raw_len)
980 char *retval, hex[5];
981 size_t i, rlen = dgst_raw_len * 3 + strlen(alg) + 2;
983 if (dgst_raw_len > 65536 || (retval = calloc(1, rlen)) == NULL)
985 strlcpy(retval, alg, rlen);
986 strlcat(retval, ":", rlen);
987 for (i = 0; i < dgst_raw_len; i++) {
988 snprintf(hex, sizeof(hex), "%s%02x",
989 i > 0 ? ":" : "", dgst_raw[i]);
990 strlcat(retval, hex, rlen);
996 fingerprint_bubblebabble(u_char *dgst_raw, size_t dgst_raw_len)
998 char vowels[] = { 'a', 'e', 'i', 'o', 'u', 'y' };
999 char consonants[] = { 'b', 'c', 'd', 'f', 'g', 'h', 'k', 'l', 'm',
1000 'n', 'p', 'r', 's', 't', 'v', 'z', 'x' };
1001 u_int i, j = 0, rounds, seed = 1;
1004 rounds = (dgst_raw_len / 2) + 1;
1005 if ((retval = calloc(rounds, 6)) == NULL)
1008 for (i = 0; i < rounds; i++) {
1009 u_int idx0, idx1, idx2, idx3, idx4;
1010 if ((i + 1 < rounds) || (dgst_raw_len % 2 != 0)) {
1011 idx0 = (((((u_int)(dgst_raw[2 * i])) >> 6) & 3) +
1013 idx1 = (((u_int)(dgst_raw[2 * i])) >> 2) & 15;
1014 idx2 = ((((u_int)(dgst_raw[2 * i])) & 3) +
1016 retval[j++] = vowels[idx0];
1017 retval[j++] = consonants[idx1];
1018 retval[j++] = vowels[idx2];
1019 if ((i + 1) < rounds) {
1020 idx3 = (((u_int)(dgst_raw[(2 * i) + 1])) >> 4) & 15;
1021 idx4 = (((u_int)(dgst_raw[(2 * i) + 1]))) & 15;
1022 retval[j++] = consonants[idx3];
1024 retval[j++] = consonants[idx4];
1025 seed = ((seed * 5) +
1026 ((((u_int)(dgst_raw[2 * i])) * 7) +
1027 ((u_int)(dgst_raw[(2 * i) + 1])))) % 36;
1033 retval[j++] = vowels[idx0];
1034 retval[j++] = consonants[idx1];
1035 retval[j++] = vowels[idx2];
1044 * Draw an ASCII-Art representing the fingerprint so human brain can
1045 * profit from its built-in pattern recognition ability.
1046 * This technique is called "random art" and can be found in some
1047 * scientific publications like this original paper:
1049 * "Hash Visualization: a New Technique to improve Real-World Security",
1050 * Perrig A. and Song D., 1999, International Workshop on Cryptographic
1051 * Techniques and E-Commerce (CrypTEC '99)
1052 * sparrow.ece.cmu.edu/~adrian/projects/validation/validation.pdf
1054 * The subject came up in a talk by Dan Kaminsky, too.
1056 * If you see the picture is different, the key is different.
1057 * If the picture looks the same, you still know nothing.
1059 * The algorithm used here is a worm crawling over a discrete plane,
1060 * leaving a trace (augmenting the field) everywhere it goes.
1061 * Movement is taken from dgst_raw 2bit-wise. Bumping into walls
1062 * makes the respective movement vector be ignored for this turn.
1063 * Graphs are not unambiguous, because circles in graphs can be
1064 * walked in either direction.
1068 * Field sizes for the random art. Have to be odd, so the starting point
1069 * can be in the exact middle of the picture, and FLDBASE should be >=8 .
1070 * Else pictures would be too dense, and drawing the frame would
1071 * fail, too, because the key type would not fit in anymore.
1074 #define FLDSIZE_Y (FLDBASE + 1)
1075 #define FLDSIZE_X (FLDBASE * 2 + 1)
1077 fingerprint_randomart(const char *alg, u_char *dgst_raw, size_t dgst_raw_len,
1078 const struct sshkey *k)
1081 * Chars to be used after each other every time the worm
1082 * intersects with itself. Matter of taste.
1084 char *augmentation_string = " .o+=*BOX@%&#/^SE";
1085 char *retval, *p, title[FLDSIZE_X], hash[FLDSIZE_X];
1086 u_char field[FLDSIZE_X][FLDSIZE_Y];
1087 size_t i, tlen, hlen;
1090 size_t len = strlen(augmentation_string) - 1;
1092 if ((retval = calloc((FLDSIZE_X + 3), (FLDSIZE_Y + 2))) == NULL)
1095 /* initialize field */
1096 memset(field, 0, FLDSIZE_X * FLDSIZE_Y * sizeof(char));
1100 /* process raw key */
1101 for (i = 0; i < dgst_raw_len; i++) {
1103 /* each byte conveys four 2-bit move commands */
1104 input = dgst_raw[i];
1105 for (b = 0; b < 4; b++) {
1106 /* evaluate 2 bit, rest is shifted later */
1107 x += (input & 0x1) ? 1 : -1;
1108 y += (input & 0x2) ? 1 : -1;
1110 /* assure we are still in bounds */
1113 x = MINIMUM(x, FLDSIZE_X - 1);
1114 y = MINIMUM(y, FLDSIZE_Y - 1);
1116 /* augment the field */
1117 if (field[x][y] < len - 2)
1123 /* mark starting point and end point*/
1124 field[FLDSIZE_X / 2][FLDSIZE_Y / 2] = len - 1;
1127 /* assemble title */
1128 r = snprintf(title, sizeof(title), "[%s %u]",
1129 sshkey_type(k), sshkey_size(k));
1130 /* If [type size] won't fit, then try [type]; fits "[ED25519-CERT]" */
1131 if (r < 0 || r > (int)sizeof(title))
1132 r = snprintf(title, sizeof(title), "[%s]", sshkey_type(k));
1133 tlen = (r <= 0) ? 0 : strlen(title);
1135 /* assemble hash ID. */
1136 r = snprintf(hash, sizeof(hash), "[%s]", alg);
1137 hlen = (r <= 0) ? 0 : strlen(hash);
1139 /* output upper border */
1142 for (i = 0; i < (FLDSIZE_X - tlen) / 2; i++)
1144 memcpy(p, title, tlen);
1146 for (i += tlen; i < FLDSIZE_X; i++)
1151 /* output content */
1152 for (y = 0; y < FLDSIZE_Y; y++) {
1154 for (x = 0; x < FLDSIZE_X; x++)
1155 *p++ = augmentation_string[MINIMUM(field[x][y], len)];
1160 /* output lower border */
1162 for (i = 0; i < (FLDSIZE_X - hlen) / 2; i++)
1164 memcpy(p, hash, hlen);
1166 for (i += hlen; i < FLDSIZE_X; i++)
1174 sshkey_fingerprint(const struct sshkey *k, int dgst_alg,
1175 enum sshkey_fp_rep dgst_rep)
1177 char *retval = NULL;
1179 size_t dgst_raw_len;
1181 if (sshkey_fingerprint_raw(k, dgst_alg, &dgst_raw, &dgst_raw_len) != 0)
1184 case SSH_FP_DEFAULT:
1185 if (dgst_alg == SSH_DIGEST_MD5) {
1186 retval = fingerprint_hex(ssh_digest_alg_name(dgst_alg),
1187 dgst_raw, dgst_raw_len);
1189 retval = fingerprint_b64(ssh_digest_alg_name(dgst_alg),
1190 dgst_raw, dgst_raw_len);
1194 retval = fingerprint_hex(ssh_digest_alg_name(dgst_alg),
1195 dgst_raw, dgst_raw_len);
1198 retval = fingerprint_b64(ssh_digest_alg_name(dgst_alg),
1199 dgst_raw, dgst_raw_len);
1201 case SSH_FP_BUBBLEBABBLE:
1202 retval = fingerprint_bubblebabble(dgst_raw, dgst_raw_len);
1204 case SSH_FP_RANDOMART:
1205 retval = fingerprint_randomart(ssh_digest_alg_name(dgst_alg),
1206 dgst_raw, dgst_raw_len, k);
1209 explicit_bzero(dgst_raw, dgst_raw_len);
1213 explicit_bzero(dgst_raw, dgst_raw_len);
1219 peek_type_nid(const char *s, size_t l, int *nid)
1221 const struct keytype *kt;
1223 for (kt = keytypes; kt->type != -1; kt++) {
1224 if (kt->name == NULL || strlen(kt->name) != l)
1226 if (memcmp(s, kt->name, l) == 0) {
1228 if (kt->type == KEY_ECDSA || kt->type == KEY_ECDSA_CERT)
1236 /* XXX this can now be made const char * */
1238 sshkey_read(struct sshkey *ret, char **cpp)
1241 char *cp, *blobcopy;
1243 int r, type, curve_nid = -1;
1244 struct sshbuf *blob;
1247 return SSH_ERR_INVALID_ARGUMENT;
1249 switch (ret->type) {
1256 case KEY_ECDSA_CERT:
1258 case KEY_ED25519_CERT:
1262 #endif /* WITH_XMSS */
1265 return SSH_ERR_INVALID_ARGUMENT;
1270 space = strcspn(cp, " \t");
1271 if (space == strlen(cp))
1272 return SSH_ERR_INVALID_FORMAT;
1273 if ((type = peek_type_nid(cp, space, &curve_nid)) == KEY_UNSPEC)
1274 return SSH_ERR_INVALID_FORMAT;
1276 /* skip whitespace */
1277 for (cp += space; *cp == ' ' || *cp == '\t'; cp++)
1280 return SSH_ERR_INVALID_FORMAT;
1281 if (ret->type != KEY_UNSPEC && ret->type != type)
1282 return SSH_ERR_KEY_TYPE_MISMATCH;
1283 if ((blob = sshbuf_new()) == NULL)
1284 return SSH_ERR_ALLOC_FAIL;
1286 /* find end of keyblob and decode */
1287 space = strcspn(cp, " \t");
1288 if ((blobcopy = strndup(cp, space)) == NULL) {
1290 return SSH_ERR_ALLOC_FAIL;
1292 if ((r = sshbuf_b64tod(blob, blobcopy)) != 0) {
1298 if ((r = sshkey_fromb(blob, &k)) != 0) {
1304 /* skip whitespace and leave cp at start of comment */
1305 for (cp += space; *cp == ' ' || *cp == '\t'; cp++)
1308 /* ensure type of blob matches type at start of line */
1309 if (k->type != type) {
1311 return SSH_ERR_KEY_TYPE_MISMATCH;
1313 if (sshkey_type_plain(type) == KEY_ECDSA && curve_nid != k->ecdsa_nid) {
1315 return SSH_ERR_EC_CURVE_MISMATCH;
1318 /* Fill in ret from parsed key */
1320 if (sshkey_is_cert(ret)) {
1321 if (!sshkey_is_cert(k)) {
1323 return SSH_ERR_EXPECTED_CERT;
1325 if (ret->cert != NULL)
1326 cert_free(ret->cert);
1327 ret->cert = k->cert;
1330 switch (sshkey_type_plain(ret->type)) {
1337 RSA_print_fp(stderr, ret->rsa, 8);
1345 DSA_print_fp(stderr, ret->dsa, 8);
1348 # ifdef OPENSSL_HAS_ECC
1350 EC_KEY_free(ret->ecdsa);
1351 ret->ecdsa = k->ecdsa;
1352 ret->ecdsa_nid = k->ecdsa_nid;
1356 sshkey_dump_ec_key(ret->ecdsa);
1359 # endif /* OPENSSL_HAS_ECC */
1360 #endif /* WITH_OPENSSL */
1362 freezero(ret->ed25519_pk, ED25519_PK_SZ);
1363 ret->ed25519_pk = k->ed25519_pk;
1364 k->ed25519_pk = NULL;
1372 ret->xmss_pk = k->xmss_pk;
1374 free(ret->xmss_state);
1375 ret->xmss_state = k->xmss_state;
1376 k->xmss_state = NULL;
1377 free(ret->xmss_name);
1378 ret->xmss_name = k->xmss_name;
1379 k->xmss_name = NULL;
1380 free(ret->xmss_filename);
1381 ret->xmss_filename = k->xmss_filename;
1382 k->xmss_filename = NULL;
1387 #endif /* WITH_XMSS */
1390 return SSH_ERR_INTERNAL_ERROR;
1401 sshkey_to_base64(const struct sshkey *key, char **b64p)
1403 int r = SSH_ERR_INTERNAL_ERROR;
1404 struct sshbuf *b = NULL;
1409 if ((b = sshbuf_new()) == NULL)
1410 return SSH_ERR_ALLOC_FAIL;
1411 if ((r = sshkey_putb(key, b)) != 0)
1413 if ((uu = sshbuf_dtob64(b)) == NULL) {
1414 r = SSH_ERR_ALLOC_FAIL;
1430 sshkey_format_text(const struct sshkey *key, struct sshbuf *b)
1432 int r = SSH_ERR_INTERNAL_ERROR;
1435 if ((r = sshkey_to_base64(key, &uu)) != 0)
1437 if ((r = sshbuf_putf(b, "%s %s",
1438 sshkey_ssh_name(key), uu)) != 0)
1447 sshkey_write(const struct sshkey *key, FILE *f)
1449 struct sshbuf *b = NULL;
1450 int r = SSH_ERR_INTERNAL_ERROR;
1452 if ((b = sshbuf_new()) == NULL)
1453 return SSH_ERR_ALLOC_FAIL;
1454 if ((r = sshkey_format_text(key, b)) != 0)
1456 if (fwrite(sshbuf_ptr(b), sshbuf_len(b), 1, f) != 1) {
1459 r = SSH_ERR_SYSTEM_ERROR;
1470 sshkey_cert_type(const struct sshkey *k)
1472 switch (k->cert->type) {
1473 case SSH2_CERT_TYPE_USER:
1475 case SSH2_CERT_TYPE_HOST:
1484 rsa_generate_private_key(u_int bits, RSA **rsap)
1486 RSA *private = NULL;
1488 int ret = SSH_ERR_INTERNAL_ERROR;
1491 return SSH_ERR_INVALID_ARGUMENT;
1492 if (bits < SSH_RSA_MINIMUM_MODULUS_SIZE ||
1493 bits > SSHBUF_MAX_BIGNUM * 8)
1494 return SSH_ERR_KEY_LENGTH;
1496 if ((private = RSA_new()) == NULL || (f4 = BN_new()) == NULL) {
1497 ret = SSH_ERR_ALLOC_FAIL;
1500 if (!BN_set_word(f4, RSA_F4) ||
1501 !RSA_generate_key_ex(private, bits, f4, NULL)) {
1502 ret = SSH_ERR_LIBCRYPTO_ERROR;
1515 dsa_generate_private_key(u_int bits, DSA **dsap)
1518 int ret = SSH_ERR_INTERNAL_ERROR;
1521 return SSH_ERR_INVALID_ARGUMENT;
1523 return SSH_ERR_KEY_LENGTH;
1524 if ((private = DSA_new()) == NULL) {
1525 ret = SSH_ERR_ALLOC_FAIL;
1529 if (!DSA_generate_parameters_ex(private, bits, NULL, 0, NULL,
1530 NULL, NULL) || !DSA_generate_key(private)) {
1531 ret = SSH_ERR_LIBCRYPTO_ERROR;
1542 # ifdef OPENSSL_HAS_ECC
1544 sshkey_ecdsa_key_to_nid(EC_KEY *k)
1548 NID_X9_62_prime256v1,
1550 # ifdef OPENSSL_HAS_NISTP521
1552 # endif /* OPENSSL_HAS_NISTP521 */
1558 const EC_GROUP *g = EC_KEY_get0_group(k);
1561 * The group may be stored in a ASN.1 encoded private key in one of two
1562 * ways: as a "named group", which is reconstituted by ASN.1 object ID
1563 * or explicit group parameters encoded into the key blob. Only the
1564 * "named group" case sets the group NID for us, but we can figure
1565 * it out for the other case by comparing against all the groups that
1568 if ((nid = EC_GROUP_get_curve_name(g)) > 0)
1570 if ((bnctx = BN_CTX_new()) == NULL)
1572 for (i = 0; nids[i] != -1; i++) {
1573 if ((eg = EC_GROUP_new_by_curve_name(nids[i])) == NULL) {
1577 if (EC_GROUP_cmp(g, eg, bnctx) == 0)
1582 if (nids[i] != -1) {
1583 /* Use the group with the NID attached */
1584 EC_GROUP_set_asn1_flag(eg, OPENSSL_EC_NAMED_CURVE);
1585 if (EC_KEY_set_group(k, eg) != 1) {
1594 ecdsa_generate_private_key(u_int bits, int *nid, EC_KEY **ecdsap)
1597 int ret = SSH_ERR_INTERNAL_ERROR;
1599 if (nid == NULL || ecdsap == NULL)
1600 return SSH_ERR_INVALID_ARGUMENT;
1601 if ((*nid = sshkey_ecdsa_bits_to_nid(bits)) == -1)
1602 return SSH_ERR_KEY_LENGTH;
1604 if ((private = EC_KEY_new_by_curve_name(*nid)) == NULL) {
1605 ret = SSH_ERR_ALLOC_FAIL;
1608 if (EC_KEY_generate_key(private) != 1) {
1609 ret = SSH_ERR_LIBCRYPTO_ERROR;
1612 EC_KEY_set_asn1_flag(private, OPENSSL_EC_NAMED_CURVE);
1617 EC_KEY_free(private);
1620 # endif /* OPENSSL_HAS_ECC */
1621 #endif /* WITH_OPENSSL */
1624 sshkey_generate(int type, u_int bits, struct sshkey **keyp)
1627 int ret = SSH_ERR_INTERNAL_ERROR;
1630 return SSH_ERR_INVALID_ARGUMENT;
1632 if ((k = sshkey_new(KEY_UNSPEC)) == NULL)
1633 return SSH_ERR_ALLOC_FAIL;
1636 if ((k->ed25519_pk = malloc(ED25519_PK_SZ)) == NULL ||
1637 (k->ed25519_sk = malloc(ED25519_SK_SZ)) == NULL) {
1638 ret = SSH_ERR_ALLOC_FAIL;
1641 crypto_sign_ed25519_keypair(k->ed25519_pk, k->ed25519_sk);
1646 ret = sshkey_xmss_generate_private_key(k, bits);
1648 #endif /* WITH_XMSS */
1651 ret = dsa_generate_private_key(bits, &k->dsa);
1653 # ifdef OPENSSL_HAS_ECC
1655 ret = ecdsa_generate_private_key(bits, &k->ecdsa_nid,
1658 # endif /* OPENSSL_HAS_ECC */
1660 ret = rsa_generate_private_key(bits, &k->rsa);
1662 #endif /* WITH_OPENSSL */
1664 ret = SSH_ERR_INVALID_ARGUMENT;
1675 sshkey_cert_copy(const struct sshkey *from_key, struct sshkey *to_key)
1678 const struct sshkey_cert *from;
1679 struct sshkey_cert *to;
1680 int ret = SSH_ERR_INTERNAL_ERROR;
1682 if (to_key->cert != NULL) {
1683 cert_free(to_key->cert);
1684 to_key->cert = NULL;
1687 if ((from = from_key->cert) == NULL)
1688 return SSH_ERR_INVALID_ARGUMENT;
1690 if ((to = to_key->cert = cert_new()) == NULL)
1691 return SSH_ERR_ALLOC_FAIL;
1693 if ((ret = sshbuf_putb(to->certblob, from->certblob)) != 0 ||
1694 (ret = sshbuf_putb(to->critical, from->critical)) != 0 ||
1695 (ret = sshbuf_putb(to->extensions, from->extensions)) != 0)
1698 to->serial = from->serial;
1699 to->type = from->type;
1700 if (from->key_id == NULL)
1702 else if ((to->key_id = strdup(from->key_id)) == NULL)
1703 return SSH_ERR_ALLOC_FAIL;
1704 to->valid_after = from->valid_after;
1705 to->valid_before = from->valid_before;
1706 if (from->signature_key == NULL)
1707 to->signature_key = NULL;
1708 else if ((ret = sshkey_from_private(from->signature_key,
1709 &to->signature_key)) != 0)
1712 if (from->nprincipals > SSHKEY_CERT_MAX_PRINCIPALS)
1713 return SSH_ERR_INVALID_ARGUMENT;
1714 if (from->nprincipals > 0) {
1715 if ((to->principals = calloc(from->nprincipals,
1716 sizeof(*to->principals))) == NULL)
1717 return SSH_ERR_ALLOC_FAIL;
1718 for (i = 0; i < from->nprincipals; i++) {
1719 to->principals[i] = strdup(from->principals[i]);
1720 if (to->principals[i] == NULL) {
1721 to->nprincipals = i;
1722 return SSH_ERR_ALLOC_FAIL;
1726 to->nprincipals = from->nprincipals;
1731 sshkey_from_private(const struct sshkey *k, struct sshkey **pkp)
1733 struct sshkey *n = NULL;
1734 int ret = SSH_ERR_INTERNAL_ERROR;
1741 if ((n = sshkey_new(k->type)) == NULL)
1742 return SSH_ERR_ALLOC_FAIL;
1743 if ((BN_copy(n->dsa->p, k->dsa->p) == NULL) ||
1744 (BN_copy(n->dsa->q, k->dsa->q) == NULL) ||
1745 (BN_copy(n->dsa->g, k->dsa->g) == NULL) ||
1746 (BN_copy(n->dsa->pub_key, k->dsa->pub_key) == NULL)) {
1748 return SSH_ERR_ALLOC_FAIL;
1751 # ifdef OPENSSL_HAS_ECC
1753 case KEY_ECDSA_CERT:
1754 if ((n = sshkey_new(k->type)) == NULL)
1755 return SSH_ERR_ALLOC_FAIL;
1756 n->ecdsa_nid = k->ecdsa_nid;
1757 n->ecdsa = EC_KEY_new_by_curve_name(k->ecdsa_nid);
1758 if (n->ecdsa == NULL) {
1760 return SSH_ERR_ALLOC_FAIL;
1762 if (EC_KEY_set_public_key(n->ecdsa,
1763 EC_KEY_get0_public_key(k->ecdsa)) != 1) {
1765 return SSH_ERR_LIBCRYPTO_ERROR;
1768 # endif /* OPENSSL_HAS_ECC */
1771 if ((n = sshkey_new(k->type)) == NULL)
1772 return SSH_ERR_ALLOC_FAIL;
1773 if ((BN_copy(n->rsa->n, k->rsa->n) == NULL) ||
1774 (BN_copy(n->rsa->e, k->rsa->e) == NULL)) {
1776 return SSH_ERR_ALLOC_FAIL;
1779 #endif /* WITH_OPENSSL */
1781 case KEY_ED25519_CERT:
1782 if ((n = sshkey_new(k->type)) == NULL)
1783 return SSH_ERR_ALLOC_FAIL;
1784 if (k->ed25519_pk != NULL) {
1785 if ((n->ed25519_pk = malloc(ED25519_PK_SZ)) == NULL) {
1787 return SSH_ERR_ALLOC_FAIL;
1789 memcpy(n->ed25519_pk, k->ed25519_pk, ED25519_PK_SZ);
1795 if ((n = sshkey_new(k->type)) == NULL)
1796 return SSH_ERR_ALLOC_FAIL;
1797 if ((ret = sshkey_xmss_init(n, k->xmss_name)) != 0) {
1801 if (k->xmss_pk != NULL) {
1802 size_t pklen = sshkey_xmss_pklen(k);
1803 if (pklen == 0 || sshkey_xmss_pklen(n) != pklen) {
1805 return SSH_ERR_INTERNAL_ERROR;
1807 if ((n->xmss_pk = malloc(pklen)) == NULL) {
1809 return SSH_ERR_ALLOC_FAIL;
1811 memcpy(n->xmss_pk, k->xmss_pk, pklen);
1814 #endif /* WITH_XMSS */
1816 return SSH_ERR_KEY_TYPE_UNKNOWN;
1818 if (sshkey_is_cert(k)) {
1819 if ((ret = sshkey_cert_copy(k, n)) != 0) {
1829 cert_parse(struct sshbuf *b, struct sshkey *key, struct sshbuf *certbuf)
1831 struct sshbuf *principals = NULL, *crit = NULL;
1832 struct sshbuf *exts = NULL, *ca = NULL;
1834 size_t signed_len = 0, slen = 0, kidlen = 0;
1835 int ret = SSH_ERR_INTERNAL_ERROR;
1837 /* Copy the entire key blob for verification and later serialisation */
1838 if ((ret = sshbuf_putb(key->cert->certblob, certbuf)) != 0)
1841 /* Parse body of certificate up to signature */
1842 if ((ret = sshbuf_get_u64(b, &key->cert->serial)) != 0 ||
1843 (ret = sshbuf_get_u32(b, &key->cert->type)) != 0 ||
1844 (ret = sshbuf_get_cstring(b, &key->cert->key_id, &kidlen)) != 0 ||
1845 (ret = sshbuf_froms(b, &principals)) != 0 ||
1846 (ret = sshbuf_get_u64(b, &key->cert->valid_after)) != 0 ||
1847 (ret = sshbuf_get_u64(b, &key->cert->valid_before)) != 0 ||
1848 (ret = sshbuf_froms(b, &crit)) != 0 ||
1849 (ret = sshbuf_froms(b, &exts)) != 0 ||
1850 (ret = sshbuf_get_string_direct(b, NULL, NULL)) != 0 ||
1851 (ret = sshbuf_froms(b, &ca)) != 0) {
1852 /* XXX debug print error for ret */
1853 ret = SSH_ERR_INVALID_FORMAT;
1857 /* Signature is left in the buffer so we can calculate this length */
1858 signed_len = sshbuf_len(key->cert->certblob) - sshbuf_len(b);
1860 if ((ret = sshbuf_get_string(b, &sig, &slen)) != 0) {
1861 ret = SSH_ERR_INVALID_FORMAT;
1865 if (key->cert->type != SSH2_CERT_TYPE_USER &&
1866 key->cert->type != SSH2_CERT_TYPE_HOST) {
1867 ret = SSH_ERR_KEY_CERT_UNKNOWN_TYPE;
1871 /* Parse principals section */
1872 while (sshbuf_len(principals) > 0) {
1873 char *principal = NULL;
1874 char **oprincipals = NULL;
1876 if (key->cert->nprincipals >= SSHKEY_CERT_MAX_PRINCIPALS) {
1877 ret = SSH_ERR_INVALID_FORMAT;
1880 if ((ret = sshbuf_get_cstring(principals, &principal,
1882 ret = SSH_ERR_INVALID_FORMAT;
1885 oprincipals = key->cert->principals;
1886 key->cert->principals = recallocarray(key->cert->principals,
1887 key->cert->nprincipals, key->cert->nprincipals + 1,
1888 sizeof(*key->cert->principals));
1889 if (key->cert->principals == NULL) {
1891 key->cert->principals = oprincipals;
1892 ret = SSH_ERR_ALLOC_FAIL;
1895 key->cert->principals[key->cert->nprincipals++] = principal;
1899 * Stash a copies of the critical options and extensions sections
1902 if ((ret = sshbuf_putb(key->cert->critical, crit)) != 0 ||
1904 (ret = sshbuf_putb(key->cert->extensions, exts)) != 0))
1908 * Validate critical options and extensions sections format.
1910 while (sshbuf_len(crit) != 0) {
1911 if ((ret = sshbuf_get_string_direct(crit, NULL, NULL)) != 0 ||
1912 (ret = sshbuf_get_string_direct(crit, NULL, NULL)) != 0) {
1913 sshbuf_reset(key->cert->critical);
1914 ret = SSH_ERR_INVALID_FORMAT;
1918 while (exts != NULL && sshbuf_len(exts) != 0) {
1919 if ((ret = sshbuf_get_string_direct(exts, NULL, NULL)) != 0 ||
1920 (ret = sshbuf_get_string_direct(exts, NULL, NULL)) != 0) {
1921 sshbuf_reset(key->cert->extensions);
1922 ret = SSH_ERR_INVALID_FORMAT;
1927 /* Parse CA key and check signature */
1928 if (sshkey_from_blob_internal(ca, &key->cert->signature_key, 0) != 0) {
1929 ret = SSH_ERR_KEY_CERT_INVALID_SIGN_KEY;
1932 if (!sshkey_type_is_valid_ca(key->cert->signature_key->type)) {
1933 ret = SSH_ERR_KEY_CERT_INVALID_SIGN_KEY;
1936 if ((ret = sshkey_verify(key->cert->signature_key, sig, slen,
1937 sshbuf_ptr(key->cert->certblob), signed_len, NULL, 0)) != 0)
1946 sshbuf_free(principals);
1952 sshkey_from_blob_internal(struct sshbuf *b, struct sshkey **keyp,
1955 int type, ret = SSH_ERR_INTERNAL_ERROR;
1956 char *ktype = NULL, *curve = NULL, *xmss_name = NULL;
1957 struct sshkey *key = NULL;
1960 struct sshbuf *copy;
1961 #if defined(WITH_OPENSSL) && defined(OPENSSL_HAS_ECC)
1963 #endif /* WITH_OPENSSL && OPENSSL_HAS_ECC */
1965 #ifdef DEBUG_PK /* XXX */
1966 sshbuf_dump(b, stderr);
1970 if ((copy = sshbuf_fromb(b)) == NULL) {
1971 ret = SSH_ERR_ALLOC_FAIL;
1974 if (sshbuf_get_cstring(b, &ktype, NULL) != 0) {
1975 ret = SSH_ERR_INVALID_FORMAT;
1979 type = sshkey_type_from_name(ktype);
1980 if (!allow_cert && sshkey_type_is_cert(type)) {
1981 ret = SSH_ERR_KEY_CERT_INVALID_SIGN_KEY;
1988 if (sshbuf_get_string_direct(b, NULL, NULL) != 0) {
1989 ret = SSH_ERR_INVALID_FORMAT;
1994 if ((key = sshkey_new(type)) == NULL) {
1995 ret = SSH_ERR_ALLOC_FAIL;
1998 if (sshbuf_get_bignum2(b, key->rsa->e) != 0 ||
1999 sshbuf_get_bignum2(b, key->rsa->n) != 0) {
2000 ret = SSH_ERR_INVALID_FORMAT;
2003 if (BN_num_bits(key->rsa->n) < SSH_RSA_MINIMUM_MODULUS_SIZE) {
2004 ret = SSH_ERR_KEY_LENGTH;
2008 RSA_print_fp(stderr, key->rsa, 8);
2013 if (sshbuf_get_string_direct(b, NULL, NULL) != 0) {
2014 ret = SSH_ERR_INVALID_FORMAT;
2019 if ((key = sshkey_new(type)) == NULL) {
2020 ret = SSH_ERR_ALLOC_FAIL;
2023 if (sshbuf_get_bignum2(b, key->dsa->p) != 0 ||
2024 sshbuf_get_bignum2(b, key->dsa->q) != 0 ||
2025 sshbuf_get_bignum2(b, key->dsa->g) != 0 ||
2026 sshbuf_get_bignum2(b, key->dsa->pub_key) != 0) {
2027 ret = SSH_ERR_INVALID_FORMAT;
2031 DSA_print_fp(stderr, key->dsa, 8);
2034 case KEY_ECDSA_CERT:
2036 if (sshbuf_get_string_direct(b, NULL, NULL) != 0) {
2037 ret = SSH_ERR_INVALID_FORMAT;
2041 # ifdef OPENSSL_HAS_ECC
2043 if ((key = sshkey_new(type)) == NULL) {
2044 ret = SSH_ERR_ALLOC_FAIL;
2047 key->ecdsa_nid = sshkey_ecdsa_nid_from_name(ktype);
2048 if (sshbuf_get_cstring(b, &curve, NULL) != 0) {
2049 ret = SSH_ERR_INVALID_FORMAT;
2052 if (key->ecdsa_nid != sshkey_curve_name_to_nid(curve)) {
2053 ret = SSH_ERR_EC_CURVE_MISMATCH;
2056 EC_KEY_free(key->ecdsa);
2057 if ((key->ecdsa = EC_KEY_new_by_curve_name(key->ecdsa_nid))
2059 ret = SSH_ERR_EC_CURVE_INVALID;
2062 if ((q = EC_POINT_new(EC_KEY_get0_group(key->ecdsa))) == NULL) {
2063 ret = SSH_ERR_ALLOC_FAIL;
2066 if (sshbuf_get_ec(b, q, EC_KEY_get0_group(key->ecdsa)) != 0) {
2067 ret = SSH_ERR_INVALID_FORMAT;
2070 if (sshkey_ec_validate_public(EC_KEY_get0_group(key->ecdsa),
2072 ret = SSH_ERR_KEY_INVALID_EC_VALUE;
2075 if (EC_KEY_set_public_key(key->ecdsa, q) != 1) {
2076 /* XXX assume it is a allocation error */
2077 ret = SSH_ERR_ALLOC_FAIL;
2081 sshkey_dump_ec_point(EC_KEY_get0_group(key->ecdsa), q);
2084 # endif /* OPENSSL_HAS_ECC */
2085 #endif /* WITH_OPENSSL */
2086 case KEY_ED25519_CERT:
2088 if (sshbuf_get_string_direct(b, NULL, NULL) != 0) {
2089 ret = SSH_ERR_INVALID_FORMAT;
2094 if ((ret = sshbuf_get_string(b, &pk, &len)) != 0)
2096 if (len != ED25519_PK_SZ) {
2097 ret = SSH_ERR_INVALID_FORMAT;
2100 if ((key = sshkey_new(type)) == NULL) {
2101 ret = SSH_ERR_ALLOC_FAIL;
2104 key->ed25519_pk = pk;
2110 if (sshbuf_get_string_direct(b, NULL, NULL) != 0) {
2111 ret = SSH_ERR_INVALID_FORMAT;
2116 if ((ret = sshbuf_get_cstring(b, &xmss_name, NULL)) != 0)
2118 if ((key = sshkey_new(type)) == NULL) {
2119 ret = SSH_ERR_ALLOC_FAIL;
2122 if ((ret = sshkey_xmss_init(key, xmss_name)) != 0)
2124 if ((ret = sshbuf_get_string(b, &pk, &len)) != 0)
2126 if (len == 0 || len != sshkey_xmss_pklen(key)) {
2127 ret = SSH_ERR_INVALID_FORMAT;
2132 if (type != KEY_XMSS_CERT &&
2133 (ret = sshkey_xmss_deserialize_pk_info(key, b)) != 0)
2136 #endif /* WITH_XMSS */
2139 ret = SSH_ERR_KEY_TYPE_UNKNOWN;
2143 /* Parse certificate potion */
2144 if (sshkey_is_cert(key) && (ret = cert_parse(b, key, copy)) != 0)
2147 if (key != NULL && sshbuf_len(b) != 0) {
2148 ret = SSH_ERR_INVALID_FORMAT;
2163 #if defined(WITH_OPENSSL) && defined(OPENSSL_HAS_ECC)
2165 #endif /* WITH_OPENSSL && OPENSSL_HAS_ECC */
2170 sshkey_from_blob(const u_char *blob, size_t blen, struct sshkey **keyp)
2175 if ((b = sshbuf_from(blob, blen)) == NULL)
2176 return SSH_ERR_ALLOC_FAIL;
2177 r = sshkey_from_blob_internal(b, keyp, 1);
2183 sshkey_fromb(struct sshbuf *b, struct sshkey **keyp)
2185 return sshkey_from_blob_internal(b, keyp, 1);
2189 sshkey_froms(struct sshbuf *buf, struct sshkey **keyp)
2194 if ((r = sshbuf_froms(buf, &b)) != 0)
2196 r = sshkey_from_blob_internal(b, keyp, 1);
2202 sshkey_sigtype(const u_char *sig, size_t siglen, char **sigtypep)
2205 struct sshbuf *b = NULL;
2206 char *sigtype = NULL;
2208 if (sigtypep != NULL)
2210 if ((b = sshbuf_from(sig, siglen)) == NULL)
2211 return SSH_ERR_ALLOC_FAIL;
2212 if ((r = sshbuf_get_cstring(b, &sigtype, NULL)) != 0)
2215 if (sigtypep != NULL) {
2216 *sigtypep = sigtype;
2227 sshkey_sign(const struct sshkey *key,
2228 u_char **sigp, size_t *lenp,
2229 const u_char *data, size_t datalen, const char *alg, u_int compat)
2235 if (datalen > SSH_KEY_MAX_SIGN_DATA_SIZE)
2236 return SSH_ERR_INVALID_ARGUMENT;
2237 switch (key->type) {
2241 return ssh_dss_sign(key, sigp, lenp, data, datalen, compat);
2242 # ifdef OPENSSL_HAS_ECC
2243 case KEY_ECDSA_CERT:
2245 return ssh_ecdsa_sign(key, sigp, lenp, data, datalen, compat);
2246 # endif /* OPENSSL_HAS_ECC */
2249 return ssh_rsa_sign(key, sigp, lenp, data, datalen, alg);
2250 #endif /* WITH_OPENSSL */
2252 case KEY_ED25519_CERT:
2253 return ssh_ed25519_sign(key, sigp, lenp, data, datalen, compat);
2257 return ssh_xmss_sign(key, sigp, lenp, data, datalen, compat);
2258 #endif /* WITH_XMSS */
2260 return SSH_ERR_KEY_TYPE_UNKNOWN;
2265 * ssh_key_verify returns 0 for a correct signature and < 0 on error.
2266 * If "alg" specified, then the signature must use that algorithm.
2269 sshkey_verify(const struct sshkey *key,
2270 const u_char *sig, size_t siglen,
2271 const u_char *data, size_t dlen, const char *alg, u_int compat)
2273 if (siglen == 0 || dlen > SSH_KEY_MAX_SIGN_DATA_SIZE)
2274 return SSH_ERR_INVALID_ARGUMENT;
2275 switch (key->type) {
2279 return ssh_dss_verify(key, sig, siglen, data, dlen, compat);
2280 # ifdef OPENSSL_HAS_ECC
2281 case KEY_ECDSA_CERT:
2283 return ssh_ecdsa_verify(key, sig, siglen, data, dlen, compat);
2284 # endif /* OPENSSL_HAS_ECC */
2287 return ssh_rsa_verify(key, sig, siglen, data, dlen, alg);
2288 #endif /* WITH_OPENSSL */
2290 case KEY_ED25519_CERT:
2291 return ssh_ed25519_verify(key, sig, siglen, data, dlen, compat);
2295 return ssh_xmss_verify(key, sig, siglen, data, dlen, compat);
2296 #endif /* WITH_XMSS */
2298 return SSH_ERR_KEY_TYPE_UNKNOWN;
2302 /* Converts a private to a public key */
2304 sshkey_demote(const struct sshkey *k, struct sshkey **dkp)
2307 int ret = SSH_ERR_INTERNAL_ERROR;
2310 if ((pk = calloc(1, sizeof(*pk))) == NULL)
2311 return SSH_ERR_ALLOC_FAIL;
2313 pk->flags = k->flags;
2314 pk->ecdsa_nid = k->ecdsa_nid;
2318 pk->ed25519_pk = NULL;
2319 pk->ed25519_sk = NULL;
2326 if ((ret = sshkey_cert_copy(k, pk)) != 0)
2330 if ((pk->rsa = RSA_new()) == NULL ||
2331 (pk->rsa->e = BN_dup(k->rsa->e)) == NULL ||
2332 (pk->rsa->n = BN_dup(k->rsa->n)) == NULL) {
2333 ret = SSH_ERR_ALLOC_FAIL;
2338 if ((ret = sshkey_cert_copy(k, pk)) != 0)
2342 if ((pk->dsa = DSA_new()) == NULL ||
2343 (pk->dsa->p = BN_dup(k->dsa->p)) == NULL ||
2344 (pk->dsa->q = BN_dup(k->dsa->q)) == NULL ||
2345 (pk->dsa->g = BN_dup(k->dsa->g)) == NULL ||
2346 (pk->dsa->pub_key = BN_dup(k->dsa->pub_key)) == NULL) {
2347 ret = SSH_ERR_ALLOC_FAIL;
2351 case KEY_ECDSA_CERT:
2352 if ((ret = sshkey_cert_copy(k, pk)) != 0)
2355 # ifdef OPENSSL_HAS_ECC
2357 pk->ecdsa = EC_KEY_new_by_curve_name(pk->ecdsa_nid);
2358 if (pk->ecdsa == NULL) {
2359 ret = SSH_ERR_ALLOC_FAIL;
2362 if (EC_KEY_set_public_key(pk->ecdsa,
2363 EC_KEY_get0_public_key(k->ecdsa)) != 1) {
2364 ret = SSH_ERR_LIBCRYPTO_ERROR;
2368 # endif /* OPENSSL_HAS_ECC */
2369 #endif /* WITH_OPENSSL */
2370 case KEY_ED25519_CERT:
2371 if ((ret = sshkey_cert_copy(k, pk)) != 0)
2375 if (k->ed25519_pk != NULL) {
2376 if ((pk->ed25519_pk = malloc(ED25519_PK_SZ)) == NULL) {
2377 ret = SSH_ERR_ALLOC_FAIL;
2380 memcpy(pk->ed25519_pk, k->ed25519_pk, ED25519_PK_SZ);
2385 if ((ret = sshkey_cert_copy(k, pk)) != 0)
2389 if ((ret = sshkey_xmss_init(pk, k->xmss_name)) != 0)
2391 if (k->xmss_pk != NULL) {
2392 size_t pklen = sshkey_xmss_pklen(k);
2394 if (pklen == 0 || sshkey_xmss_pklen(pk) != pklen) {
2395 ret = SSH_ERR_INTERNAL_ERROR;
2398 if ((pk->xmss_pk = malloc(pklen)) == NULL) {
2399 ret = SSH_ERR_ALLOC_FAIL;
2402 memcpy(pk->xmss_pk, k->xmss_pk, pklen);
2405 #endif /* WITH_XMSS */
2407 ret = SSH_ERR_KEY_TYPE_UNKNOWN;
2416 /* Convert a plain key to their _CERT equivalent */
2418 sshkey_to_certified(struct sshkey *k)
2425 newtype = KEY_RSA_CERT;
2428 newtype = KEY_DSA_CERT;
2431 newtype = KEY_ECDSA_CERT;
2433 #endif /* WITH_OPENSSL */
2435 newtype = KEY_ED25519_CERT;
2439 newtype = KEY_XMSS_CERT;
2441 #endif /* WITH_XMSS */
2443 return SSH_ERR_INVALID_ARGUMENT;
2445 if ((k->cert = cert_new()) == NULL)
2446 return SSH_ERR_ALLOC_FAIL;
2451 /* Convert a certificate to its raw key equivalent */
2453 sshkey_drop_cert(struct sshkey *k)
2455 if (!sshkey_type_is_cert(k->type))
2456 return SSH_ERR_KEY_TYPE_UNKNOWN;
2459 k->type = sshkey_type_plain(k->type);
2463 /* Sign a certified key, (re-)generating the signed certblob. */
2465 sshkey_certify_custom(struct sshkey *k, struct sshkey *ca, const char *alg,
2466 sshkey_certify_signer *signer, void *signer_ctx)
2468 struct sshbuf *principals = NULL;
2469 u_char *ca_blob = NULL, *sig_blob = NULL, nonce[32];
2470 size_t i, ca_len, sig_len;
2471 int ret = SSH_ERR_INTERNAL_ERROR;
2472 struct sshbuf *cert;
2474 if (k == NULL || k->cert == NULL ||
2475 k->cert->certblob == NULL || ca == NULL)
2476 return SSH_ERR_INVALID_ARGUMENT;
2477 if (!sshkey_is_cert(k))
2478 return SSH_ERR_KEY_TYPE_UNKNOWN;
2479 if (!sshkey_type_is_valid_ca(ca->type))
2480 return SSH_ERR_KEY_CERT_INVALID_SIGN_KEY;
2482 if ((ret = sshkey_to_blob(ca, &ca_blob, &ca_len)) != 0)
2483 return SSH_ERR_KEY_CERT_INVALID_SIGN_KEY;
2485 cert = k->cert->certblob; /* for readability */
2487 if ((ret = sshbuf_put_cstring(cert, sshkey_ssh_name(k))) != 0)
2490 /* -v01 certs put nonce first */
2491 arc4random_buf(&nonce, sizeof(nonce));
2492 if ((ret = sshbuf_put_string(cert, nonce, sizeof(nonce))) != 0)
2495 /* XXX this substantially duplicates to_blob(); refactor */
2499 if ((ret = sshbuf_put_bignum2(cert, k->dsa->p)) != 0 ||
2500 (ret = sshbuf_put_bignum2(cert, k->dsa->q)) != 0 ||
2501 (ret = sshbuf_put_bignum2(cert, k->dsa->g)) != 0 ||
2502 (ret = sshbuf_put_bignum2(cert, k->dsa->pub_key)) != 0)
2505 # ifdef OPENSSL_HAS_ECC
2506 case KEY_ECDSA_CERT:
2507 if ((ret = sshbuf_put_cstring(cert,
2508 sshkey_curve_nid_to_name(k->ecdsa_nid))) != 0 ||
2509 (ret = sshbuf_put_ec(cert,
2510 EC_KEY_get0_public_key(k->ecdsa),
2511 EC_KEY_get0_group(k->ecdsa))) != 0)
2514 # endif /* OPENSSL_HAS_ECC */
2516 if ((ret = sshbuf_put_bignum2(cert, k->rsa->e)) != 0 ||
2517 (ret = sshbuf_put_bignum2(cert, k->rsa->n)) != 0)
2520 #endif /* WITH_OPENSSL */
2521 case KEY_ED25519_CERT:
2522 if ((ret = sshbuf_put_string(cert,
2523 k->ed25519_pk, ED25519_PK_SZ)) != 0)
2528 if (k->xmss_name == NULL) {
2529 ret = SSH_ERR_INVALID_ARGUMENT;
2532 if ((ret = sshbuf_put_cstring(cert, k->xmss_name)) ||
2533 (ret = sshbuf_put_string(cert,
2534 k->xmss_pk, sshkey_xmss_pklen(k))) != 0)
2537 #endif /* WITH_XMSS */
2539 ret = SSH_ERR_INVALID_ARGUMENT;
2543 if ((ret = sshbuf_put_u64(cert, k->cert->serial)) != 0 ||
2544 (ret = sshbuf_put_u32(cert, k->cert->type)) != 0 ||
2545 (ret = sshbuf_put_cstring(cert, k->cert->key_id)) != 0)
2548 if ((principals = sshbuf_new()) == NULL) {
2549 ret = SSH_ERR_ALLOC_FAIL;
2552 for (i = 0; i < k->cert->nprincipals; i++) {
2553 if ((ret = sshbuf_put_cstring(principals,
2554 k->cert->principals[i])) != 0)
2557 if ((ret = sshbuf_put_stringb(cert, principals)) != 0 ||
2558 (ret = sshbuf_put_u64(cert, k->cert->valid_after)) != 0 ||
2559 (ret = sshbuf_put_u64(cert, k->cert->valid_before)) != 0 ||
2560 (ret = sshbuf_put_stringb(cert, k->cert->critical)) != 0 ||
2561 (ret = sshbuf_put_stringb(cert, k->cert->extensions)) != 0 ||
2562 (ret = sshbuf_put_string(cert, NULL, 0)) != 0 || /* Reserved */
2563 (ret = sshbuf_put_string(cert, ca_blob, ca_len)) != 0)
2566 /* Sign the whole mess */
2567 if ((ret = signer(ca, &sig_blob, &sig_len, sshbuf_ptr(cert),
2568 sshbuf_len(cert), alg, 0, signer_ctx)) != 0)
2571 /* Append signature and we are done */
2572 if ((ret = sshbuf_put_string(cert, sig_blob, sig_len)) != 0)
2580 sshbuf_free(principals);
2585 default_key_sign(const struct sshkey *key, u_char **sigp, size_t *lenp,
2586 const u_char *data, size_t datalen,
2587 const char *alg, u_int compat, void *ctx)
2590 return SSH_ERR_INVALID_ARGUMENT;
2591 return sshkey_sign(key, sigp, lenp, data, datalen, alg, compat);
2595 sshkey_certify(struct sshkey *k, struct sshkey *ca, const char *alg)
2597 return sshkey_certify_custom(k, ca, alg, default_key_sign, NULL);
2601 sshkey_cert_check_authority(const struct sshkey *k,
2602 int want_host, int require_principal,
2603 const char *name, const char **reason)
2605 u_int i, principal_matches;
2606 time_t now = time(NULL);
2612 if (k->cert->type != SSH2_CERT_TYPE_HOST) {
2613 *reason = "Certificate invalid: not a host certificate";
2614 return SSH_ERR_KEY_CERT_INVALID;
2617 if (k->cert->type != SSH2_CERT_TYPE_USER) {
2618 *reason = "Certificate invalid: not a user certificate";
2619 return SSH_ERR_KEY_CERT_INVALID;
2623 /* yikes - system clock before epoch! */
2624 *reason = "Certificate invalid: not yet valid";
2625 return SSH_ERR_KEY_CERT_INVALID;
2627 if ((u_int64_t)now < k->cert->valid_after) {
2628 *reason = "Certificate invalid: not yet valid";
2629 return SSH_ERR_KEY_CERT_INVALID;
2631 if ((u_int64_t)now >= k->cert->valid_before) {
2632 *reason = "Certificate invalid: expired";
2633 return SSH_ERR_KEY_CERT_INVALID;
2635 if (k->cert->nprincipals == 0) {
2636 if (require_principal) {
2637 *reason = "Certificate lacks principal list";
2638 return SSH_ERR_KEY_CERT_INVALID;
2640 } else if (name != NULL) {
2641 principal_matches = 0;
2642 for (i = 0; i < k->cert->nprincipals; i++) {
2643 if (strcmp(name, k->cert->principals[i]) == 0) {
2644 principal_matches = 1;
2648 if (!principal_matches) {
2649 *reason = "Certificate invalid: name is not a listed "
2651 return SSH_ERR_KEY_CERT_INVALID;
2658 sshkey_format_cert_validity(const struct sshkey_cert *cert, char *s, size_t l)
2660 char from[32], to[32], ret[64];
2665 if (cert->valid_after == 0 &&
2666 cert->valid_before == 0xffffffffffffffffULL)
2667 return strlcpy(s, "forever", l);
2669 if (cert->valid_after != 0) {
2670 /* XXX revisit INT_MAX in 2038 :) */
2671 tt = cert->valid_after > INT_MAX ?
2672 INT_MAX : cert->valid_after;
2673 tm = localtime(&tt);
2674 strftime(from, sizeof(from), "%Y-%m-%dT%H:%M:%S", tm);
2676 if (cert->valid_before != 0xffffffffffffffffULL) {
2677 /* XXX revisit INT_MAX in 2038 :) */
2678 tt = cert->valid_before > INT_MAX ?
2679 INT_MAX : cert->valid_before;
2680 tm = localtime(&tt);
2681 strftime(to, sizeof(to), "%Y-%m-%dT%H:%M:%S", tm);
2684 if (cert->valid_after == 0)
2685 snprintf(ret, sizeof(ret), "before %s", to);
2686 else if (cert->valid_before == 0xffffffffffffffffULL)
2687 snprintf(ret, sizeof(ret), "after %s", from);
2689 snprintf(ret, sizeof(ret), "from %s to %s", from, to);
2691 return strlcpy(s, ret, l);
2695 sshkey_private_serialize_opt(const struct sshkey *key, struct sshbuf *b,
2696 enum sshkey_serialize_rep opts)
2698 int r = SSH_ERR_INTERNAL_ERROR;
2700 if ((r = sshbuf_put_cstring(b, sshkey_ssh_name(key))) != 0)
2702 switch (key->type) {
2705 if ((r = sshbuf_put_bignum2(b, key->rsa->n)) != 0 ||
2706 (r = sshbuf_put_bignum2(b, key->rsa->e)) != 0 ||
2707 (r = sshbuf_put_bignum2(b, key->rsa->d)) != 0 ||
2708 (r = sshbuf_put_bignum2(b, key->rsa->iqmp)) != 0 ||
2709 (r = sshbuf_put_bignum2(b, key->rsa->p)) != 0 ||
2710 (r = sshbuf_put_bignum2(b, key->rsa->q)) != 0)
2714 if (key->cert == NULL || sshbuf_len(key->cert->certblob) == 0) {
2715 r = SSH_ERR_INVALID_ARGUMENT;
2718 if ((r = sshbuf_put_stringb(b, key->cert->certblob)) != 0 ||
2719 (r = sshbuf_put_bignum2(b, key->rsa->d)) != 0 ||
2720 (r = sshbuf_put_bignum2(b, key->rsa->iqmp)) != 0 ||
2721 (r = sshbuf_put_bignum2(b, key->rsa->p)) != 0 ||
2722 (r = sshbuf_put_bignum2(b, key->rsa->q)) != 0)
2726 if ((r = sshbuf_put_bignum2(b, key->dsa->p)) != 0 ||
2727 (r = sshbuf_put_bignum2(b, key->dsa->q)) != 0 ||
2728 (r = sshbuf_put_bignum2(b, key->dsa->g)) != 0 ||
2729 (r = sshbuf_put_bignum2(b, key->dsa->pub_key)) != 0 ||
2730 (r = sshbuf_put_bignum2(b, key->dsa->priv_key)) != 0)
2734 if (key->cert == NULL || sshbuf_len(key->cert->certblob) == 0) {
2735 r = SSH_ERR_INVALID_ARGUMENT;
2738 if ((r = sshbuf_put_stringb(b, key->cert->certblob)) != 0 ||
2739 (r = sshbuf_put_bignum2(b, key->dsa->priv_key)) != 0)
2742 # ifdef OPENSSL_HAS_ECC
2744 if ((r = sshbuf_put_cstring(b,
2745 sshkey_curve_nid_to_name(key->ecdsa_nid))) != 0 ||
2746 (r = sshbuf_put_eckey(b, key->ecdsa)) != 0 ||
2747 (r = sshbuf_put_bignum2(b,
2748 EC_KEY_get0_private_key(key->ecdsa))) != 0)
2751 case KEY_ECDSA_CERT:
2752 if (key->cert == NULL || sshbuf_len(key->cert->certblob) == 0) {
2753 r = SSH_ERR_INVALID_ARGUMENT;
2756 if ((r = sshbuf_put_stringb(b, key->cert->certblob)) != 0 ||
2757 (r = sshbuf_put_bignum2(b,
2758 EC_KEY_get0_private_key(key->ecdsa))) != 0)
2761 # endif /* OPENSSL_HAS_ECC */
2762 #endif /* WITH_OPENSSL */
2764 if ((r = sshbuf_put_string(b, key->ed25519_pk,
2765 ED25519_PK_SZ)) != 0 ||
2766 (r = sshbuf_put_string(b, key->ed25519_sk,
2767 ED25519_SK_SZ)) != 0)
2770 case KEY_ED25519_CERT:
2771 if (key->cert == NULL || sshbuf_len(key->cert->certblob) == 0) {
2772 r = SSH_ERR_INVALID_ARGUMENT;
2775 if ((r = sshbuf_put_stringb(b, key->cert->certblob)) != 0 ||
2776 (r = sshbuf_put_string(b, key->ed25519_pk,
2777 ED25519_PK_SZ)) != 0 ||
2778 (r = sshbuf_put_string(b, key->ed25519_sk,
2779 ED25519_SK_SZ)) != 0)
2784 if (key->xmss_name == NULL) {
2785 r = SSH_ERR_INVALID_ARGUMENT;
2788 if ((r = sshbuf_put_cstring(b, key->xmss_name)) != 0 ||
2789 (r = sshbuf_put_string(b, key->xmss_pk,
2790 sshkey_xmss_pklen(key))) != 0 ||
2791 (r = sshbuf_put_string(b, key->xmss_sk,
2792 sshkey_xmss_sklen(key))) != 0 ||
2793 (r = sshkey_xmss_serialize_state_opt(key, b, opts)) != 0)
2797 if (key->cert == NULL || sshbuf_len(key->cert->certblob) == 0 ||
2798 key->xmss_name == NULL) {
2799 r = SSH_ERR_INVALID_ARGUMENT;
2802 if ((r = sshbuf_put_stringb(b, key->cert->certblob)) != 0 ||
2803 (r = sshbuf_put_cstring(b, key->xmss_name)) != 0 ||
2804 (r = sshbuf_put_string(b, key->xmss_pk,
2805 sshkey_xmss_pklen(key))) != 0 ||
2806 (r = sshbuf_put_string(b, key->xmss_sk,
2807 sshkey_xmss_sklen(key))) != 0 ||
2808 (r = sshkey_xmss_serialize_state_opt(key, b, opts)) != 0)
2811 #endif /* WITH_XMSS */
2813 r = SSH_ERR_INVALID_ARGUMENT;
2823 sshkey_private_serialize(const struct sshkey *key, struct sshbuf *b)
2825 return sshkey_private_serialize_opt(key, b,
2826 SSHKEY_SERIALIZE_DEFAULT);
2830 sshkey_private_deserialize(struct sshbuf *buf, struct sshkey **kp)
2832 char *tname = NULL, *curve = NULL, *xmss_name = NULL;
2833 struct sshkey *k = NULL;
2834 size_t pklen = 0, sklen = 0;
2835 int type, r = SSH_ERR_INTERNAL_ERROR;
2836 u_char *ed25519_pk = NULL, *ed25519_sk = NULL;
2837 u_char *xmss_pk = NULL, *xmss_sk = NULL;
2839 BIGNUM *exponent = NULL;
2840 #endif /* WITH_OPENSSL */
2844 if ((r = sshbuf_get_cstring(buf, &tname, NULL)) != 0)
2846 type = sshkey_type_from_name(tname);
2850 if ((k = sshkey_new_private(type)) == NULL) {
2851 r = SSH_ERR_ALLOC_FAIL;
2854 if ((r = sshbuf_get_bignum2(buf, k->dsa->p)) != 0 ||
2855 (r = sshbuf_get_bignum2(buf, k->dsa->q)) != 0 ||
2856 (r = sshbuf_get_bignum2(buf, k->dsa->g)) != 0 ||
2857 (r = sshbuf_get_bignum2(buf, k->dsa->pub_key)) != 0 ||
2858 (r = sshbuf_get_bignum2(buf, k->dsa->priv_key)) != 0)
2862 if ((r = sshkey_froms(buf, &k)) != 0 ||
2863 (r = sshkey_add_private(k)) != 0 ||
2864 (r = sshbuf_get_bignum2(buf, k->dsa->priv_key)) != 0)
2867 # ifdef OPENSSL_HAS_ECC
2869 if ((k = sshkey_new_private(type)) == NULL) {
2870 r = SSH_ERR_ALLOC_FAIL;
2873 if ((k->ecdsa_nid = sshkey_ecdsa_nid_from_name(tname)) == -1) {
2874 r = SSH_ERR_INVALID_ARGUMENT;
2877 if ((r = sshbuf_get_cstring(buf, &curve, NULL)) != 0)
2879 if (k->ecdsa_nid != sshkey_curve_name_to_nid(curve)) {
2880 r = SSH_ERR_EC_CURVE_MISMATCH;
2883 k->ecdsa = EC_KEY_new_by_curve_name(k->ecdsa_nid);
2884 if (k->ecdsa == NULL || (exponent = BN_new()) == NULL) {
2885 r = SSH_ERR_LIBCRYPTO_ERROR;
2888 if ((r = sshbuf_get_eckey(buf, k->ecdsa)) != 0 ||
2889 (r = sshbuf_get_bignum2(buf, exponent)))
2891 if (EC_KEY_set_private_key(k->ecdsa, exponent) != 1) {
2892 r = SSH_ERR_LIBCRYPTO_ERROR;
2895 if ((r = sshkey_ec_validate_public(EC_KEY_get0_group(k->ecdsa),
2896 EC_KEY_get0_public_key(k->ecdsa))) != 0 ||
2897 (r = sshkey_ec_validate_private(k->ecdsa)) != 0)
2900 case KEY_ECDSA_CERT:
2901 if ((exponent = BN_new()) == NULL) {
2902 r = SSH_ERR_LIBCRYPTO_ERROR;
2905 if ((r = sshkey_froms(buf, &k)) != 0 ||
2906 (r = sshkey_add_private(k)) != 0 ||
2907 (r = sshbuf_get_bignum2(buf, exponent)) != 0)
2909 if (EC_KEY_set_private_key(k->ecdsa, exponent) != 1) {
2910 r = SSH_ERR_LIBCRYPTO_ERROR;
2913 if ((r = sshkey_ec_validate_public(EC_KEY_get0_group(k->ecdsa),
2914 EC_KEY_get0_public_key(k->ecdsa))) != 0 ||
2915 (r = sshkey_ec_validate_private(k->ecdsa)) != 0)
2918 # endif /* OPENSSL_HAS_ECC */
2920 if ((k = sshkey_new_private(type)) == NULL) {
2921 r = SSH_ERR_ALLOC_FAIL;
2924 if ((r = sshbuf_get_bignum2(buf, k->rsa->n)) != 0 ||
2925 (r = sshbuf_get_bignum2(buf, k->rsa->e)) != 0 ||
2926 (r = sshbuf_get_bignum2(buf, k->rsa->d)) != 0 ||
2927 (r = sshbuf_get_bignum2(buf, k->rsa->iqmp)) != 0 ||
2928 (r = sshbuf_get_bignum2(buf, k->rsa->p)) != 0 ||
2929 (r = sshbuf_get_bignum2(buf, k->rsa->q)) != 0 ||
2930 (r = ssh_rsa_generate_additional_parameters(k)) != 0)
2932 if (BN_num_bits(k->rsa->n) < SSH_RSA_MINIMUM_MODULUS_SIZE) {
2933 r = SSH_ERR_KEY_LENGTH;
2938 if ((r = sshkey_froms(buf, &k)) != 0 ||
2939 (r = sshkey_add_private(k)) != 0 ||
2940 (r = sshbuf_get_bignum2(buf, k->rsa->d)) != 0 ||
2941 (r = sshbuf_get_bignum2(buf, k->rsa->iqmp)) != 0 ||
2942 (r = sshbuf_get_bignum2(buf, k->rsa->p)) != 0 ||
2943 (r = sshbuf_get_bignum2(buf, k->rsa->q)) != 0 ||
2944 (r = ssh_rsa_generate_additional_parameters(k)) != 0)
2946 if (BN_num_bits(k->rsa->n) < SSH_RSA_MINIMUM_MODULUS_SIZE) {
2947 r = SSH_ERR_KEY_LENGTH;
2951 #endif /* WITH_OPENSSL */
2953 if ((k = sshkey_new_private(type)) == NULL) {
2954 r = SSH_ERR_ALLOC_FAIL;
2957 if ((r = sshbuf_get_string(buf, &ed25519_pk, &pklen)) != 0 ||
2958 (r = sshbuf_get_string(buf, &ed25519_sk, &sklen)) != 0)
2960 if (pklen != ED25519_PK_SZ || sklen != ED25519_SK_SZ) {
2961 r = SSH_ERR_INVALID_FORMAT;
2964 k->ed25519_pk = ed25519_pk;
2965 k->ed25519_sk = ed25519_sk;
2966 ed25519_pk = ed25519_sk = NULL;
2968 case KEY_ED25519_CERT:
2969 if ((r = sshkey_froms(buf, &k)) != 0 ||
2970 (r = sshkey_add_private(k)) != 0 ||
2971 (r = sshbuf_get_string(buf, &ed25519_pk, &pklen)) != 0 ||
2972 (r = sshbuf_get_string(buf, &ed25519_sk, &sklen)) != 0)
2974 if (pklen != ED25519_PK_SZ || sklen != ED25519_SK_SZ) {
2975 r = SSH_ERR_INVALID_FORMAT;
2978 k->ed25519_pk = ed25519_pk;
2979 k->ed25519_sk = ed25519_sk;
2980 ed25519_pk = ed25519_sk = NULL;
2984 if ((k = sshkey_new_private(type)) == NULL) {
2985 r = SSH_ERR_ALLOC_FAIL;
2988 if ((r = sshbuf_get_cstring(buf, &xmss_name, NULL)) != 0 ||
2989 (r = sshkey_xmss_init(k, xmss_name)) != 0 ||
2990 (r = sshbuf_get_string(buf, &xmss_pk, &pklen)) != 0 ||
2991 (r = sshbuf_get_string(buf, &xmss_sk, &sklen)) != 0)
2993 if (pklen != sshkey_xmss_pklen(k) ||
2994 sklen != sshkey_xmss_sklen(k)) {
2995 r = SSH_ERR_INVALID_FORMAT;
2998 k->xmss_pk = xmss_pk;
2999 k->xmss_sk = xmss_sk;
3000 xmss_pk = xmss_sk = NULL;
3001 /* optional internal state */
3002 if ((r = sshkey_xmss_deserialize_state_opt(k, buf)) != 0)
3006 if ((r = sshkey_froms(buf, &k)) != 0 ||
3007 (r = sshkey_add_private(k)) != 0 ||
3008 (r = sshbuf_get_cstring(buf, &xmss_name, NULL)) != 0 ||
3009 (r = sshbuf_get_string(buf, &xmss_pk, &pklen)) != 0 ||
3010 (r = sshbuf_get_string(buf, &xmss_sk, &sklen)) != 0)
3012 if (strcmp(xmss_name, k->xmss_name)) {
3013 r = SSH_ERR_INVALID_FORMAT;
3016 if (pklen != sshkey_xmss_pklen(k) ||
3017 sklen != sshkey_xmss_sklen(k)) {
3018 r = SSH_ERR_INVALID_FORMAT;
3021 k->xmss_pk = xmss_pk;
3022 k->xmss_sk = xmss_sk;
3023 xmss_pk = xmss_sk = NULL;
3024 /* optional internal state */
3025 if ((r = sshkey_xmss_deserialize_state_opt(k, buf)) != 0)
3028 #endif /* WITH_XMSS */
3030 r = SSH_ERR_KEY_TYPE_UNKNOWN;
3034 /* enable blinding */
3038 if (RSA_blinding_on(k->rsa, NULL) != 1) {
3039 r = SSH_ERR_LIBCRYPTO_ERROR;
3044 #endif /* WITH_OPENSSL */
3055 BN_clear_free(exponent);
3056 #endif /* WITH_OPENSSL */
3058 freezero(ed25519_pk, pklen);
3059 freezero(ed25519_sk, sklen);
3061 freezero(xmss_pk, pklen);
3062 freezero(xmss_sk, sklen);
3066 #if defined(WITH_OPENSSL) && defined(OPENSSL_HAS_ECC)
3068 sshkey_ec_validate_public(const EC_GROUP *group, const EC_POINT *public)
3071 EC_POINT *nq = NULL;
3072 BIGNUM *order, *x, *y, *tmp;
3073 int ret = SSH_ERR_KEY_INVALID_EC_VALUE;
3076 * NB. This assumes OpenSSL has already verified that the public
3077 * point lies on the curve. This is done by EC_POINT_oct2point()
3078 * implicitly calling EC_POINT_is_on_curve(). If this code is ever
3079 * reachable with public points not unmarshalled using
3080 * EC_POINT_oct2point then the caller will need to explicitly check.
3083 if ((bnctx = BN_CTX_new()) == NULL)
3084 return SSH_ERR_ALLOC_FAIL;
3085 BN_CTX_start(bnctx);
3088 * We shouldn't ever hit this case because bignum_get_ecpoint()
3089 * refuses to load GF2m points.
3091 if (EC_METHOD_get_field_type(EC_GROUP_method_of(group)) !=
3092 NID_X9_62_prime_field)
3096 if (EC_POINT_is_at_infinity(group, public))
3099 if ((x = BN_CTX_get(bnctx)) == NULL ||
3100 (y = BN_CTX_get(bnctx)) == NULL ||
3101 (order = BN_CTX_get(bnctx)) == NULL ||
3102 (tmp = BN_CTX_get(bnctx)) == NULL) {
3103 ret = SSH_ERR_ALLOC_FAIL;
3107 /* log2(x) > log2(order)/2, log2(y) > log2(order)/2 */
3108 if (EC_GROUP_get_order(group, order, bnctx) != 1 ||
3109 EC_POINT_get_affine_coordinates_GFp(group, public,
3110 x, y, bnctx) != 1) {
3111 ret = SSH_ERR_LIBCRYPTO_ERROR;
3114 if (BN_num_bits(x) <= BN_num_bits(order) / 2 ||
3115 BN_num_bits(y) <= BN_num_bits(order) / 2)
3118 /* nQ == infinity (n == order of subgroup) */
3119 if ((nq = EC_POINT_new(group)) == NULL) {
3120 ret = SSH_ERR_ALLOC_FAIL;
3123 if (EC_POINT_mul(group, nq, NULL, public, order, bnctx) != 1) {
3124 ret = SSH_ERR_LIBCRYPTO_ERROR;
3127 if (EC_POINT_is_at_infinity(group, nq) != 1)
3130 /* x < order - 1, y < order - 1 */
3131 if (!BN_sub(tmp, order, BN_value_one())) {
3132 ret = SSH_ERR_LIBCRYPTO_ERROR;
3135 if (BN_cmp(x, tmp) >= 0 || BN_cmp(y, tmp) >= 0)
3145 sshkey_ec_validate_private(const EC_KEY *key)
3148 BIGNUM *order, *tmp;
3149 int ret = SSH_ERR_KEY_INVALID_EC_VALUE;
3151 if ((bnctx = BN_CTX_new()) == NULL)
3152 return SSH_ERR_ALLOC_FAIL;
3153 BN_CTX_start(bnctx);
3155 if ((order = BN_CTX_get(bnctx)) == NULL ||
3156 (tmp = BN_CTX_get(bnctx)) == NULL) {
3157 ret = SSH_ERR_ALLOC_FAIL;
3161 /* log2(private) > log2(order)/2 */
3162 if (EC_GROUP_get_order(EC_KEY_get0_group(key), order, bnctx) != 1) {
3163 ret = SSH_ERR_LIBCRYPTO_ERROR;
3166 if (BN_num_bits(EC_KEY_get0_private_key(key)) <=
3167 BN_num_bits(order) / 2)
3170 /* private < order - 1 */
3171 if (!BN_sub(tmp, order, BN_value_one())) {
3172 ret = SSH_ERR_LIBCRYPTO_ERROR;
3175 if (BN_cmp(EC_KEY_get0_private_key(key), tmp) >= 0)
3184 sshkey_dump_ec_point(const EC_GROUP *group, const EC_POINT *point)
3189 if (point == NULL) {
3190 fputs("point=(NULL)\n", stderr);
3193 if ((bnctx = BN_CTX_new()) == NULL) {
3194 fprintf(stderr, "%s: BN_CTX_new failed\n", __func__);
3197 BN_CTX_start(bnctx);
3198 if ((x = BN_CTX_get(bnctx)) == NULL ||
3199 (y = BN_CTX_get(bnctx)) == NULL) {
3200 fprintf(stderr, "%s: BN_CTX_get failed\n", __func__);
3203 if (EC_METHOD_get_field_type(EC_GROUP_method_of(group)) !=
3204 NID_X9_62_prime_field) {
3205 fprintf(stderr, "%s: group is not a prime field\n", __func__);
3208 if (EC_POINT_get_affine_coordinates_GFp(group, point, x, y,
3210 fprintf(stderr, "%s: EC_POINT_get_affine_coordinates_GFp\n",
3214 fputs("x=", stderr);
3215 BN_print_fp(stderr, x);
3216 fputs("\ny=", stderr);
3217 BN_print_fp(stderr, y);
3218 fputs("\n", stderr);
3223 sshkey_dump_ec_key(const EC_KEY *key)
3225 const BIGNUM *exponent;
3227 sshkey_dump_ec_point(EC_KEY_get0_group(key),
3228 EC_KEY_get0_public_key(key));
3229 fputs("exponent=", stderr);
3230 if ((exponent = EC_KEY_get0_private_key(key)) == NULL)
3231 fputs("(NULL)", stderr);
3233 BN_print_fp(stderr, EC_KEY_get0_private_key(key));
3234 fputs("\n", stderr);
3236 #endif /* WITH_OPENSSL && OPENSSL_HAS_ECC */
3239 sshkey_private_to_blob2(const struct sshkey *prv, struct sshbuf *blob,
3240 const char *passphrase, const char *comment, const char *ciphername,
3243 u_char *cp, *key = NULL, *pubkeyblob = NULL;
3244 u_char salt[SALT_LEN];
3246 size_t i, pubkeylen, keylen, ivlen, blocksize, authlen;
3248 int r = SSH_ERR_INTERNAL_ERROR;
3249 struct sshcipher_ctx *ciphercontext = NULL;
3250 const struct sshcipher *cipher;
3251 const char *kdfname = KDFNAME;
3252 struct sshbuf *encoded = NULL, *encrypted = NULL, *kdf = NULL;
3255 rounds = DEFAULT_ROUNDS;
3256 if (passphrase == NULL || !strlen(passphrase)) {
3257 ciphername = "none";
3259 } else if (ciphername == NULL)
3260 ciphername = DEFAULT_CIPHERNAME;
3261 if ((cipher = cipher_by_name(ciphername)) == NULL) {
3262 r = SSH_ERR_INVALID_ARGUMENT;
3266 if ((kdf = sshbuf_new()) == NULL ||
3267 (encoded = sshbuf_new()) == NULL ||
3268 (encrypted = sshbuf_new()) == NULL) {
3269 r = SSH_ERR_ALLOC_FAIL;
3272 blocksize = cipher_blocksize(cipher);
3273 keylen = cipher_keylen(cipher);
3274 ivlen = cipher_ivlen(cipher);
3275 authlen = cipher_authlen(cipher);
3276 if ((key = calloc(1, keylen + ivlen)) == NULL) {
3277 r = SSH_ERR_ALLOC_FAIL;
3280 if (strcmp(kdfname, "bcrypt") == 0) {
3281 arc4random_buf(salt, SALT_LEN);
3282 if (bcrypt_pbkdf(passphrase, strlen(passphrase),
3283 salt, SALT_LEN, key, keylen + ivlen, rounds) < 0) {
3284 r = SSH_ERR_INVALID_ARGUMENT;
3287 if ((r = sshbuf_put_string(kdf, salt, SALT_LEN)) != 0 ||
3288 (r = sshbuf_put_u32(kdf, rounds)) != 0)
3290 } else if (strcmp(kdfname, "none") != 0) {
3291 /* Unsupported KDF type */
3292 r = SSH_ERR_KEY_UNKNOWN_CIPHER;
3295 if ((r = cipher_init(&ciphercontext, cipher, key, keylen,
3296 key + keylen, ivlen, 1)) != 0)
3299 if ((r = sshbuf_put(encoded, AUTH_MAGIC, sizeof(AUTH_MAGIC))) != 0 ||
3300 (r = sshbuf_put_cstring(encoded, ciphername)) != 0 ||
3301 (r = sshbuf_put_cstring(encoded, kdfname)) != 0 ||
3302 (r = sshbuf_put_stringb(encoded, kdf)) != 0 ||
3303 (r = sshbuf_put_u32(encoded, 1)) != 0 || /* number of keys */
3304 (r = sshkey_to_blob(prv, &pubkeyblob, &pubkeylen)) != 0 ||
3305 (r = sshbuf_put_string(encoded, pubkeyblob, pubkeylen)) != 0)
3308 /* set up the buffer that will be encrypted */
3310 /* Random check bytes */
3311 check = arc4random();
3312 if ((r = sshbuf_put_u32(encrypted, check)) != 0 ||
3313 (r = sshbuf_put_u32(encrypted, check)) != 0)
3316 /* append private key and comment*/
3317 if ((r = sshkey_private_serialize_opt(prv, encrypted,
3318 SSHKEY_SERIALIZE_FULL)) != 0 ||
3319 (r = sshbuf_put_cstring(encrypted, comment)) != 0)
3324 while (sshbuf_len(encrypted) % blocksize) {
3325 if ((r = sshbuf_put_u8(encrypted, ++i & 0xff)) != 0)
3329 /* length in destination buffer */
3330 if ((r = sshbuf_put_u32(encoded, sshbuf_len(encrypted))) != 0)
3334 if ((r = sshbuf_reserve(encoded,
3335 sshbuf_len(encrypted) + authlen, &cp)) != 0)
3337 if ((r = cipher_crypt(ciphercontext, 0, cp,
3338 sshbuf_ptr(encrypted), sshbuf_len(encrypted), 0, authlen)) != 0)
3342 if ((b64 = sshbuf_dtob64(encoded)) == NULL) {
3343 r = SSH_ERR_ALLOC_FAIL;
3348 if ((r = sshbuf_put(blob, MARK_BEGIN, MARK_BEGIN_LEN)) != 0)
3350 for (i = 0; i < strlen(b64); i++) {
3351 if ((r = sshbuf_put_u8(blob, b64[i])) != 0)
3353 /* insert line breaks */
3354 if (i % 70 == 69 && (r = sshbuf_put_u8(blob, '\n')) != 0)
3357 if (i % 70 != 69 && (r = sshbuf_put_u8(blob, '\n')) != 0)
3359 if ((r = sshbuf_put(blob, MARK_END, MARK_END_LEN)) != 0)
3367 sshbuf_free(encoded);
3368 sshbuf_free(encrypted);
3369 cipher_free(ciphercontext);
3370 explicit_bzero(salt, sizeof(salt));
3372 explicit_bzero(key, keylen + ivlen);
3375 if (pubkeyblob != NULL) {
3376 explicit_bzero(pubkeyblob, pubkeylen);
3380 explicit_bzero(b64, strlen(b64));
3387 sshkey_parse_private2(struct sshbuf *blob, int type, const char *passphrase,
3388 struct sshkey **keyp, char **commentp)
3390 char *comment = NULL, *ciphername = NULL, *kdfname = NULL;
3391 const struct sshcipher *cipher = NULL;
3393 int r = SSH_ERR_INTERNAL_ERROR;
3395 size_t i, keylen = 0, ivlen = 0, authlen = 0, slen = 0;
3396 struct sshbuf *encoded = NULL, *decoded = NULL;
3397 struct sshbuf *kdf = NULL, *decrypted = NULL;
3398 struct sshcipher_ctx *ciphercontext = NULL;
3399 struct sshkey *k = NULL;
3400 u_char *key = NULL, *salt = NULL, *dp, pad, last;
3401 u_int blocksize, rounds, nkeys, encrypted_len, check1, check2;
3405 if (commentp != NULL)
3408 if ((encoded = sshbuf_new()) == NULL ||
3409 (decoded = sshbuf_new()) == NULL ||
3410 (decrypted = sshbuf_new()) == NULL) {
3411 r = SSH_ERR_ALLOC_FAIL;
3415 /* check preamble */
3416 cp = sshbuf_ptr(blob);
3417 encoded_len = sshbuf_len(blob);
3418 if (encoded_len < (MARK_BEGIN_LEN + MARK_END_LEN) ||
3419 memcmp(cp, MARK_BEGIN, MARK_BEGIN_LEN) != 0) {
3420 r = SSH_ERR_INVALID_FORMAT;
3423 cp += MARK_BEGIN_LEN;
3424 encoded_len -= MARK_BEGIN_LEN;
3426 /* Look for end marker, removing whitespace as we go */
3427 while (encoded_len > 0) {
3428 if (*cp != '\n' && *cp != '\r') {
3429 if ((r = sshbuf_put_u8(encoded, *cp)) != 0)
3436 if (encoded_len >= MARK_END_LEN &&
3437 memcmp(cp, MARK_END, MARK_END_LEN) == 0) {
3439 if ((r = sshbuf_put_u8(encoded, 0)) != 0)
3445 if (encoded_len == 0) {
3446 r = SSH_ERR_INVALID_FORMAT;
3451 if ((r = sshbuf_b64tod(decoded, (char *)sshbuf_ptr(encoded))) != 0)
3455 if (sshbuf_len(decoded) < sizeof(AUTH_MAGIC) ||
3456 memcmp(sshbuf_ptr(decoded), AUTH_MAGIC, sizeof(AUTH_MAGIC))) {
3457 r = SSH_ERR_INVALID_FORMAT;
3460 /* parse public portion of key */
3461 if ((r = sshbuf_consume(decoded, sizeof(AUTH_MAGIC))) != 0 ||
3462 (r = sshbuf_get_cstring(decoded, &ciphername, NULL)) != 0 ||
3463 (r = sshbuf_get_cstring(decoded, &kdfname, NULL)) != 0 ||
3464 (r = sshbuf_froms(decoded, &kdf)) != 0 ||
3465 (r = sshbuf_get_u32(decoded, &nkeys)) != 0 ||
3466 (r = sshbuf_skip_string(decoded)) != 0 || /* pubkey */
3467 (r = sshbuf_get_u32(decoded, &encrypted_len)) != 0)
3470 if ((cipher = cipher_by_name(ciphername)) == NULL) {
3471 r = SSH_ERR_KEY_UNKNOWN_CIPHER;
3474 if ((passphrase == NULL || strlen(passphrase) == 0) &&
3475 strcmp(ciphername, "none") != 0) {
3476 /* passphrase required */
3477 r = SSH_ERR_KEY_WRONG_PASSPHRASE;
3480 if (strcmp(kdfname, "none") != 0 && strcmp(kdfname, "bcrypt") != 0) {
3481 r = SSH_ERR_KEY_UNKNOWN_CIPHER;
3484 if (!strcmp(kdfname, "none") && strcmp(ciphername, "none") != 0) {
3485 r = SSH_ERR_INVALID_FORMAT;
3489 /* XXX only one key supported */
3490 r = SSH_ERR_INVALID_FORMAT;
3494 /* check size of encrypted key blob */
3495 blocksize = cipher_blocksize(cipher);
3496 if (encrypted_len < blocksize || (encrypted_len % blocksize) != 0) {
3497 r = SSH_ERR_INVALID_FORMAT;
3502 keylen = cipher_keylen(cipher);
3503 ivlen = cipher_ivlen(cipher);
3504 authlen = cipher_authlen(cipher);
3505 if ((key = calloc(1, keylen + ivlen)) == NULL) {
3506 r = SSH_ERR_ALLOC_FAIL;
3509 if (strcmp(kdfname, "bcrypt") == 0) {
3510 if ((r = sshbuf_get_string(kdf, &salt, &slen)) != 0 ||
3511 (r = sshbuf_get_u32(kdf, &rounds)) != 0)
3513 if (bcrypt_pbkdf(passphrase, strlen(passphrase), salt, slen,
3514 key, keylen + ivlen, rounds) < 0) {
3515 r = SSH_ERR_INVALID_FORMAT;
3520 /* check that an appropriate amount of auth data is present */
3521 if (sshbuf_len(decoded) < encrypted_len + authlen) {
3522 r = SSH_ERR_INVALID_FORMAT;
3526 /* decrypt private portion of key */
3527 if ((r = sshbuf_reserve(decrypted, encrypted_len, &dp)) != 0 ||
3528 (r = cipher_init(&ciphercontext, cipher, key, keylen,
3529 key + keylen, ivlen, 0)) != 0)
3531 if ((r = cipher_crypt(ciphercontext, 0, dp, sshbuf_ptr(decoded),
3532 encrypted_len, 0, authlen)) != 0) {
3533 /* an integrity error here indicates an incorrect passphrase */
3534 if (r == SSH_ERR_MAC_INVALID)
3535 r = SSH_ERR_KEY_WRONG_PASSPHRASE;
3538 if ((r = sshbuf_consume(decoded, encrypted_len + authlen)) != 0)
3540 /* there should be no trailing data */
3541 if (sshbuf_len(decoded) != 0) {
3542 r = SSH_ERR_INVALID_FORMAT;
3546 /* check check bytes */
3547 if ((r = sshbuf_get_u32(decrypted, &check1)) != 0 ||
3548 (r = sshbuf_get_u32(decrypted, &check2)) != 0)
3550 if (check1 != check2) {
3551 r = SSH_ERR_KEY_WRONG_PASSPHRASE;
3555 /* Load the private key and comment */
3556 if ((r = sshkey_private_deserialize(decrypted, &k)) != 0 ||
3557 (r = sshbuf_get_cstring(decrypted, &comment, NULL)) != 0)
3560 /* Check deterministic padding */
3562 while (sshbuf_len(decrypted)) {
3563 if ((r = sshbuf_get_u8(decrypted, &pad)) != 0)
3565 if (pad != (++i & 0xff)) {
3566 r = SSH_ERR_INVALID_FORMAT;
3571 /* XXX decode pubkey and check against private */
3579 if (commentp != NULL) {
3580 *commentp = comment;
3585 cipher_free(ciphercontext);
3590 explicit_bzero(salt, slen);
3594 explicit_bzero(key, keylen + ivlen);
3597 sshbuf_free(encoded);
3598 sshbuf_free(decoded);
3600 sshbuf_free(decrypted);
3607 /* convert SSH v2 key in OpenSSL PEM format */
3609 sshkey_private_pem_to_blob(struct sshkey *key, struct sshbuf *blob,
3610 const char *_passphrase, const char *comment)
3613 int blen, len = strlen(_passphrase);
3614 u_char *passphrase = (len > 0) ? (u_char *)_passphrase : NULL;
3615 const EVP_CIPHER *cipher = (len > 0) ? EVP_aes_128_cbc() : NULL;
3619 if (len > 0 && len <= 4)
3620 return SSH_ERR_PASSPHRASE_TOO_SHORT;
3621 if ((bio = BIO_new(BIO_s_mem())) == NULL)
3622 return SSH_ERR_ALLOC_FAIL;
3624 switch (key->type) {
3626 success = PEM_write_bio_DSAPrivateKey(bio, key->dsa,
3627 cipher, passphrase, len, NULL, NULL);
3629 #ifdef OPENSSL_HAS_ECC
3631 success = PEM_write_bio_ECPrivateKey(bio, key->ecdsa,
3632 cipher, passphrase, len, NULL, NULL);
3636 success = PEM_write_bio_RSAPrivateKey(bio, key->rsa,
3637 cipher, passphrase, len, NULL, NULL);
3644 r = SSH_ERR_LIBCRYPTO_ERROR;
3647 if ((blen = BIO_get_mem_data(bio, &bptr)) <= 0) {
3648 r = SSH_ERR_INTERNAL_ERROR;
3651 if ((r = sshbuf_put(blob, bptr, blen)) != 0)
3658 #endif /* WITH_OPENSSL */
3660 /* Serialise "key" to buffer "blob" */
3662 sshkey_private_to_fileblob(struct sshkey *key, struct sshbuf *blob,
3663 const char *passphrase, const char *comment,
3664 int force_new_format, const char *new_format_cipher, int new_format_rounds)
3666 switch (key->type) {
3671 if (force_new_format) {
3672 return sshkey_private_to_blob2(key, blob, passphrase,
3673 comment, new_format_cipher, new_format_rounds);
3675 return sshkey_private_pem_to_blob(key, blob,
3676 passphrase, comment);
3677 #endif /* WITH_OPENSSL */
3681 #endif /* WITH_XMSS */
3682 return sshkey_private_to_blob2(key, blob, passphrase,
3683 comment, new_format_cipher, new_format_rounds);
3685 return SSH_ERR_KEY_TYPE_UNKNOWN;
3692 translate_libcrypto_error(unsigned long pem_err)
3694 int pem_reason = ERR_GET_REASON(pem_err);
3696 switch (ERR_GET_LIB(pem_err)) {
3698 switch (pem_reason) {
3699 case PEM_R_BAD_PASSWORD_READ:
3700 case PEM_R_PROBLEMS_GETTING_PASSWORD:
3701 case PEM_R_BAD_DECRYPT:
3702 return SSH_ERR_KEY_WRONG_PASSPHRASE;
3704 return SSH_ERR_INVALID_FORMAT;
3707 switch (pem_reason) {
3708 case EVP_R_BAD_DECRYPT:
3709 return SSH_ERR_KEY_WRONG_PASSPHRASE;
3710 case EVP_R_BN_DECODE_ERROR:
3711 case EVP_R_DECODE_ERROR:
3712 #ifdef EVP_R_PRIVATE_KEY_DECODE_ERROR
3713 case EVP_R_PRIVATE_KEY_DECODE_ERROR:
3715 return SSH_ERR_INVALID_FORMAT;
3717 return SSH_ERR_LIBCRYPTO_ERROR;
3720 return SSH_ERR_INVALID_FORMAT;
3722 return SSH_ERR_LIBCRYPTO_ERROR;
3726 clear_libcrypto_errors(void)
3728 while (ERR_get_error() != 0)
3733 * Translate OpenSSL error codes to determine whether
3734 * passphrase is required/incorrect.
3737 convert_libcrypto_error(void)
3740 * Some password errors are reported at the beginning
3741 * of the error queue.
3743 if (translate_libcrypto_error(ERR_peek_error()) ==
3744 SSH_ERR_KEY_WRONG_PASSPHRASE)
3745 return SSH_ERR_KEY_WRONG_PASSPHRASE;
3746 return translate_libcrypto_error(ERR_peek_last_error());
3750 sshkey_parse_private_pem_fileblob(struct sshbuf *blob, int type,
3751 const char *passphrase, struct sshkey **keyp)
3753 EVP_PKEY *pk = NULL;
3754 struct sshkey *prv = NULL;
3761 if ((bio = BIO_new(BIO_s_mem())) == NULL || sshbuf_len(blob) > INT_MAX)
3762 return SSH_ERR_ALLOC_FAIL;
3763 if (BIO_write(bio, sshbuf_ptr(blob), sshbuf_len(blob)) !=
3764 (int)sshbuf_len(blob)) {
3765 r = SSH_ERR_ALLOC_FAIL;
3769 clear_libcrypto_errors();
3770 if ((pk = PEM_read_bio_PrivateKey(bio, NULL, NULL,
3771 (char *)passphrase)) == NULL) {
3772 r = convert_libcrypto_error();
3775 if (pk->type == EVP_PKEY_RSA &&
3776 (type == KEY_UNSPEC || type == KEY_RSA)) {
3777 if ((prv = sshkey_new(KEY_UNSPEC)) == NULL) {
3778 r = SSH_ERR_ALLOC_FAIL;
3781 prv->rsa = EVP_PKEY_get1_RSA(pk);
3782 prv->type = KEY_RSA;
3784 RSA_print_fp(stderr, prv->rsa, 8);
3786 if (RSA_blinding_on(prv->rsa, NULL) != 1) {
3787 r = SSH_ERR_LIBCRYPTO_ERROR;
3790 if (BN_num_bits(prv->rsa->n) < SSH_RSA_MINIMUM_MODULUS_SIZE) {
3791 r = SSH_ERR_KEY_LENGTH;
3794 } else if (pk->type == EVP_PKEY_DSA &&
3795 (type == KEY_UNSPEC || type == KEY_DSA)) {
3796 if ((prv = sshkey_new(KEY_UNSPEC)) == NULL) {
3797 r = SSH_ERR_ALLOC_FAIL;
3800 prv->dsa = EVP_PKEY_get1_DSA(pk);
3801 prv->type = KEY_DSA;
3803 DSA_print_fp(stderr, prv->dsa, 8);
3805 #ifdef OPENSSL_HAS_ECC
3806 } else if (pk->type == EVP_PKEY_EC &&
3807 (type == KEY_UNSPEC || type == KEY_ECDSA)) {
3808 if ((prv = sshkey_new(KEY_UNSPEC)) == NULL) {
3809 r = SSH_ERR_ALLOC_FAIL;
3812 prv->ecdsa = EVP_PKEY_get1_EC_KEY(pk);
3813 prv->type = KEY_ECDSA;
3814 prv->ecdsa_nid = sshkey_ecdsa_key_to_nid(prv->ecdsa);
3815 if (prv->ecdsa_nid == -1 ||
3816 sshkey_curve_nid_to_name(prv->ecdsa_nid) == NULL ||
3817 sshkey_ec_validate_public(EC_KEY_get0_group(prv->ecdsa),
3818 EC_KEY_get0_public_key(prv->ecdsa)) != 0 ||
3819 sshkey_ec_validate_private(prv->ecdsa) != 0) {
3820 r = SSH_ERR_INVALID_FORMAT;
3824 if (prv != NULL && prv->ecdsa != NULL)
3825 sshkey_dump_ec_key(prv->ecdsa);
3827 #endif /* OPENSSL_HAS_ECC */
3829 r = SSH_ERR_INVALID_FORMAT;
3843 #endif /* WITH_OPENSSL */
3846 sshkey_parse_private_fileblob_type(struct sshbuf *blob, int type,
3847 const char *passphrase, struct sshkey **keyp, char **commentp)
3849 int r = SSH_ERR_INTERNAL_ERROR;
3853 if (commentp != NULL)
3861 return sshkey_parse_private_pem_fileblob(blob, type,
3863 #endif /* WITH_OPENSSL */
3867 #endif /* WITH_XMSS */
3868 return sshkey_parse_private2(blob, type, passphrase,
3871 r = sshkey_parse_private2(blob, type, passphrase, keyp,
3873 /* Do not fallback to PEM parser if only passphrase is wrong. */
3874 if (r == 0 || r == SSH_ERR_KEY_WRONG_PASSPHRASE)
3877 return sshkey_parse_private_pem_fileblob(blob, type,
3880 return SSH_ERR_INVALID_FORMAT;
3881 #endif /* WITH_OPENSSL */
3883 return SSH_ERR_KEY_TYPE_UNKNOWN;
3888 sshkey_parse_private_fileblob(struct sshbuf *buffer, const char *passphrase,
3889 struct sshkey **keyp, char **commentp)
3893 if (commentp != NULL)
3896 return sshkey_parse_private_fileblob_type(buffer, KEY_UNSPEC,
3897 passphrase, keyp, commentp);
3902 * serialize the key with the current state and forward the state
3906 sshkey_private_serialize_maxsign(const struct sshkey *k, struct sshbuf *b,
3907 u_int32_t maxsign, sshkey_printfn *pr)
3912 sshkey_type_plain(k->type) != KEY_XMSS)
3913 return sshkey_private_serialize_opt(k, b,
3914 SSHKEY_SERIALIZE_DEFAULT);
3915 if ((r = sshkey_xmss_get_state(k, pr)) != 0 ||
3916 (r = sshkey_private_serialize_opt(k, b,
3917 SSHKEY_SERIALIZE_STATE)) != 0 ||
3918 (r = sshkey_xmss_forward_state(k, maxsign)) != 0)
3922 if ((rupdate = sshkey_xmss_update_state(k, pr)) != 0) {
3930 sshkey_signatures_left(const struct sshkey *k)
3932 if (sshkey_type_plain(k->type) == KEY_XMSS)
3933 return sshkey_xmss_signatures_left(k);
3938 sshkey_enable_maxsign(struct sshkey *k, u_int32_t maxsign)
3940 if (sshkey_type_plain(k->type) != KEY_XMSS)
3941 return SSH_ERR_INVALID_ARGUMENT;
3942 return sshkey_xmss_enable_maxsign(k, maxsign);
3946 sshkey_set_filename(struct sshkey *k, const char *filename)
3949 return SSH_ERR_INVALID_ARGUMENT;
3950 if (sshkey_type_plain(k->type) != KEY_XMSS)
3952 if (filename == NULL)
3953 return SSH_ERR_INVALID_ARGUMENT;
3954 if ((k->xmss_filename = strdup(filename)) == NULL)
3955 return SSH_ERR_ALLOC_FAIL;
3960 sshkey_private_serialize_maxsign(const struct sshkey *k, struct sshbuf *b,
3961 u_int32_t maxsign, sshkey_printfn *pr)
3963 return sshkey_private_serialize_opt(k, b, SSHKEY_SERIALIZE_DEFAULT);
3967 sshkey_signatures_left(const struct sshkey *k)
3973 sshkey_enable_maxsign(struct sshkey *k, u_int32_t maxsign)
3975 return SSH_ERR_INVALID_ARGUMENT;
3979 sshkey_set_filename(struct sshkey *k, const char *filename)
3982 return SSH_ERR_INVALID_ARGUMENT;
3985 #endif /* WITH_XMSS */