1 /* $OpenBSD: sk-api.h,v 1.14 2021/11/02 22:56:40 djm Exp $ */ 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 #ifndef _SK_API_H 19 #define _SK_API_H 1 20 21 #include <stddef.h> 22 #include <stdint.h> 23 24 /* Flags */ 25 #define SSH_SK_USER_PRESENCE_REQD 0x01 26 #define SSH_SK_USER_VERIFICATION_REQD 0x04 27 #define SSH_SK_RESIDENT_KEY 0x20 28 29 /* Algs */ 30 #define SSH_SK_ECDSA 0x00 31 #define SSH_SK_ED25519 0x01 32 33 /* Error codes */ 34 #define SSH_SK_ERR_GENERAL -1 35 #define SSH_SK_ERR_UNSUPPORTED -2 36 #define SSH_SK_ERR_PIN_REQUIRED -3 37 #define SSH_SK_ERR_DEVICE_NOT_FOUND -4 38 39 struct sk_enroll_response { 40 uint8_t flags; 41 uint8_t *public_key; 42 size_t public_key_len; 43 uint8_t *key_handle; 44 size_t key_handle_len; 45 uint8_t *signature; 46 size_t signature_len; 47 uint8_t *attestation_cert; 48 size_t attestation_cert_len; 49 uint8_t *authdata; 50 size_t authdata_len; 51 }; 52 53 struct sk_sign_response { 54 uint8_t flags; 55 uint32_t counter; 56 uint8_t *sig_r; 57 size_t sig_r_len; 58 uint8_t *sig_s; 59 size_t sig_s_len; 60 }; 61 62 struct sk_resident_key { 63 uint32_t alg; 64 size_t slot; 65 char *application; 66 struct sk_enroll_response key; 67 uint8_t flags; 68 uint8_t *user_id; 69 size_t user_id_len; 70 }; 71 72 struct sk_option { 73 char *name; 74 char *value; 75 uint8_t required; 76 }; 77 78 #define SSH_SK_VERSION_MAJOR 0x00090000 /* current API version */ 79 #define SSH_SK_VERSION_MAJOR_MASK 0xffff0000 80 81 /* Return the version of the middleware API */ 82 uint32_t sk_api_version(void); 83 84 /* Enroll a U2F key (private key generation) */ 85 int sk_enroll(uint32_t alg, const uint8_t *challenge, size_t challenge_len, 86 const char *application, uint8_t flags, const char *pin, 87 struct sk_option **options, struct sk_enroll_response **enroll_response); 88 89 /* Sign a challenge */ 90 int sk_sign(uint32_t alg, const uint8_t *data, size_t data_len, 91 const char *application, const uint8_t *key_handle, size_t key_handle_len, 92 uint8_t flags, const char *pin, struct sk_option **options, 93 struct sk_sign_response **sign_response); 94 95 /* Enumerate all resident keys */ 96 int sk_load_resident_keys(const char *pin, struct sk_option **options, 97 struct sk_resident_key ***rks, size_t *nrks); 98 99 #endif /* _SK_API_H */ 100