Coverage Report

Created: 2025-10-10 06:38

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/openssh/sshkey.c
Line
Count
Source
1
/* $OpenBSD: sshkey.c,v 1.155 2025/10/03 00:08:02 djm Exp $ */
2
/*
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.
6
 *
7
 * Redistribution and use in source and binary forms, with or without
8
 * modification, are permitted provided that the following conditions
9
 * are met:
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.
15
 *
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.
26
 */
27
28
#include "includes.h"
29
30
#include <sys/types.h>
31
#include <sys/mman.h>
32
#include <netinet/in.h>
33
34
#ifdef WITH_OPENSSL
35
#include <openssl/bn.h>
36
#include <openssl/evp.h>
37
#include <openssl/err.h>
38
#include <openssl/pem.h>
39
#endif
40
41
#include "crypto_api.h"
42
43
#include <errno.h>
44
#include <limits.h>
45
#include <stdio.h>
46
#include <stdlib.h>
47
#include <string.h>
48
#include <resolv.h>
49
#include <time.h>
50
#include <util.h>
51
52
#include "ssh2.h"
53
#include "ssherr.h"
54
#include "misc.h"
55
#include "sshbuf.h"
56
#include "cipher.h"
57
#include "digest.h"
58
#define SSHKEY_INTERNAL
59
#include "sshkey.h"
60
#include "match.h"
61
#include "ssh-sk.h"
62
#include "ssh-pkcs11.h"
63
64
#include "openbsd-compat/openssl-compat.h"
65
66
/* openssh private key file format */
67
0
#define MARK_BEGIN    "-----BEGIN OPENSSH PRIVATE KEY-----\n"
68
0
#define MARK_END    "-----END OPENSSH PRIVATE KEY-----\n"
69
0
#define MARK_BEGIN_LEN    (sizeof(MARK_BEGIN) - 1)
70
0
#define MARK_END_LEN    (sizeof(MARK_END) - 1)
71
0
#define KDFNAME     "bcrypt"
72
0
#define AUTH_MAGIC    "openssh-key-v1"
73
0
#define SALT_LEN    16
74
0
#define DEFAULT_CIPHERNAME  "aes256-ctr"
75
0
#define DEFAULT_ROUNDS    24
76
77
/*
78
 * Constants relating to "shielding" support; protection of keys expected
79
 * to remain in memory for long durations
80
 */
81
0
#define SSHKEY_SHIELD_PREKEY_LEN  (16 * 1024)
82
0
#define SSHKEY_SHIELD_CIPHER    "aes256-ctr" /* XXX want AES-EME* */
83
0
#define SSHKEY_SHIELD_PREKEY_HASH SSH_DIGEST_SHA512
84
85
static int sshkey_from_blob_internal(struct sshbuf *buf,
86
    struct sshkey **keyp, int allow_cert);
87
88
/* Supported key types */
89
extern const struct sshkey_impl sshkey_ed25519_impl;
90
extern const struct sshkey_impl sshkey_ed25519_cert_impl;
91
extern const struct sshkey_impl sshkey_ed25519_sk_impl;
92
extern const struct sshkey_impl sshkey_ed25519_sk_cert_impl;
93
#ifdef WITH_OPENSSL
94
# ifdef OPENSSL_HAS_ECC
95
#  ifdef ENABLE_SK
96
extern const struct sshkey_impl sshkey_ecdsa_sk_impl;
97
extern const struct sshkey_impl sshkey_ecdsa_sk_cert_impl;
98
extern const struct sshkey_impl sshkey_ecdsa_sk_webauthn_impl;
99
#  endif /* ENABLE_SK */
100
extern const struct sshkey_impl sshkey_ecdsa_nistp256_impl;
101
extern const struct sshkey_impl sshkey_ecdsa_nistp256_cert_impl;
102
extern const struct sshkey_impl sshkey_ecdsa_nistp384_impl;
103
extern const struct sshkey_impl sshkey_ecdsa_nistp384_cert_impl;
104
#  ifdef OPENSSL_HAS_NISTP521
105
extern const struct sshkey_impl sshkey_ecdsa_nistp521_impl;
106
extern const struct sshkey_impl sshkey_ecdsa_nistp521_cert_impl;
107
#  endif /* OPENSSL_HAS_NISTP521 */
108
# endif /* OPENSSL_HAS_ECC */
109
extern const struct sshkey_impl sshkey_rsa_impl;
110
extern const struct sshkey_impl sshkey_rsa_cert_impl;
111
extern const struct sshkey_impl sshkey_rsa_sha256_impl;
112
extern const struct sshkey_impl sshkey_rsa_sha256_cert_impl;
113
extern const struct sshkey_impl sshkey_rsa_sha512_impl;
114
extern const struct sshkey_impl sshkey_rsa_sha512_cert_impl;
115
#endif /* WITH_OPENSSL */
116
117
const struct sshkey_impl * const keyimpls[] = {
118
  &sshkey_ed25519_impl,
119
  &sshkey_ed25519_cert_impl,
120
#ifdef ENABLE_SK
121
  &sshkey_ed25519_sk_impl,
122
  &sshkey_ed25519_sk_cert_impl,
123
#endif
124
#ifdef WITH_OPENSSL
125
# ifdef OPENSSL_HAS_ECC
126
  &sshkey_ecdsa_nistp256_impl,
127
  &sshkey_ecdsa_nistp256_cert_impl,
128
  &sshkey_ecdsa_nistp384_impl,
129
  &sshkey_ecdsa_nistp384_cert_impl,
130
#  ifdef OPENSSL_HAS_NISTP521
131
  &sshkey_ecdsa_nistp521_impl,
132
  &sshkey_ecdsa_nistp521_cert_impl,
133
#  endif /* OPENSSL_HAS_NISTP521 */
134
#  ifdef ENABLE_SK
135
  &sshkey_ecdsa_sk_impl,
136
  &sshkey_ecdsa_sk_cert_impl,
137
  &sshkey_ecdsa_sk_webauthn_impl,
138
#  endif /* ENABLE_SK */
139
# endif /* OPENSSL_HAS_ECC */
140
  &sshkey_rsa_impl,
141
  &sshkey_rsa_cert_impl,
142
  &sshkey_rsa_sha256_impl,
143
  &sshkey_rsa_sha256_cert_impl,
144
  &sshkey_rsa_sha512_impl,
145
  &sshkey_rsa_sha512_cert_impl,
146
#endif /* WITH_OPENSSL */
147
  NULL
148
};
149
150
static const struct sshkey_impl *
151
sshkey_impl_from_type(int type)
152
12.7k
{
153
12.7k
  int i;
154
155
82.0k
  for (i = 0; keyimpls[i] != NULL; i++) {
156
81.9k
    if (keyimpls[i]->type == type)
157
12.5k
      return keyimpls[i];
158
81.9k
  }
159
138
  return NULL;
160
12.7k
}
161
162
static const struct sshkey_impl *
163
sshkey_impl_from_type_nid(int type, int nid)
164
887
{
165
887
  int i;
166
167
5.15k
  for (i = 0; keyimpls[i] != NULL; i++) {
168
5.15k
    if (keyimpls[i]->type == type &&
169
887
        (keyimpls[i]->nid == 0 || keyimpls[i]->nid == nid))
170
887
      return keyimpls[i];
171
5.15k
  }
172
0
  return NULL;
173
887
}
174
175
static const struct sshkey_impl *
176
sshkey_impl_from_key(const struct sshkey *k)
177
676
{
178
676
  if (k == NULL)
179
0
    return NULL;
180
676
  return sshkey_impl_from_type_nid(k->type, k->ecdsa_nid);
181
676
}
182
183
const char *
184
sshkey_type(const struct sshkey *k)
185
0
{
186
0
  const struct sshkey_impl *impl;
187
188
0
  if ((impl = sshkey_impl_from_key(k)) == NULL)
189
0
    return "unknown";
190
0
  return impl->shortname;
191
0
}
192
193
static const char *
194
sshkey_ssh_name_from_type_nid(int type, int nid)
195
211
{
196
211
  const struct sshkey_impl *impl;
197
198
211
  if ((impl = sshkey_impl_from_type_nid(type, nid)) == NULL)
199
0
    return "ssh-unknown";
200
211
  return impl->name;
201
211
}
202
203
int
204
sshkey_type_is_cert(int type)
205
6.96k
{
206
6.96k
  const struct sshkey_impl *impl;
207
208
6.96k
  if ((impl = sshkey_impl_from_type(type)) == NULL)
209
3
    return 0;
210
6.96k
  return impl->cert;
211
6.96k
}
212
213
const char *
214
sshkey_ssh_name(const struct sshkey *k)
215
0
{
216
0
  return sshkey_ssh_name_from_type_nid(k->type, k->ecdsa_nid);
217
0
}
218
219
const char *
220
sshkey_ssh_name_plain(const struct sshkey *k)
221
211
{
222
211
  return sshkey_ssh_name_from_type_nid(sshkey_type_plain(k->type),
223
211
      k->ecdsa_nid);
224
211
}
225
226
static int
227
type_from_name(const char *name, int allow_short)
228
1.90k
{
229
1.90k
  int i;
230
1.90k
  const struct sshkey_impl *impl;
231
232
14.1k
  for (i = 0; keyimpls[i] != NULL; i++) {
233
13.9k
    impl = keyimpls[i];
234
13.9k
    if (impl->name != NULL && strcmp(name, impl->name) == 0)
235
1.77k
      return impl->type;
236
    /* Only allow shortname matches for plain key types */
237
12.1k
    if (allow_short && !impl->cert && impl->shortname != NULL &&
238
0
        strcasecmp(impl->shortname, name) == 0)
239
0
      return impl->type;
240
12.1k
  }
241
135
  return KEY_UNSPEC;
242
1.90k
}
243
244
int
245
sshkey_type_from_name(const char *name)
246
1.90k
{
247
1.90k
  return type_from_name(name, 0);
248
1.90k
}
249
250
int
251
sshkey_type_from_shortname(const char *name)
252
0
{
253
0
  return type_from_name(name, 1);
254
0
}
255
256
static int
257
key_type_is_ecdsa_variant(int type)
258
1.75k
{
259
1.75k
  switch (type) {
260
509
  case KEY_ECDSA:
261
784
  case KEY_ECDSA_CERT:
262
790
  case KEY_ECDSA_SK:
263
792
  case KEY_ECDSA_SK_CERT:
264
792
    return 1;
265
1.75k
  }
266
964
  return 0;
267
1.75k
}
268
269
int
270
sshkey_ecdsa_nid_from_name(const char *name)
271
241
{
272
241
  int i;
273
274
1.75k
  for (i = 0; keyimpls[i] != NULL; i++) {
275
1.75k
    if (!key_type_is_ecdsa_variant(keyimpls[i]->type))
276
964
      continue;
277
792
    if (keyimpls[i]->name != NULL &&
278
792
        strcmp(name, keyimpls[i]->name) == 0)
279
241
      return keyimpls[i]->nid;
280
792
  }
281
0
  return -1;
282
241
}
283
284
int
285
sshkey_match_keyname_to_sigalgs(const char *keyname, const char *sigalgs)
286
0
{
287
0
  int ktype;
288
289
0
  if (sigalgs == NULL || *sigalgs == '\0' ||
290
0
      (ktype = sshkey_type_from_name(keyname)) == KEY_UNSPEC)
291
0
    return 0;
292
0
  else if (ktype == KEY_RSA) {
293
0
    return match_pattern_list("ssh-rsa", sigalgs, 0) == 1 ||
294
0
        match_pattern_list("rsa-sha2-256", sigalgs, 0) == 1 ||
295
0
        match_pattern_list("rsa-sha2-512", sigalgs, 0) == 1;
296
0
  } else if (ktype == KEY_RSA_CERT) {
297
0
    return match_pattern_list("ssh-rsa-cert-v01@openssh.com",
298
0
        sigalgs, 0) == 1 ||
299
0
        match_pattern_list("rsa-sha2-256-cert-v01@openssh.com",
300
0
        sigalgs, 0) == 1 ||
301
0
        match_pattern_list("rsa-sha2-512-cert-v01@openssh.com",
302
0
        sigalgs, 0) == 1;
303
0
  } else
304
0
    return match_pattern_list(keyname, sigalgs, 0) == 1;
305
0
}
306
307
char *
308
sshkey_alg_list(int certs_only, int plain_only, int include_sigonly, char sep)
309
0
{
310
0
  char *ret = NULL;
311
0
  size_t i;
312
0
  const struct sshkey_impl *impl;
313
0
  char sep_str[2] = {sep, '\0'};
314
315
0
  for (i = 0; keyimpls[i] != NULL; i++) {
316
0
    impl = keyimpls[i];
317
0
    if (impl->name == NULL)
318
0
      continue;
319
0
    if (!include_sigonly && impl->sigonly)
320
0
      continue;
321
0
    if ((certs_only && !impl->cert) || (plain_only && impl->cert))
322
0
      continue;
323
0
    xextendf(&ret, sep_str, "%s", impl->name);
324
0
  }
325
0
  return ret;
326
0
}
327
328
int
329
sshkey_names_valid2(const char *names, int allow_wildcard, int plain_only)
330
0
{
331
0
  char *s, *cp, *p;
332
0
  const struct sshkey_impl *impl;
333
0
  int i, type;
334
335
0
  if (names == NULL || strcmp(names, "") == 0)
336
0
    return 0;
337
0
  if ((s = cp = strdup(names)) == NULL)
338
0
    return 0;
339
0
  for ((p = strsep(&cp, ",")); p && *p != '\0';
340
0
      (p = strsep(&cp, ","))) {
341
0
    type = sshkey_type_from_name(p);
342
0
    if (type == KEY_UNSPEC) {
343
0
      if (allow_wildcard) {
344
        /*
345
         * Try matching key types against the string.
346
         * If any has a positive or negative match then
347
         * the component is accepted.
348
         */
349
0
        impl = NULL;
350
0
        for (i = 0; keyimpls[i] != NULL; i++) {
351
0
          if (match_pattern_list(
352
0
              keyimpls[i]->name, p, 0) != 0) {
353
0
            impl = keyimpls[i];
354
0
            break;
355
0
          }
356
0
        }
357
0
        if (impl != NULL)
358
0
          continue;
359
0
      }
360
0
      free(s);
361
0
      return 0;
362
0
    } else if (plain_only && sshkey_type_is_cert(type)) {
363
0
      free(s);
364
0
      return 0;
365
0
    }
366
0
  }
367
0
  free(s);
368
0
  return 1;
369
0
}
370
371
u_int
372
sshkey_size(const struct sshkey *k)
373
0
{
374
0
  const struct sshkey_impl *impl;
375
376
0
  if ((impl = sshkey_impl_from_key(k)) == NULL)
377
0
    return 0;
378
0
  if (impl->funcs->size != NULL)
379
0
    return impl->funcs->size(k);
380
0
  return impl->keybits;
381
0
}
382
383
static int
384
sshkey_type_is_valid_ca(int type)
385
288
{
386
288
  const struct sshkey_impl *impl;
387
388
288
  if ((impl = sshkey_impl_from_type(type)) == NULL)
389
0
    return 0;
390
  /* All non-certificate types may act as CAs */
391
288
  return !impl->cert;
392
288
}
393
394
int
395
sshkey_is_cert(const struct sshkey *k)
396
4.89k
{
397
4.89k
  if (k == NULL)
398
0
    return 0;
399
4.89k
  return sshkey_type_is_cert(k->type);
400
4.89k
}
401
402
int
403
sshkey_is_sk(const struct sshkey *k)
404
0
{
405
0
  if (k == NULL)
406
0
    return 0;
407
0
  switch (sshkey_type_plain(k->type)) {
408
0
  case KEY_ECDSA_SK:
409
0
  case KEY_ED25519_SK:
410
0
    return 1;
411
0
  default:
412
0
    return 0;
413
0
  }
414
0
}
415
416
/* Return the cert-less equivalent to a certified key type */
417
int
418
sshkey_type_plain(int type)
419
1.28k
{
420
1.28k
  switch (type) {
421
0
  case KEY_RSA_CERT:
422
0
    return KEY_RSA;
423
0
  case KEY_ECDSA_CERT:
424
0
    return KEY_ECDSA;
425
0
  case KEY_ECDSA_SK_CERT:
426
0
    return KEY_ECDSA_SK;
427
0
  case KEY_ED25519_CERT:
428
0
    return KEY_ED25519;
429
70
  case KEY_ED25519_SK_CERT:
430
70
    return KEY_ED25519_SK;
431
1.21k
  default:
432
1.21k
    return type;
433
1.28k
  }
434
1.28k
}
435
436
/* Return the cert equivalent to a plain key type */
437
static int
438
sshkey_type_certified(int type)
439
0
{
440
0
  switch (type) {
441
0
  case KEY_RSA:
442
0
    return KEY_RSA_CERT;
443
0
  case KEY_ECDSA:
444
0
    return KEY_ECDSA_CERT;
445
0
  case KEY_ECDSA_SK:
446
0
    return KEY_ECDSA_SK_CERT;
447
0
  case KEY_ED25519:
448
0
    return KEY_ED25519_CERT;
449
0
  case KEY_ED25519_SK:
450
0
    return KEY_ED25519_SK_CERT;
451
0
  default:
452
0
    return -1;
453
0
  }
454
0
}
455
456
#ifdef WITH_OPENSSL
457
static const EVP_MD *
458
ssh_digest_to_md(int hash_alg)
459
22
{
460
22
  switch (hash_alg) {
461
1
  case SSH_DIGEST_SHA1:
462
1
    return EVP_sha1();
463
9
  case SSH_DIGEST_SHA256:
464
9
    return EVP_sha256();
465
0
  case SSH_DIGEST_SHA384:
466
0
    return EVP_sha384();
467
12
  case SSH_DIGEST_SHA512:
468
12
    return EVP_sha512();
469
22
  }
470
0
  return NULL;
471
22
}
472
473
int
474
sshkey_pkey_digest_sign(EVP_PKEY *pkey, int hash_alg, u_char **sigp,
475
    size_t *lenp, const u_char *data, size_t datalen)
476
0
{
477
0
  EVP_MD_CTX *ctx = NULL;
478
0
  u_char *sig = NULL;
479
0
  int ret;
480
0
  size_t slen;
481
0
  const EVP_MD *evpmd;
482
483
0
  *sigp = NULL;
484
0
  *lenp = 0;
485
486
0
  slen = EVP_PKEY_size(pkey);
487
0
  if (slen <= 0 || slen > SSHBUF_MAX_BIGNUM ||
488
0
     (evpmd = ssh_digest_to_md(hash_alg)) == NULL)
489
0
    return SSH_ERR_INVALID_ARGUMENT;
490
491
0
  if ((sig = malloc(slen)) == NULL)
492
0
    return SSH_ERR_ALLOC_FAIL;
493
494
0
  if ((ctx = EVP_MD_CTX_new()) == NULL) {
495
0
    ret = SSH_ERR_ALLOC_FAIL;
496
0
    goto out;
497
0
  }
498
0
  if (EVP_DigestSignInit(ctx, NULL, evpmd, NULL, pkey) != 1 ||
499
0
      EVP_DigestSign(ctx, sig, &slen, data, datalen) != 1) {
500
0
    ret = SSH_ERR_LIBCRYPTO_ERROR;
501
0
    goto out;
502
0
  }
503
504
0
  *sigp = sig;
505
0
  *lenp = slen;
506
  /* Now owned by the caller */
507
0
  sig = NULL;
508
0
  ret = 0;
509
510
0
 out:
511
0
  EVP_MD_CTX_free(ctx);
512
0
  free(sig);
513
0
  return ret;
514
0
}
515
516
int
517
sshkey_pkey_digest_verify(EVP_PKEY *pkey, int hash_alg, const u_char *data,
518
    size_t datalen, u_char *sigbuf, size_t siglen)
519
22
{
520
22
  EVP_MD_CTX *ctx = NULL;
521
22
  int ret = SSH_ERR_INTERNAL_ERROR;
522
22
  const EVP_MD *evpmd;
523
524
22
  if ((evpmd = ssh_digest_to_md(hash_alg)) == NULL)
525
0
    return SSH_ERR_INVALID_ARGUMENT;
526
22
  if ((ctx = EVP_MD_CTX_new()) == NULL)
527
0
    return SSH_ERR_ALLOC_FAIL;
528
22
  if (EVP_DigestVerifyInit(ctx, NULL, evpmd, NULL, pkey) != 1) {
529
0
    ret = SSH_ERR_LIBCRYPTO_ERROR;
530
0
    goto out;
531
0
  }
532
22
  switch (EVP_DigestVerify(ctx, sigbuf, siglen, data, datalen)) {
533
0
  case 1:
534
0
    ret = 0;
535
0
    break;
536
22
  case 0:
537
22
    ret = SSH_ERR_SIGNATURE_INVALID;
538
22
    break;
539
0
  default:
540
0
    ret = SSH_ERR_LIBCRYPTO_ERROR;
541
0
    break;
542
22
  }
543
544
22
 out:
545
22
  EVP_MD_CTX_free(ctx);
546
22
  return ret;
547
22
}
548
549
/* XXX: these are really begging for a table-driven approach */
550
int
551
sshkey_curve_name_to_nid(const char *name)
552
230
{
553
230
  if (strcmp(name, "nistp256") == 0)
554
29
    return NID_X9_62_prime256v1;
555
201
  else if (strcmp(name, "nistp384") == 0)
556
43
    return NID_secp384r1;
557
158
# ifdef OPENSSL_HAS_NISTP521
558
158
  else if (strcmp(name, "nistp521") == 0)
559
45
    return NID_secp521r1;
560
113
# endif /* OPENSSL_HAS_NISTP521 */
561
113
  else
562
113
    return -1;
563
230
}
564
565
u_int
566
sshkey_curve_nid_to_bits(int nid)
567
0
{
568
0
  switch (nid) {
569
0
  case NID_X9_62_prime256v1:
570
0
    return 256;
571
0
  case NID_secp384r1:
572
0
    return 384;
573
0
# ifdef OPENSSL_HAS_NISTP521
574
0
  case NID_secp521r1:
575
0
    return 521;
576
0
# endif /* OPENSSL_HAS_NISTP521 */
577
0
  default:
578
0
    return 0;
579
0
  }
580
0
}
581
582
int
583
sshkey_ecdsa_bits_to_nid(int bits)
584
0
{
585
0
  switch (bits) {
586
0
  case 256:
587
0
    return NID_X9_62_prime256v1;
588
0
  case 384:
589
0
    return NID_secp384r1;
590
0
# ifdef OPENSSL_HAS_NISTP521
591
0
  case 521:
592
0
    return NID_secp521r1;
593
0
# endif /* OPENSSL_HAS_NISTP521 */
594
0
  default:
595
0
    return -1;
596
0
  }
597
0
}
598
599
const char *
600
sshkey_curve_nid_to_name(int nid)
601
0
{
602
0
  switch (nid) {
603
0
  case NID_X9_62_prime256v1:
604
0
    return "nistp256";
605
0
  case NID_secp384r1:
606
0
    return "nistp384";
607
0
# ifdef OPENSSL_HAS_NISTP521
608
0
  case NID_secp521r1:
609
0
    return "nistp521";
610
0
# endif /* OPENSSL_HAS_NISTP521 */
611
0
  default:
612
0
    return NULL;
613
0
  }
614
0
}
615
616
int
617
sshkey_ec_nid_to_hash_alg(int nid)
618
0
{
619
0
  int kbits = sshkey_curve_nid_to_bits(nid);
620
621
0
  if (kbits <= 0)
622
0
    return -1;
623
624
  /* RFC5656 section 6.2.1 */
625
0
  if (kbits <= 256)
626
0
    return SSH_DIGEST_SHA256;
627
0
  else if (kbits <= 384)
628
0
    return SSH_DIGEST_SHA384;
629
0
  else
630
0
    return SSH_DIGEST_SHA512;
631
0
}
632
#endif /* WITH_OPENSSL */
633
634
static void
635
cert_free(struct sshkey_cert *cert)
636
623
{
637
623
  u_int i;
638
639
623
  if (cert == NULL)
640
0
    return;
641
623
  sshbuf_free(cert->certblob);
642
623
  sshbuf_free(cert->critical);
643
623
  sshbuf_free(cert->extensions);
644
623
  free(cert->key_id);
645
3.26k
  for (i = 0; i < cert->nprincipals; i++)
646
2.64k
    free(cert->principals[i]);
647
623
  free(cert->principals);
648
623
  sshkey_free(cert->signature_key);
649
623
  free(cert->signature_type);
650
623
  freezero(cert, sizeof(*cert));
651
623
}
652
653
static struct sshkey_cert *
654
cert_new(void)
655
623
{
656
623
  struct sshkey_cert *cert;
657
658
623
  if ((cert = calloc(1, sizeof(*cert))) == NULL)
659
0
    return NULL;
660
623
  if ((cert->certblob = sshbuf_new()) == NULL ||
661
623
      (cert->critical = sshbuf_new()) == NULL ||
662
623
      (cert->extensions = sshbuf_new()) == NULL) {
663
0
    cert_free(cert);
664
0
    return NULL;
665
0
  }
666
623
  cert->key_id = NULL;
667
623
  cert->principals = NULL;
668
623
  cert->signature_key = NULL;
669
623
  cert->signature_type = NULL;
670
623
  return cert;
671
623
}
672
673
struct sshkey *
674
sshkey_new(int type)
675
1.77k
{
676
1.77k
  struct sshkey *k;
677
1.77k
  const struct sshkey_impl *impl = NULL;
678
679
1.77k
  if (type != KEY_UNSPEC &&
680
1.77k
      (impl = sshkey_impl_from_type(type)) == NULL)
681
0
    return NULL;
682
683
  /* All non-certificate types may act as CAs */
684
1.77k
  if ((k = calloc(1, sizeof(*k))) == NULL)
685
0
    return NULL;
686
1.77k
  k->type = type;
687
1.77k
  k->ecdsa_nid = -1;
688
1.77k
  if (impl != NULL && impl->funcs->alloc != NULL) {
689
474
    if (impl->funcs->alloc(k) != 0) {
690
0
      free(k);
691
0
      return NULL;
692
0
    }
693
474
  }
694
1.77k
  if (sshkey_is_cert(k)) {
695
623
    if ((k->cert = cert_new()) == NULL) {
696
0
      sshkey_free(k);
697
0
      return NULL;
698
0
    }
699
623
  }
700
701
1.77k
  return k;
702
1.77k
}
703
704
/* Frees common FIDO fields */
705
void
706
sshkey_sk_cleanup(struct sshkey *k)
707
667
{
708
667
  free(k->sk_application);
709
667
  sshbuf_free(k->sk_key_handle);
710
667
  sshbuf_free(k->sk_reserved);
711
667
  k->sk_application = NULL;
712
667
  k->sk_key_handle = k->sk_reserved = NULL;
713
667
}
714
715
#if defined(MAP_CONCEAL)
716
# define PREKEY_MMAP_FLAG MAP_CONCEAL
717
#elif defined(MAP_NOCORE)
718
# define PREKEY_MMAP_FLAG MAP_NOCORE
719
#else
720
0
# define PREKEY_MMAP_FLAG 0
721
#endif
722
723
static int
724
sshkey_prekey_alloc(u_char **prekeyp, size_t len)
725
0
{
726
0
#if defined(HAVE_MMAP) && defined(MAP_ANON) && defined(MAP_PRIVATE)
727
0
  u_char *prekey;
728
729
0
  *prekeyp = NULL;
730
0
  if ((prekey = mmap(NULL, len, PROT_READ|PROT_WRITE,
731
0
      MAP_ANON|MAP_PRIVATE|PREKEY_MMAP_FLAG, -1, 0)) == MAP_FAILED)
732
0
    return SSH_ERR_SYSTEM_ERROR;
733
0
#if defined(MADV_DONTDUMP) && !defined(MAP_CONCEAL) && !defined(MAP_NOCORE)
734
0
  (void)madvise(prekey, len, MADV_DONTDUMP);
735
0
#endif
736
0
  *prekeyp = prekey;
737
#else
738
  *prekeyp = calloc(1, len);
739
#endif /* HAVE_MMAP et al */
740
0
  return 0;
741
0
}
742
743
static void
744
sshkey_prekey_free(void *prekey, size_t len)
745
1.77k
{
746
1.77k
#if defined(HAVE_MMAP) && defined(MAP_ANON) && defined(MAP_PRIVATE)
747
1.77k
  if (prekey == NULL)
748
1.77k
    return;
749
0
  munmap(prekey, len);
750
#else
751
  free(prekey);
752
#endif /* HAVE_MMAP et al */
753
0
}
754
755
static void
756
sshkey_free_contents(struct sshkey *k)
757
6.33k
{
758
6.33k
  const struct sshkey_impl *impl;
759
760
6.33k
  if (k == NULL)
761
4.56k
    return;
762
1.77k
  if ((k->flags & SSHKEY_FLAG_EXT) != 0)
763
0
    pkcs11_key_free(k);
764
1.77k
  if ((impl = sshkey_impl_from_type(k->type)) != NULL &&
765
1.77k
      impl->funcs->cleanup != NULL)
766
1.77k
    impl->funcs->cleanup(k);
767
1.77k
  if (sshkey_is_cert(k))
768
623
    cert_free(k->cert);
769
1.77k
  freezero(k->shielded_private, k->shielded_len);
770
1.77k
  sshkey_prekey_free(k->shield_prekey, k->shield_prekey_len);
771
1.77k
}
772
773
void
774
sshkey_free(struct sshkey *k)
775
6.33k
{
776
6.33k
  sshkey_free_contents(k);
777
6.33k
  freezero(k, sizeof(*k));
778
6.33k
}
779
780
static int
781
cert_compare(struct sshkey_cert *a, struct sshkey_cert *b)
782
0
{
783
0
  if (a == NULL && b == NULL)
784
0
    return 1;
785
0
  if (a == NULL || b == NULL)
786
0
    return 0;
787
0
  if (sshbuf_len(a->certblob) != sshbuf_len(b->certblob))
788
0
    return 0;
789
0
  if (timingsafe_bcmp(sshbuf_ptr(a->certblob), sshbuf_ptr(b->certblob),
790
0
      sshbuf_len(a->certblob)) != 0)
791
0
    return 0;
792
0
  return 1;
793
0
}
794
795
/* Compares FIDO-specific pubkey fields only */
796
int
797
sshkey_sk_fields_equal(const struct sshkey *a, const struct sshkey *b)
798
0
{
799
0
  if (a->sk_application == NULL || b->sk_application == NULL)
800
0
    return 0;
801
0
  if (strcmp(a->sk_application, b->sk_application) != 0)
802
0
    return 0;
803
0
  return 1;
804
0
}
805
806
/*
807
 * Compare public portions of key only, allowing comparisons between
808
 * certificates and plain keys too.
809
 */
810
int
811
sshkey_equal_public(const struct sshkey *a, const struct sshkey *b)
812
0
{
813
0
  const struct sshkey_impl *impl;
814
815
0
  if (a == NULL || b == NULL ||
816
0
      sshkey_type_plain(a->type) != sshkey_type_plain(b->type))
817
0
    return 0;
818
0
  if ((impl = sshkey_impl_from_type(a->type)) == NULL)
819
0
    return 0;
820
0
  return impl->funcs->equal(a, b);
821
0
}
822
823
int
824
sshkey_equal(const struct sshkey *a, const struct sshkey *b)
825
0
{
826
0
  if (a == NULL || b == NULL || a->type != b->type)
827
0
    return 0;
828
0
  if (sshkey_is_cert(a)) {
829
0
    if (!cert_compare(a->cert, b->cert))
830
0
      return 0;
831
0
  }
832
0
  return sshkey_equal_public(a, b);
833
0
}
834
835
836
/* Serialise common FIDO key parts */
837
int
838
sshkey_serialize_sk(const struct sshkey *key, struct sshbuf *b)
839
0
{
840
0
  int r;
841
842
0
  if ((r = sshbuf_put_cstring(b, key->sk_application)) != 0)
843
0
    return r;
844
845
0
  return 0;
846
0
}
847
848
static int
849
to_blob_buf(const struct sshkey *key, struct sshbuf *b, int force_plain,
850
  enum sshkey_serialize_rep opts)
851
0
{
852
0
  int type, ret = SSH_ERR_INTERNAL_ERROR;
853
0
  const char *typename;
854
0
  const struct sshkey_impl *impl;
855
856
0
  if (key == NULL)
857
0
    return SSH_ERR_INVALID_ARGUMENT;
858
859
0
  type = force_plain ? sshkey_type_plain(key->type) : key->type;
860
861
0
  if (sshkey_type_is_cert(type)) {
862
0
    if (key->cert == NULL)
863
0
      return SSH_ERR_EXPECTED_CERT;
864
0
    if (sshbuf_len(key->cert->certblob) == 0)
865
0
      return SSH_ERR_KEY_LACKS_CERTBLOB;
866
    /* Use the existing blob */
867
0
    if ((ret = sshbuf_putb(b, key->cert->certblob)) != 0)
868
0
      return ret;
869
0
    return 0;
870
0
  }
871
0
  if ((impl = sshkey_impl_from_type(type)) == NULL)
872
0
    return SSH_ERR_KEY_TYPE_UNKNOWN;
873
874
0
  typename = sshkey_ssh_name_from_type_nid(type, key->ecdsa_nid);
875
0
  if ((ret = sshbuf_put_cstring(b, typename)) != 0)
876
0
    return ret;
877
0
  return impl->funcs->serialize_public(key, b, opts);
878
0
}
879
880
int
881
sshkey_putb(const struct sshkey *key, struct sshbuf *b)
882
0
{
883
0
  return to_blob_buf(key, b, 0, SSHKEY_SERIALIZE_DEFAULT);
884
0
}
885
886
static int
887
sshkey_puts_opts_internal(const struct sshkey *key, struct sshbuf *b,
888
    enum sshkey_serialize_rep opts, int force_plain)
889
0
{
890
0
  struct sshbuf *tmp;
891
0
  int r;
892
893
0
  if ((tmp = sshbuf_new()) == NULL)
894
0
    return SSH_ERR_ALLOC_FAIL;
895
0
  r = to_blob_buf(key, tmp, force_plain, opts);
896
0
  if (r == 0)
897
0
    r = sshbuf_put_stringb(b, tmp);
898
0
  sshbuf_free(tmp);
899
0
  return r;
900
0
}
901
902
int
903
sshkey_puts(const struct sshkey *key, struct sshbuf *b)
904
0
{
905
0
  return sshkey_puts_opts_internal(key, b, SSHKEY_SERIALIZE_DEFAULT, 0);
906
0
}
907
908
int
909
sshkey_putb_plain(const struct sshkey *key, struct sshbuf *b)
910
0
{
911
0
  return to_blob_buf(key, b, 1, SSHKEY_SERIALIZE_DEFAULT);
912
0
}
913
914
int
915
sshkey_puts_plain(const struct sshkey *key, struct sshbuf *b)
916
0
{
917
0
  return sshkey_puts_opts_internal(key, b, SSHKEY_SERIALIZE_DEFAULT, 1);
918
0
}
919
920
static int
921
to_blob(const struct sshkey *key, u_char **blobp, size_t *lenp, int force_plain,
922
    enum sshkey_serialize_rep opts)
923
0
{
924
0
  int ret = SSH_ERR_INTERNAL_ERROR;
925
0
  size_t len;
926
0
  struct sshbuf *b = NULL;
927
928
0
  if (lenp != NULL)
929
0
    *lenp = 0;
930
0
  if (blobp != NULL)
931
0
    *blobp = NULL;
932
0
  if ((b = sshbuf_new()) == NULL)
933
0
    return SSH_ERR_ALLOC_FAIL;
934
0
  if ((ret = to_blob_buf(key, b, force_plain, opts)) != 0)
935
0
    goto out;
936
0
  len = sshbuf_len(b);
937
0
  if (lenp != NULL)
938
0
    *lenp = len;
939
0
  if (blobp != NULL) {
940
0
    if ((*blobp = malloc(len)) == NULL) {
941
0
      ret = SSH_ERR_ALLOC_FAIL;
942
0
      goto out;
943
0
    }
944
0
    memcpy(*blobp, sshbuf_ptr(b), len);
945
0
  }
946
0
  ret = 0;
947
0
 out:
948
0
  sshbuf_free(b);
949
0
  return ret;
950
0
}
951
952
int
953
sshkey_to_blob(const struct sshkey *key, u_char **blobp, size_t *lenp)
954
0
{
955
0
  return to_blob(key, blobp, lenp, 0, SSHKEY_SERIALIZE_DEFAULT);
956
0
}
957
958
int
959
sshkey_plain_to_blob(const struct sshkey *key, u_char **blobp, size_t *lenp)
960
0
{
961
0
  return to_blob(key, blobp, lenp, 1, SSHKEY_SERIALIZE_DEFAULT);
962
0
}
963
964
int
965
sshkey_fingerprint_raw(const struct sshkey *k, int dgst_alg,
966
    u_char **retp, size_t *lenp)
967
0
{
968
0
  u_char *blob = NULL, *ret = NULL;
969
0
  size_t blob_len = 0;
970
0
  int r = SSH_ERR_INTERNAL_ERROR;
971
972
0
  if (retp != NULL)
973
0
    *retp = NULL;
974
0
  if (lenp != NULL)
975
0
    *lenp = 0;
976
0
  if (ssh_digest_bytes(dgst_alg) == 0) {
977
0
    r = SSH_ERR_INVALID_ARGUMENT;
978
0
    goto out;
979
0
  }
980
0
  if ((r = to_blob(k, &blob, &blob_len, 1, SSHKEY_SERIALIZE_DEFAULT))
981
0
      != 0)
982
0
    goto out;
983
0
  if ((ret = calloc(1, SSH_DIGEST_MAX_LENGTH)) == NULL) {
984
0
    r = SSH_ERR_ALLOC_FAIL;
985
0
    goto out;
986
0
  }
987
0
  if ((r = ssh_digest_memory(dgst_alg, blob, blob_len,
988
0
      ret, SSH_DIGEST_MAX_LENGTH)) != 0)
989
0
    goto out;
990
  /* success */
991
0
  if (retp != NULL) {
992
0
    *retp = ret;
993
0
    ret = NULL;
994
0
  }
995
0
  if (lenp != NULL)
996
0
    *lenp = ssh_digest_bytes(dgst_alg);
997
0
  r = 0;
998
0
 out:
999
0
  free(ret);
1000
0
  if (blob != NULL)
1001
0
    freezero(blob, blob_len);
1002
0
  return r;
1003
0
}
1004
1005
static char *
1006
fingerprint_b64(const char *alg, u_char *dgst_raw, size_t dgst_raw_len)
1007
0
{
1008
0
  char *ret;
1009
0
  size_t plen = strlen(alg) + 1;
1010
0
  size_t rlen = ((dgst_raw_len + 2) / 3) * 4 + plen + 1;
1011
1012
0
  if (dgst_raw_len > 65536 || (ret = calloc(1, rlen)) == NULL)
1013
0
    return NULL;
1014
0
  strlcpy(ret, alg, rlen);
1015
0
  strlcat(ret, ":", rlen);
1016
0
  if (dgst_raw_len == 0)
1017
0
    return ret;
1018
0
  if (b64_ntop(dgst_raw, dgst_raw_len, ret + plen, rlen - plen) == -1) {
1019
0
    freezero(ret, rlen);
1020
0
    return NULL;
1021
0
  }
1022
  /* Trim padding characters from end */
1023
0
  ret[strcspn(ret, "=")] = '\0';
1024
0
  return ret;
1025
0
}
1026
1027
static char *
1028
fingerprint_hex(const char *alg, u_char *dgst_raw, size_t dgst_raw_len)
1029
0
{
1030
0
  char *retval, hex[5];
1031
0
  size_t i, rlen = dgst_raw_len * 3 + strlen(alg) + 2;
1032
1033
0
  if (dgst_raw_len > 65536 || (retval = calloc(1, rlen)) == NULL)
1034
0
    return NULL;
1035
0
  strlcpy(retval, alg, rlen);
1036
0
  strlcat(retval, ":", rlen);
1037
0
  for (i = 0; i < dgst_raw_len; i++) {
1038
0
    snprintf(hex, sizeof(hex), "%s%02x",
1039
0
        i > 0 ? ":" : "", dgst_raw[i]);
1040
0
    strlcat(retval, hex, rlen);
1041
0
  }
1042
0
  return retval;
1043
0
}
1044
1045
static char *
1046
fingerprint_bubblebabble(u_char *dgst_raw, size_t dgst_raw_len)
1047
0
{
1048
0
  char vowels[] = { 'a', 'e', 'i', 'o', 'u', 'y' };
1049
0
  char consonants[] = { 'b', 'c', 'd', 'f', 'g', 'h', 'k', 'l', 'm',
1050
0
      'n', 'p', 'r', 's', 't', 'v', 'z', 'x' };
1051
0
  u_int i, j = 0, rounds, seed = 1;
1052
0
  char *retval;
1053
1054
0
  rounds = (dgst_raw_len / 2) + 1;
1055
0
  if ((retval = calloc(rounds, 6)) == NULL)
1056
0
    return NULL;
1057
0
  retval[j++] = 'x';
1058
0
  for (i = 0; i < rounds; i++) {
1059
0
    u_int idx0, idx1, idx2, idx3, idx4;
1060
0
    if ((i + 1 < rounds) || (dgst_raw_len % 2 != 0)) {
1061
0
      idx0 = (((((u_int)(dgst_raw[2 * i])) >> 6) & 3) +
1062
0
          seed) % 6;
1063
0
      idx1 = (((u_int)(dgst_raw[2 * i])) >> 2) & 15;
1064
0
      idx2 = ((((u_int)(dgst_raw[2 * i])) & 3) +
1065
0
          (seed / 6)) % 6;
1066
0
      retval[j++] = vowels[idx0];
1067
0
      retval[j++] = consonants[idx1];
1068
0
      retval[j++] = vowels[idx2];
1069
0
      if ((i + 1) < rounds) {
1070
0
        idx3 = (((u_int)(dgst_raw[(2 * i) + 1])) >> 4) & 15;
1071
0
        idx4 = (((u_int)(dgst_raw[(2 * i) + 1]))) & 15;
1072
0
        retval[j++] = consonants[idx3];
1073
0
        retval[j++] = '-';
1074
0
        retval[j++] = consonants[idx4];
1075
0
        seed = ((seed * 5) +
1076
0
            ((((u_int)(dgst_raw[2 * i])) * 7) +
1077
0
            ((u_int)(dgst_raw[(2 * i) + 1])))) % 36;
1078
0
      }
1079
0
    } else {
1080
0
      idx0 = seed % 6;
1081
0
      idx1 = 16;
1082
0
      idx2 = seed / 6;
1083
0
      retval[j++] = vowels[idx0];
1084
0
      retval[j++] = consonants[idx1];
1085
0
      retval[j++] = vowels[idx2];
1086
0
    }
1087
0
  }
1088
0
  retval[j++] = 'x';
1089
0
  retval[j++] = '\0';
1090
0
  return retval;
1091
0
}
1092
1093
/*
1094
 * Draw an ASCII-Art representing the fingerprint so human brain can
1095
 * profit from its built-in pattern recognition ability.
1096
 * This technique is called "random art" and can be found in some
1097
 * scientific publications like this original paper:
1098
 *
1099
 * "Hash Visualization: a New Technique to improve Real-World Security",
1100
 * Perrig A. and Song D., 1999, International Workshop on Cryptographic
1101
 * Techniques and E-Commerce (CrypTEC '99)
1102
 * sparrow.ece.cmu.edu/~adrian/projects/validation/validation.pdf
1103
 *
1104
 * The subject came up in a talk by Dan Kaminsky, too.
1105
 *
1106
 * If you see the picture is different, the key is different.
1107
 * If the picture looks the same, you still know nothing.
1108
 *
1109
 * The algorithm used here is a worm crawling over a discrete plane,
1110
 * leaving a trace (augmenting the field) everywhere it goes.
1111
 * Movement is taken from dgst_raw 2bit-wise.  Bumping into walls
1112
 * makes the respective movement vector be ignored for this turn.
1113
 * Graphs are not unambiguous, because circles in graphs can be
1114
 * walked in either direction.
1115
 */
1116
1117
/*
1118
 * Field sizes for the random art.  Have to be odd, so the starting point
1119
 * can be in the exact middle of the picture, and FLDBASE should be >=8 .
1120
 * Else pictures would be too dense, and drawing the frame would
1121
 * fail, too, because the key type would not fit in anymore.
1122
 */
1123
0
#define FLDBASE   8
1124
0
#define FLDSIZE_Y (FLDBASE + 1)
1125
0
#define FLDSIZE_X (FLDBASE * 2 + 1)
1126
static char *
1127
fingerprint_randomart(const char *alg, u_char *dgst_raw, size_t dgst_raw_len,
1128
    const struct sshkey *k)
1129
0
{
1130
  /*
1131
   * Chars to be used after each other every time the worm
1132
   * intersects with itself.  Matter of taste.
1133
   */
1134
0
  char  *augmentation_string = " .o+=*BOX@%&#/^SE";
1135
0
  char  *retval, *p, title[FLDSIZE_X], hash[FLDSIZE_X];
1136
0
  u_char   field[FLDSIZE_X][FLDSIZE_Y];
1137
0
  size_t   i, tlen, hlen;
1138
0
  u_int  b;
1139
0
  int  x, y, r;
1140
0
  size_t   len = strlen(augmentation_string) - 1;
1141
1142
0
  if ((retval = calloc((FLDSIZE_X + 3), (FLDSIZE_Y + 2))) == NULL)
1143
0
    return NULL;
1144
1145
  /* initialize field */
1146
0
  memset(field, 0, FLDSIZE_X * FLDSIZE_Y * sizeof(char));
1147
0
  x = FLDSIZE_X / 2;
1148
0
  y = FLDSIZE_Y / 2;
1149
1150
  /* process raw key */
1151
0
  for (i = 0; i < dgst_raw_len; i++) {
1152
0
    int input;
1153
    /* each byte conveys four 2-bit move commands */
1154
0
    input = dgst_raw[i];
1155
0
    for (b = 0; b < 4; b++) {
1156
      /* evaluate 2 bit, rest is shifted later */
1157
0
      x += (input & 0x1) ? 1 : -1;
1158
0
      y += (input & 0x2) ? 1 : -1;
1159
1160
      /* assure we are still in bounds */
1161
0
      x = MAXIMUM(x, 0);
1162
0
      y = MAXIMUM(y, 0);
1163
0
      x = MINIMUM(x, FLDSIZE_X - 1);
1164
0
      y = MINIMUM(y, FLDSIZE_Y - 1);
1165
1166
      /* augment the field */
1167
0
      if (field[x][y] < len - 2)
1168
0
        field[x][y]++;
1169
0
      input = input >> 2;
1170
0
    }
1171
0
  }
1172
1173
  /* mark starting point and end point*/
1174
0
  field[FLDSIZE_X / 2][FLDSIZE_Y / 2] = len - 1;
1175
0
  field[x][y] = len;
1176
1177
  /* assemble title */
1178
0
  r = snprintf(title, sizeof(title), "[%s %u]",
1179
0
    sshkey_type(k), sshkey_size(k));
1180
  /* If [type size] won't fit, then try [type]; fits "[ED25519-CERT]" */
1181
0
  if (r < 0 || r > (int)sizeof(title))
1182
0
    r = snprintf(title, sizeof(title), "[%s]", sshkey_type(k));
1183
0
  tlen = (r <= 0) ? 0 : strlen(title);
1184
1185
  /* assemble hash ID. */
1186
0
  r = snprintf(hash, sizeof(hash), "[%s]", alg);
1187
0
  hlen = (r <= 0) ? 0 : strlen(hash);
1188
1189
  /* output upper border */
1190
0
  p = retval;
1191
0
  *p++ = '+';
1192
0
  for (i = 0; i < (FLDSIZE_X - tlen) / 2; i++)
1193
0
    *p++ = '-';
1194
0
  memcpy(p, title, tlen);
1195
0
  p += tlen;
1196
0
  for (i += tlen; i < FLDSIZE_X; i++)
1197
0
    *p++ = '-';
1198
0
  *p++ = '+';
1199
0
  *p++ = '\n';
1200
1201
  /* output content */
1202
0
  for (y = 0; y < FLDSIZE_Y; y++) {
1203
0
    *p++ = '|';
1204
0
    for (x = 0; x < FLDSIZE_X; x++)
1205
0
      *p++ = augmentation_string[MINIMUM(field[x][y], len)];
1206
0
    *p++ = '|';
1207
0
    *p++ = '\n';
1208
0
  }
1209
1210
  /* output lower border */
1211
0
  *p++ = '+';
1212
0
  for (i = 0; i < (FLDSIZE_X - hlen) / 2; i++)
1213
0
    *p++ = '-';
1214
0
  memcpy(p, hash, hlen);
1215
0
  p += hlen;
1216
0
  for (i += hlen; i < FLDSIZE_X; i++)
1217
0
    *p++ = '-';
1218
0
  *p++ = '+';
1219
1220
0
  return retval;
1221
0
}
1222
1223
char *
1224
sshkey_fingerprint(const struct sshkey *k, int dgst_alg,
1225
    enum sshkey_fp_rep dgst_rep)
1226
0
{
1227
0
  char *retval = NULL;
1228
0
  u_char *dgst_raw;
1229
0
  size_t dgst_raw_len;
1230
1231
0
  if (sshkey_fingerprint_raw(k, dgst_alg, &dgst_raw, &dgst_raw_len) != 0)
1232
0
    return NULL;
1233
0
  switch (dgst_rep) {
1234
0
  case SSH_FP_DEFAULT:
1235
0
    if (dgst_alg == SSH_DIGEST_MD5) {
1236
0
      retval = fingerprint_hex(ssh_digest_alg_name(dgst_alg),
1237
0
          dgst_raw, dgst_raw_len);
1238
0
    } else {
1239
0
      retval = fingerprint_b64(ssh_digest_alg_name(dgst_alg),
1240
0
          dgst_raw, dgst_raw_len);
1241
0
    }
1242
0
    break;
1243
0
  case SSH_FP_HEX:
1244
0
    retval = fingerprint_hex(ssh_digest_alg_name(dgst_alg),
1245
0
        dgst_raw, dgst_raw_len);
1246
0
    break;
1247
0
  case SSH_FP_BASE64:
1248
0
    retval = fingerprint_b64(ssh_digest_alg_name(dgst_alg),
1249
0
        dgst_raw, dgst_raw_len);
1250
0
    break;
1251
0
  case SSH_FP_BUBBLEBABBLE:
1252
0
    retval = fingerprint_bubblebabble(dgst_raw, dgst_raw_len);
1253
0
    break;
1254
0
  case SSH_FP_RANDOMART:
1255
0
    retval = fingerprint_randomart(ssh_digest_alg_name(dgst_alg),
1256
0
        dgst_raw, dgst_raw_len, k);
1257
0
    break;
1258
0
  default:
1259
0
    freezero(dgst_raw, dgst_raw_len);
1260
0
    return NULL;
1261
0
  }
1262
0
  freezero(dgst_raw, dgst_raw_len);
1263
0
  return retval;
1264
0
}
1265
1266
static int
1267
peek_type_nid(const char *s, size_t l, int *nid)
1268
0
{
1269
0
  const struct sshkey_impl *impl;
1270
0
  int i;
1271
1272
0
  for (i = 0; keyimpls[i] != NULL; i++) {
1273
0
    impl = keyimpls[i];
1274
0
    if (impl->name == NULL || strlen(impl->name) != l)
1275
0
      continue;
1276
0
    if (memcmp(s, impl->name, l) == 0) {
1277
0
      *nid = -1;
1278
0
      if (key_type_is_ecdsa_variant(impl->type))
1279
0
        *nid = impl->nid;
1280
0
      return impl->type;
1281
0
    }
1282
0
  }
1283
0
  return KEY_UNSPEC;
1284
0
}
1285
1286
/* XXX this can now be made const char * */
1287
int
1288
sshkey_read(struct sshkey *ret, char **cpp)
1289
0
{
1290
0
  struct sshkey *k;
1291
0
  char *cp, *blobcopy;
1292
0
  size_t space;
1293
0
  int r, type, curve_nid = -1;
1294
0
  struct sshbuf *blob;
1295
1296
0
  if (ret == NULL)
1297
0
    return SSH_ERR_INVALID_ARGUMENT;
1298
0
  if (ret->type != KEY_UNSPEC && sshkey_impl_from_type(ret->type) == NULL)
1299
0
    return SSH_ERR_INVALID_ARGUMENT;
1300
1301
  /* Decode type */
1302
0
  cp = *cpp;
1303
0
  space = strcspn(cp, " \t");
1304
0
  if (space == strlen(cp))
1305
0
    return SSH_ERR_INVALID_FORMAT;
1306
0
  if ((type = peek_type_nid(cp, space, &curve_nid)) == KEY_UNSPEC)
1307
0
    return SSH_ERR_INVALID_FORMAT;
1308
1309
  /* skip whitespace */
1310
0
  for (cp += space; *cp == ' ' || *cp == '\t'; cp++)
1311
0
    ;
1312
0
  if (*cp == '\0')
1313
0
    return SSH_ERR_INVALID_FORMAT;
1314
0
  if (ret->type != KEY_UNSPEC && ret->type != type)
1315
0
    return SSH_ERR_KEY_TYPE_MISMATCH;
1316
0
  if ((blob = sshbuf_new()) == NULL)
1317
0
    return SSH_ERR_ALLOC_FAIL;
1318
1319
  /* find end of keyblob and decode */
1320
0
  space = strcspn(cp, " \t");
1321
0
  if ((blobcopy = strndup(cp, space)) == NULL) {
1322
0
    sshbuf_free(blob);
1323
0
    return SSH_ERR_ALLOC_FAIL;
1324
0
  }
1325
0
  if ((r = sshbuf_b64tod(blob, blobcopy)) != 0) {
1326
0
    free(blobcopy);
1327
0
    sshbuf_free(blob);
1328
0
    return r;
1329
0
  }
1330
0
  free(blobcopy);
1331
0
  if ((r = sshkey_fromb(blob, &k)) != 0) {
1332
0
    sshbuf_free(blob);
1333
0
    return r;
1334
0
  }
1335
0
  sshbuf_free(blob);
1336
1337
  /* skip whitespace and leave cp at start of comment */
1338
0
  for (cp += space; *cp == ' ' || *cp == '\t'; cp++)
1339
0
    ;
1340
1341
  /* ensure type of blob matches type at start of line */
1342
0
  if (k->type != type) {
1343
0
    sshkey_free(k);
1344
0
    return SSH_ERR_KEY_TYPE_MISMATCH;
1345
0
  }
1346
0
  if (key_type_is_ecdsa_variant(type) && curve_nid != k->ecdsa_nid) {
1347
0
    sshkey_free(k);
1348
0
    return SSH_ERR_EC_CURVE_MISMATCH;
1349
0
  }
1350
1351
  /* Fill in ret from parsed key */
1352
0
  sshkey_free_contents(ret);
1353
0
  *ret = *k;
1354
0
  freezero(k, sizeof(*k));
1355
1356
  /* success */
1357
0
  *cpp = cp;
1358
0
  return 0;
1359
0
}
1360
1361
int
1362
sshkey_to_base64(const struct sshkey *key, char **b64p)
1363
0
{
1364
0
  int r = SSH_ERR_INTERNAL_ERROR;
1365
0
  struct sshbuf *b = NULL;
1366
0
  char *uu = NULL;
1367
1368
0
  if (b64p != NULL)
1369
0
    *b64p = NULL;
1370
0
  if ((b = sshbuf_new()) == NULL)
1371
0
    return SSH_ERR_ALLOC_FAIL;
1372
0
  if ((r = sshkey_putb(key, b)) != 0)
1373
0
    goto out;
1374
0
  if ((uu = sshbuf_dtob64_string(b, 0)) == NULL) {
1375
0
    r = SSH_ERR_ALLOC_FAIL;
1376
0
    goto out;
1377
0
  }
1378
  /* Success */
1379
0
  if (b64p != NULL) {
1380
0
    *b64p = uu;
1381
0
    uu = NULL;
1382
0
  }
1383
0
  r = 0;
1384
0
 out:
1385
0
  sshbuf_free(b);
1386
0
  free(uu);
1387
0
  return r;
1388
0
}
1389
1390
int
1391
sshkey_format_text(const struct sshkey *key, struct sshbuf *b)
1392
0
{
1393
0
  int r = SSH_ERR_INTERNAL_ERROR;
1394
0
  char *uu = NULL;
1395
1396
0
  if ((r = sshkey_to_base64(key, &uu)) != 0)
1397
0
    goto out;
1398
0
  if ((r = sshbuf_putf(b, "%s %s",
1399
0
      sshkey_ssh_name(key), uu)) != 0)
1400
0
    goto out;
1401
0
  r = 0;
1402
0
 out:
1403
0
  free(uu);
1404
0
  return r;
1405
0
}
1406
1407
int
1408
sshkey_write(const struct sshkey *key, FILE *f)
1409
0
{
1410
0
  struct sshbuf *b = NULL;
1411
0
  int r = SSH_ERR_INTERNAL_ERROR;
1412
1413
0
  if ((b = sshbuf_new()) == NULL)
1414
0
    return SSH_ERR_ALLOC_FAIL;
1415
0
  if ((r = sshkey_format_text(key, b)) != 0)
1416
0
    goto out;
1417
0
  if (fwrite(sshbuf_ptr(b), sshbuf_len(b), 1, f) != 1) {
1418
0
    if (feof(f))
1419
0
      errno = EPIPE;
1420
0
    r = SSH_ERR_SYSTEM_ERROR;
1421
0
    goto out;
1422
0
  }
1423
  /* Success */
1424
0
  r = 0;
1425
0
 out:
1426
0
  sshbuf_free(b);
1427
0
  return r;
1428
0
}
1429
1430
const char *
1431
sshkey_cert_type(const struct sshkey *k)
1432
0
{
1433
0
  switch (k->cert->type) {
1434
0
  case SSH2_CERT_TYPE_USER:
1435
0
    return "user";
1436
0
  case SSH2_CERT_TYPE_HOST:
1437
0
    return "host";
1438
0
  default:
1439
0
    return "unknown";
1440
0
  }
1441
0
}
1442
1443
int
1444
sshkey_check_rsa_length(const struct sshkey *k, int min_size)
1445
351
{
1446
351
#ifdef WITH_OPENSSL
1447
351
  int nbits;
1448
1449
351
  if (k == NULL || k->pkey == NULL ||
1450
351
      (k->type != KEY_RSA && k->type != KEY_RSA_CERT))
1451
0
    return 0;
1452
351
  nbits = EVP_PKEY_bits(k->pkey);
1453
351
  if (nbits < SSH_RSA_MINIMUM_MODULUS_SIZE ||
1454
324
      (min_size > 0 && nbits < min_size))
1455
27
    return SSH_ERR_KEY_LENGTH;
1456
324
#endif /* WITH_OPENSSL */
1457
324
  return 0;
1458
351
}
1459
1460
#if defined(WITH_OPENSSL) && defined(OPENSSL_HAS_ECC)
1461
int
1462
sshkey_ecdsa_key_to_nid(const EC_KEY *k)
1463
0
{
1464
0
  const EC_GROUP *g;
1465
0
  int nid;
1466
1467
0
  if (k == NULL || (g = EC_KEY_get0_group(k)) == NULL)
1468
0
    return -1;
1469
0
  if ((nid = EC_GROUP_get_curve_name(g)) <= 0)
1470
0
    return -1;
1471
0
  return nid;
1472
0
}
1473
1474
int
1475
sshkey_ecdsa_pkey_to_nid(EVP_PKEY *pkey)
1476
0
{
1477
0
  return sshkey_ecdsa_key_to_nid(EVP_PKEY_get0_EC_KEY(pkey));
1478
0
}
1479
#endif /* defined(WITH_OPENSSL) && defined(OPENSSL_HAS_ECC) */
1480
1481
int
1482
sshkey_generate(int type, u_int bits, struct sshkey **keyp)
1483
0
{
1484
0
  struct sshkey *k;
1485
0
  int ret = SSH_ERR_INTERNAL_ERROR;
1486
0
  const struct sshkey_impl *impl;
1487
1488
0
  if (keyp == NULL || sshkey_type_is_cert(type))
1489
0
    return SSH_ERR_INVALID_ARGUMENT;
1490
0
  *keyp = NULL;
1491
0
  if ((impl = sshkey_impl_from_type(type)) == NULL)
1492
0
    return SSH_ERR_KEY_TYPE_UNKNOWN;
1493
0
  if (impl->funcs->generate == NULL)
1494
0
    return SSH_ERR_FEATURE_UNSUPPORTED;
1495
0
  if ((k = sshkey_new(KEY_UNSPEC)) == NULL)
1496
0
    return SSH_ERR_ALLOC_FAIL;
1497
0
  k->type = type;
1498
0
  if ((ret = impl->funcs->generate(k, bits)) != 0) {
1499
0
    sshkey_free(k);
1500
0
    return ret;
1501
0
  }
1502
  /* success */
1503
0
  *keyp = k;
1504
0
  return 0;
1505
0
}
1506
1507
int
1508
sshkey_cert_copy(const struct sshkey *from_key, struct sshkey *to_key)
1509
0
{
1510
0
  u_int i;
1511
0
  const struct sshkey_cert *from;
1512
0
  struct sshkey_cert *to;
1513
0
  int r = SSH_ERR_INTERNAL_ERROR;
1514
1515
0
  if (to_key == NULL || (from = from_key->cert) == NULL)
1516
0
    return SSH_ERR_INVALID_ARGUMENT;
1517
1518
0
  if ((to = cert_new()) == NULL)
1519
0
    return SSH_ERR_ALLOC_FAIL;
1520
1521
0
  if ((r = sshbuf_putb(to->certblob, from->certblob)) != 0 ||
1522
0
      (r = sshbuf_putb(to->critical, from->critical)) != 0 ||
1523
0
      (r = sshbuf_putb(to->extensions, from->extensions)) != 0)
1524
0
    goto out;
1525
1526
0
  to->serial = from->serial;
1527
0
  to->type = from->type;
1528
0
  if (from->key_id == NULL)
1529
0
    to->key_id = NULL;
1530
0
  else if ((to->key_id = strdup(from->key_id)) == NULL) {
1531
0
    r = SSH_ERR_ALLOC_FAIL;
1532
0
    goto out;
1533
0
  }
1534
0
  to->valid_after = from->valid_after;
1535
0
  to->valid_before = from->valid_before;
1536
0
  if (from->signature_key == NULL)
1537
0
    to->signature_key = NULL;
1538
0
  else if ((r = sshkey_from_private(from->signature_key,
1539
0
      &to->signature_key)) != 0)
1540
0
    goto out;
1541
0
  if (from->signature_type != NULL &&
1542
0
      (to->signature_type = strdup(from->signature_type)) == NULL) {
1543
0
    r = SSH_ERR_ALLOC_FAIL;
1544
0
    goto out;
1545
0
  }
1546
0
  if (from->nprincipals > SSHKEY_CERT_MAX_PRINCIPALS) {
1547
0
    r = SSH_ERR_INVALID_ARGUMENT;
1548
0
    goto out;
1549
0
  }
1550
0
  if (from->nprincipals > 0) {
1551
0
    if ((to->principals = calloc(from->nprincipals,
1552
0
        sizeof(*to->principals))) == NULL) {
1553
0
      r = SSH_ERR_ALLOC_FAIL;
1554
0
      goto out;
1555
0
    }
1556
0
    for (i = 0; i < from->nprincipals; i++) {
1557
0
      to->principals[i] = strdup(from->principals[i]);
1558
0
      if (to->principals[i] == NULL) {
1559
0
        to->nprincipals = i;
1560
0
        r = SSH_ERR_ALLOC_FAIL;
1561
0
        goto out;
1562
0
      }
1563
0
    }
1564
0
  }
1565
0
  to->nprincipals = from->nprincipals;
1566
1567
  /* success */
1568
0
  cert_free(to_key->cert);
1569
0
  to_key->cert = to;
1570
0
  to = NULL;
1571
0
  r = 0;
1572
0
 out:
1573
0
  cert_free(to);
1574
0
  return r;
1575
0
}
1576
1577
int
1578
sshkey_copy_public_sk(const struct sshkey *from, struct sshkey *to)
1579
0
{
1580
  /* Append security-key application string */
1581
0
  if ((to->sk_application = strdup(from->sk_application)) == NULL)
1582
0
    return SSH_ERR_ALLOC_FAIL;
1583
0
  return 0;
1584
0
}
1585
1586
int
1587
sshkey_from_private(const struct sshkey *k, struct sshkey **pkp)
1588
0
{
1589
0
  struct sshkey *n = NULL;
1590
0
  int r = SSH_ERR_INTERNAL_ERROR;
1591
0
  const struct sshkey_impl *impl;
1592
1593
0
  *pkp = NULL;
1594
0
  if ((impl = sshkey_impl_from_key(k)) == NULL)
1595
0
    return SSH_ERR_KEY_TYPE_UNKNOWN;
1596
0
  if ((n = sshkey_new(k->type)) == NULL) {
1597
0
    r = SSH_ERR_ALLOC_FAIL;
1598
0
    goto out;
1599
0
  }
1600
0
  if ((r = impl->funcs->copy_public(k, n)) != 0)
1601
0
    goto out;
1602
0
  if (sshkey_is_cert(k) && (r = sshkey_cert_copy(k, n)) != 0)
1603
0
    goto out;
1604
  /* success */
1605
0
  *pkp = n;
1606
0
  n = NULL;
1607
0
  r = 0;
1608
0
 out:
1609
0
  sshkey_free(n);
1610
0
  return r;
1611
0
}
1612
1613
int
1614
sshkey_is_shielded(struct sshkey *k)
1615
0
{
1616
0
  return k != NULL && k->shielded_private != NULL;
1617
0
}
1618
1619
int
1620
sshkey_shield_private(struct sshkey *k)
1621
0
{
1622
0
  struct sshbuf *prvbuf = NULL;
1623
0
  u_char *prekey = NULL, *enc = NULL, keyiv[SSH_DIGEST_MAX_LENGTH];
1624
0
  struct sshcipher_ctx *cctx = NULL;
1625
0
  const struct sshcipher *cipher;
1626
0
  size_t i, enclen = 0;
1627
0
  struct sshkey *kswap = NULL, tmp;
1628
0
  int r = SSH_ERR_INTERNAL_ERROR;
1629
1630
#ifdef DEBUG_PK
1631
  fprintf(stderr, "%s: entering for %s\n", __func__, sshkey_ssh_name(k));
1632
#endif
1633
0
  if ((cipher = cipher_by_name(SSHKEY_SHIELD_CIPHER)) == NULL) {
1634
0
    r = SSH_ERR_INVALID_ARGUMENT;
1635
0
    goto out;
1636
0
  }
1637
0
  if (cipher_keylen(cipher) + cipher_ivlen(cipher) >
1638
0
      ssh_digest_bytes(SSHKEY_SHIELD_PREKEY_HASH)) {
1639
0
    r = SSH_ERR_INTERNAL_ERROR;
1640
0
    goto out;
1641
0
  }
1642
1643
  /* Prepare a random pre-key, and from it an ephemeral key */
1644
0
  if ((r = sshkey_prekey_alloc(&prekey, SSHKEY_SHIELD_PREKEY_LEN)) != 0)
1645
0
    goto out;
1646
0
  arc4random_buf(prekey, SSHKEY_SHIELD_PREKEY_LEN);
1647
0
  if ((r = ssh_digest_memory(SSHKEY_SHIELD_PREKEY_HASH,
1648
0
      prekey, SSHKEY_SHIELD_PREKEY_LEN,
1649
0
      keyiv, SSH_DIGEST_MAX_LENGTH)) != 0)
1650
0
    goto out;
1651
#ifdef DEBUG_PK
1652
  fprintf(stderr, "%s: key+iv\n", __func__);
1653
  sshbuf_dump_data(keyiv, ssh_digest_bytes(SSHKEY_SHIELD_PREKEY_HASH),
1654
      stderr);
1655
#endif
1656
0
  if ((r = cipher_init(&cctx, cipher, keyiv, cipher_keylen(cipher),
1657
0
      keyiv + cipher_keylen(cipher), cipher_ivlen(cipher), 1)) != 0)
1658
0
    goto out;
1659
1660
  /* Serialise and encrypt the private key using the ephemeral key */
1661
0
  if ((prvbuf = sshbuf_new()) == NULL) {
1662
0
    r = SSH_ERR_ALLOC_FAIL;
1663
0
    goto out;
1664
0
  }
1665
0
  if (sshkey_is_shielded(k) && (r = sshkey_unshield_private(k)) != 0)
1666
0
    goto out;
1667
0
  if ((r = sshkey_private_serialize(k, prvbuf)) != 0)
1668
0
    goto out;
1669
  /* pad to cipher blocksize */
1670
0
  i = 0;
1671
0
  while (sshbuf_len(prvbuf) % cipher_blocksize(cipher)) {
1672
0
    if ((r = sshbuf_put_u8(prvbuf, ++i & 0xff)) != 0)
1673
0
      goto out;
1674
0
  }
1675
#ifdef DEBUG_PK
1676
  fprintf(stderr, "%s: serialised\n", __func__);
1677
  sshbuf_dump(prvbuf, stderr);
1678
#endif
1679
  /* encrypt */
1680
0
  enclen = sshbuf_len(prvbuf);
1681
0
  if ((enc = malloc(enclen)) == NULL) {
1682
0
    r = SSH_ERR_ALLOC_FAIL;
1683
0
    goto out;
1684
0
  }
1685
0
  if ((r = cipher_crypt(cctx, 0, enc,
1686
0
      sshbuf_ptr(prvbuf), sshbuf_len(prvbuf), 0, 0)) != 0)
1687
0
    goto out;
1688
#ifdef DEBUG_PK
1689
  fprintf(stderr, "%s: encrypted\n", __func__);
1690
  sshbuf_dump_data(enc, enclen, stderr);
1691
#endif
1692
1693
  /* Make a scrubbed, public-only copy of our private key argument */
1694
0
  if ((r = sshkey_from_private(k, &kswap)) != 0)
1695
0
    goto out;
1696
1697
  /* Swap the private key out (it will be destroyed below) */
1698
0
  tmp = *kswap;
1699
0
  *kswap = *k;
1700
0
  *k = tmp;
1701
1702
  /* Insert the shielded key into our argument */
1703
0
  k->shielded_private = enc;
1704
0
  k->shielded_len = enclen;
1705
0
  k->shield_prekey = prekey;
1706
0
  k->shield_prekey_len = SSHKEY_SHIELD_PREKEY_LEN;
1707
0
  enc = prekey = NULL; /* transferred */
1708
0
  enclen = 0;
1709
1710
  /* preserve key fields that are required for correct operation */
1711
0
  k->sk_flags = kswap->sk_flags;
1712
1713
  /* success */
1714
0
  r = 0;
1715
1716
0
 out:
1717
  /* XXX behaviour on error - invalidate original private key? */
1718
0
  cipher_free(cctx);
1719
0
  explicit_bzero(keyiv, sizeof(keyiv));
1720
0
  explicit_bzero(&tmp, sizeof(tmp));
1721
0
  freezero(enc, enclen);
1722
0
  sshkey_prekey_free(prekey, SSHKEY_SHIELD_PREKEY_LEN);
1723
0
  sshkey_free(kswap);
1724
0
  sshbuf_free(prvbuf);
1725
0
  return r;
1726
0
}
1727
1728
/* Check deterministic padding after private key */
1729
static int
1730
private2_check_padding(struct sshbuf *decrypted)
1731
0
{
1732
0
  u_char pad;
1733
0
  size_t i;
1734
0
  int r;
1735
1736
0
  i = 0;
1737
0
  while (sshbuf_len(decrypted)) {
1738
0
    if ((r = sshbuf_get_u8(decrypted, &pad)) != 0)
1739
0
      goto out;
1740
0
    if (pad != (++i & 0xff)) {
1741
0
      r = SSH_ERR_INVALID_FORMAT;
1742
0
      goto out;
1743
0
    }
1744
0
  }
1745
  /* success */
1746
0
  r = 0;
1747
0
 out:
1748
0
  explicit_bzero(&pad, sizeof(pad));
1749
0
  explicit_bzero(&i, sizeof(i));
1750
0
  return r;
1751
0
}
1752
1753
int
1754
sshkey_unshield_private(struct sshkey *k)
1755
0
{
1756
0
  struct sshbuf *prvbuf = NULL;
1757
0
  u_char *cp, keyiv[SSH_DIGEST_MAX_LENGTH];
1758
0
  struct sshcipher_ctx *cctx = NULL;
1759
0
  const struct sshcipher *cipher;
1760
0
  struct sshkey *kswap = NULL, tmp;
1761
0
  int r = SSH_ERR_INTERNAL_ERROR;
1762
1763
#ifdef DEBUG_PK
1764
  fprintf(stderr, "%s: entering for %s\n", __func__, sshkey_ssh_name(k));
1765
#endif
1766
0
  if (!sshkey_is_shielded(k))
1767
0
    return 0; /* nothing to do */
1768
1769
0
  if ((cipher = cipher_by_name(SSHKEY_SHIELD_CIPHER)) == NULL) {
1770
0
    r = SSH_ERR_INVALID_ARGUMENT;
1771
0
    goto out;
1772
0
  }
1773
0
  if (cipher_keylen(cipher) + cipher_ivlen(cipher) >
1774
0
      ssh_digest_bytes(SSHKEY_SHIELD_PREKEY_HASH)) {
1775
0
    r = SSH_ERR_INTERNAL_ERROR;
1776
0
    goto out;
1777
0
  }
1778
  /* check size of shielded key blob */
1779
0
  if (k->shielded_len < cipher_blocksize(cipher) ||
1780
0
      (k->shielded_len % cipher_blocksize(cipher)) != 0) {
1781
0
    r = SSH_ERR_INVALID_FORMAT;
1782
0
    goto out;
1783
0
  }
1784
1785
  /* Calculate the ephemeral key from the prekey */
1786
0
  if ((r = ssh_digest_memory(SSHKEY_SHIELD_PREKEY_HASH,
1787
0
      k->shield_prekey, k->shield_prekey_len,
1788
0
      keyiv, SSH_DIGEST_MAX_LENGTH)) != 0)
1789
0
    goto out;
1790
0
  if ((r = cipher_init(&cctx, cipher, keyiv, cipher_keylen(cipher),
1791
0
      keyiv + cipher_keylen(cipher), cipher_ivlen(cipher), 0)) != 0)
1792
0
    goto out;
1793
#ifdef DEBUG_PK
1794
  fprintf(stderr, "%s: key+iv\n", __func__);
1795
  sshbuf_dump_data(keyiv, ssh_digest_bytes(SSHKEY_SHIELD_PREKEY_HASH),
1796
      stderr);
1797
#endif
1798
1799
  /* Decrypt and parse the shielded private key using the ephemeral key */
1800
0
  if ((prvbuf = sshbuf_new()) == NULL) {
1801
0
    r = SSH_ERR_ALLOC_FAIL;
1802
0
    goto out;
1803
0
  }
1804
0
  if ((r = sshbuf_reserve(prvbuf, k->shielded_len, &cp)) != 0)
1805
0
    goto out;
1806
  /* decrypt */
1807
#ifdef DEBUG_PK
1808
  fprintf(stderr, "%s: encrypted\n", __func__);
1809
  sshbuf_dump_data(k->shielded_private, k->shielded_len, stderr);
1810
#endif
1811
0
  if ((r = cipher_crypt(cctx, 0, cp,
1812
0
      k->shielded_private, k->shielded_len, 0, 0)) != 0)
1813
0
    goto out;
1814
#ifdef DEBUG_PK
1815
  fprintf(stderr, "%s: serialised\n", __func__);
1816
  sshbuf_dump(prvbuf, stderr);
1817
#endif
1818
  /* Parse private key */
1819
0
  if ((r = sshkey_private_deserialize(prvbuf, &kswap)) != 0)
1820
0
    goto out;
1821
1822
0
  if ((r = private2_check_padding(prvbuf)) != 0)
1823
0
    goto out;
1824
1825
  /* Swap the parsed key back into place */
1826
0
  tmp = *kswap;
1827
0
  *kswap = *k;
1828
0
  *k = tmp;
1829
1830
  /* success */
1831
0
  r = 0;
1832
1833
0
 out:
1834
0
  cipher_free(cctx);
1835
0
  explicit_bzero(keyiv, sizeof(keyiv));
1836
0
  explicit_bzero(&tmp, sizeof(tmp));
1837
0
  sshkey_free(kswap);
1838
0
  sshbuf_free(prvbuf);
1839
0
  return r;
1840
0
}
1841
1842
static int
1843
cert_parse(struct sshbuf *b, struct sshkey *key, struct sshbuf *certbuf)
1844
590
{
1845
590
  struct sshbuf *principals = NULL, *crit = NULL;
1846
590
  struct sshbuf *exts = NULL, *ca = NULL;
1847
590
  u_char *sig = NULL;
1848
590
  size_t signed_len = 0, slen = 0, kidlen = 0;
1849
590
  int ret = SSH_ERR_INTERNAL_ERROR;
1850
1851
  /* Copy the entire key blob for verification and later serialisation */
1852
590
  if ((ret = sshbuf_putb(key->cert->certblob, certbuf)) != 0)
1853
0
    return ret;
1854
1855
  /* Parse body of certificate up to signature */
1856
590
  if ((ret = sshbuf_get_u64(b, &key->cert->serial)) != 0 ||
1857
584
      (ret = sshbuf_get_u32(b, &key->cert->type)) != 0 ||
1858
581
      (ret = sshbuf_get_cstring(b, &key->cert->key_id, &kidlen)) != 0 ||
1859
574
      (ret = sshbuf_froms(b, &principals)) != 0 ||
1860
535
      (ret = sshbuf_get_u64(b, &key->cert->valid_after)) != 0 ||
1861
522
      (ret = sshbuf_get_u64(b, &key->cert->valid_before)) != 0 ||
1862
520
      (ret = sshbuf_froms(b, &crit)) != 0 ||
1863
516
      (ret = sshbuf_froms(b, &exts)) != 0 ||
1864
512
      (ret = sshbuf_get_string_direct(b, NULL, NULL)) != 0 ||
1865
509
      (ret = sshbuf_froms(b, &ca)) != 0) {
1866
    /* XXX debug print error for ret */
1867
84
    ret = SSH_ERR_INVALID_FORMAT;
1868
84
    goto out;
1869
84
  }
1870
1871
  /* Signature is left in the buffer so we can calculate this length */
1872
506
  signed_len = sshbuf_len(key->cert->certblob) - sshbuf_len(b);
1873
1874
506
  if ((ret = sshbuf_get_string(b, &sig, &slen)) != 0) {
1875
8
    ret = SSH_ERR_INVALID_FORMAT;
1876
8
    goto out;
1877
8
  }
1878
1879
498
  if (key->cert->type != SSH2_CERT_TYPE_USER &&
1880
184
      key->cert->type != SSH2_CERT_TYPE_HOST) {
1881
50
    ret = SSH_ERR_KEY_CERT_UNKNOWN_TYPE;
1882
50
    goto out;
1883
50
  }
1884
1885
  /* Parse principals section */
1886
3.09k
  while (sshbuf_len(principals) > 0) {
1887
2.67k
    char *principal = NULL;
1888
2.67k
    char **oprincipals = NULL;
1889
1890
2.67k
    if (key->cert->nprincipals >= SSHKEY_CERT_MAX_PRINCIPALS) {
1891
1
      ret = SSH_ERR_INVALID_FORMAT;
1892
1
      goto out;
1893
1
    }
1894
2.67k
    if ((ret = sshbuf_get_cstring(principals, &principal,
1895
2.67k
        NULL)) != 0) {
1896
32
      ret = SSH_ERR_INVALID_FORMAT;
1897
32
      goto out;
1898
32
    }
1899
2.64k
    oprincipals = key->cert->principals;
1900
2.64k
    key->cert->principals = recallocarray(key->cert->principals,
1901
2.64k
        key->cert->nprincipals, key->cert->nprincipals + 1,
1902
2.64k
        sizeof(*key->cert->principals));
1903
2.64k
    if (key->cert->principals == NULL) {
1904
0
      free(principal);
1905
0
      key->cert->principals = oprincipals;
1906
0
      ret = SSH_ERR_ALLOC_FAIL;
1907
0
      goto out;
1908
0
    }
1909
2.64k
    key->cert->principals[key->cert->nprincipals++] = principal;
1910
2.64k
  }
1911
1912
  /*
1913
   * Stash a copies of the critical options and extensions sections
1914
   * for later use.
1915
   */
1916
415
  if ((ret = sshbuf_putb(key->cert->critical, crit)) != 0 ||
1917
415
      (exts != NULL &&
1918
415
      (ret = sshbuf_putb(key->cert->extensions, exts)) != 0))
1919
0
    goto out;
1920
1921
  /*
1922
   * Validate critical options and extensions sections format.
1923
   */
1924
1.51k
  while (sshbuf_len(crit) != 0) {
1925
1.15k
    if ((ret = sshbuf_get_string_direct(crit, NULL, NULL)) != 0 ||
1926
1.12k
        (ret = sshbuf_get_string_direct(crit, NULL, NULL)) != 0) {
1927
53
      sshbuf_reset(key->cert->critical);
1928
53
      ret = SSH_ERR_INVALID_FORMAT;
1929
53
      goto out;
1930
53
    }
1931
1.15k
  }
1932
1.28k
  while (exts != NULL && sshbuf_len(exts) != 0) {
1933
950
    if ((ret = sshbuf_get_string_direct(exts, NULL, NULL)) != 0 ||
1934
929
        (ret = sshbuf_get_string_direct(exts, NULL, NULL)) != 0) {
1935
28
      sshbuf_reset(key->cert->extensions);
1936
28
      ret = SSH_ERR_INVALID_FORMAT;
1937
28
      goto out;
1938
28
    }
1939
950
  }
1940
1941
  /* Parse CA key and check signature */
1942
334
  if (sshkey_from_blob_internal(ca, &key->cert->signature_key, 0) != 0) {
1943
46
    ret = SSH_ERR_KEY_CERT_INVALID_SIGN_KEY;
1944
46
    goto out;
1945
46
  }
1946
288
  if (!sshkey_type_is_valid_ca(key->cert->signature_key->type)) {
1947
0
    ret = SSH_ERR_KEY_CERT_INVALID_SIGN_KEY;
1948
0
    goto out;
1949
0
  }
1950
288
  if ((ret = sshkey_verify(key->cert->signature_key, sig, slen,
1951
288
      sshbuf_ptr(key->cert->certblob), signed_len, NULL, 0, NULL)) != 0)
1952
260
    goto out;
1953
28
  if ((ret = sshkey_get_sigtype(sig, slen,
1954
28
      &key->cert->signature_type)) != 0)
1955
0
    goto out;
1956
1957
  /* Success */
1958
28
  ret = 0;
1959
590
 out:
1960
590
  sshbuf_free(ca);
1961
590
  sshbuf_free(crit);
1962
590
  sshbuf_free(exts);
1963
590
  sshbuf_free(principals);
1964
590
  free(sig);
1965
590
  return ret;
1966
28
}
1967
1968
int
1969
sshkey_deserialize_sk(struct sshbuf *b, struct sshkey *key)
1970
653
{
1971
  /* Parse additional security-key application string */
1972
653
  if (sshbuf_get_cstring(b, &key->sk_application, NULL) != 0)
1973
2
    return SSH_ERR_INVALID_FORMAT;
1974
651
  return 0;
1975
653
}
1976
1977
static int
1978
sshkey_from_blob_internal(struct sshbuf *b, struct sshkey **keyp,
1979
    int allow_cert)
1980
1.99k
{
1981
1.99k
  int type, ret = SSH_ERR_INTERNAL_ERROR;
1982
1.99k
  char *ktype = NULL;
1983
1.99k
  struct sshkey *key = NULL;
1984
1.99k
  struct sshbuf *copy;
1985
1.99k
  const struct sshkey_impl *impl;
1986
1987
#ifdef DEBUG_PK /* XXX */
1988
  sshbuf_dump(b, stderr);
1989
#endif
1990
1.99k
  if (keyp != NULL)
1991
1.99k
    *keyp = NULL;
1992
1.99k
  if ((copy = sshbuf_fromb(b)) == NULL) {
1993
0
    ret = SSH_ERR_ALLOC_FAIL;
1994
0
    goto out;
1995
0
  }
1996
1.99k
  if (sshbuf_get_cstring(b, &ktype, NULL) != 0) {
1997
86
    ret = SSH_ERR_INVALID_FORMAT;
1998
86
    goto out;
1999
86
  }
2000
2001
1.90k
  type = sshkey_type_from_name(ktype);
2002
1.90k
  if (!allow_cert && sshkey_type_is_cert(type)) {
2003
2
    ret = SSH_ERR_KEY_CERT_INVALID_SIGN_KEY;
2004
2
    goto out;
2005
2
  }
2006
1.90k
  if ((impl = sshkey_impl_from_type(type)) == NULL) {
2007
135
    ret = SSH_ERR_KEY_TYPE_UNKNOWN;
2008
135
    goto out;
2009
135
  }
2010
1.77k
  if ((key = sshkey_new(type)) == NULL) {
2011
0
    ret = SSH_ERR_ALLOC_FAIL;
2012
0
    goto out;
2013
0
  }
2014
1.77k
  if (sshkey_type_is_cert(type)) {
2015
    /* Skip nonce that precedes all certificates */
2016
623
    if (sshbuf_get_string_direct(b, NULL, NULL) != 0) {
2017
4
      ret = SSH_ERR_INVALID_FORMAT;
2018
4
      goto out;
2019
4
    }
2020
623
  }
2021
1.76k
  if ((ret = impl->funcs->deserialize_public(ktype, b, key)) != 0)
2022
413
    goto out;
2023
2024
  /* Parse certificate potion */
2025
1.35k
  if (sshkey_is_cert(key) && (ret = cert_parse(b, key, copy)) != 0)
2026
562
    goto out;
2027
2028
792
  if (key != NULL && sshbuf_len(b) != 0) {
2029
20
    ret = SSH_ERR_INVALID_FORMAT;
2030
20
    goto out;
2031
20
  }
2032
772
  ret = 0;
2033
772
  if (keyp != NULL) {
2034
772
    *keyp = key;
2035
772
    key = NULL;
2036
772
  }
2037
1.99k
 out:
2038
1.99k
  sshbuf_free(copy);
2039
1.99k
  sshkey_free(key);
2040
1.99k
  free(ktype);
2041
1.99k
  return ret;
2042
772
}
2043
2044
int
2045
sshkey_from_blob(const u_char *blob, size_t blen, struct sshkey **keyp)
2046
0
{
2047
0
  struct sshbuf *b;
2048
0
  int r;
2049
2050
0
  if ((b = sshbuf_from(blob, blen)) == NULL)
2051
0
    return SSH_ERR_ALLOC_FAIL;
2052
0
  r = sshkey_from_blob_internal(b, keyp, 1);
2053
0
  sshbuf_free(b);
2054
0
  return r;
2055
0
}
2056
2057
int
2058
sshkey_fromb(struct sshbuf *b, struct sshkey **keyp)
2059
0
{
2060
0
  return sshkey_from_blob_internal(b, keyp, 1);
2061
0
}
2062
2063
int
2064
sshkey_froms(struct sshbuf *buf, struct sshkey **keyp)
2065
1.66k
{
2066
1.66k
  struct sshbuf *b;
2067
1.66k
  int r;
2068
2069
1.66k
  if ((r = sshbuf_froms(buf, &b)) != 0)
2070
0
    return r;
2071
1.66k
  r = sshkey_from_blob_internal(b, keyp, 1);
2072
1.66k
  sshbuf_free(b);
2073
1.66k
  return r;
2074
1.66k
}
2075
2076
int
2077
sshkey_get_sigtype(const u_char *sig, size_t siglen, char **sigtypep)
2078
69
{
2079
69
  int r;
2080
69
  struct sshbuf *b = NULL;
2081
69
  char *sigtype = NULL;
2082
2083
69
  if (sigtypep != NULL)
2084
69
    *sigtypep = NULL;
2085
69
  if ((b = sshbuf_from(sig, siglen)) == NULL)
2086
0
    return SSH_ERR_ALLOC_FAIL;
2087
69
  if ((r = sshbuf_get_cstring(b, &sigtype, NULL)) != 0)
2088
2
    goto out;
2089
  /* success */
2090
67
  if (sigtypep != NULL) {
2091
67
    *sigtypep = sigtype;
2092
67
    sigtype = NULL;
2093
67
  }
2094
67
  r = 0;
2095
69
 out:
2096
69
  free(sigtype);
2097
69
  sshbuf_free(b);
2098
69
  return r;
2099
67
}
2100
2101
/*
2102
 *
2103
 * Checks whether a certificate's signature type is allowed.
2104
 * Returns 0 (success) if the certificate signature type appears in the
2105
 * "allowed" pattern-list, or the key is not a certificate to begin with.
2106
 * Otherwise returns a ssherr.h code.
2107
 */
2108
int
2109
sshkey_check_cert_sigtype(const struct sshkey *key, const char *allowed)
2110
0
{
2111
0
  if (key == NULL || allowed == NULL)
2112
0
    return SSH_ERR_INVALID_ARGUMENT;
2113
0
  if (!sshkey_type_is_cert(key->type))
2114
0
    return 0;
2115
0
  if (key->cert == NULL || key->cert->signature_type == NULL)
2116
0
    return SSH_ERR_INVALID_ARGUMENT;
2117
0
  if (match_pattern_list(key->cert->signature_type, allowed, 0) != 1)
2118
0
    return SSH_ERR_SIGN_ALG_UNSUPPORTED;
2119
0
  return 0;
2120
0
}
2121
2122
/*
2123
 * Returns the expected signature algorithm for a given public key algorithm.
2124
 */
2125
const char *
2126
sshkey_sigalg_by_name(const char *name)
2127
0
{
2128
0
  const struct sshkey_impl *impl;
2129
0
  int i;
2130
2131
0
  for (i = 0; keyimpls[i] != NULL; i++) {
2132
0
    impl = keyimpls[i];
2133
0
    if (strcmp(impl->name, name) != 0)
2134
0
      continue;
2135
0
    if (impl->sigalg != NULL)
2136
0
      return impl->sigalg;
2137
0
    if (!impl->cert)
2138
0
      return impl->name;
2139
0
    return sshkey_ssh_name_from_type_nid(
2140
0
        sshkey_type_plain(impl->type), impl->nid);
2141
0
  }
2142
0
  return NULL;
2143
0
}
2144
2145
/*
2146
 * Verifies that the signature algorithm appearing inside the signature blob
2147
 * matches that which was requested.
2148
 */
2149
int
2150
sshkey_check_sigtype(const u_char *sig, size_t siglen,
2151
    const char *requested_alg)
2152
0
{
2153
0
  const char *expected_alg;
2154
0
  char *sigtype = NULL;
2155
0
  int r;
2156
2157
0
  if (requested_alg == NULL)
2158
0
    return 0;
2159
0
  if ((expected_alg = sshkey_sigalg_by_name(requested_alg)) == NULL)
2160
0
    return SSH_ERR_INVALID_ARGUMENT;
2161
0
  if ((r = sshkey_get_sigtype(sig, siglen, &sigtype)) != 0)
2162
0
    return r;
2163
0
  r = strcmp(expected_alg, sigtype) == 0;
2164
0
  free(sigtype);
2165
0
  return r ? 0 : SSH_ERR_SIGN_ALG_UNSUPPORTED;
2166
0
}
2167
2168
int
2169
sshkey_sign(struct sshkey *key,
2170
    u_char **sigp, size_t *lenp,
2171
    const u_char *data, size_t datalen,
2172
    const char *alg, const char *sk_provider, const char *sk_pin, u_int compat)
2173
0
{
2174
0
  int was_shielded = sshkey_is_shielded(key);
2175
0
  int r2, r = SSH_ERR_INTERNAL_ERROR;
2176
0
  const struct sshkey_impl *impl;
2177
2178
0
  if (sigp != NULL)
2179
0
    *sigp = NULL;
2180
0
  if (lenp != NULL)
2181
0
    *lenp = 0;
2182
0
  if (datalen > SSH_KEY_MAX_SIGN_DATA_SIZE)
2183
0
    return SSH_ERR_INVALID_ARGUMENT;
2184
0
  if ((impl = sshkey_impl_from_key(key)) == NULL)
2185
0
    return SSH_ERR_KEY_TYPE_UNKNOWN;
2186
0
  if ((r = sshkey_unshield_private(key)) != 0)
2187
0
    return r;
2188
0
  if (sshkey_is_sk(key)) {
2189
0
    r = sshsk_sign(sk_provider, key, sigp, lenp, data,
2190
0
        datalen, compat, sk_pin);
2191
0
  } else if ((key->flags & SSHKEY_FLAG_EXT) != 0) {
2192
0
    r = pkcs11_sign(key, sigp, lenp, data, datalen,
2193
0
        alg, sk_provider, sk_pin, compat);
2194
0
  } else {
2195
0
    if (impl->funcs->sign == NULL)
2196
0
      r = SSH_ERR_SIGN_ALG_UNSUPPORTED;
2197
0
    else {
2198
0
      r = impl->funcs->sign(key, sigp, lenp, data, datalen,
2199
0
          alg, sk_provider, sk_pin, compat);
2200
0
     }
2201
0
  }
2202
0
  if (was_shielded && (r2 = sshkey_shield_private(key)) != 0)
2203
0
    return r2;
2204
0
  return r;
2205
0
}
2206
2207
/*
2208
 * ssh_key_verify returns 0 for a correct signature  and < 0 on error.
2209
 * If "alg" specified, then the signature must use that algorithm.
2210
 */
2211
int
2212
sshkey_verify(const struct sshkey *key,
2213
    const u_char *sig, size_t siglen,
2214
    const u_char *data, size_t dlen, const char *alg, u_int compat,
2215
    struct sshkey_sig_details **detailsp)
2216
681
{
2217
681
  const struct sshkey_impl *impl;
2218
2219
681
  if (detailsp != NULL)
2220
393
    *detailsp = NULL;
2221
681
  if (siglen == 0 || dlen > SSH_KEY_MAX_SIGN_DATA_SIZE)
2222
5
    return SSH_ERR_INVALID_ARGUMENT;
2223
676
  if ((impl = sshkey_impl_from_key(key)) == NULL)
2224
0
    return SSH_ERR_KEY_TYPE_UNKNOWN;
2225
676
  return impl->funcs->verify(key, sig, siglen, data, dlen,
2226
676
      alg, compat, detailsp);
2227
676
}
2228
2229
/* Convert a plain key to their _CERT equivalent */
2230
int
2231
sshkey_to_certified(struct sshkey *k)
2232
0
{
2233
0
  int newtype;
2234
2235
0
  if ((newtype = sshkey_type_certified(k->type)) == -1)
2236
0
    return SSH_ERR_INVALID_ARGUMENT;
2237
0
  if ((k->cert = cert_new()) == NULL)
2238
0
    return SSH_ERR_ALLOC_FAIL;
2239
0
  k->type = newtype;
2240
0
  return 0;
2241
0
}
2242
2243
/* Convert a certificate to its raw key equivalent */
2244
int
2245
sshkey_drop_cert(struct sshkey *k)
2246
0
{
2247
0
  if (!sshkey_type_is_cert(k->type))
2248
0
    return SSH_ERR_KEY_TYPE_UNKNOWN;
2249
0
  cert_free(k->cert);
2250
0
  k->cert = NULL;
2251
0
  k->type = sshkey_type_plain(k->type);
2252
0
  return 0;
2253
0
}
2254
2255
/* Sign a certified key, (re-)generating the signed certblob. */
2256
int
2257
sshkey_certify_custom(struct sshkey *k, struct sshkey *ca, const char *alg,
2258
    const char *sk_provider, const char *sk_pin,
2259
    sshkey_certify_signer *signer, void *signer_ctx)
2260
0
{
2261
0
  const struct sshkey_impl *impl;
2262
0
  struct sshbuf *principals = NULL;
2263
0
  u_char *ca_blob = NULL, *sig_blob = NULL, nonce[32];
2264
0
  size_t i, ca_len, sig_len;
2265
0
  int ret = SSH_ERR_INTERNAL_ERROR;
2266
0
  struct sshbuf *cert = NULL;
2267
0
  char *sigtype = NULL;
2268
2269
0
  if (k == NULL || k->cert == NULL ||
2270
0
      k->cert->certblob == NULL || ca == NULL)
2271
0
    return SSH_ERR_INVALID_ARGUMENT;
2272
0
  if (!sshkey_is_cert(k))
2273
0
    return SSH_ERR_KEY_TYPE_UNKNOWN;
2274
0
  if (!sshkey_type_is_valid_ca(ca->type))
2275
0
    return SSH_ERR_KEY_CERT_INVALID_SIGN_KEY;
2276
0
  if ((impl = sshkey_impl_from_key(k)) == NULL)
2277
0
    return SSH_ERR_INTERNAL_ERROR;
2278
2279
  /*
2280
   * If no alg specified as argument but a signature_type was set,
2281
   * then prefer that. If both were specified, then they must match.
2282
   */
2283
0
  if (alg == NULL)
2284
0
    alg = k->cert->signature_type;
2285
0
  else if (k->cert->signature_type != NULL &&
2286
0
      strcmp(alg, k->cert->signature_type) != 0)
2287
0
    return SSH_ERR_INVALID_ARGUMENT;
2288
2289
  /*
2290
   * If no signing algorithm or signature_type was specified and we're
2291
   * using a RSA key, then default to a good signature algorithm.
2292
   */
2293
0
  if (alg == NULL && ca->type == KEY_RSA)
2294
0
    alg = "rsa-sha2-512";
2295
2296
0
  if ((ret = sshkey_to_blob(ca, &ca_blob, &ca_len)) != 0)
2297
0
    return SSH_ERR_KEY_CERT_INVALID_SIGN_KEY;
2298
2299
0
  cert = k->cert->certblob; /* for readability */
2300
0
  sshbuf_reset(cert);
2301
0
  if ((ret = sshbuf_put_cstring(cert, sshkey_ssh_name(k))) != 0)
2302
0
    goto out;
2303
2304
  /* -v01 certs put nonce first */
2305
0
  arc4random_buf(&nonce, sizeof(nonce));
2306
0
  if ((ret = sshbuf_put_string(cert, nonce, sizeof(nonce))) != 0)
2307
0
    goto out;
2308
2309
  /* Public key next */
2310
0
  if ((ret = impl->funcs->serialize_public(k, cert,
2311
0
      SSHKEY_SERIALIZE_DEFAULT)) != 0)
2312
0
    goto out;
2313
2314
  /* Then remaining cert fields */
2315
0
  if ((ret = sshbuf_put_u64(cert, k->cert->serial)) != 0 ||
2316
0
      (ret = sshbuf_put_u32(cert, k->cert->type)) != 0 ||
2317
0
      (ret = sshbuf_put_cstring(cert, k->cert->key_id)) != 0)
2318
0
    goto out;
2319
2320
0
  if ((principals = sshbuf_new()) == NULL) {
2321
0
    ret = SSH_ERR_ALLOC_FAIL;
2322
0
    goto out;
2323
0
  }
2324
0
  for (i = 0; i < k->cert->nprincipals; i++) {
2325
0
    if ((ret = sshbuf_put_cstring(principals,
2326
0
        k->cert->principals[i])) != 0)
2327
0
      goto out;
2328
0
  }
2329
0
  if ((ret = sshbuf_put_stringb(cert, principals)) != 0 ||
2330
0
      (ret = sshbuf_put_u64(cert, k->cert->valid_after)) != 0 ||
2331
0
      (ret = sshbuf_put_u64(cert, k->cert->valid_before)) != 0 ||
2332
0
      (ret = sshbuf_put_stringb(cert, k->cert->critical)) != 0 ||
2333
0
      (ret = sshbuf_put_stringb(cert, k->cert->extensions)) != 0 ||
2334
0
      (ret = sshbuf_put_string(cert, NULL, 0)) != 0 || /* Reserved */
2335
0
      (ret = sshbuf_put_string(cert, ca_blob, ca_len)) != 0)
2336
0
    goto out;
2337
2338
  /* Sign the whole mess */
2339
0
  if ((ret = signer(ca, &sig_blob, &sig_len, sshbuf_ptr(cert),
2340
0
      sshbuf_len(cert), alg, sk_provider, sk_pin, 0, signer_ctx)) != 0)
2341
0
    goto out;
2342
  /* Check and update signature_type against what was actually used */
2343
0
  if ((ret = sshkey_get_sigtype(sig_blob, sig_len, &sigtype)) != 0)
2344
0
    goto out;
2345
0
  if (alg != NULL && strcmp(alg, sigtype) != 0) {
2346
0
    ret = SSH_ERR_SIGN_ALG_UNSUPPORTED;
2347
0
    goto out;
2348
0
  }
2349
0
  if (k->cert->signature_type == NULL) {
2350
0
    k->cert->signature_type = sigtype;
2351
0
    sigtype = NULL;
2352
0
  }
2353
  /* Append signature and we are done */
2354
0
  if ((ret = sshbuf_put_string(cert, sig_blob, sig_len)) != 0)
2355
0
    goto out;
2356
0
  ret = 0;
2357
0
 out:
2358
0
  if (ret != 0)
2359
0
    sshbuf_reset(cert);
2360
0
  free(sig_blob);
2361
0
  free(ca_blob);
2362
0
  free(sigtype);
2363
0
  sshbuf_free(principals);
2364
0
  return ret;
2365
0
}
2366
2367
static int
2368
default_key_sign(struct sshkey *key, u_char **sigp, size_t *lenp,
2369
    const u_char *data, size_t datalen,
2370
    const char *alg, const char *sk_provider, const char *sk_pin,
2371
    u_int compat, void *ctx)
2372
0
{
2373
0
  if (ctx != NULL)
2374
0
    return SSH_ERR_INVALID_ARGUMENT;
2375
0
  return sshkey_sign(key, sigp, lenp, data, datalen, alg,
2376
0
      sk_provider, sk_pin, compat);
2377
0
}
2378
2379
int
2380
sshkey_certify(struct sshkey *k, struct sshkey *ca, const char *alg,
2381
    const char *sk_provider, const char *sk_pin)
2382
0
{
2383
0
  return sshkey_certify_custom(k, ca, alg, sk_provider, sk_pin,
2384
0
      default_key_sign, NULL);
2385
0
}
2386
2387
int
2388
sshkey_cert_check_authority(const struct sshkey *k,
2389
    int want_host, int require_principal, int wildcard_pattern,
2390
    uint64_t verify_time, const char *name, const char **reason)
2391
0
{
2392
0
  u_int i, principal_matches;
2393
2394
0
  if (reason == NULL)
2395
0
    return SSH_ERR_INVALID_ARGUMENT;
2396
0
  if (!sshkey_is_cert(k)) {
2397
0
    *reason = "Key is not a certificate";
2398
0
    return SSH_ERR_KEY_CERT_INVALID;
2399
0
  }
2400
0
  if (want_host) {
2401
0
    if (k->cert->type != SSH2_CERT_TYPE_HOST) {
2402
0
      *reason = "Certificate invalid: not a host certificate";
2403
0
      return SSH_ERR_KEY_CERT_INVALID;
2404
0
    }
2405
0
  } else {
2406
0
    if (k->cert->type != SSH2_CERT_TYPE_USER) {
2407
0
      *reason = "Certificate invalid: not a user certificate";
2408
0
      return SSH_ERR_KEY_CERT_INVALID;
2409
0
    }
2410
0
  }
2411
0
  if (verify_time < k->cert->valid_after) {
2412
0
    *reason = "Certificate invalid: not yet valid";
2413
0
    return SSH_ERR_KEY_CERT_INVALID;
2414
0
  }
2415
0
  if (verify_time >= k->cert->valid_before) {
2416
0
    *reason = "Certificate invalid: expired";
2417
0
    return SSH_ERR_KEY_CERT_INVALID;
2418
0
  }
2419
0
  if (k->cert->nprincipals == 0) {
2420
0
    if (require_principal) {
2421
0
      *reason = "Certificate lacks principal list";
2422
0
      return SSH_ERR_KEY_CERT_INVALID;
2423
0
    }
2424
0
  } else if (name != NULL) {
2425
0
    principal_matches = 0;
2426
0
    for (i = 0; i < k->cert->nprincipals; i++) {
2427
0
      if (wildcard_pattern) {
2428
0
        if (match_pattern(k->cert->principals[i],
2429
0
            name)) {
2430
0
          principal_matches = 1;
2431
0
          break;
2432
0
        }
2433
0
      } else if (strcmp(name, k->cert->principals[i]) == 0) {
2434
0
        principal_matches = 1;
2435
0
        break;
2436
0
      }
2437
0
    }
2438
0
    if (!principal_matches) {
2439
0
      *reason = "Certificate invalid: name is not a listed "
2440
0
          "principal";
2441
0
      return SSH_ERR_KEY_CERT_INVALID;
2442
0
    }
2443
0
  }
2444
0
  return 0;
2445
0
}
2446
2447
int
2448
sshkey_cert_check_authority_now(const struct sshkey *k,
2449
    int want_host, int require_principal, int wildcard_pattern,
2450
    const char *name, const char **reason)
2451
0
{
2452
0
  time_t now;
2453
2454
0
  if ((now = time(NULL)) < 0) {
2455
    /* yikes - system clock before epoch! */
2456
0
    *reason = "Certificate invalid: not yet valid";
2457
0
    return SSH_ERR_KEY_CERT_INVALID;
2458
0
  }
2459
0
  return sshkey_cert_check_authority(k, want_host, require_principal,
2460
0
      wildcard_pattern, (uint64_t)now, name, reason);
2461
0
}
2462
2463
int
2464
sshkey_cert_check_host(const struct sshkey *key, const char *host,
2465
    int wildcard_principals, const char *ca_sign_algorithms,
2466
    const char **reason)
2467
0
{
2468
0
  int r;
2469
2470
0
  if ((r = sshkey_cert_check_authority_now(key, 1, 0, wildcard_principals,
2471
0
      host, reason)) != 0)
2472
0
    return r;
2473
0
  if (sshbuf_len(key->cert->critical) != 0) {
2474
0
    *reason = "Certificate contains unsupported critical options";
2475
0
    return SSH_ERR_KEY_CERT_INVALID;
2476
0
  }
2477
0
  if (ca_sign_algorithms != NULL &&
2478
0
      (r = sshkey_check_cert_sigtype(key, ca_sign_algorithms)) != 0) {
2479
0
    *reason = "Certificate signed with disallowed algorithm";
2480
0
    return SSH_ERR_KEY_CERT_INVALID;
2481
0
  }
2482
0
  return 0;
2483
0
}
2484
2485
size_t
2486
sshkey_format_cert_validity(const struct sshkey_cert *cert, char *s, size_t l)
2487
0
{
2488
0
  char from[32], to[32], ret[128];
2489
2490
0
  *from = *to = '\0';
2491
0
  if (cert->valid_after == 0 &&
2492
0
      cert->valid_before == 0xffffffffffffffffULL)
2493
0
    return strlcpy(s, "forever", l);
2494
2495
0
  if (cert->valid_after != 0)
2496
0
    format_absolute_time(cert->valid_after, from, sizeof(from));
2497
0
  if (cert->valid_before != 0xffffffffffffffffULL)
2498
0
    format_absolute_time(cert->valid_before, to, sizeof(to));
2499
2500
0
  if (cert->valid_after == 0)
2501
0
    snprintf(ret, sizeof(ret), "before %s", to);
2502
0
  else if (cert->valid_before == 0xffffffffffffffffULL)
2503
0
    snprintf(ret, sizeof(ret), "after %s", from);
2504
0
  else
2505
0
    snprintf(ret, sizeof(ret), "from %s to %s", from, to);
2506
2507
0
  return strlcpy(s, ret, l);
2508
0
}
2509
2510
/* Common serialization for FIDO private keys */
2511
int
2512
sshkey_serialize_private_sk(const struct sshkey *key, struct sshbuf *b)
2513
0
{
2514
0
  int r;
2515
2516
0
  if ((r = sshbuf_put_cstring(b, key->sk_application)) != 0 ||
2517
0
      (r = sshbuf_put_u8(b, key->sk_flags)) != 0 ||
2518
0
      (r = sshbuf_put_stringb(b, key->sk_key_handle)) != 0 ||
2519
0
      (r = sshbuf_put_stringb(b, key->sk_reserved)) != 0)
2520
0
    return r;
2521
2522
0
  return 0;
2523
0
}
2524
2525
static int
2526
sshkey_private_serialize_opt(struct sshkey *key, struct sshbuf *buf,
2527
    enum sshkey_serialize_rep opts)
2528
0
{
2529
0
  int r = SSH_ERR_INTERNAL_ERROR;
2530
0
  int was_shielded = sshkey_is_shielded(key);
2531
0
  struct sshbuf *b = NULL;
2532
0
  const struct sshkey_impl *impl;
2533
2534
0
  if ((impl = sshkey_impl_from_key(key)) == NULL)
2535
0
    return SSH_ERR_INTERNAL_ERROR;
2536
0
  if ((r = sshkey_unshield_private(key)) != 0)
2537
0
    return r;
2538
0
  if ((b = sshbuf_new()) == NULL)
2539
0
    return SSH_ERR_ALLOC_FAIL;
2540
0
  if ((r = sshbuf_put_cstring(b, sshkey_ssh_name(key))) != 0)
2541
0
    goto out;
2542
0
  if (sshkey_is_cert(key)) {
2543
0
    if (key->cert == NULL ||
2544
0
        sshbuf_len(key->cert->certblob) == 0) {
2545
0
      r = SSH_ERR_INVALID_ARGUMENT;
2546
0
      goto out;
2547
0
    }
2548
0
    if ((r = sshbuf_put_stringb(b, key->cert->certblob)) != 0)
2549
0
      goto out;
2550
0
  }
2551
0
  if ((r = impl->funcs->serialize_private(key, b, opts)) != 0)
2552
0
    goto out;
2553
2554
  /*
2555
   * success (but we still need to append the output to buf after
2556
   * possibly re-shielding the private key)
2557
   */
2558
0
  r = 0;
2559
0
 out:
2560
0
  if (was_shielded)
2561
0
    r = sshkey_shield_private(key);
2562
0
  if (r == 0)
2563
0
    r = sshbuf_putb(buf, b);
2564
0
  sshbuf_free(b);
2565
2566
0
  return r;
2567
0
}
2568
2569
int
2570
sshkey_private_serialize(struct sshkey *key, struct sshbuf *b)
2571
0
{
2572
0
  return sshkey_private_serialize_opt(key, b,
2573
0
      SSHKEY_SERIALIZE_DEFAULT);
2574
0
}
2575
2576
2577
/* Shared deserialization of FIDO private key components */
2578
int
2579
sshkey_private_deserialize_sk(struct sshbuf *buf, struct sshkey *k)
2580
0
{
2581
0
  int r;
2582
2583
0
  if ((k->sk_key_handle = sshbuf_new()) == NULL ||
2584
0
      (k->sk_reserved = sshbuf_new()) == NULL)
2585
0
    return SSH_ERR_ALLOC_FAIL;
2586
0
  if ((r = sshbuf_get_cstring(buf, &k->sk_application, NULL)) != 0 ||
2587
0
      (r = sshbuf_get_u8(buf, &k->sk_flags)) != 0 ||
2588
0
      (r = sshbuf_get_stringb(buf, k->sk_key_handle)) != 0 ||
2589
0
      (r = sshbuf_get_stringb(buf, k->sk_reserved)) != 0)
2590
0
    return r;
2591
2592
0
  return 0;
2593
0
}
2594
2595
int
2596
sshkey_private_deserialize(struct sshbuf *buf, struct sshkey **kp)
2597
0
{
2598
0
  const struct sshkey_impl *impl;
2599
0
  char *tname = NULL;
2600
0
  char *expect_sk_application = NULL;
2601
0
  u_char *expect_ed25519_pk = NULL;
2602
0
  struct sshkey *k = NULL;
2603
0
  int type, r = SSH_ERR_INTERNAL_ERROR;
2604
2605
0
  if (kp != NULL)
2606
0
    *kp = NULL;
2607
0
  if ((r = sshbuf_get_cstring(buf, &tname, NULL)) != 0)
2608
0
    goto out;
2609
0
  type = sshkey_type_from_name(tname);
2610
0
  if (sshkey_type_is_cert(type)) {
2611
    /*
2612
     * Certificate key private keys begin with the certificate
2613
     * itself. Make sure this matches the type of the enclosing
2614
     * private key.
2615
     */
2616
0
    if ((r = sshkey_froms(buf, &k)) != 0)
2617
0
      goto out;
2618
0
    if (k->type != type) {
2619
0
      r = SSH_ERR_KEY_CERT_MISMATCH;
2620
0
      goto out;
2621
0
    }
2622
    /* For ECDSA keys, the group must match too */
2623
0
    if (k->type == KEY_ECDSA &&
2624
0
        k->ecdsa_nid != sshkey_ecdsa_nid_from_name(tname)) {
2625
0
      r = SSH_ERR_KEY_CERT_MISMATCH;
2626
0
      goto out;
2627
0
    }
2628
    /*
2629
     * Several fields are redundant between certificate and
2630
     * private key body, we require these to match.
2631
     */
2632
0
    expect_sk_application = k->sk_application;
2633
0
    expect_ed25519_pk = k->ed25519_pk;
2634
0
    k->sk_application = NULL;
2635
0
    k->ed25519_pk = NULL;
2636
0
  } else {
2637
0
    if ((k = sshkey_new(type)) == NULL) {
2638
0
      r = SSH_ERR_ALLOC_FAIL;
2639
0
      goto out;
2640
0
    }
2641
0
  }
2642
0
  if ((impl = sshkey_impl_from_type(type)) == NULL) {
2643
0
    r = SSH_ERR_INTERNAL_ERROR;
2644
0
    goto out;
2645
0
  }
2646
0
  if ((r = impl->funcs->deserialize_private(tname, buf, k)) != 0)
2647
0
    goto out;
2648
2649
0
  if ((expect_sk_application != NULL && (k->sk_application == NULL ||
2650
0
      strcmp(expect_sk_application, k->sk_application) != 0)) ||
2651
0
      (expect_ed25519_pk != NULL && (k->ed25519_pk == NULL ||
2652
0
      memcmp(expect_ed25519_pk, k->ed25519_pk, ED25519_PK_SZ) != 0))) {
2653
0
    r = SSH_ERR_KEY_CERT_MISMATCH;
2654
0
    goto out;
2655
0
  }
2656
  /* success */
2657
0
  r = 0;
2658
0
  if (kp != NULL) {
2659
0
    *kp = k;
2660
0
    k = NULL;
2661
0
  }
2662
0
 out:
2663
0
  free(tname);
2664
0
  sshkey_free(k);
2665
0
  free(expect_sk_application);
2666
0
  free(expect_ed25519_pk);
2667
0
  return r;
2668
0
}
2669
2670
#if defined(WITH_OPENSSL) && defined(OPENSSL_HAS_ECC)
2671
int
2672
sshkey_ec_validate_public(const EC_GROUP *group, const EC_POINT *public)
2673
0
{
2674
0
  EC_POINT *nq = NULL;
2675
0
  BIGNUM *order = NULL, *x = NULL, *y = NULL, *tmp = NULL;
2676
0
  int ret = SSH_ERR_KEY_INVALID_EC_VALUE;
2677
2678
  /*
2679
   * NB. This assumes OpenSSL has already verified that the public
2680
   * point lies on the curve. This is done by EC_POINT_oct2point()
2681
   * implicitly calling EC_POINT_is_on_curve(). If this code is ever
2682
   * reachable with public points not unmarshalled using
2683
   * EC_POINT_oct2point then the caller will need to explicitly check.
2684
   */
2685
2686
  /* Q != infinity */
2687
0
  if (EC_POINT_is_at_infinity(group, public))
2688
0
    goto out;
2689
2690
0
  if ((x = BN_new()) == NULL ||
2691
0
      (y = BN_new()) == NULL ||
2692
0
      (order = BN_new()) == NULL ||
2693
0
      (tmp = BN_new()) == NULL) {
2694
0
    ret = SSH_ERR_ALLOC_FAIL;
2695
0
    goto out;
2696
0
  }
2697
2698
  /* log2(x) > log2(order)/2, log2(y) > log2(order)/2 */
2699
0
  if (EC_GROUP_get_order(group, order, NULL) != 1 ||
2700
0
      EC_POINT_get_affine_coordinates(group, public, x, y, NULL) != 1) {
2701
0
    ret = SSH_ERR_LIBCRYPTO_ERROR;
2702
0
    goto out;
2703
0
  }
2704
0
  if (BN_num_bits(x) <= BN_num_bits(order) / 2 ||
2705
0
      BN_num_bits(y) <= BN_num_bits(order) / 2)
2706
0
    goto out;
2707
2708
  /* nQ == infinity (n == order of subgroup) */
2709
0
  if ((nq = EC_POINT_new(group)) == NULL) {
2710
0
    ret = SSH_ERR_ALLOC_FAIL;
2711
0
    goto out;
2712
0
  }
2713
0
  if (EC_POINT_mul(group, nq, NULL, public, order, NULL) != 1) {
2714
0
    ret = SSH_ERR_LIBCRYPTO_ERROR;
2715
0
    goto out;
2716
0
  }
2717
0
  if (EC_POINT_is_at_infinity(group, nq) != 1)
2718
0
    goto out;
2719
2720
  /* x < order - 1, y < order - 1 */
2721
0
  if (!BN_sub(tmp, order, BN_value_one())) {
2722
0
    ret = SSH_ERR_LIBCRYPTO_ERROR;
2723
0
    goto out;
2724
0
  }
2725
0
  if (BN_cmp(x, tmp) >= 0 || BN_cmp(y, tmp) >= 0)
2726
0
    goto out;
2727
0
  ret = 0;
2728
0
 out:
2729
0
  BN_clear_free(x);
2730
0
  BN_clear_free(y);
2731
0
  BN_clear_free(order);
2732
0
  BN_clear_free(tmp);
2733
0
  EC_POINT_free(nq);
2734
0
  return ret;
2735
0
}
2736
2737
int
2738
sshkey_ec_validate_private(const EC_KEY *key)
2739
0
{
2740
0
  BIGNUM *order = NULL, *tmp = NULL;
2741
0
  int ret = SSH_ERR_KEY_INVALID_EC_VALUE;
2742
2743
0
  if ((order = BN_new()) == NULL || (tmp = BN_new()) == NULL) {
2744
0
    ret = SSH_ERR_ALLOC_FAIL;
2745
0
    goto out;
2746
0
  }
2747
2748
  /* log2(private) > log2(order)/2 */
2749
0
  if (EC_GROUP_get_order(EC_KEY_get0_group(key), order, NULL) != 1) {
2750
0
    ret = SSH_ERR_LIBCRYPTO_ERROR;
2751
0
    goto out;
2752
0
  }
2753
0
  if (BN_num_bits(EC_KEY_get0_private_key(key)) <=
2754
0
      BN_num_bits(order) / 2)
2755
0
    goto out;
2756
2757
  /* private < order - 1 */
2758
0
  if (!BN_sub(tmp, order, BN_value_one())) {
2759
0
    ret = SSH_ERR_LIBCRYPTO_ERROR;
2760
0
    goto out;
2761
0
  }
2762
0
  if (BN_cmp(EC_KEY_get0_private_key(key), tmp) >= 0)
2763
0
    goto out;
2764
0
  ret = 0;
2765
0
 out:
2766
0
  BN_clear_free(order);
2767
0
  BN_clear_free(tmp);
2768
0
  return ret;
2769
0
}
2770
2771
void
2772
sshkey_dump_ec_point(const EC_GROUP *group, const EC_POINT *point)
2773
0
{
2774
0
  BIGNUM *x = NULL, *y = NULL;
2775
2776
0
  if (point == NULL) {
2777
0
    fputs("point=(NULL)\n", stderr);
2778
0
    return;
2779
0
  }
2780
0
  if ((x = BN_new()) == NULL || (y = BN_new()) == NULL) {
2781
0
    fprintf(stderr, "%s: BN_new failed\n", __func__);
2782
0
    goto out;
2783
0
  }
2784
0
  if (EC_POINT_get_affine_coordinates(group, point, x, y, NULL) != 1) {
2785
0
    fprintf(stderr, "%s: EC_POINT_get_affine_coordinates\n",
2786
0
        __func__);
2787
0
    goto out;
2788
0
  }
2789
0
  fputs("x=", stderr);
2790
0
  BN_print_fp(stderr, x);
2791
0
  fputs("\ny=", stderr);
2792
0
  BN_print_fp(stderr, y);
2793
0
  fputs("\n", stderr);
2794
0
 out:
2795
0
  BN_clear_free(x);
2796
0
  BN_clear_free(y);
2797
0
}
2798
2799
void
2800
sshkey_dump_ec_key(const EC_KEY *key)
2801
0
{
2802
0
  const BIGNUM *exponent;
2803
2804
0
  sshkey_dump_ec_point(EC_KEY_get0_group(key),
2805
0
      EC_KEY_get0_public_key(key));
2806
0
  fputs("exponent=", stderr);
2807
0
  if ((exponent = EC_KEY_get0_private_key(key)) == NULL)
2808
0
    fputs("(NULL)", stderr);
2809
0
  else
2810
0
    BN_print_fp(stderr, EC_KEY_get0_private_key(key));
2811
0
  fputs("\n", stderr);
2812
0
}
2813
#endif /* WITH_OPENSSL && OPENSSL_HAS_ECC */
2814
2815
static int
2816
sshkey_private_to_blob2(struct sshkey *prv, struct sshbuf *blob,
2817
    const char *passphrase, const char *comment, const char *ciphername,
2818
    int rounds)
2819
0
{
2820
0
  u_char *cp, *key = NULL, *pubkeyblob = NULL;
2821
0
  u_char salt[SALT_LEN];
2822
0
  size_t i, pubkeylen, keylen, ivlen, blocksize, authlen;
2823
0
  u_int check;
2824
0
  int r = SSH_ERR_INTERNAL_ERROR;
2825
0
  struct sshcipher_ctx *ciphercontext = NULL;
2826
0
  const struct sshcipher *cipher;
2827
0
  const char *kdfname = KDFNAME;
2828
0
  struct sshbuf *encoded = NULL, *encrypted = NULL, *kdf = NULL;
2829
2830
0
  if (rounds <= 0)
2831
0
    rounds = DEFAULT_ROUNDS;
2832
0
  if (passphrase == NULL || !strlen(passphrase)) {
2833
0
    ciphername = "none";
2834
0
    kdfname = "none";
2835
0
  } else if (ciphername == NULL)
2836
0
    ciphername = DEFAULT_CIPHERNAME;
2837
0
  if ((cipher = cipher_by_name(ciphername)) == NULL) {
2838
0
    r = SSH_ERR_INVALID_ARGUMENT;
2839
0
    goto out;
2840
0
  }
2841
2842
0
  if ((kdf = sshbuf_new()) == NULL ||
2843
0
      (encoded = sshbuf_new()) == NULL ||
2844
0
      (encrypted = sshbuf_new()) == NULL) {
2845
0
    r = SSH_ERR_ALLOC_FAIL;
2846
0
    goto out;
2847
0
  }
2848
0
  blocksize = cipher_blocksize(cipher);
2849
0
  keylen = cipher_keylen(cipher);
2850
0
  ivlen = cipher_ivlen(cipher);
2851
0
  authlen = cipher_authlen(cipher);
2852
0
  if ((key = calloc(1, keylen + ivlen)) == NULL) {
2853
0
    r = SSH_ERR_ALLOC_FAIL;
2854
0
    goto out;
2855
0
  }
2856
0
  if (strcmp(kdfname, "bcrypt") == 0) {
2857
0
    arc4random_buf(salt, SALT_LEN);
2858
0
    if (bcrypt_pbkdf(passphrase, strlen(passphrase),
2859
0
        salt, SALT_LEN, key, keylen + ivlen, rounds) < 0) {
2860
0
      r = SSH_ERR_INVALID_ARGUMENT;
2861
0
      goto out;
2862
0
    }
2863
0
    if ((r = sshbuf_put_string(kdf, salt, SALT_LEN)) != 0 ||
2864
0
        (r = sshbuf_put_u32(kdf, rounds)) != 0)
2865
0
      goto out;
2866
0
  } else if (strcmp(kdfname, "none") != 0) {
2867
    /* Unsupported KDF type */
2868
0
    r = SSH_ERR_KEY_UNKNOWN_CIPHER;
2869
0
    goto out;
2870
0
  }
2871
0
  if ((r = cipher_init(&ciphercontext, cipher, key, keylen,
2872
0
      key + keylen, ivlen, 1)) != 0)
2873
0
    goto out;
2874
2875
0
  if ((r = sshbuf_put(encoded, AUTH_MAGIC, sizeof(AUTH_MAGIC))) != 0 ||
2876
0
      (r = sshbuf_put_cstring(encoded, ciphername)) != 0 ||
2877
0
      (r = sshbuf_put_cstring(encoded, kdfname)) != 0 ||
2878
0
      (r = sshbuf_put_stringb(encoded, kdf)) != 0 ||
2879
0
      (r = sshbuf_put_u32(encoded, 1)) != 0 || /* number of keys */
2880
0
      (r = sshkey_to_blob(prv, &pubkeyblob, &pubkeylen)) != 0 ||
2881
0
      (r = sshbuf_put_string(encoded, pubkeyblob, pubkeylen)) != 0)
2882
0
    goto out;
2883
2884
  /* set up the buffer that will be encrypted */
2885
2886
  /* Random check bytes */
2887
0
  check = arc4random();
2888
0
  if ((r = sshbuf_put_u32(encrypted, check)) != 0 ||
2889
0
      (r = sshbuf_put_u32(encrypted, check)) != 0)
2890
0
    goto out;
2891
2892
  /* append private key and comment*/
2893
0
  if ((r = sshkey_private_serialize(prv, encrypted)) != 0 ||
2894
0
      (r = sshbuf_put_cstring(encrypted, comment)) != 0)
2895
0
    goto out;
2896
2897
  /* padding */
2898
0
  i = 0;
2899
0
  while (sshbuf_len(encrypted) % blocksize) {
2900
0
    if ((r = sshbuf_put_u8(encrypted, ++i & 0xff)) != 0)
2901
0
      goto out;
2902
0
  }
2903
2904
  /* length in destination buffer */
2905
0
  if ((r = sshbuf_put_u32(encoded, sshbuf_len(encrypted))) != 0)
2906
0
    goto out;
2907
2908
  /* encrypt */
2909
0
  if ((r = sshbuf_reserve(encoded,
2910
0
      sshbuf_len(encrypted) + authlen, &cp)) != 0)
2911
0
    goto out;
2912
0
  if ((r = cipher_crypt(ciphercontext, 0, cp,
2913
0
      sshbuf_ptr(encrypted), sshbuf_len(encrypted), 0, authlen)) != 0)
2914
0
    goto out;
2915
2916
0
  sshbuf_reset(blob);
2917
2918
  /* assemble uuencoded key */
2919
0
  if ((r = sshbuf_put(blob, MARK_BEGIN, MARK_BEGIN_LEN)) != 0 ||
2920
0
      (r = sshbuf_dtob64(encoded, blob, 1)) != 0 ||
2921
0
      (r = sshbuf_put(blob, MARK_END, MARK_END_LEN)) != 0)
2922
0
    goto out;
2923
2924
  /* success */
2925
0
  r = 0;
2926
2927
0
 out:
2928
0
  sshbuf_free(kdf);
2929
0
  sshbuf_free(encoded);
2930
0
  sshbuf_free(encrypted);
2931
0
  cipher_free(ciphercontext);
2932
0
  explicit_bzero(salt, sizeof(salt));
2933
0
  if (key != NULL)
2934
0
    freezero(key, keylen + ivlen);
2935
0
  if (pubkeyblob != NULL)
2936
0
    freezero(pubkeyblob, pubkeylen);
2937
0
  return r;
2938
0
}
2939
2940
static int
2941
private2_uudecode(struct sshbuf *blob, struct sshbuf **decodedp)
2942
0
{
2943
0
  const u_char *cp;
2944
0
  size_t encoded_len;
2945
0
  int r;
2946
0
  u_char last;
2947
0
  struct sshbuf *encoded = NULL, *decoded = NULL;
2948
2949
0
  if (blob == NULL || decodedp == NULL)
2950
0
    return SSH_ERR_INVALID_ARGUMENT;
2951
2952
0
  *decodedp = NULL;
2953
2954
0
  if ((encoded = sshbuf_new()) == NULL ||
2955
0
      (decoded = sshbuf_new()) == NULL) {
2956
0
    r = SSH_ERR_ALLOC_FAIL;
2957
0
    goto out;
2958
0
  }
2959
2960
  /* check preamble */
2961
0
  cp = sshbuf_ptr(blob);
2962
0
  encoded_len = sshbuf_len(blob);
2963
0
  if (encoded_len < (MARK_BEGIN_LEN + MARK_END_LEN) ||
2964
0
      memcmp(cp, MARK_BEGIN, MARK_BEGIN_LEN) != 0) {
2965
0
    r = SSH_ERR_INVALID_FORMAT;
2966
0
    goto out;
2967
0
  }
2968
0
  cp += MARK_BEGIN_LEN;
2969
0
  encoded_len -= MARK_BEGIN_LEN;
2970
2971
  /* Look for end marker, removing whitespace as we go */
2972
0
  while (encoded_len > 0) {
2973
0
    if (*cp != '\n' && *cp != '\r') {
2974
0
      if ((r = sshbuf_put_u8(encoded, *cp)) != 0)
2975
0
        goto out;
2976
0
    }
2977
0
    last = *cp;
2978
0
    encoded_len--;
2979
0
    cp++;
2980
0
    if (last == '\n') {
2981
0
      if (encoded_len >= MARK_END_LEN &&
2982
0
          memcmp(cp, MARK_END, MARK_END_LEN) == 0) {
2983
        /* \0 terminate */
2984
0
        if ((r = sshbuf_put_u8(encoded, 0)) != 0)
2985
0
          goto out;
2986
0
        break;
2987
0
      }
2988
0
    }
2989
0
  }
2990
0
  if (encoded_len == 0) {
2991
0
    r = SSH_ERR_INVALID_FORMAT;
2992
0
    goto out;
2993
0
  }
2994
2995
  /* decode base64 */
2996
0
  if ((r = sshbuf_b64tod(decoded, (char *)sshbuf_ptr(encoded))) != 0)
2997
0
    goto out;
2998
2999
  /* check magic */
3000
0
  if (sshbuf_len(decoded) < sizeof(AUTH_MAGIC) ||
3001
0
      memcmp(sshbuf_ptr(decoded), AUTH_MAGIC, sizeof(AUTH_MAGIC))) {
3002
0
    r = SSH_ERR_INVALID_FORMAT;
3003
0
    goto out;
3004
0
  }
3005
  /* success */
3006
0
  *decodedp = decoded;
3007
0
  decoded = NULL;
3008
0
  r = 0;
3009
0
 out:
3010
0
  sshbuf_free(encoded);
3011
0
  sshbuf_free(decoded);
3012
0
  return r;
3013
0
}
3014
3015
static int
3016
private2_decrypt(struct sshbuf *decoded, const char *passphrase,
3017
    struct sshbuf **decryptedp, struct sshkey **pubkeyp)
3018
0
{
3019
0
  char *ciphername = NULL, *kdfname = NULL;
3020
0
  const struct sshcipher *cipher = NULL;
3021
0
  int r = SSH_ERR_INTERNAL_ERROR;
3022
0
  size_t keylen = 0, ivlen = 0, authlen = 0, slen = 0;
3023
0
  struct sshbuf *kdf = NULL, *decrypted = NULL;
3024
0
  struct sshcipher_ctx *ciphercontext = NULL;
3025
0
  struct sshkey *pubkey = NULL;
3026
0
  u_char *key = NULL, *salt = NULL, *dp;
3027
0
  u_int blocksize, rounds, nkeys, encrypted_len, check1, check2;
3028
3029
0
  if (decoded == NULL || decryptedp == NULL || pubkeyp == NULL)
3030
0
    return SSH_ERR_INVALID_ARGUMENT;
3031
3032
0
  *decryptedp = NULL;
3033
0
  *pubkeyp = NULL;
3034
3035
0
  if ((decrypted = sshbuf_new()) == NULL) {
3036
0
    r = SSH_ERR_ALLOC_FAIL;
3037
0
    goto out;
3038
0
  }
3039
3040
  /* parse public portion of key */
3041
0
  if ((r = sshbuf_consume(decoded, sizeof(AUTH_MAGIC))) != 0 ||
3042
0
      (r = sshbuf_get_cstring(decoded, &ciphername, NULL)) != 0 ||
3043
0
      (r = sshbuf_get_cstring(decoded, &kdfname, NULL)) != 0 ||
3044
0
      (r = sshbuf_froms(decoded, &kdf)) != 0 ||
3045
0
      (r = sshbuf_get_u32(decoded, &nkeys)) != 0)
3046
0
    goto out;
3047
3048
0
  if (nkeys != 1) {
3049
    /* XXX only one key supported at present */
3050
0
    r = SSH_ERR_INVALID_FORMAT;
3051
0
    goto out;
3052
0
  }
3053
3054
0
  if ((r = sshkey_froms(decoded, &pubkey)) != 0 ||
3055
0
      (r = sshbuf_get_u32(decoded, &encrypted_len)) != 0)
3056
0
    goto out;
3057
3058
0
  if ((cipher = cipher_by_name(ciphername)) == NULL) {
3059
0
    r = SSH_ERR_KEY_UNKNOWN_CIPHER;
3060
0
    goto out;
3061
0
  }
3062
0
  if (strcmp(kdfname, "none") != 0 && strcmp(kdfname, "bcrypt") != 0) {
3063
0
    r = SSH_ERR_KEY_UNKNOWN_CIPHER;
3064
0
    goto out;
3065
0
  }
3066
0
  if (strcmp(kdfname, "none") == 0 && strcmp(ciphername, "none") != 0) {
3067
0
    r = SSH_ERR_INVALID_FORMAT;
3068
0
    goto out;
3069
0
  }
3070
0
  if ((passphrase == NULL || strlen(passphrase) == 0) &&
3071
0
      strcmp(kdfname, "none") != 0) {
3072
    /* passphrase required */
3073
0
    r = SSH_ERR_KEY_WRONG_PASSPHRASE;
3074
0
    goto out;
3075
0
  }
3076
3077
  /* check size of encrypted key blob */
3078
0
  blocksize = cipher_blocksize(cipher);
3079
0
  if (encrypted_len < blocksize || (encrypted_len % blocksize) != 0) {
3080
0
    r = SSH_ERR_INVALID_FORMAT;
3081
0
    goto out;
3082
0
  }
3083
3084
  /* setup key */
3085
0
  keylen = cipher_keylen(cipher);
3086
0
  ivlen = cipher_ivlen(cipher);
3087
0
  authlen = cipher_authlen(cipher);
3088
0
  if ((key = calloc(1, keylen + ivlen)) == NULL) {
3089
0
    r = SSH_ERR_ALLOC_FAIL;
3090
0
    goto out;
3091
0
  }
3092
0
  if (strcmp(kdfname, "bcrypt") == 0) {
3093
0
    if ((r = sshbuf_get_string(kdf, &salt, &slen)) != 0 ||
3094
0
        (r = sshbuf_get_u32(kdf, &rounds)) != 0)
3095
0
      goto out;
3096
0
    if (bcrypt_pbkdf(passphrase, strlen(passphrase), salt, slen,
3097
0
        key, keylen + ivlen, rounds) < 0) {
3098
0
      r = SSH_ERR_INVALID_FORMAT;
3099
0
      goto out;
3100
0
    }
3101
0
  }
3102
3103
  /* check that an appropriate amount of auth data is present */
3104
0
  if (sshbuf_len(decoded) < authlen ||
3105
0
      sshbuf_len(decoded) - authlen < encrypted_len) {
3106
0
    r = SSH_ERR_INVALID_FORMAT;
3107
0
    goto out;
3108
0
  }
3109
3110
  /* decrypt private portion of key */
3111
0
  if ((r = sshbuf_reserve(decrypted, encrypted_len, &dp)) != 0 ||
3112
0
      (r = cipher_init(&ciphercontext, cipher, key, keylen,
3113
0
      key + keylen, ivlen, 0)) != 0)
3114
0
    goto out;
3115
0
  if ((r = cipher_crypt(ciphercontext, 0, dp, sshbuf_ptr(decoded),
3116
0
      encrypted_len, 0, authlen)) != 0) {
3117
    /* an integrity error here indicates an incorrect passphrase */
3118
0
    if (r == SSH_ERR_MAC_INVALID)
3119
0
      r = SSH_ERR_KEY_WRONG_PASSPHRASE;
3120
0
    goto out;
3121
0
  }
3122
0
  if ((r = sshbuf_consume(decoded, encrypted_len + authlen)) != 0)
3123
0
    goto out;
3124
  /* there should be no trailing data */
3125
0
  if (sshbuf_len(decoded) != 0) {
3126
0
    r = SSH_ERR_INVALID_FORMAT;
3127
0
    goto out;
3128
0
  }
3129
3130
  /* check check bytes */
3131
0
  if ((r = sshbuf_get_u32(decrypted, &check1)) != 0 ||
3132
0
      (r = sshbuf_get_u32(decrypted, &check2)) != 0)
3133
0
    goto out;
3134
0
  if (check1 != check2) {
3135
0
    r = SSH_ERR_KEY_WRONG_PASSPHRASE;
3136
0
    goto out;
3137
0
  }
3138
  /* success */
3139
0
  *decryptedp = decrypted;
3140
0
  decrypted = NULL;
3141
0
  *pubkeyp = pubkey;
3142
0
  pubkey = NULL;
3143
0
  r = 0;
3144
0
 out:
3145
0
  cipher_free(ciphercontext);
3146
0
  free(ciphername);
3147
0
  free(kdfname);
3148
0
  sshkey_free(pubkey);
3149
0
  if (salt != NULL) {
3150
0
    explicit_bzero(salt, slen);
3151
0
    free(salt);
3152
0
  }
3153
0
  if (key != NULL) {
3154
0
    explicit_bzero(key, keylen + ivlen);
3155
0
    free(key);
3156
0
  }
3157
0
  sshbuf_free(kdf);
3158
0
  sshbuf_free(decrypted);
3159
0
  return r;
3160
0
}
3161
3162
static int
3163
sshkey_parse_private2(struct sshbuf *blob, int type, const char *passphrase,
3164
    struct sshkey **keyp, char **commentp)
3165
0
{
3166
0
  char *comment = NULL;
3167
0
  int r = SSH_ERR_INTERNAL_ERROR;
3168
0
  struct sshbuf *decoded = NULL, *decrypted = NULL;
3169
0
  struct sshkey *k = NULL, *pubkey = NULL;
3170
3171
0
  if (keyp != NULL)
3172
0
    *keyp = NULL;
3173
0
  if (commentp != NULL)
3174
0
    *commentp = NULL;
3175
3176
  /* Undo base64 encoding and decrypt the private section */
3177
0
  if ((r = private2_uudecode(blob, &decoded)) != 0 ||
3178
0
      (r = private2_decrypt(decoded, passphrase,
3179
0
      &decrypted, &pubkey)) != 0)
3180
0
    goto out;
3181
3182
0
  if (type != KEY_UNSPEC &&
3183
0
      sshkey_type_plain(type) != sshkey_type_plain(pubkey->type)) {
3184
0
    r = SSH_ERR_KEY_TYPE_MISMATCH;
3185
0
    goto out;
3186
0
  }
3187
3188
  /* Load the private key and comment */
3189
0
  if ((r = sshkey_private_deserialize(decrypted, &k)) != 0 ||
3190
0
      (r = sshbuf_get_cstring(decrypted, &comment, NULL)) != 0)
3191
0
    goto out;
3192
3193
  /* Check deterministic padding after private section */
3194
0
  if ((r = private2_check_padding(decrypted)) != 0)
3195
0
    goto out;
3196
3197
  /* Check that the public key in the envelope matches the private key */
3198
0
  if (!sshkey_equal(pubkey, k)) {
3199
0
    r = SSH_ERR_INVALID_FORMAT;
3200
0
    goto out;
3201
0
  }
3202
3203
  /* success */
3204
0
  r = 0;
3205
0
  if (keyp != NULL) {
3206
0
    *keyp = k;
3207
0
    k = NULL;
3208
0
  }
3209
0
  if (commentp != NULL) {
3210
0
    *commentp = comment;
3211
0
    comment = NULL;
3212
0
  }
3213
0
 out:
3214
0
  free(comment);
3215
0
  sshbuf_free(decoded);
3216
0
  sshbuf_free(decrypted);
3217
0
  sshkey_free(k);
3218
0
  sshkey_free(pubkey);
3219
0
  return r;
3220
0
}
3221
3222
static int
3223
sshkey_parse_private2_pubkey(struct sshbuf *blob, int type,
3224
    struct sshkey **keyp)
3225
0
{
3226
0
  int r = SSH_ERR_INTERNAL_ERROR;
3227
0
  struct sshbuf *decoded = NULL;
3228
0
  struct sshkey *pubkey = NULL;
3229
0
  u_int nkeys = 0;
3230
3231
0
  if (keyp != NULL)
3232
0
    *keyp = NULL;
3233
3234
0
  if ((r = private2_uudecode(blob, &decoded)) != 0)
3235
0
    goto out;
3236
  /* parse public key from unencrypted envelope */
3237
0
  if ((r = sshbuf_consume(decoded, sizeof(AUTH_MAGIC))) != 0 ||
3238
0
      (r = sshbuf_skip_string(decoded)) != 0 || /* cipher */
3239
0
      (r = sshbuf_skip_string(decoded)) != 0 || /* KDF alg */
3240
0
      (r = sshbuf_skip_string(decoded)) != 0 || /* KDF hint */
3241
0
      (r = sshbuf_get_u32(decoded, &nkeys)) != 0)
3242
0
    goto out;
3243
3244
0
  if (nkeys != 1) {
3245
    /* XXX only one key supported at present */
3246
0
    r = SSH_ERR_INVALID_FORMAT;
3247
0
    goto out;
3248
0
  }
3249
3250
  /* Parse the public key */
3251
0
  if ((r = sshkey_froms(decoded, &pubkey)) != 0)
3252
0
    goto out;
3253
3254
0
  if (type != KEY_UNSPEC &&
3255
0
      sshkey_type_plain(type) != sshkey_type_plain(pubkey->type)) {
3256
0
    r = SSH_ERR_KEY_TYPE_MISMATCH;
3257
0
    goto out;
3258
0
  }
3259
3260
  /* success */
3261
0
  r = 0;
3262
0
  if (keyp != NULL) {
3263
0
    *keyp = pubkey;
3264
0
    pubkey = NULL;
3265
0
  }
3266
0
 out:
3267
0
  sshbuf_free(decoded);
3268
0
  sshkey_free(pubkey);
3269
0
  return r;
3270
0
}
3271
3272
#ifdef WITH_OPENSSL
3273
/* convert SSH v2 key to PEM or PKCS#8 format */
3274
static int
3275
sshkey_private_to_blob_pem_pkcs8(struct sshkey *key, struct sshbuf *buf,
3276
    int format, const char *_passphrase, const char *comment)
3277
0
{
3278
0
  int was_shielded = sshkey_is_shielded(key);
3279
0
  int success, r;
3280
0
  int blen, len = strlen(_passphrase);
3281
0
  u_char *passphrase = (len > 0) ? (u_char *)_passphrase : NULL;
3282
0
  const EVP_CIPHER *cipher = (len > 0) ? EVP_aes_128_cbc() : NULL;
3283
0
  char *bptr;
3284
0
  BIO *bio = NULL;
3285
0
  struct sshbuf *blob;
3286
0
  EVP_PKEY *pkey = NULL;
3287
3288
0
  if (len > 0 && len <= 4)
3289
0
    return SSH_ERR_PASSPHRASE_TOO_SHORT;
3290
0
  if ((blob = sshbuf_new()) == NULL)
3291
0
    return SSH_ERR_ALLOC_FAIL;
3292
0
  if ((bio = BIO_new(BIO_s_mem())) == NULL) {
3293
0
    r = SSH_ERR_ALLOC_FAIL;
3294
0
    goto out;
3295
0
  }
3296
0
  if ((r = sshkey_unshield_private(key)) != 0)
3297
0
    goto out;
3298
3299
0
  switch (key->type) {
3300
0
#ifdef OPENSSL_HAS_ECC
3301
0
  case KEY_ECDSA:
3302
0
    if (format == SSHKEY_PRIVATE_PEM) {
3303
0
      success = PEM_write_bio_ECPrivateKey(bio,
3304
0
          EVP_PKEY_get0_EC_KEY(key->pkey),
3305
0
          cipher, passphrase, len, NULL, NULL);
3306
0
    } else {
3307
0
      pkey = key->pkey;
3308
0
      EVP_PKEY_up_ref(key->pkey);
3309
0
      success = 1;
3310
0
    }
3311
0
    break;
3312
0
#endif
3313
0
  case KEY_RSA:
3314
0
    if (format == SSHKEY_PRIVATE_PEM) {
3315
0
      success = PEM_write_bio_RSAPrivateKey(bio,
3316
0
          EVP_PKEY_get0_RSA(key->pkey),
3317
0
          cipher, passphrase, len, NULL, NULL);
3318
0
    } else {
3319
0
      pkey = key->pkey;
3320
0
      EVP_PKEY_up_ref(key->pkey);
3321
0
      success = 1;
3322
0
    }
3323
0
    break;
3324
0
  default:
3325
0
    success = 0;
3326
0
    break;
3327
0
  }
3328
0
  if (success == 0) {
3329
0
    r = SSH_ERR_LIBCRYPTO_ERROR;
3330
0
    goto out;
3331
0
  }
3332
0
  if (format == SSHKEY_PRIVATE_PKCS8) {
3333
0
    if ((success = PEM_write_bio_PrivateKey(bio, pkey, cipher,
3334
0
        passphrase, len, NULL, NULL)) == 0) {
3335
0
      r = SSH_ERR_LIBCRYPTO_ERROR;
3336
0
      goto out;
3337
0
    }
3338
0
  }
3339
0
  if ((blen = BIO_get_mem_data(bio, &bptr)) <= 0) {
3340
0
    r = SSH_ERR_INTERNAL_ERROR;
3341
0
    goto out;
3342
0
  }
3343
0
  if ((r = sshbuf_put(blob, bptr, blen)) != 0)
3344
0
    goto out;
3345
0
  r = 0;
3346
0
 out:
3347
0
  if (was_shielded)
3348
0
    r = sshkey_shield_private(key);
3349
0
  if (r == 0)
3350
0
    r = sshbuf_putb(buf, blob);
3351
3352
0
  EVP_PKEY_free(pkey);
3353
0
  sshbuf_free(blob);
3354
0
  BIO_free(bio);
3355
0
  return r;
3356
0
}
3357
#endif /* WITH_OPENSSL */
3358
3359
/* Serialise "key" to buffer "blob" */
3360
int
3361
sshkey_private_to_fileblob(struct sshkey *key, struct sshbuf *blob,
3362
    const char *passphrase, const char *comment,
3363
    int format, const char *openssh_format_cipher, int openssh_format_rounds)
3364
0
{
3365
0
  switch (key->type) {
3366
0
#ifdef WITH_OPENSSL
3367
0
  case KEY_ECDSA:
3368
0
  case KEY_RSA:
3369
0
    break; /* see below */
3370
0
#endif /* WITH_OPENSSL */
3371
0
  case KEY_ED25519:
3372
0
  case KEY_ED25519_SK:
3373
0
#ifdef WITH_OPENSSL
3374
0
  case KEY_ECDSA_SK:
3375
0
#endif /* WITH_OPENSSL */
3376
0
    return sshkey_private_to_blob2(key, blob, passphrase,
3377
0
        comment, openssh_format_cipher, openssh_format_rounds);
3378
0
  default:
3379
0
    return SSH_ERR_KEY_TYPE_UNKNOWN;
3380
0
  }
3381
3382
0
#ifdef WITH_OPENSSL
3383
0
  switch (format) {
3384
0
  case SSHKEY_PRIVATE_OPENSSH:
3385
0
    return sshkey_private_to_blob2(key, blob, passphrase,
3386
0
        comment, openssh_format_cipher, openssh_format_rounds);
3387
0
  case SSHKEY_PRIVATE_PEM:
3388
0
  case SSHKEY_PRIVATE_PKCS8:
3389
0
    return sshkey_private_to_blob_pem_pkcs8(key, blob,
3390
0
        format, passphrase, comment);
3391
0
  default:
3392
0
    return SSH_ERR_INVALID_ARGUMENT;
3393
0
  }
3394
0
#endif /* WITH_OPENSSL */
3395
0
}
3396
3397
#ifdef WITH_OPENSSL
3398
static int
3399
translate_libcrypto_error(unsigned long pem_err)
3400
0
{
3401
0
  int pem_reason = ERR_GET_REASON(pem_err);
3402
3403
0
  switch (ERR_GET_LIB(pem_err)) {
3404
0
  case ERR_LIB_PEM:
3405
0
    switch (pem_reason) {
3406
0
    case PEM_R_BAD_PASSWORD_READ:
3407
0
#ifdef PEM_R_PROBLEMS_GETTING_PASSWORD
3408
0
    case PEM_R_PROBLEMS_GETTING_PASSWORD:
3409
0
#endif
3410
0
#ifdef PEM_R_BAD_DECRYPT
3411
0
    case PEM_R_BAD_DECRYPT:
3412
0
#endif
3413
0
      return SSH_ERR_KEY_WRONG_PASSPHRASE;
3414
0
    default:
3415
0
      return SSH_ERR_INVALID_FORMAT;
3416
0
    }
3417
0
  case ERR_LIB_EVP:
3418
0
    switch (pem_reason) {
3419
0
#ifdef EVP_R_BAD_DECRYPT
3420
0
    case EVP_R_BAD_DECRYPT:
3421
0
      return SSH_ERR_KEY_WRONG_PASSPHRASE;
3422
0
#endif
3423
#ifdef EVP_R_BN_DECODE_ERROR
3424
    case EVP_R_BN_DECODE_ERROR:
3425
#endif
3426
0
    case EVP_R_DECODE_ERROR:
3427
0
#ifdef EVP_R_PRIVATE_KEY_DECODE_ERROR
3428
0
    case EVP_R_PRIVATE_KEY_DECODE_ERROR:
3429
0
#endif
3430
0
      return SSH_ERR_INVALID_FORMAT;
3431
0
    default:
3432
0
      return SSH_ERR_LIBCRYPTO_ERROR;
3433
0
    }
3434
0
  case ERR_LIB_ASN1:
3435
0
    return SSH_ERR_INVALID_FORMAT;
3436
0
  }
3437
0
  return SSH_ERR_LIBCRYPTO_ERROR;
3438
0
}
3439
3440
static void
3441
clear_libcrypto_errors(void)
3442
0
{
3443
0
  while (ERR_get_error() != 0)
3444
0
    ;
3445
0
}
3446
3447
/*
3448
 * Translate OpenSSL error codes to determine whether
3449
 * passphrase is required/incorrect.
3450
 */
3451
static int
3452
convert_libcrypto_error(void)
3453
0
{
3454
  /*
3455
   * Some password errors are reported at the beginning
3456
   * of the error queue.
3457
   */
3458
0
  if (translate_libcrypto_error(ERR_peek_error()) ==
3459
0
      SSH_ERR_KEY_WRONG_PASSPHRASE)
3460
0
    return SSH_ERR_KEY_WRONG_PASSPHRASE;
3461
0
  return translate_libcrypto_error(ERR_peek_last_error());
3462
0
}
3463
3464
static int
3465
pem_passphrase_cb(char *buf, int size, int rwflag, void *u)
3466
0
{
3467
0
  char *p = (char *)u;
3468
0
  size_t len;
3469
3470
0
  if (p == NULL || (len = strlen(p)) == 0)
3471
0
    return -1;
3472
0
  if (size < 0 || len > (size_t)size)
3473
0
    return -1;
3474
0
  memcpy(buf, p, len);
3475
0
  return (int)len;
3476
0
}
3477
3478
static int
3479
sshkey_parse_private_pem_fileblob(struct sshbuf *blob, int type,
3480
    const char *passphrase, struct sshkey **keyp)
3481
0
{
3482
0
  EVP_PKEY *pk = NULL;
3483
0
  struct sshkey *prv = NULL;
3484
0
  BIO *bio = NULL;
3485
0
  int r;
3486
0
  RSA *rsa = NULL;
3487
0
  EC_KEY *ecdsa = NULL;
3488
3489
0
  if (keyp != NULL)
3490
0
    *keyp = NULL;
3491
3492
0
  if ((bio = BIO_new(BIO_s_mem())) == NULL || sshbuf_len(blob) > INT_MAX)
3493
0
    return SSH_ERR_ALLOC_FAIL;
3494
0
  if (BIO_write(bio, sshbuf_ptr(blob), sshbuf_len(blob)) !=
3495
0
      (int)sshbuf_len(blob)) {
3496
0
    r = SSH_ERR_ALLOC_FAIL;
3497
0
    goto out;
3498
0
  }
3499
3500
0
  clear_libcrypto_errors();
3501
0
  if ((pk = PEM_read_bio_PrivateKey(bio, NULL, pem_passphrase_cb,
3502
0
      (char *)passphrase)) == NULL) {
3503
    /*
3504
     * libcrypto may return various ASN.1 errors when attempting
3505
     * to parse a key with an incorrect passphrase.
3506
     * Treat all format errors as "incorrect passphrase" if a
3507
     * passphrase was supplied.
3508
     */
3509
0
    if (passphrase != NULL && *passphrase != '\0')
3510
0
      r = SSH_ERR_KEY_WRONG_PASSPHRASE;
3511
0
    else
3512
0
      r = convert_libcrypto_error();
3513
0
    goto out;
3514
0
  }
3515
0
  if (EVP_PKEY_base_id(pk) == EVP_PKEY_RSA &&
3516
0
      (type == KEY_UNSPEC || type == KEY_RSA)) {
3517
0
    if ((prv = sshkey_new(KEY_UNSPEC)) == NULL) {
3518
0
      r = SSH_ERR_ALLOC_FAIL;
3519
0
      goto out;
3520
0
    }
3521
0
    if ((rsa = EVP_PKEY_get1_RSA(pk)) == NULL) {
3522
0
      r = SSH_ERR_LIBCRYPTO_ERROR;
3523
0
      goto out;
3524
0
    }
3525
0
    prv->type = KEY_RSA;
3526
#ifdef DEBUG_PK
3527
    RSA_print_fp(stderr, rsa, 8);
3528
#endif
3529
0
    if (RSA_blinding_on(rsa, NULL) != 1 ||
3530
0
        EVP_PKEY_set1_RSA(pk, rsa) != 1) {
3531
0
      r = SSH_ERR_LIBCRYPTO_ERROR;
3532
0
      goto out;
3533
0
    }
3534
0
    EVP_PKEY_up_ref(pk);
3535
0
    prv->pkey = pk;
3536
0
    if ((r = sshkey_check_rsa_length(prv, 0)) != 0)
3537
0
      goto out;
3538
0
#ifdef OPENSSL_HAS_ECC
3539
0
  } else if (EVP_PKEY_base_id(pk) == EVP_PKEY_EC &&
3540
0
      (type == KEY_UNSPEC || type == KEY_ECDSA)) {
3541
0
    if ((prv = sshkey_new(KEY_UNSPEC)) == NULL) {
3542
0
      r = SSH_ERR_ALLOC_FAIL;
3543
0
      goto out;
3544
0
    }
3545
0
    if ((prv->ecdsa_nid = sshkey_ecdsa_fixup_group(pk)) == -1 ||
3546
0
        (ecdsa = EVP_PKEY_get1_EC_KEY(pk)) == NULL) {
3547
0
      r = SSH_ERR_LIBCRYPTO_ERROR;
3548
0
      goto out;
3549
0
    }
3550
0
    prv->type = KEY_ECDSA;
3551
0
    if (sshkey_curve_nid_to_name(prv->ecdsa_nid) == NULL ||
3552
0
        sshkey_ec_validate_public(EC_KEY_get0_group(ecdsa),
3553
0
        EC_KEY_get0_public_key(ecdsa)) != 0 ||
3554
0
        sshkey_ec_validate_private(ecdsa) != 0) {
3555
0
      r = SSH_ERR_INVALID_FORMAT;
3556
0
      goto out;
3557
0
    }
3558
0
    EVP_PKEY_up_ref(pk);
3559
0
    prv->pkey = pk;
3560
#ifdef DEBUG_PK
3561
    if (prv != NULL && prv->pkey != NULL)
3562
      sshkey_dump_ec_key(EVP_PKEY_get0_EC_KEY(prv->pkey));
3563
#endif
3564
0
#endif /* OPENSSL_HAS_ECC */
3565
0
#ifdef OPENSSL_HAS_ED25519
3566
0
  } else if (EVP_PKEY_base_id(pk) == EVP_PKEY_ED25519 &&
3567
0
      (type == KEY_UNSPEC || type == KEY_ED25519)) {
3568
0
    size_t len;
3569
3570
0
    if ((prv = sshkey_new(KEY_UNSPEC)) == NULL ||
3571
0
        (prv->ed25519_sk = calloc(1, ED25519_SK_SZ)) == NULL ||
3572
0
        (prv->ed25519_pk = calloc(1, ED25519_PK_SZ)) == NULL) {
3573
0
      r = SSH_ERR_ALLOC_FAIL;
3574
0
      goto out;
3575
0
    }
3576
0
    prv->type = KEY_ED25519;
3577
0
    len = ED25519_PK_SZ;
3578
0
    if (!EVP_PKEY_get_raw_public_key(pk, prv->ed25519_pk, &len)) {
3579
0
      r = SSH_ERR_LIBCRYPTO_ERROR;
3580
0
      goto out;
3581
0
    }
3582
0
    if (len != ED25519_PK_SZ) {
3583
0
      r = SSH_ERR_INVALID_FORMAT;
3584
0
      goto out;
3585
0
    }
3586
0
    len = ED25519_SK_SZ - ED25519_PK_SZ;
3587
0
    if (!EVP_PKEY_get_raw_private_key(pk, prv->ed25519_sk, &len)) {
3588
0
      r = SSH_ERR_LIBCRYPTO_ERROR;
3589
0
      goto out;
3590
0
    }
3591
0
    if (len != ED25519_SK_SZ - ED25519_PK_SZ) {
3592
0
      r = SSH_ERR_INVALID_FORMAT;
3593
0
      goto out;
3594
0
    }
3595
    /* Append the public key to our private key */
3596
0
    memcpy(prv->ed25519_sk + (ED25519_SK_SZ - ED25519_PK_SZ),
3597
0
        prv->ed25519_pk, ED25519_PK_SZ);
3598
#ifdef DEBUG_PK
3599
    sshbuf_dump_data(prv->ed25519_sk, ED25519_SK_SZ, stderr);
3600
#endif
3601
0
#endif /* OPENSSL_HAS_ED25519 */
3602
0
  } else {
3603
0
    r = SSH_ERR_INVALID_FORMAT;
3604
0
    goto out;
3605
0
  }
3606
0
  r = 0;
3607
0
  if (keyp != NULL) {
3608
0
    *keyp = prv;
3609
0
    prv = NULL;
3610
0
  }
3611
0
 out:
3612
0
  BIO_free(bio);
3613
0
  EVP_PKEY_free(pk);
3614
0
  RSA_free(rsa);
3615
0
#ifdef OPENSSL_HAS_ECC
3616
0
  EC_KEY_free(ecdsa);
3617
0
#endif
3618
0
  sshkey_free(prv);
3619
0
  return r;
3620
0
}
3621
#endif /* WITH_OPENSSL */
3622
3623
int
3624
sshkey_parse_private_fileblob_type(struct sshbuf *blob, int type,
3625
    const char *passphrase, struct sshkey **keyp, char **commentp)
3626
0
{
3627
0
  int r = SSH_ERR_INTERNAL_ERROR;
3628
3629
0
  if (keyp != NULL)
3630
0
    *keyp = NULL;
3631
0
  if (commentp != NULL)
3632
0
    *commentp = NULL;
3633
3634
0
  r = sshkey_parse_private2(blob, type, passphrase, keyp, commentp);
3635
  /* Only fallback to PEM parser if a format error occurred. */
3636
0
  if (r != SSH_ERR_INVALID_FORMAT)
3637
0
    return r;
3638
0
#ifdef WITH_OPENSSL
3639
0
  return sshkey_parse_private_pem_fileblob(blob, type,
3640
0
      passphrase, keyp);
3641
#else
3642
  return SSH_ERR_INVALID_FORMAT;
3643
#endif /* WITH_OPENSSL */
3644
0
}
3645
3646
int
3647
sshkey_parse_private_fileblob(struct sshbuf *buffer, const char *passphrase,
3648
    struct sshkey **keyp, char **commentp)
3649
0
{
3650
0
  if (keyp != NULL)
3651
0
    *keyp = NULL;
3652
0
  if (commentp != NULL)
3653
0
    *commentp = NULL;
3654
3655
0
  return sshkey_parse_private_fileblob_type(buffer, KEY_UNSPEC,
3656
0
      passphrase, keyp, commentp);
3657
0
}
3658
3659
void
3660
sshkey_sig_details_free(struct sshkey_sig_details *details)
3661
2.29k
{
3662
2.29k
  freezero(details, sizeof(*details));
3663
2.29k
}
3664
3665
int
3666
sshkey_parse_pubkey_from_private_fileblob_type(struct sshbuf *blob, int type,
3667
    struct sshkey **pubkeyp)
3668
0
{
3669
0
  int r = SSH_ERR_INTERNAL_ERROR;
3670
3671
0
  if (pubkeyp != NULL)
3672
0
    *pubkeyp = NULL;
3673
  /* only new-format private keys bundle a public key inside */
3674
0
  if ((r = sshkey_parse_private2_pubkey(blob, type, pubkeyp)) != 0)
3675
0
    return r;
3676
0
  return 0;
3677
0
}