1 /* 2 * Copyright (c) 2018 Yubico AB. All rights reserved. 3 * Use of this source code is governed by a BSD-style 4 * license that can be found in the LICENSE file. 5 */ 6 7 #ifndef _FIDO_H 8 #define _FIDO_H 9 10 #include <openssl/ec.h> 11 #include <openssl/evp.h> 12 13 #include <stdbool.h> 14 #include <stdint.h> 15 #include <stdlib.h> 16 17 #ifdef _FIDO_INTERNAL 18 #include <cbor.h> 19 #include <limits.h> 20 21 #include "blob.h" 22 /* #include "../openbsd-compat/openbsd-compat.h" */ 23 #include "iso7816.h" 24 #include "extern.h" 25 #endif 26 27 #include "fido/err.h" 28 #include "fido/param.h" 29 #include "fido/types.h" 30 31 #ifdef __cplusplus 32 extern "C" { 33 #endif /* __cplusplus */ 34 35 #if defined(_MSC_VER) 36 #define FIDO_DEPRECATED(reason) __declspec(deprecated(reason)) 37 #elif defined(__OpenBSD__) 38 #define FIDO_DEPRECATED(reason) 39 #else 40 #define FIDO_DEPRECATED(reason) __attribute__((__deprecated__(reason))) 41 #endif 42 43 fido_assert_t *fido_assert_new(void); 44 fido_cred_t *fido_cred_new(void); 45 fido_dev_t *fido_dev_new(void); 46 fido_dev_t *fido_dev_new_with_info(const fido_dev_info_t *); 47 fido_dev_info_t *fido_dev_info_new(size_t); 48 fido_cbor_info_t *fido_cbor_info_new(void); 49 50 void fido_assert_free(fido_assert_t **); 51 void fido_cbor_info_free(fido_cbor_info_t **); 52 void fido_cred_free(fido_cred_t **); 53 void fido_dev_force_fido2(fido_dev_t *); 54 void fido_dev_force_u2f(fido_dev_t *); 55 void fido_dev_free(fido_dev_t **); 56 void fido_dev_info_free(fido_dev_info_t **, size_t); 57 58 /* fido_init() flags. */ 59 #define FIDO_DEBUG 0x01 60 61 void fido_init(int); 62 void fido_set_log_handler(fido_log_handler_t *); 63 64 const unsigned char *fido_assert_authdata_ptr(const fido_assert_t *, size_t); 65 const unsigned char *fido_assert_clientdata_hash_ptr(const fido_assert_t *); 66 const unsigned char *fido_assert_hmac_secret_ptr(const fido_assert_t *, size_t); 67 const unsigned char *fido_assert_id_ptr(const fido_assert_t *, size_t); 68 const unsigned char *fido_assert_sig_ptr(const fido_assert_t *, size_t); 69 const unsigned char *fido_assert_user_id_ptr(const fido_assert_t *, size_t); 70 71 char **fido_cbor_info_extensions_ptr(const fido_cbor_info_t *); 72 char **fido_cbor_info_options_name_ptr(const fido_cbor_info_t *); 73 char **fido_cbor_info_versions_ptr(const fido_cbor_info_t *); 74 const bool *fido_cbor_info_options_value_ptr(const fido_cbor_info_t *); 75 const char *fido_assert_rp_id(const fido_assert_t *); 76 const char *fido_assert_user_display_name(const fido_assert_t *, size_t); 77 const char *fido_assert_user_icon(const fido_assert_t *, size_t); 78 const char *fido_assert_user_name(const fido_assert_t *, size_t); 79 const char *fido_cred_display_name(const fido_cred_t *); 80 const char *fido_cred_fmt(const fido_cred_t *); 81 const char *fido_cred_rp_id(const fido_cred_t *); 82 const char *fido_cred_rp_name(const fido_cred_t *); 83 const char *fido_cred_user_name(const fido_cred_t *); 84 const char *fido_dev_info_manufacturer_string(const fido_dev_info_t *); 85 const char *fido_dev_info_path(const fido_dev_info_t *); 86 const char *fido_dev_info_product_string(const fido_dev_info_t *); 87 const fido_dev_info_t *fido_dev_info_ptr(const fido_dev_info_t *, size_t); 88 const uint8_t *fido_cbor_info_protocols_ptr(const fido_cbor_info_t *); 89 const unsigned char *fido_cbor_info_aaguid_ptr(const fido_cbor_info_t *); 90 const unsigned char *fido_cred_authdata_ptr(const fido_cred_t *); 91 const unsigned char *fido_cred_clientdata_hash_ptr(const fido_cred_t *); 92 const unsigned char *fido_cred_id_ptr(const fido_cred_t *); 93 const unsigned char *fido_cred_aaguid_ptr(const fido_cred_t *); 94 const unsigned char *fido_cred_user_id_ptr(const fido_cred_t *); 95 const unsigned char *fido_cred_pubkey_ptr(const fido_cred_t *); 96 const unsigned char *fido_cred_sig_ptr(const fido_cred_t *); 97 const unsigned char *fido_cred_x5c_ptr(const fido_cred_t *); 98 99 int fido_assert_allow_cred(fido_assert_t *, const unsigned char *, size_t); 100 int fido_assert_set_authdata(fido_assert_t *, size_t, const unsigned char *, 101 size_t); 102 int fido_assert_set_authdata_raw(fido_assert_t *, size_t, const unsigned char *, 103 size_t); 104 int fido_assert_set_clientdata_hash(fido_assert_t *, const unsigned char *, 105 size_t); 106 int fido_assert_set_count(fido_assert_t *, size_t); 107 int fido_assert_set_extensions(fido_assert_t *, int); 108 int fido_assert_set_hmac_salt(fido_assert_t *, const unsigned char *, size_t); 109 FIDO_DEPRECATED("use fido_assert_set_up/fido_assert_set_uv") 110 int fido_assert_set_options(fido_assert_t *, bool, bool); 111 int fido_assert_set_rp(fido_assert_t *, const char *); 112 int fido_assert_set_up(fido_assert_t *, fido_opt_t); 113 int fido_assert_set_uv(fido_assert_t *, fido_opt_t); 114 int fido_assert_set_sig(fido_assert_t *, size_t, const unsigned char *, size_t); 115 int fido_assert_verify(const fido_assert_t *, size_t, int, const void *); 116 int fido_cred_exclude(fido_cred_t *, const unsigned char *, size_t); 117 int fido_cred_prot(const fido_cred_t *); 118 int fido_cred_set_authdata(fido_cred_t *, const unsigned char *, size_t); 119 int fido_cred_set_authdata_raw(fido_cred_t *, const unsigned char *, size_t); 120 int fido_cred_set_clientdata_hash(fido_cred_t *, const unsigned char *, size_t); 121 int fido_cred_set_extensions(fido_cred_t *, int); 122 int fido_cred_set_fmt(fido_cred_t *, const char *); 123 FIDO_DEPRECATED("use fido_cred_set_rk/fido_cred_set_uv") 124 int fido_cred_set_options(fido_cred_t *, bool, bool); 125 int fido_cred_set_prot(fido_cred_t *, int); 126 int fido_cred_set_rk(fido_cred_t *, fido_opt_t); 127 int fido_cred_set_rp(fido_cred_t *, const char *, const char *); 128 int fido_cred_set_sig(fido_cred_t *, const unsigned char *, size_t); 129 int fido_cred_set_type(fido_cred_t *, int); 130 int fido_cred_set_uv(fido_cred_t *, fido_opt_t); 131 int fido_cred_type(const fido_cred_t *); 132 int fido_cred_set_user(fido_cred_t *, const unsigned char *, size_t, 133 const char *, const char *, const char *); 134 int fido_cred_set_x509(fido_cred_t *, const unsigned char *, size_t); 135 int fido_cred_verify(const fido_cred_t *); 136 int fido_cred_verify_self(const fido_cred_t *); 137 int fido_dev_cancel(fido_dev_t *); 138 int fido_dev_close(fido_dev_t *); 139 int fido_dev_get_assert(fido_dev_t *, fido_assert_t *, const char *); 140 int fido_dev_get_cbor_info(fido_dev_t *, fido_cbor_info_t *); 141 int fido_dev_get_retry_count(fido_dev_t *, int *); 142 int fido_dev_get_touch_begin(fido_dev_t *); 143 int fido_dev_get_touch_status(fido_dev_t *, int *, int); 144 int fido_dev_info_manifest(fido_dev_info_t *, size_t, size_t *); 145 int fido_dev_make_cred(fido_dev_t *, fido_cred_t *, const char *); 146 int fido_dev_open_with_info(fido_dev_t *); 147 int fido_dev_open(fido_dev_t *, const char *); 148 int fido_dev_reset(fido_dev_t *); 149 int fido_dev_set_io_functions(fido_dev_t *, const fido_dev_io_t *); 150 int fido_dev_set_pin(fido_dev_t *, const char *, const char *); 151 int fido_dev_set_transport_functions(fido_dev_t *, const fido_dev_transport_t *); 152 153 size_t fido_assert_authdata_len(const fido_assert_t *, size_t); 154 size_t fido_assert_clientdata_hash_len(const fido_assert_t *); 155 size_t fido_assert_count(const fido_assert_t *); 156 size_t fido_assert_hmac_secret_len(const fido_assert_t *, size_t); 157 size_t fido_assert_id_len(const fido_assert_t *, size_t); 158 size_t fido_assert_sig_len(const fido_assert_t *, size_t); 159 size_t fido_assert_user_id_len(const fido_assert_t *, size_t); 160 size_t fido_cbor_info_aaguid_len(const fido_cbor_info_t *); 161 size_t fido_cbor_info_extensions_len(const fido_cbor_info_t *); 162 size_t fido_cbor_info_options_len(const fido_cbor_info_t *); 163 size_t fido_cbor_info_protocols_len(const fido_cbor_info_t *); 164 size_t fido_cbor_info_versions_len(const fido_cbor_info_t *); 165 size_t fido_cred_authdata_len(const fido_cred_t *); 166 size_t fido_cred_clientdata_hash_len(const fido_cred_t *); 167 size_t fido_cred_id_len(const fido_cred_t *); 168 size_t fido_cred_aaguid_len(const fido_cred_t *); 169 size_t fido_cred_user_id_len(const fido_cred_t *); 170 size_t fido_cred_pubkey_len(const fido_cred_t *); 171 size_t fido_cred_sig_len(const fido_cred_t *); 172 size_t fido_cred_x5c_len(const fido_cred_t *); 173 174 uint8_t fido_assert_flags(const fido_assert_t *, size_t); 175 uint32_t fido_assert_sigcount(const fido_assert_t *, size_t); 176 uint8_t fido_cred_flags(const fido_cred_t *); 177 uint8_t fido_dev_protocol(const fido_dev_t *); 178 uint8_t fido_dev_major(const fido_dev_t *); 179 uint8_t fido_dev_minor(const fido_dev_t *); 180 uint8_t fido_dev_build(const fido_dev_t *); 181 uint8_t fido_dev_flags(const fido_dev_t *); 182 int16_t fido_dev_info_vendor(const fido_dev_info_t *); 183 int16_t fido_dev_info_product(const fido_dev_info_t *); 184 uint64_t fido_cbor_info_maxmsgsiz(const fido_cbor_info_t *); 185 uint64_t fido_cbor_info_maxcredcntlst(const fido_cbor_info_t *); 186 uint64_t fido_cbor_info_maxcredidlen(const fido_cbor_info_t *); 187 uint64_t fido_cbor_info_fwversion(const fido_cbor_info_t *); 188 189 bool fido_dev_has_pin(const fido_dev_t *); 190 bool fido_dev_is_fido2(const fido_dev_t *); 191 bool fido_dev_supports_pin(const fido_dev_t *); 192 bool fido_dev_supports_cred_prot(const fido_dev_t *); 193 194 #ifdef __cplusplus 195 } /* extern "C" */ 196 #endif /* __cplusplus */ 197 198 #endif /* !_FIDO_H */ 199