Annotation of src/usr.bin/ssh/ssh-sk.c, Revision 1.26
1.26 ! djm 1: /* $OpenBSD: ssh-sk.c,v 1.25 2020/01/25 23:13:09 djm Exp $ */
1.1 djm 2: /*
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 <dlfcn.h>
21: #include <stddef.h>
22: #include <stdint.h>
23: #include <string.h>
24: #include <stdio.h>
25:
1.15 naddy 26: #ifdef WITH_OPENSSL
1.1 djm 27: #include <openssl/objects.h>
28: #include <openssl/ec.h>
1.15 naddy 29: #endif /* WITH_OPENSSL */
1.1 djm 30:
31: #include "log.h"
32: #include "misc.h"
33: #include "sshbuf.h"
34: #include "sshkey.h"
35: #include "ssherr.h"
36: #include "digest.h"
37:
38: #include "ssh-sk.h"
39: #include "sk-api.h"
1.6 markus 40: #include "crypto_api.h"
1.1 djm 41:
42: struct sshsk_provider {
43: char *path;
44: void *dlhandle;
45:
46: /* Return the version of the middleware API */
47: uint32_t (*sk_api_version)(void);
48:
49: /* Enroll a U2F key (private key generation) */
1.7 markus 50: int (*sk_enroll)(int alg, const uint8_t *challenge,
51: size_t challenge_len, const char *application, uint8_t flags,
1.24 djm 52: const char *pin, struct sk_option **opts,
53: struct sk_enroll_response **enroll_response);
1.1 djm 54:
55: /* Sign a challenge */
1.7 markus 56: int (*sk_sign)(int alg, const uint8_t *message, size_t message_len,
1.1 djm 57: const char *application,
58: const uint8_t *key_handle, size_t key_handle_len,
1.24 djm 59: uint8_t flags, const char *pin, struct sk_option **opts,
1.21 djm 60: struct sk_sign_response **sign_response);
1.20 djm 61:
62: /* Enumerate resident keys */
1.24 djm 63: int (*sk_load_resident_keys)(const char *pin, struct sk_option **opts,
1.20 djm 64: struct sk_resident_key ***rks, size_t *nrks);
1.1 djm 65: };
66:
1.12 djm 67: /* Built-in version */
68: int ssh_sk_enroll(int alg, const uint8_t *challenge,
69: size_t challenge_len, const char *application, uint8_t flags,
1.24 djm 70: const char *pin, struct sk_option **opts,
71: struct sk_enroll_response **enroll_response);
1.12 djm 72: int ssh_sk_sign(int alg, const uint8_t *message, size_t message_len,
73: const char *application,
74: const uint8_t *key_handle, size_t key_handle_len,
1.24 djm 75: uint8_t flags, const char *pin, struct sk_option **opts,
76: struct sk_sign_response **sign_response);
77: int ssh_sk_load_resident_keys(const char *pin, struct sk_option **opts,
1.20 djm 78: struct sk_resident_key ***rks, size_t *nrks);
1.12 djm 79:
1.1 djm 80: static void
81: sshsk_free(struct sshsk_provider *p)
82: {
83: if (p == NULL)
84: return;
85: free(p->path);
86: if (p->dlhandle != NULL)
87: dlclose(p->dlhandle);
88: free(p);
89: }
90:
91: static struct sshsk_provider *
92: sshsk_open(const char *path)
93: {
94: struct sshsk_provider *ret = NULL;
95: uint32_t version;
96:
97: if ((ret = calloc(1, sizeof(*ret))) == NULL) {
98: error("%s: calloc failed", __func__);
99: return NULL;
100: }
101: if ((ret->path = strdup(path)) == NULL) {
102: error("%s: strdup failed", __func__);
103: goto fail;
1.12 djm 104: }
105: /* Skip the rest if we're using the linked in middleware */
106: if (strcasecmp(ret->path, "internal") == 0) {
107: ret->sk_enroll = ssh_sk_enroll;
108: ret->sk_sign = ssh_sk_sign;
1.20 djm 109: ret->sk_load_resident_keys = ssh_sk_load_resident_keys;
1.12 djm 110: return ret;
1.1 djm 111: }
112: if ((ret->dlhandle = dlopen(path, RTLD_NOW)) == NULL) {
1.22 djm 113: error("Security key provider \"%s\" dlopen failed: %s",
1.1 djm 114: path, dlerror());
115: goto fail;
116: }
117: if ((ret->sk_api_version = dlsym(ret->dlhandle,
118: "sk_api_version")) == NULL) {
1.22 djm 119: error("Security key provider \"%s\" dlsym(sk_api_version) "
1.1 djm 120: "failed: %s", path, dlerror());
121: goto fail;
122: }
123: version = ret->sk_api_version();
124: debug("%s: provider %s implements version 0x%08lx", __func__,
125: ret->path, (u_long)version);
126: if ((version & SSH_SK_VERSION_MAJOR_MASK) != SSH_SK_VERSION_MAJOR) {
1.22 djm 127: error("Security key provider \"%s\" implements unsupported "
128: "version 0x%08lx (supported: 0x%08lx)",
129: path, (u_long)version, (u_long)SSH_SK_VERSION_MAJOR);
1.1 djm 130: goto fail;
131: }
132: if ((ret->sk_enroll = dlsym(ret->dlhandle, "sk_enroll")) == NULL) {
133: error("Security key provider %s dlsym(sk_enroll) "
134: "failed: %s", path, dlerror());
135: goto fail;
136: }
137: if ((ret->sk_sign = dlsym(ret->dlhandle, "sk_sign")) == NULL) {
1.22 djm 138: error("Security key provider \"%s\" dlsym(sk_sign) failed: %s",
1.1 djm 139: path, dlerror());
140: goto fail;
141: }
1.20 djm 142: if ((ret->sk_load_resident_keys = dlsym(ret->dlhandle,
143: "sk_load_resident_keys")) == NULL) {
1.22 djm 144: error("Security key provider \"%s\" "
145: "dlsym(sk_load_resident_keys) failed: %s", path, dlerror());
1.20 djm 146: goto fail;
147: }
1.1 djm 148: /* success */
149: return ret;
150: fail:
151: sshsk_free(ret);
152: return NULL;
153: }
154:
155: static void
156: sshsk_free_enroll_response(struct sk_enroll_response *r)
157: {
158: if (r == NULL)
159: return;
160: freezero(r->key_handle, r->key_handle_len);
161: freezero(r->public_key, r->public_key_len);
162: freezero(r->signature, r->signature_len);
163: freezero(r->attestation_cert, r->attestation_cert_len);
164: freezero(r, sizeof(*r));
1.17 djm 165: }
1.1 djm 166:
167: static void
168: sshsk_free_sign_response(struct sk_sign_response *r)
169: {
170: if (r == NULL)
171: return;
172: freezero(r->sig_r, r->sig_r_len);
173: freezero(r->sig_s, r->sig_s_len);
174: freezero(r, sizeof(*r));
1.17 djm 175: }
1.1 djm 176:
1.15 naddy 177: #ifdef WITH_OPENSSL
1.2 markus 178: /* Assemble key from response */
179: static int
180: sshsk_ecdsa_assemble(struct sk_enroll_response *resp, struct sshkey **keyp)
181: {
182: struct sshkey *key = NULL;
183: struct sshbuf *b = NULL;
184: EC_POINT *q = NULL;
185: int r;
186:
187: *keyp = NULL;
188: if ((key = sshkey_new(KEY_ECDSA_SK)) == NULL) {
189: error("%s: sshkey_new failed", __func__);
190: r = SSH_ERR_ALLOC_FAIL;
191: goto out;
192: }
193: key->ecdsa_nid = NID_X9_62_prime256v1;
194: if ((key->ecdsa = EC_KEY_new_by_curve_name(key->ecdsa_nid)) == NULL ||
195: (q = EC_POINT_new(EC_KEY_get0_group(key->ecdsa))) == NULL ||
196: (b = sshbuf_new()) == NULL) {
197: error("%s: allocation failed", __func__);
198: r = SSH_ERR_ALLOC_FAIL;
199: goto out;
200: }
201: if ((r = sshbuf_put_string(b,
202: resp->public_key, resp->public_key_len)) != 0) {
203: error("%s: buffer error: %s", __func__, ssh_err(r));
204: goto out;
205: }
206: if ((r = sshbuf_get_ec(b, q, EC_KEY_get0_group(key->ecdsa))) != 0) {
207: error("%s: parse key: %s", __func__, ssh_err(r));
208: r = SSH_ERR_INVALID_FORMAT;
209: goto out;
210: }
211: if (sshkey_ec_validate_public(EC_KEY_get0_group(key->ecdsa), q) != 0) {
212: error("Security key returned invalid ECDSA key");
213: r = SSH_ERR_KEY_INVALID_EC_VALUE;
214: goto out;
215: }
216: if (EC_KEY_set_public_key(key->ecdsa, q) != 1) {
217: /* XXX assume it is a allocation error */
218: error("%s: allocation failed", __func__);
219: r = SSH_ERR_ALLOC_FAIL;
220: goto out;
221: }
222: /* success */
223: *keyp = key;
224: key = NULL; /* transferred */
225: r = 0;
226: out:
227: EC_POINT_free(q);
228: sshkey_free(key);
229: sshbuf_free(b);
230: return r;
231: }
1.15 naddy 232: #endif /* WITH_OPENSSL */
1.2 markus 233:
1.6 markus 234: static int
235: sshsk_ed25519_assemble(struct sk_enroll_response *resp, struct sshkey **keyp)
236: {
237: struct sshkey *key = NULL;
238: int r;
239:
240: *keyp = NULL;
241: if (resp->public_key_len != ED25519_PK_SZ) {
242: error("%s: invalid size: %zu", __func__, resp->public_key_len);
243: r = SSH_ERR_INVALID_FORMAT;
244: goto out;
245: }
246: if ((key = sshkey_new(KEY_ED25519_SK)) == NULL) {
247: error("%s: sshkey_new failed", __func__);
248: r = SSH_ERR_ALLOC_FAIL;
249: goto out;
250: }
251: if ((key->ed25519_pk = malloc(ED25519_PK_SZ)) == NULL) {
252: error("%s: malloc failed", __func__);
253: r = SSH_ERR_ALLOC_FAIL;
254: goto out;
255: }
256: memcpy(key->ed25519_pk, resp->public_key, ED25519_PK_SZ);
257: /* success */
258: *keyp = key;
259: key = NULL; /* transferred */
260: r = 0;
261: out:
262: sshkey_free(key);
263: return r;
264: }
265:
1.19 djm 266: static int
267: sshsk_key_from_response(int alg, const char *application, uint8_t flags,
268: struct sk_enroll_response *resp, struct sshkey **keyp)
269: {
270: struct sshkey *key = NULL;
271: int r = SSH_ERR_INTERNAL_ERROR;
272:
273: *keyp = NULL;
274:
275: /* Check response validity */
1.20 djm 276: if (resp->public_key == NULL || resp->key_handle == NULL) {
1.19 djm 277: error("%s: sk_enroll response invalid", __func__);
278: r = SSH_ERR_INVALID_FORMAT;
279: goto out;
280: }
281: switch (alg) {
282: #ifdef WITH_OPENSSL
283: case SSH_SK_ECDSA:
284: if ((r = sshsk_ecdsa_assemble(resp, &key)) != 0)
285: goto out;
286: break;
287: #endif /* WITH_OPENSSL */
288: case SSH_SK_ED25519:
289: if ((r = sshsk_ed25519_assemble(resp, &key)) != 0)
290: goto out;
291: break;
292: default:
293: error("%s: unsupported algorithm %d", __func__, alg);
294: r = SSH_ERR_INVALID_ARGUMENT;
295: goto out;
296: }
297: key->sk_flags = flags;
298: if ((key->sk_key_handle = sshbuf_new()) == NULL ||
299: (key->sk_reserved = sshbuf_new()) == NULL) {
300: error("%s: allocation failed", __func__);
301: r = SSH_ERR_ALLOC_FAIL;
302: goto out;
303: }
304: if ((key->sk_application = strdup(application)) == NULL) {
305: error("%s: strdup application failed", __func__);
306: r = SSH_ERR_ALLOC_FAIL;
307: goto out;
308: }
309: if ((r = sshbuf_put(key->sk_key_handle, resp->key_handle,
310: resp->key_handle_len)) != 0) {
311: error("%s: buffer error: %s", __func__, ssh_err(r));
312: goto out;
313: }
314: /* success */
315: r = 0;
316: *keyp = key;
317: key = NULL;
318: out:
319: sshkey_free(key);
320: return r;
321: }
322:
1.23 djm 323: static int
324: skerr_to_ssherr(int skerr)
325: {
326: switch (skerr) {
327: case SSH_SK_ERR_UNSUPPORTED:
328: return SSH_ERR_FEATURE_UNSUPPORTED;
329: case SSH_SK_ERR_PIN_REQUIRED:
330: return SSH_ERR_KEY_WRONG_PASSPHRASE;
1.25 djm 331: case SSH_SK_ERR_DEVICE_NOT_FOUND:
332: return SSH_ERR_DEVICE_NOT_FOUND;
1.23 djm 333: case SSH_SK_ERR_GENERAL:
334: default:
335: return SSH_ERR_INVALID_FORMAT;
336: }
337: }
338:
1.24 djm 339: static void
340: sshsk_free_options(struct sk_option **opts)
341: {
342: size_t i;
343:
344: if (opts == NULL)
345: return;
346: for (i = 0; opts[i] != NULL; i++) {
347: free(opts[i]->name);
348: free(opts[i]->value);
349: free(opts[i]);
350: }
351: free(opts);
352: }
353:
354: static int
355: sshsk_add_option(struct sk_option ***optsp, size_t *noptsp,
356: const char *name, const char *value, uint8_t required)
357: {
358: struct sk_option **opts = *optsp;
359: size_t nopts = *noptsp;
360:
361: if ((opts = recallocarray(opts, nopts, nopts + 2, /* extra for NULL */
362: sizeof(*opts))) == NULL) {
363: error("%s: array alloc failed", __func__);
364: return SSH_ERR_ALLOC_FAIL;
365: }
366: *optsp = opts;
367: *noptsp = nopts + 1;
368: if ((opts[nopts] = calloc(1, sizeof(**opts))) == NULL) {
369: error("%s: alloc failed", __func__);
370: return SSH_ERR_ALLOC_FAIL;
371: }
372: if ((opts[nopts]->name = strdup(name)) == NULL ||
373: (opts[nopts]->value = strdup(value)) == NULL) {
374: error("%s: alloc failed", __func__);
375: return SSH_ERR_ALLOC_FAIL;
376: }
377: opts[nopts]->required = required;
378: return 0;
379: }
380:
381: static int
382: make_options(const char *device, const char *user_id,
383: struct sk_option ***optsp)
384: {
385: struct sk_option **opts = NULL;
386: size_t nopts = 0;
387: int r, ret = SSH_ERR_INTERNAL_ERROR;
388:
389: if (device != NULL &&
390: (r = sshsk_add_option(&opts, &nopts, "device", device, 0)) != 0) {
391: ret = r;
392: goto out;
393: }
394: if (user_id != NULL &&
395: (r = sshsk_add_option(&opts, &nopts, "user", user_id, 0)) != 0) {
396: ret = r;
397: goto out;
398: }
399: /* success */
400: *optsp = opts;
401: opts = NULL;
402: nopts = 0;
403: ret = 0;
404: out:
405: sshsk_free_options(opts);
406: return ret;
407: }
408:
1.1 djm 409: int
1.24 djm 410: sshsk_enroll(int type, const char *provider_path, const char *device,
411: const char *application, const char *userid, uint8_t flags,
412: const char *pin, struct sshbuf *challenge_buf,
1.21 djm 413: struct sshkey **keyp, struct sshbuf *attest)
1.1 djm 414: {
415: struct sshsk_provider *skp = NULL;
416: struct sshkey *key = NULL;
417: u_char randchall[32];
418: const u_char *challenge;
419: size_t challenge_len;
420: struct sk_enroll_response *resp = NULL;
1.24 djm 421: struct sk_option **opts = NULL;
1.1 djm 422: int r = SSH_ERR_INTERNAL_ERROR;
1.7 markus 423: int alg;
1.1 djm 424:
1.24 djm 425: debug("%s: provider \"%s\", device \"%s\", application \"%s\", "
426: "userid \"%s\", flags 0x%02x, challenge len %zu%s", __func__,
427: provider_path, device, application, userid, flags,
428: challenge_buf == NULL ? 0 : sshbuf_len(challenge_buf),
1.21 djm 429: (pin != NULL && *pin != '\0') ? " with-pin" : "");
1.13 djm 430:
1.1 djm 431: *keyp = NULL;
432: if (attest)
433: sshbuf_reset(attest);
1.24 djm 434:
435: if ((r = make_options(device, userid, &opts)) != 0)
436: goto out;
437:
1.6 markus 438: switch (type) {
1.15 naddy 439: #ifdef WITH_OPENSSL
1.6 markus 440: case KEY_ECDSA_SK:
1.7 markus 441: alg = SSH_SK_ECDSA;
442: break;
1.15 naddy 443: #endif /* WITH_OPENSSL */
1.6 markus 444: case KEY_ED25519_SK:
1.7 markus 445: alg = SSH_SK_ED25519;
1.6 markus 446: break;
447: default:
448: error("%s: unsupported key type", __func__);
449: r = SSH_ERR_INVALID_ARGUMENT;
450: goto out;
451: }
1.1 djm 452: if (provider_path == NULL) {
453: error("%s: missing provider", __func__);
454: r = SSH_ERR_INVALID_ARGUMENT;
455: goto out;
456: }
457: if (application == NULL || *application == '\0') {
458: error("%s: missing application", __func__);
459: r = SSH_ERR_INVALID_ARGUMENT;
460: goto out;
461: }
462: if (challenge_buf == NULL) {
463: debug("%s: using random challenge", __func__);
464: arc4random_buf(randchall, sizeof(randchall));
465: challenge = randchall;
466: challenge_len = sizeof(randchall);
467: } else if (sshbuf_len(challenge_buf) == 0) {
468: error("Missing enrollment challenge");
469: r = SSH_ERR_INVALID_ARGUMENT;
470: goto out;
471: } else {
472: challenge = sshbuf_ptr(challenge_buf);
473: challenge_len = sshbuf_len(challenge_buf);
474: debug3("%s: using explicit challenge len=%zd",
475: __func__, challenge_len);
476: }
477: if ((skp = sshsk_open(provider_path)) == NULL) {
478: r = SSH_ERR_INVALID_FORMAT; /* XXX sshsk_open return code? */
479: goto out;
480: }
481: /* XXX validate flags? */
482: /* enroll key */
1.7 markus 483: if ((r = skp->sk_enroll(alg, challenge, challenge_len, application,
1.24 djm 484: flags, pin, opts, &resp)) != 0) {
1.25 djm 485: debug("%s: provider \"%s\" returned failure %d", __func__,
1.1 djm 486: provider_path, r);
1.23 djm 487: r = skerr_to_ssherr(r);
1.1 djm 488: goto out;
489: }
1.19 djm 490:
491: if ((r = sshsk_key_from_response(alg, application, flags,
492: resp, &key)) != 0)
1.1 djm 493: goto out;
1.19 djm 494:
1.1 djm 495: /* Optionally fill in the attestation information */
496: if (attest != NULL) {
1.26 ! djm 497: if ((r = sshbuf_put_cstring(attest,
! 498: "ssh-sk-attest-v00")) != 0 ||
1.1 djm 499: (r = sshbuf_put_string(attest,
500: resp->attestation_cert, resp->attestation_cert_len)) != 0 ||
501: (r = sshbuf_put_string(attest,
502: resp->signature, resp->signature_len)) != 0 ||
1.26 ! djm 503: (r = sshbuf_put_u32(attest, 0)) != 0 || /* resvd flags */
! 504: (r = sshbuf_put_string(attest, NULL, 0)) != 0 /* resvd */) {
1.1 djm 505: error("%s: buffer error: %s", __func__, ssh_err(r));
506: goto out;
507: }
508: }
509: /* success */
510: *keyp = key;
511: key = NULL; /* transferred */
512: r = 0;
513: out:
1.24 djm 514: sshsk_free_options(opts);
1.1 djm 515: sshsk_free(skp);
516: sshkey_free(key);
517: sshsk_free_enroll_response(resp);
518: explicit_bzero(randchall, sizeof(randchall));
519: return r;
520: }
521:
1.15 naddy 522: #ifdef WITH_OPENSSL
1.3 markus 523: static int
1.9 markus 524: sshsk_ecdsa_sig(struct sk_sign_response *resp, struct sshbuf *sig)
1.3 markus 525: {
526: struct sshbuf *inner_sig = NULL;
527: int r = SSH_ERR_INTERNAL_ERROR;
528:
1.8 markus 529: /* Check response validity */
1.11 markus 530: if (resp->sig_r == NULL || resp->sig_s == NULL) {
1.8 markus 531: error("%s: sk_sign response invalid", __func__);
532: r = SSH_ERR_INVALID_FORMAT;
533: goto out;
534: }
1.3 markus 535: if ((inner_sig = sshbuf_new()) == NULL) {
536: r = SSH_ERR_ALLOC_FAIL;
537: goto out;
538: }
1.9 markus 539: /* Prepare and append inner signature object */
1.3 markus 540: if ((r = sshbuf_put_bignum2_bytes(inner_sig,
541: resp->sig_r, resp->sig_r_len)) != 0 ||
542: (r = sshbuf_put_bignum2_bytes(inner_sig,
1.16 djm 543: resp->sig_s, resp->sig_s_len)) != 0) {
1.3 markus 544: debug("%s: buffer error: %s", __func__, ssh_err(r));
545: goto out;
546: }
1.16 djm 547: if ((r = sshbuf_put_stringb(sig, inner_sig)) != 0 ||
548: (r = sshbuf_put_u8(sig, resp->flags)) != 0 ||
549: (r = sshbuf_put_u32(sig, resp->counter)) != 0) {
1.9 markus 550: debug("%s: buffer error: %s", __func__, ssh_err(r));
551: goto out;
552: }
1.3 markus 553: #ifdef DEBUG_SK
554: fprintf(stderr, "%s: sig_r:\n", __func__);
555: sshbuf_dump_data(resp->sig_r, resp->sig_r_len, stderr);
556: fprintf(stderr, "%s: sig_s:\n", __func__);
557: sshbuf_dump_data(resp->sig_s, resp->sig_s_len, stderr);
1.9 markus 558: fprintf(stderr, "%s: inner:\n", __func__);
559: sshbuf_dump(inner_sig, stderr);
1.5 markus 560: #endif
561: r = 0;
1.9 markus 562: out:
1.5 markus 563: sshbuf_free(inner_sig);
564: return r;
565: }
1.15 naddy 566: #endif /* WITH_OPENSSL */
1.5 markus 567:
568: static int
1.9 markus 569: sshsk_ed25519_sig(struct sk_sign_response *resp, struct sshbuf *sig)
1.5 markus 570: {
571: int r = SSH_ERR_INTERNAL_ERROR;
572:
1.8 markus 573: /* Check response validity */
574: if (resp->sig_r == NULL) {
575: error("%s: sk_sign response invalid", __func__);
576: r = SSH_ERR_INVALID_FORMAT;
577: goto out;
578: }
1.9 markus 579: if ((r = sshbuf_put_string(sig,
1.5 markus 580: resp->sig_r, resp->sig_r_len)) != 0 ||
1.9 markus 581: (r = sshbuf_put_u8(sig, resp->flags)) != 0 ||
582: (r = sshbuf_put_u32(sig, resp->counter)) != 0) {
1.5 markus 583: debug("%s: buffer error: %s", __func__, ssh_err(r));
584: goto out;
585: }
586: #ifdef DEBUG_SK
587: fprintf(stderr, "%s: sig_r:\n", __func__);
588: sshbuf_dump_data(resp->sig_r, resp->sig_r_len, stderr);
1.3 markus 589: #endif
590: r = 0;
1.9 markus 591: out:
592: return 0;
1.3 markus 593: }
594:
1.1 djm 595: int
1.18 djm 596: sshsk_sign(const char *provider_path, struct sshkey *key,
1.1 djm 597: u_char **sigp, size_t *lenp, const u_char *data, size_t datalen,
1.21 djm 598: u_int compat, const char *pin)
1.1 djm 599: {
600: struct sshsk_provider *skp = NULL;
601: int r = SSH_ERR_INTERNAL_ERROR;
1.7 markus 602: int type, alg;
1.1 djm 603: struct sk_sign_response *resp = NULL;
604: struct sshbuf *inner_sig = NULL, *sig = NULL;
605: uint8_t message[32];
1.24 djm 606: struct sk_option **opts = NULL;
1.13 djm 607:
1.21 djm 608: debug("%s: provider \"%s\", key %s, flags 0x%02x%s", __func__,
609: provider_path, sshkey_type(key), key->sk_flags,
610: (pin != NULL && *pin != '\0') ? " with-pin" : "");
1.1 djm 611:
612: if (sigp != NULL)
613: *sigp = NULL;
614: if (lenp != NULL)
615: *lenp = 0;
1.5 markus 616: type = sshkey_type_plain(key->type);
617: switch (type) {
1.15 naddy 618: #ifdef WITH_OPENSSL
1.5 markus 619: case KEY_ECDSA_SK:
1.7 markus 620: alg = SSH_SK_ECDSA;
621: break;
1.15 naddy 622: #endif /* WITH_OPENSSL */
1.5 markus 623: case KEY_ED25519_SK:
1.7 markus 624: alg = SSH_SK_ED25519;
1.5 markus 625: break;
626: default:
627: return SSH_ERR_INVALID_ARGUMENT;
628: }
1.1 djm 629: if (provider_path == NULL ||
630: key->sk_key_handle == NULL ||
631: key->sk_application == NULL || *key->sk_application == '\0') {
632: r = SSH_ERR_INVALID_ARGUMENT;
633: goto out;
634: }
635: if ((skp = sshsk_open(provider_path)) == NULL) {
636: r = SSH_ERR_INVALID_FORMAT; /* XXX sshsk_open return code? */
637: goto out;
638: }
639:
640: /* hash data to be signed before it goes to the security key */
641: if ((r = ssh_digest_memory(SSH_DIGEST_SHA256, data, datalen,
642: message, sizeof(message))) != 0) {
643: error("%s: hash application failed: %s", __func__, ssh_err(r));
644: r = SSH_ERR_INTERNAL_ERROR;
645: goto out;
646: }
1.7 markus 647: if ((r = skp->sk_sign(alg, message, sizeof(message),
1.1 djm 648: key->sk_application,
649: sshbuf_ptr(key->sk_key_handle), sshbuf_len(key->sk_key_handle),
1.24 djm 650: key->sk_flags, pin, opts, &resp)) != 0) {
1.1 djm 651: debug("%s: sk_sign failed with code %d", __func__, r);
1.23 djm 652: r = skerr_to_ssherr(r);
1.1 djm 653: goto out;
654: }
1.9 markus 655: /* Assemble signature */
656: if ((sig = sshbuf_new()) == NULL) {
657: r = SSH_ERR_ALLOC_FAIL;
658: goto out;
659: }
660: if ((r = sshbuf_put_cstring(sig, sshkey_ssh_name_plain(key))) != 0) {
661: debug("%s: buffer error (outer): %s", __func__, ssh_err(r));
662: goto out;
663: }
1.5 markus 664: switch (type) {
1.15 naddy 665: #ifdef WITH_OPENSSL
1.5 markus 666: case KEY_ECDSA_SK:
1.9 markus 667: if ((r = sshsk_ecdsa_sig(resp, sig)) != 0)
1.5 markus 668: goto out;
669: break;
1.15 naddy 670: #endif /* WITH_OPENSSL */
1.5 markus 671: case KEY_ED25519_SK:
1.9 markus 672: if ((r = sshsk_ed25519_sig(resp, sig)) != 0)
1.5 markus 673: goto out;
674: break;
675: }
1.1 djm 676: #ifdef DEBUG_SK
1.5 markus 677: fprintf(stderr, "%s: sig_flags = 0x%02x, sig_counter = %u\n",
678: __func__, resp->flags, resp->counter);
1.1 djm 679: fprintf(stderr, "%s: hashed message:\n", __func__);
680: sshbuf_dump_data(message, sizeof(message), stderr);
681: fprintf(stderr, "%s: sigbuf:\n", __func__);
682: sshbuf_dump(sig, stderr);
683: #endif
684: if (sigp != NULL) {
685: if ((*sigp = malloc(sshbuf_len(sig))) == NULL) {
686: r = SSH_ERR_ALLOC_FAIL;
687: goto out;
688: }
689: memcpy(*sigp, sshbuf_ptr(sig), sshbuf_len(sig));
690: }
691: if (lenp != NULL)
692: *lenp = sshbuf_len(sig);
693: /* success */
694: r = 0;
695: out:
1.24 djm 696: sshsk_free_options(opts);
1.1 djm 697: explicit_bzero(message, sizeof(message));
698: sshsk_free(skp);
699: sshsk_free_sign_response(resp);
700: sshbuf_free(sig);
701: sshbuf_free(inner_sig);
702: return r;
703: }
1.20 djm 704:
705: static void
706: sshsk_free_sk_resident_keys(struct sk_resident_key **rks, size_t nrks)
707: {
708: size_t i;
709:
710: if (nrks == 0 || rks == NULL)
711: return;
712: for (i = 0; i < nrks; i++) {
713: free(rks[i]->application);
714: freezero(rks[i]->key.key_handle, rks[i]->key.key_handle_len);
715: freezero(rks[i]->key.public_key, rks[i]->key.public_key_len);
716: freezero(rks[i]->key.signature, rks[i]->key.signature_len);
717: freezero(rks[i]->key.attestation_cert,
718: rks[i]->key.attestation_cert_len);
719: freezero(rks[i], sizeof(**rks));
720: }
721: free(rks);
722: }
723:
724: int
1.24 djm 725: sshsk_load_resident(const char *provider_path, const char *device,
726: const char *pin, struct sshkey ***keysp, size_t *nkeysp)
1.20 djm 727: {
728: struct sshsk_provider *skp = NULL;
729: int r = SSH_ERR_INTERNAL_ERROR;
730: struct sk_resident_key **rks = NULL;
731: size_t i, nrks = 0, nkeys = 0;
732: struct sshkey *key = NULL, **keys = NULL, **tmp;
733: uint8_t flags;
1.24 djm 734: struct sk_option **opts = NULL;
1.20 djm 735:
736: debug("%s: provider \"%s\"%s", __func__, provider_path,
737: (pin != NULL && *pin != '\0') ? ", have-pin": "");
738:
739: if (keysp == NULL || nkeysp == NULL)
740: return SSH_ERR_INVALID_ARGUMENT;
741: *keysp = NULL;
742: *nkeysp = 0;
743:
1.24 djm 744: if ((r = make_options(device, NULL, &opts)) != 0)
745: goto out;
1.20 djm 746: if ((skp = sshsk_open(provider_path)) == NULL) {
747: r = SSH_ERR_INVALID_FORMAT; /* XXX sshsk_open return code? */
748: goto out;
749: }
1.24 djm 750: if ((r = skp->sk_load_resident_keys(pin, opts, &rks, &nrks)) != 0) {
1.22 djm 751: error("Security key provider \"%s\" returned failure %d",
1.20 djm 752: provider_path, r);
1.23 djm 753: r = skerr_to_ssherr(r);
1.20 djm 754: goto out;
755: }
756: for (i = 0; i < nrks; i++) {
757: debug3("%s: rk %zu: slot = %zu, alg = %d, application = \"%s\"",
758: __func__, i, rks[i]->slot, rks[i]->alg,
759: rks[i]->application);
760: /* XXX need better filter here */
761: if (strncmp(rks[i]->application, "ssh:", 4) != 0)
762: continue;
763: switch (rks[i]->alg) {
764: case SSH_SK_ECDSA:
765: case SSH_SK_ED25519:
766: break;
767: default:
768: continue;
769: }
770: /* XXX where to get flags? */
771: flags = SSH_SK_USER_PRESENCE_REQD|SSH_SK_RESIDENT_KEY;
772: if ((r = sshsk_key_from_response(rks[i]->alg,
773: rks[i]->application, flags, &rks[i]->key, &key)) != 0)
774: goto out;
775: if ((tmp = recallocarray(keys, nkeys, nkeys + 1,
776: sizeof(*tmp))) == NULL) {
777: error("%s: recallocarray failed", __func__);
778: r = SSH_ERR_ALLOC_FAIL;
779: goto out;
780: }
781: keys = tmp;
782: keys[nkeys++] = key;
783: key = NULL;
784: /* XXX synthesise comment */
785: }
786: /* success */
787: *keysp = keys;
788: *nkeysp = nkeys;
789: keys = NULL;
790: nkeys = 0;
791: r = 0;
792: out:
1.24 djm 793: sshsk_free_options(opts);
1.20 djm 794: sshsk_free(skp);
795: sshsk_free_sk_resident_keys(rks, nrks);
796: sshkey_free(key);
797: if (nkeys != 0) {
798: for (i = 0; i < nkeys; i++)
799: sshkey_free(keys[i]);
800: free(keys);
801: }
802: return r;
803: }
804:
![[BACK]](/icons/back.gif){kind=icon}
Return to ssh-sk.c CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / ssh