blob: a5d3c64d21799094fd4666248409086b8040aa4d [file] [log] [blame]
djm@openbsd.orgc54cd182019-12-30 09:23:28 +00001/* $OpenBSD: ssh-sk.c,v 1.21 2019/12/30 09:23:28 djm Exp $ */
djm@openbsd.orged3467c2019-10-31 21:16:20 +00002/*
3 * Copyright (c) 2019 Google LLC
4 *
5 * Permission to use, copy, modify, and distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
8 *
9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16 */
17
18/* #define DEBUG_SK 1 */
19
20#include "includes.h"
21
Damien Miller764d51e2019-11-01 13:34:49 +110022#ifdef ENABLE_SK
23
djm@openbsd.orged3467c2019-10-31 21:16:20 +000024#include <dlfcn.h>
25#include <stddef.h>
26#include <stdint.h>
27#include <string.h>
28#include <stdio.h>
29
naddy@openbsd.org723a5362019-11-18 16:08:57 +000030#ifdef WITH_OPENSSL
djm@openbsd.orged3467c2019-10-31 21:16:20 +000031#include <openssl/objects.h>
32#include <openssl/ec.h>
naddy@openbsd.org723a5362019-11-18 16:08:57 +000033#endif /* WITH_OPENSSL */
djm@openbsd.orged3467c2019-10-31 21:16:20 +000034
35#include "log.h"
36#include "misc.h"
37#include "sshbuf.h"
38#include "sshkey.h"
39#include "ssherr.h"
40#include "digest.h"
41
42#include "ssh-sk.h"
43#include "sk-api.h"
markus@openbsd.org7c32b512019-11-12 19:31:45 +000044#include "crypto_api.h"
djm@openbsd.orged3467c2019-10-31 21:16:20 +000045
46struct sshsk_provider {
47 char *path;
48 void *dlhandle;
49
50 /* Return the version of the middleware API */
51 uint32_t (*sk_api_version)(void);
52
53 /* Enroll a U2F key (private key generation) */
markus@openbsd.orgfd1a3b52019-11-12 19:32:30 +000054 int (*sk_enroll)(int alg, const uint8_t *challenge,
55 size_t challenge_len, const char *application, uint8_t flags,
djm@openbsd.orgc54cd182019-12-30 09:23:28 +000056 const char *pin, struct sk_enroll_response **enroll_response);
djm@openbsd.orged3467c2019-10-31 21:16:20 +000057
58 /* Sign a challenge */
markus@openbsd.orgfd1a3b52019-11-12 19:32:30 +000059 int (*sk_sign)(int alg, const uint8_t *message, size_t message_len,
djm@openbsd.orged3467c2019-10-31 21:16:20 +000060 const char *application,
61 const uint8_t *key_handle, size_t key_handle_len,
djm@openbsd.orgc54cd182019-12-30 09:23:28 +000062 uint8_t flags, const char *pin,
63 struct sk_sign_response **sign_response);
djm@openbsd.org14cea362019-12-30 09:21:16 +000064
65 /* Enumerate resident keys */
66 int (*sk_load_resident_keys)(const char *pin,
67 struct sk_resident_key ***rks, size_t *nrks);
djm@openbsd.orged3467c2019-10-31 21:16:20 +000068};
69
djm@openbsd.org6bff9522019-11-14 21:27:29 +000070/* Built-in version */
71int ssh_sk_enroll(int alg, const uint8_t *challenge,
72 size_t challenge_len, const char *application, uint8_t flags,
djm@openbsd.orgc54cd182019-12-30 09:23:28 +000073 const char *pin, struct sk_enroll_response **enroll_response);
djm@openbsd.org6bff9522019-11-14 21:27:29 +000074int ssh_sk_sign(int alg, const uint8_t *message, size_t message_len,
75 const char *application,
76 const uint8_t *key_handle, size_t key_handle_len,
djm@openbsd.orgc54cd182019-12-30 09:23:28 +000077 uint8_t flags, const char *pin, struct sk_sign_response **sign_response);
djm@openbsd.org14cea362019-12-30 09:21:16 +000078int ssh_sk_load_resident_keys(const char *pin,
79 struct sk_resident_key ***rks, size_t *nrks);
djm@openbsd.org6bff9522019-11-14 21:27:29 +000080
djm@openbsd.orged3467c2019-10-31 21:16:20 +000081static void
82sshsk_free(struct sshsk_provider *p)
83{
84 if (p == NULL)
85 return;
86 free(p->path);
87 if (p->dlhandle != NULL)
88 dlclose(p->dlhandle);
89 free(p);
90}
91
92static struct sshsk_provider *
93sshsk_open(const char *path)
94{
95 struct sshsk_provider *ret = NULL;
96 uint32_t version;
97
98 if ((ret = calloc(1, sizeof(*ret))) == NULL) {
99 error("%s: calloc failed", __func__);
100 return NULL;
101 }
102 if ((ret->path = strdup(path)) == NULL) {
103 error("%s: strdup failed", __func__);
104 goto fail;
105 }
djm@openbsd.org6bff9522019-11-14 21:27:29 +0000106 /* Skip the rest if we're using the linked in middleware */
107 if (strcasecmp(ret->path, "internal") == 0) {
108#ifdef ENABLE_SK_INTERNAL
109 ret->sk_enroll = ssh_sk_enroll;
110 ret->sk_sign = ssh_sk_sign;
djm@openbsd.org14cea362019-12-30 09:21:16 +0000111 ret->sk_load_resident_keys = ssh_sk_load_resident_keys;
djm@openbsd.org6bff9522019-11-14 21:27:29 +0000112#else
113 error("internal security key support not enabled");
114#endif
115 return ret;
116 }
djm@openbsd.orged3467c2019-10-31 21:16:20 +0000117 if ((ret->dlhandle = dlopen(path, RTLD_NOW)) == NULL) {
118 error("Security key provider %s dlopen failed: %s",
119 path, dlerror());
120 goto fail;
121 }
122 if ((ret->sk_api_version = dlsym(ret->dlhandle,
123 "sk_api_version")) == NULL) {
124 error("Security key provider %s dlsym(sk_api_version) "
125 "failed: %s", path, dlerror());
126 goto fail;
127 }
128 version = ret->sk_api_version();
129 debug("%s: provider %s implements version 0x%08lx", __func__,
130 ret->path, (u_long)version);
131 if ((version & SSH_SK_VERSION_MAJOR_MASK) != SSH_SK_VERSION_MAJOR) {
132 error("Security key provider %s implements unsupported version "
133 "0x%08lx (supported: 0x%08lx)", path, (u_long)version,
134 (u_long)SSH_SK_VERSION_MAJOR);
135 goto fail;
136 }
137 if ((ret->sk_enroll = dlsym(ret->dlhandle, "sk_enroll")) == NULL) {
138 error("Security key provider %s dlsym(sk_enroll) "
139 "failed: %s", path, dlerror());
140 goto fail;
141 }
142 if ((ret->sk_sign = dlsym(ret->dlhandle, "sk_sign")) == NULL) {
143 error("Security key provider %s dlsym(sk_sign) failed: %s",
144 path, dlerror());
145 goto fail;
146 }
djm@openbsd.org14cea362019-12-30 09:21:16 +0000147 if ((ret->sk_load_resident_keys = dlsym(ret->dlhandle,
148 "sk_load_resident_keys")) == NULL) {
149 error("Security key provider %s dlsym(sk_load_resident_keys) "
150 "failed: %s", path, dlerror());
151 goto fail;
152 }
djm@openbsd.orged3467c2019-10-31 21:16:20 +0000153 /* success */
154 return ret;
155fail:
156 sshsk_free(ret);
157 return NULL;
158}
159
160static void
161sshsk_free_enroll_response(struct sk_enroll_response *r)
162{
163 if (r == NULL)
164 return;
165 freezero(r->key_handle, r->key_handle_len);
166 freezero(r->public_key, r->public_key_len);
167 freezero(r->signature, r->signature_len);
168 freezero(r->attestation_cert, r->attestation_cert_len);
169 freezero(r, sizeof(*r));
djm@openbsd.orgd8b28382019-11-27 22:32:11 +0000170}
djm@openbsd.orged3467c2019-10-31 21:16:20 +0000171
172static void
173sshsk_free_sign_response(struct sk_sign_response *r)
174{
175 if (r == NULL)
176 return;
177 freezero(r->sig_r, r->sig_r_len);
178 freezero(r->sig_s, r->sig_s_len);
179 freezero(r, sizeof(*r));
djm@openbsd.orgd8b28382019-11-27 22:32:11 +0000180}
djm@openbsd.orged3467c2019-10-31 21:16:20 +0000181
naddy@openbsd.org723a5362019-11-18 16:08:57 +0000182#ifdef WITH_OPENSSL
markus@openbsd.orgcef84a02019-11-12 19:29:54 +0000183/* Assemble key from response */
184static int
185sshsk_ecdsa_assemble(struct sk_enroll_response *resp, struct sshkey **keyp)
186{
187 struct sshkey *key = NULL;
188 struct sshbuf *b = NULL;
189 EC_POINT *q = NULL;
190 int r;
191
192 *keyp = NULL;
193 if ((key = sshkey_new(KEY_ECDSA_SK)) == NULL) {
194 error("%s: sshkey_new failed", __func__);
195 r = SSH_ERR_ALLOC_FAIL;
196 goto out;
197 }
198 key->ecdsa_nid = NID_X9_62_prime256v1;
199 if ((key->ecdsa = EC_KEY_new_by_curve_name(key->ecdsa_nid)) == NULL ||
200 (q = EC_POINT_new(EC_KEY_get0_group(key->ecdsa))) == NULL ||
201 (b = sshbuf_new()) == NULL) {
202 error("%s: allocation failed", __func__);
203 r = SSH_ERR_ALLOC_FAIL;
204 goto out;
205 }
206 if ((r = sshbuf_put_string(b,
207 resp->public_key, resp->public_key_len)) != 0) {
208 error("%s: buffer error: %s", __func__, ssh_err(r));
209 goto out;
210 }
211 if ((r = sshbuf_get_ec(b, q, EC_KEY_get0_group(key->ecdsa))) != 0) {
212 error("%s: parse key: %s", __func__, ssh_err(r));
213 r = SSH_ERR_INVALID_FORMAT;
214 goto out;
215 }
216 if (sshkey_ec_validate_public(EC_KEY_get0_group(key->ecdsa), q) != 0) {
217 error("Security key returned invalid ECDSA key");
218 r = SSH_ERR_KEY_INVALID_EC_VALUE;
219 goto out;
220 }
221 if (EC_KEY_set_public_key(key->ecdsa, q) != 1) {
222 /* XXX assume it is a allocation error */
223 error("%s: allocation failed", __func__);
224 r = SSH_ERR_ALLOC_FAIL;
225 goto out;
226 }
227 /* success */
228 *keyp = key;
229 key = NULL; /* transferred */
230 r = 0;
231 out:
232 EC_POINT_free(q);
233 sshkey_free(key);
234 sshbuf_free(b);
235 return r;
236}
naddy@openbsd.org723a5362019-11-18 16:08:57 +0000237#endif /* WITH_OPENSSL */
markus@openbsd.orgcef84a02019-11-12 19:29:54 +0000238
markus@openbsd.org7c32b512019-11-12 19:31:45 +0000239static int
240sshsk_ed25519_assemble(struct sk_enroll_response *resp, struct sshkey **keyp)
241{
242 struct sshkey *key = NULL;
243 int r;
244
245 *keyp = NULL;
246 if (resp->public_key_len != ED25519_PK_SZ) {
247 error("%s: invalid size: %zu", __func__, resp->public_key_len);
248 r = SSH_ERR_INVALID_FORMAT;
249 goto out;
250 }
251 if ((key = sshkey_new(KEY_ED25519_SK)) == NULL) {
252 error("%s: sshkey_new failed", __func__);
253 r = SSH_ERR_ALLOC_FAIL;
254 goto out;
255 }
256 if ((key->ed25519_pk = malloc(ED25519_PK_SZ)) == NULL) {
257 error("%s: malloc failed", __func__);
258 r = SSH_ERR_ALLOC_FAIL;
259 goto out;
260 }
261 memcpy(key->ed25519_pk, resp->public_key, ED25519_PK_SZ);
262 /* success */
263 *keyp = key;
264 key = NULL; /* transferred */
265 r = 0;
266 out:
267 sshkey_free(key);
268 return r;
269}
270
djm@openbsd.org2fe05fc2019-12-30 09:20:36 +0000271static int
272sshsk_key_from_response(int alg, const char *application, uint8_t flags,
273 struct sk_enroll_response *resp, struct sshkey **keyp)
274{
275 struct sshkey *key = NULL;
276 int r = SSH_ERR_INTERNAL_ERROR;
277
278 *keyp = NULL;
279
280 /* Check response validity */
djm@openbsd.org14cea362019-12-30 09:21:16 +0000281 if (resp->public_key == NULL || resp->key_handle == NULL) {
djm@openbsd.org2fe05fc2019-12-30 09:20:36 +0000282 error("%s: sk_enroll response invalid", __func__);
283 r = SSH_ERR_INVALID_FORMAT;
284 goto out;
285 }
286 switch (alg) {
287#ifdef WITH_OPENSSL
288 case SSH_SK_ECDSA:
289 if ((r = sshsk_ecdsa_assemble(resp, &key)) != 0)
290 goto out;
291 break;
292#endif /* WITH_OPENSSL */
293 case SSH_SK_ED25519:
294 if ((r = sshsk_ed25519_assemble(resp, &key)) != 0)
295 goto out;
296 break;
297 default:
298 error("%s: unsupported algorithm %d", __func__, alg);
299 r = SSH_ERR_INVALID_ARGUMENT;
300 goto out;
301 }
302 key->sk_flags = flags;
303 if ((key->sk_key_handle = sshbuf_new()) == NULL ||
304 (key->sk_reserved = sshbuf_new()) == NULL) {
305 error("%s: allocation failed", __func__);
306 r = SSH_ERR_ALLOC_FAIL;
307 goto out;
308 }
309 if ((key->sk_application = strdup(application)) == NULL) {
310 error("%s: strdup application failed", __func__);
311 r = SSH_ERR_ALLOC_FAIL;
312 goto out;
313 }
314 if ((r = sshbuf_put(key->sk_key_handle, resp->key_handle,
315 resp->key_handle_len)) != 0) {
316 error("%s: buffer error: %s", __func__, ssh_err(r));
317 goto out;
318 }
319 /* success */
320 r = 0;
321 *keyp = key;
322 key = NULL;
323 out:
324 sshkey_free(key);
325 return r;
326}
327
djm@openbsd.orged3467c2019-10-31 21:16:20 +0000328int
markus@openbsd.org7c32b512019-11-12 19:31:45 +0000329sshsk_enroll(int type, const char *provider_path, const char *application,
djm@openbsd.orgc54cd182019-12-30 09:23:28 +0000330 uint8_t flags, const char *pin, struct sshbuf *challenge_buf,
331 struct sshkey **keyp, struct sshbuf *attest)
djm@openbsd.orged3467c2019-10-31 21:16:20 +0000332{
333 struct sshsk_provider *skp = NULL;
334 struct sshkey *key = NULL;
335 u_char randchall[32];
336 const u_char *challenge;
337 size_t challenge_len;
338 struct sk_enroll_response *resp = NULL;
339 int r = SSH_ERR_INTERNAL_ERROR;
markus@openbsd.orgfd1a3b52019-11-12 19:32:30 +0000340 int alg;
djm@openbsd.orged3467c2019-10-31 21:16:20 +0000341
djm@openbsd.org4103a3e2019-11-16 22:42:30 +0000342 debug("%s: provider \"%s\", application \"%s\", flags 0x%02x, "
djm@openbsd.orgc54cd182019-12-30 09:23:28 +0000343 "challenge len %zu%s", __func__, provider_path, application,
344 flags, challenge_buf == NULL ? 0 : sshbuf_len(challenge_buf),
345 (pin != NULL && *pin != '\0') ? " with-pin" : "");
djm@openbsd.org4103a3e2019-11-16 22:42:30 +0000346
djm@openbsd.orged3467c2019-10-31 21:16:20 +0000347 *keyp = NULL;
348 if (attest)
349 sshbuf_reset(attest);
markus@openbsd.org7c32b512019-11-12 19:31:45 +0000350 switch (type) {
naddy@openbsd.org723a5362019-11-18 16:08:57 +0000351#ifdef WITH_OPENSSL
markus@openbsd.org7c32b512019-11-12 19:31:45 +0000352 case KEY_ECDSA_SK:
markus@openbsd.orgfd1a3b52019-11-12 19:32:30 +0000353 alg = SSH_SK_ECDSA;
354 break;
naddy@openbsd.org723a5362019-11-18 16:08:57 +0000355#endif /* WITH_OPENSSL */
markus@openbsd.org7c32b512019-11-12 19:31:45 +0000356 case KEY_ED25519_SK:
markus@openbsd.orgfd1a3b52019-11-12 19:32:30 +0000357 alg = SSH_SK_ED25519;
markus@openbsd.org7c32b512019-11-12 19:31:45 +0000358 break;
359 default:
360 error("%s: unsupported key type", __func__);
361 r = SSH_ERR_INVALID_ARGUMENT;
362 goto out;
363 }
djm@openbsd.orged3467c2019-10-31 21:16:20 +0000364 if (provider_path == NULL) {
365 error("%s: missing provider", __func__);
366 r = SSH_ERR_INVALID_ARGUMENT;
367 goto out;
368 }
369 if (application == NULL || *application == '\0') {
370 error("%s: missing application", __func__);
371 r = SSH_ERR_INVALID_ARGUMENT;
372 goto out;
373 }
374 if (challenge_buf == NULL) {
375 debug("%s: using random challenge", __func__);
376 arc4random_buf(randchall, sizeof(randchall));
377 challenge = randchall;
378 challenge_len = sizeof(randchall);
379 } else if (sshbuf_len(challenge_buf) == 0) {
380 error("Missing enrollment challenge");
381 r = SSH_ERR_INVALID_ARGUMENT;
382 goto out;
383 } else {
384 challenge = sshbuf_ptr(challenge_buf);
385 challenge_len = sshbuf_len(challenge_buf);
386 debug3("%s: using explicit challenge len=%zd",
387 __func__, challenge_len);
388 }
389 if ((skp = sshsk_open(provider_path)) == NULL) {
390 r = SSH_ERR_INVALID_FORMAT; /* XXX sshsk_open return code? */
391 goto out;
392 }
393 /* XXX validate flags? */
394 /* enroll key */
markus@openbsd.orgfd1a3b52019-11-12 19:32:30 +0000395 if ((r = skp->sk_enroll(alg, challenge, challenge_len, application,
djm@openbsd.orgc54cd182019-12-30 09:23:28 +0000396 flags, pin, &resp)) != 0) {
djm@openbsd.orged3467c2019-10-31 21:16:20 +0000397 error("Security key provider %s returned failure %d",
398 provider_path, r);
399 r = SSH_ERR_INVALID_FORMAT; /* XXX error codes in API? */
400 goto out;
401 }
djm@openbsd.org2fe05fc2019-12-30 09:20:36 +0000402
403 if ((r = sshsk_key_from_response(alg, application, flags,
404 resp, &key)) != 0)
djm@openbsd.orged3467c2019-10-31 21:16:20 +0000405 goto out;
djm@openbsd.org2fe05fc2019-12-30 09:20:36 +0000406
djm@openbsd.orged3467c2019-10-31 21:16:20 +0000407 /* Optionally fill in the attestation information */
408 if (attest != NULL) {
409 if ((r = sshbuf_put_cstring(attest, "sk-attest-v00")) != 0 ||
410 (r = sshbuf_put_u32(attest, 1)) != 0 || /* XXX U2F ver */
411 (r = sshbuf_put_string(attest,
412 resp->attestation_cert, resp->attestation_cert_len)) != 0 ||
413 (r = sshbuf_put_string(attest,
414 resp->signature, resp->signature_len)) != 0 ||
415 (r = sshbuf_put_u32(attest, flags)) != 0 || /* XXX right? */
416 (r = sshbuf_put_string(attest, NULL, 0)) != 0) {
417 error("%s: buffer error: %s", __func__, ssh_err(r));
418 goto out;
419 }
420 }
421 /* success */
422 *keyp = key;
423 key = NULL; /* transferred */
424 r = 0;
425 out:
djm@openbsd.orged3467c2019-10-31 21:16:20 +0000426 sshsk_free(skp);
djm@openbsd.orged3467c2019-10-31 21:16:20 +0000427 sshkey_free(key);
428 sshsk_free_enroll_response(resp);
429 explicit_bzero(randchall, sizeof(randchall));
430 return r;
431}
432
naddy@openbsd.org723a5362019-11-18 16:08:57 +0000433#ifdef WITH_OPENSSL
markus@openbsd.orgbc7b5d62019-11-12 19:30:21 +0000434static int
markus@openbsd.orgb556cc32019-11-12 19:34:40 +0000435sshsk_ecdsa_sig(struct sk_sign_response *resp, struct sshbuf *sig)
markus@openbsd.orgbc7b5d62019-11-12 19:30:21 +0000436{
437 struct sshbuf *inner_sig = NULL;
438 int r = SSH_ERR_INTERNAL_ERROR;
439
markus@openbsd.org3fcf69a2019-11-12 19:34:00 +0000440 /* Check response validity */
markus@openbsd.orgdffd02e2019-11-13 20:25:45 +0000441 if (resp->sig_r == NULL || resp->sig_s == NULL) {
markus@openbsd.org3fcf69a2019-11-12 19:34:00 +0000442 error("%s: sk_sign response invalid", __func__);
443 r = SSH_ERR_INVALID_FORMAT;
444 goto out;
445 }
markus@openbsd.orgbc7b5d62019-11-12 19:30:21 +0000446 if ((inner_sig = sshbuf_new()) == NULL) {
447 r = SSH_ERR_ALLOC_FAIL;
448 goto out;
449 }
markus@openbsd.orgb556cc32019-11-12 19:34:40 +0000450 /* Prepare and append inner signature object */
markus@openbsd.orgbc7b5d62019-11-12 19:30:21 +0000451 if ((r = sshbuf_put_bignum2_bytes(inner_sig,
452 resp->sig_r, resp->sig_r_len)) != 0 ||
453 (r = sshbuf_put_bignum2_bytes(inner_sig,
djm@openbsd.orga70d92f2019-11-19 22:23:19 +0000454 resp->sig_s, resp->sig_s_len)) != 0) {
markus@openbsd.orgbc7b5d62019-11-12 19:30:21 +0000455 debug("%s: buffer error: %s", __func__, ssh_err(r));
456 goto out;
457 }
djm@openbsd.orga70d92f2019-11-19 22:23:19 +0000458 if ((r = sshbuf_put_stringb(sig, inner_sig)) != 0 ||
459 (r = sshbuf_put_u8(sig, resp->flags)) != 0 ||
460 (r = sshbuf_put_u32(sig, resp->counter)) != 0) {
markus@openbsd.orgb556cc32019-11-12 19:34:40 +0000461 debug("%s: buffer error: %s", __func__, ssh_err(r));
462 goto out;
463 }
markus@openbsd.orgbc7b5d62019-11-12 19:30:21 +0000464#ifdef DEBUG_SK
465 fprintf(stderr, "%s: sig_r:\n", __func__);
466 sshbuf_dump_data(resp->sig_r, resp->sig_r_len, stderr);
467 fprintf(stderr, "%s: sig_s:\n", __func__);
468 sshbuf_dump_data(resp->sig_s, resp->sig_s_len, stderr);
markus@openbsd.orgb556cc32019-11-12 19:34:40 +0000469 fprintf(stderr, "%s: inner:\n", __func__);
470 sshbuf_dump(inner_sig, stderr);
markus@openbsd.orgfe05a362019-11-12 19:31:18 +0000471#endif
markus@openbsd.orgfe05a362019-11-12 19:31:18 +0000472 r = 0;
markus@openbsd.orgb556cc32019-11-12 19:34:40 +0000473 out:
markus@openbsd.orgfe05a362019-11-12 19:31:18 +0000474 sshbuf_free(inner_sig);
475 return r;
476}
naddy@openbsd.org723a5362019-11-18 16:08:57 +0000477#endif /* WITH_OPENSSL */
markus@openbsd.orgfe05a362019-11-12 19:31:18 +0000478
479static int
markus@openbsd.orgb556cc32019-11-12 19:34:40 +0000480sshsk_ed25519_sig(struct sk_sign_response *resp, struct sshbuf *sig)
markus@openbsd.orgfe05a362019-11-12 19:31:18 +0000481{
markus@openbsd.orgfe05a362019-11-12 19:31:18 +0000482 int r = SSH_ERR_INTERNAL_ERROR;
483
markus@openbsd.org3fcf69a2019-11-12 19:34:00 +0000484 /* Check response validity */
485 if (resp->sig_r == NULL) {
486 error("%s: sk_sign response invalid", __func__);
487 r = SSH_ERR_INVALID_FORMAT;
488 goto out;
489 }
markus@openbsd.orgb556cc32019-11-12 19:34:40 +0000490 if ((r = sshbuf_put_string(sig,
markus@openbsd.orgfe05a362019-11-12 19:31:18 +0000491 resp->sig_r, resp->sig_r_len)) != 0 ||
markus@openbsd.orgb556cc32019-11-12 19:34:40 +0000492 (r = sshbuf_put_u8(sig, resp->flags)) != 0 ||
493 (r = sshbuf_put_u32(sig, resp->counter)) != 0) {
markus@openbsd.orgfe05a362019-11-12 19:31:18 +0000494 debug("%s: buffer error: %s", __func__, ssh_err(r));
495 goto out;
496 }
497#ifdef DEBUG_SK
498 fprintf(stderr, "%s: sig_r:\n", __func__);
499 sshbuf_dump_data(resp->sig_r, resp->sig_r_len, stderr);
markus@openbsd.orgbc7b5d62019-11-12 19:30:21 +0000500#endif
markus@openbsd.orgbc7b5d62019-11-12 19:30:21 +0000501 r = 0;
markus@openbsd.orgb556cc32019-11-12 19:34:40 +0000502 out:
503 return 0;
markus@openbsd.orgbc7b5d62019-11-12 19:30:21 +0000504}
505
djm@openbsd.orged3467c2019-10-31 21:16:20 +0000506int
djm@openbsd.orgb52ec0b2019-12-13 19:09:10 +0000507sshsk_sign(const char *provider_path, struct sshkey *key,
djm@openbsd.orged3467c2019-10-31 21:16:20 +0000508 u_char **sigp, size_t *lenp, const u_char *data, size_t datalen,
djm@openbsd.orgc54cd182019-12-30 09:23:28 +0000509 u_int compat, const char *pin)
djm@openbsd.orged3467c2019-10-31 21:16:20 +0000510{
511 struct sshsk_provider *skp = NULL;
512 int r = SSH_ERR_INTERNAL_ERROR;
markus@openbsd.orgfd1a3b52019-11-12 19:32:30 +0000513 int type, alg;
djm@openbsd.orged3467c2019-10-31 21:16:20 +0000514 struct sk_sign_response *resp = NULL;
515 struct sshbuf *inner_sig = NULL, *sig = NULL;
516 uint8_t message[32];
517
djm@openbsd.orgc54cd182019-12-30 09:23:28 +0000518 debug("%s: provider \"%s\", key %s, flags 0x%02x%s", __func__,
519 provider_path, sshkey_type(key), key->sk_flags,
520 (pin != NULL && *pin != '\0') ? " with-pin" : "");
djm@openbsd.org4103a3e2019-11-16 22:42:30 +0000521
djm@openbsd.orged3467c2019-10-31 21:16:20 +0000522 if (sigp != NULL)
523 *sigp = NULL;
524 if (lenp != NULL)
525 *lenp = 0;
markus@openbsd.orgfe05a362019-11-12 19:31:18 +0000526 type = sshkey_type_plain(key->type);
527 switch (type) {
naddy@openbsd.org723a5362019-11-18 16:08:57 +0000528#ifdef WITH_OPENSSL
markus@openbsd.orgfe05a362019-11-12 19:31:18 +0000529 case KEY_ECDSA_SK:
markus@openbsd.orgfd1a3b52019-11-12 19:32:30 +0000530 alg = SSH_SK_ECDSA;
531 break;
naddy@openbsd.org723a5362019-11-18 16:08:57 +0000532#endif /* WITH_OPENSSL */
markus@openbsd.orgfe05a362019-11-12 19:31:18 +0000533 case KEY_ED25519_SK:
markus@openbsd.orgfd1a3b52019-11-12 19:32:30 +0000534 alg = SSH_SK_ED25519;
markus@openbsd.orgfe05a362019-11-12 19:31:18 +0000535 break;
536 default:
537 return SSH_ERR_INVALID_ARGUMENT;
538 }
djm@openbsd.orged3467c2019-10-31 21:16:20 +0000539 if (provider_path == NULL ||
djm@openbsd.orged3467c2019-10-31 21:16:20 +0000540 key->sk_key_handle == NULL ||
541 key->sk_application == NULL || *key->sk_application == '\0') {
542 r = SSH_ERR_INVALID_ARGUMENT;
543 goto out;
544 }
545 if ((skp = sshsk_open(provider_path)) == NULL) {
546 r = SSH_ERR_INVALID_FORMAT; /* XXX sshsk_open return code? */
547 goto out;
548 }
549
550 /* hash data to be signed before it goes to the security key */
551 if ((r = ssh_digest_memory(SSH_DIGEST_SHA256, data, datalen,
552 message, sizeof(message))) != 0) {
553 error("%s: hash application failed: %s", __func__, ssh_err(r));
554 r = SSH_ERR_INTERNAL_ERROR;
555 goto out;
556 }
markus@openbsd.orgfd1a3b52019-11-12 19:32:30 +0000557 if ((r = skp->sk_sign(alg, message, sizeof(message),
djm@openbsd.orged3467c2019-10-31 21:16:20 +0000558 key->sk_application,
559 sshbuf_ptr(key->sk_key_handle), sshbuf_len(key->sk_key_handle),
djm@openbsd.orgc54cd182019-12-30 09:23:28 +0000560 key->sk_flags, pin, &resp)) != 0) {
djm@openbsd.orged3467c2019-10-31 21:16:20 +0000561 debug("%s: sk_sign failed with code %d", __func__, r);
562 goto out;
563 }
markus@openbsd.orgb556cc32019-11-12 19:34:40 +0000564 /* Assemble signature */
markus@openbsd.orgbc7b5d62019-11-12 19:30:21 +0000565 if ((sig = sshbuf_new()) == NULL) {
djm@openbsd.orged3467c2019-10-31 21:16:20 +0000566 r = SSH_ERR_ALLOC_FAIL;
567 goto out;
568 }
markus@openbsd.orgb556cc32019-11-12 19:34:40 +0000569 if ((r = sshbuf_put_cstring(sig, sshkey_ssh_name_plain(key))) != 0) {
djm@openbsd.orged3467c2019-10-31 21:16:20 +0000570 debug("%s: buffer error (outer): %s", __func__, ssh_err(r));
571 goto out;
572 }
markus@openbsd.orgb556cc32019-11-12 19:34:40 +0000573 switch (type) {
naddy@openbsd.org723a5362019-11-18 16:08:57 +0000574#ifdef WITH_OPENSSL
markus@openbsd.orgb556cc32019-11-12 19:34:40 +0000575 case KEY_ECDSA_SK:
576 if ((r = sshsk_ecdsa_sig(resp, sig)) != 0)
577 goto out;
578 break;
naddy@openbsd.org723a5362019-11-18 16:08:57 +0000579#endif /* WITH_OPENSSL */
markus@openbsd.orgb556cc32019-11-12 19:34:40 +0000580 case KEY_ED25519_SK:
581 if ((r = sshsk_ed25519_sig(resp, sig)) != 0)
582 goto out;
583 break;
584 }
djm@openbsd.orged3467c2019-10-31 21:16:20 +0000585#ifdef DEBUG_SK
markus@openbsd.orgfe05a362019-11-12 19:31:18 +0000586 fprintf(stderr, "%s: sig_flags = 0x%02x, sig_counter = %u\n",
587 __func__, resp->flags, resp->counter);
djm@openbsd.orged3467c2019-10-31 21:16:20 +0000588 fprintf(stderr, "%s: hashed message:\n", __func__);
589 sshbuf_dump_data(message, sizeof(message), stderr);
djm@openbsd.orged3467c2019-10-31 21:16:20 +0000590 fprintf(stderr, "%s: sigbuf:\n", __func__);
591 sshbuf_dump(sig, stderr);
592#endif
593 if (sigp != NULL) {
594 if ((*sigp = malloc(sshbuf_len(sig))) == NULL) {
595 r = SSH_ERR_ALLOC_FAIL;
596 goto out;
597 }
598 memcpy(*sigp, sshbuf_ptr(sig), sshbuf_len(sig));
599 }
600 if (lenp != NULL)
601 *lenp = sshbuf_len(sig);
602 /* success */
603 r = 0;
604 out:
605 explicit_bzero(message, sizeof(message));
606 sshsk_free(skp);
607 sshsk_free_sign_response(resp);
608 sshbuf_free(sig);
609 sshbuf_free(inner_sig);
610 return r;
611}
djm@openbsd.org14cea362019-12-30 09:21:16 +0000612
613static void
614sshsk_free_sk_resident_keys(struct sk_resident_key **rks, size_t nrks)
615{
616 size_t i;
617
618 if (nrks == 0 || rks == NULL)
619 return;
620 for (i = 0; i < nrks; i++) {
621 free(rks[i]->application);
622 freezero(rks[i]->key.key_handle, rks[i]->key.key_handle_len);
623 freezero(rks[i]->key.public_key, rks[i]->key.public_key_len);
624 freezero(rks[i]->key.signature, rks[i]->key.signature_len);
625 freezero(rks[i]->key.attestation_cert,
626 rks[i]->key.attestation_cert_len);
627 freezero(rks[i], sizeof(**rks));
628 }
629 free(rks);
630}
631
632int
633sshsk_load_resident(const char *provider_path, const char *pin,
634 struct sshkey ***keysp, size_t *nkeysp)
635{
636 struct sshsk_provider *skp = NULL;
637 int r = SSH_ERR_INTERNAL_ERROR;
638 struct sk_resident_key **rks = NULL;
639 size_t i, nrks = 0, nkeys = 0;
640 struct sshkey *key = NULL, **keys = NULL, **tmp;
641 uint8_t flags;
642
643 debug("%s: provider \"%s\"%s", __func__, provider_path,
644 (pin != NULL && *pin != '\0') ? ", have-pin": "");
645
646 if (keysp == NULL || nkeysp == NULL)
647 return SSH_ERR_INVALID_ARGUMENT;
648 *keysp = NULL;
649 *nkeysp = 0;
650
651 if ((skp = sshsk_open(provider_path)) == NULL) {
652 r = SSH_ERR_INVALID_FORMAT; /* XXX sshsk_open return code? */
653 goto out;
654 }
655 if ((r = skp->sk_load_resident_keys(pin, &rks, &nrks)) != 0) {
656 error("Security key provider %s returned failure %d",
657 provider_path, r);
658 r = SSH_ERR_INVALID_FORMAT; /* XXX error codes in API? */
659 goto out;
660 }
661 for (i = 0; i < nrks; i++) {
662 debug3("%s: rk %zu: slot = %zu, alg = %d, application = \"%s\"",
663 __func__, i, rks[i]->slot, rks[i]->alg,
664 rks[i]->application);
665 /* XXX need better filter here */
666 if (strncmp(rks[i]->application, "ssh:", 4) != 0)
667 continue;
668 switch (rks[i]->alg) {
669 case SSH_SK_ECDSA:
670 case SSH_SK_ED25519:
671 break;
672 default:
673 continue;
674 }
675 /* XXX where to get flags? */
676 flags = SSH_SK_USER_PRESENCE_REQD|SSH_SK_RESIDENT_KEY;
677 if ((r = sshsk_key_from_response(rks[i]->alg,
678 rks[i]->application, flags, &rks[i]->key, &key)) != 0)
679 goto out;
680 if ((tmp = recallocarray(keys, nkeys, nkeys + 1,
681 sizeof(*tmp))) == NULL) {
682 error("%s: recallocarray failed", __func__);
683 r = SSH_ERR_ALLOC_FAIL;
684 goto out;
685 }
686 keys = tmp;
687 keys[nkeys++] = key;
688 key = NULL;
689 /* XXX synthesise comment */
690 }
691 /* success */
692 *keysp = keys;
693 *nkeysp = nkeys;
694 keys = NULL;
695 nkeys = 0;
696 r = 0;
697 out:
698 sshsk_free(skp);
699 sshsk_free_sk_resident_keys(rks, nrks);
700 sshkey_free(key);
701 if (nkeys != 0) {
702 for (i = 0; i < nkeys; i++)
703 sshkey_free(keys[i]);
704 free(keys);
705 }
706 return r;
707}
708
Damien Miller764d51e2019-11-01 13:34:49 +1100709#endif /* ENABLE_SK */