Coverage Report

Created: 2022-07-22 12:05

/libfido2/src/fido.h
Line
Count
Source
1
/*
2
 * Copyright (c) 2018-2022 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 <sys/types.h>
19
20
#include <cbor.h>
21
#include <limits.h>
22
23
#include "../openbsd-compat/openbsd-compat.h"
24
#include "blob.h"
25
#include "iso7816.h"
26
#include "extern.h"
27
#endif
28
29
#include "fido/err.h"
30
#include "fido/param.h"
31
#include "fido/types.h"
32
33
#ifdef __cplusplus
34
extern "C" {
35
#endif /* __cplusplus */
36
37
fido_assert_t *fido_assert_new(void);
38
fido_cred_t *fido_cred_new(void);
39
fido_dev_t *fido_dev_new(void);
40
fido_dev_t *fido_dev_new_with_info(const fido_dev_info_t *);
41
fido_dev_info_t *fido_dev_info_new(size_t);
42
fido_cbor_info_t *fido_cbor_info_new(void);
43
void *fido_dev_io_handle(const fido_dev_t *);
44
45
void fido_assert_free(fido_assert_t **);
46
void fido_cbor_info_free(fido_cbor_info_t **);
47
void fido_cred_free(fido_cred_t **);
48
void fido_dev_force_fido2(fido_dev_t *);
49
void fido_dev_force_u2f(fido_dev_t *);
50
void fido_dev_free(fido_dev_t **);
51
void fido_dev_info_free(fido_dev_info_t **, size_t);
52
53
/* fido_init() flags. */
54
22.7k
#define FIDO_DEBUG      0x01
55
11.3k
#define FIDO_DISABLE_U2F_FALLBACK 0x02
56
57
void fido_init(int);
58
void fido_set_log_handler(fido_log_handler_t *);
59
60
const unsigned char *fido_assert_authdata_ptr(const fido_assert_t *, size_t);
61
const unsigned char *fido_assert_clientdata_hash_ptr(const fido_assert_t *);
62
const unsigned char *fido_assert_hmac_secret_ptr(const fido_assert_t *, size_t);
63
const unsigned char *fido_assert_id_ptr(const fido_assert_t *, size_t);
64
const unsigned char *fido_assert_largeblob_key_ptr(const fido_assert_t *, size_t);
65
const unsigned char *fido_assert_sig_ptr(const fido_assert_t *, size_t);
66
const unsigned char *fido_assert_user_id_ptr(const fido_assert_t *, size_t);
67
const unsigned char *fido_assert_blob_ptr(const fido_assert_t *, size_t);
68
69
char **fido_cbor_info_certs_name_ptr(const fido_cbor_info_t *);
70
char **fido_cbor_info_extensions_ptr(const fido_cbor_info_t *);
71
char **fido_cbor_info_options_name_ptr(const fido_cbor_info_t *);
72
char **fido_cbor_info_transports_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_cbor_info_algorithm_type(const fido_cbor_info_t *, size_t);
80
const char *fido_cred_display_name(const fido_cred_t *);
81
const char *fido_cred_fmt(const fido_cred_t *);
82
const char *fido_cred_rp_id(const fido_cred_t *);
83
const char *fido_cred_rp_name(const fido_cred_t *);
84
const char *fido_cred_user_name(const fido_cred_t *);
85
const char *fido_dev_info_manufacturer_string(const fido_dev_info_t *);
86
const char *fido_dev_info_path(const fido_dev_info_t *);
87
const char *fido_dev_info_product_string(const fido_dev_info_t *);
88
const fido_dev_info_t *fido_dev_info_ptr(const fido_dev_info_t *, size_t);
89
const uint8_t *fido_cbor_info_protocols_ptr(const fido_cbor_info_t *);
90
const uint64_t *fido_cbor_info_certs_value_ptr(const fido_cbor_info_t *);
91
const unsigned char *fido_cbor_info_aaguid_ptr(const fido_cbor_info_t *);
92
const unsigned char *fido_cred_aaguid_ptr(const fido_cred_t *);
93
const unsigned char *fido_cred_attstmt_ptr(const fido_cred_t *);
94
const unsigned char *fido_cred_authdata_ptr(const fido_cred_t *);
95
const unsigned char *fido_cred_authdata_raw_ptr(const fido_cred_t *);
96
const unsigned char *fido_cred_clientdata_hash_ptr(const fido_cred_t *);
97
const unsigned char *fido_cred_id_ptr(const fido_cred_t *);
98
const unsigned char *fido_cred_largeblob_key_ptr(const fido_cred_t *);
99
const unsigned char *fido_cred_pubkey_ptr(const fido_cred_t *);
100
const unsigned char *fido_cred_sig_ptr(const fido_cred_t *);
101
const unsigned char *fido_cred_user_id_ptr(const fido_cred_t *);
102
const unsigned char *fido_cred_x5c_ptr(const fido_cred_t *);
103
104
int fido_assert_allow_cred(fido_assert_t *, const unsigned char *, size_t);
105
int fido_assert_set_authdata(fido_assert_t *, size_t, const unsigned char *,
106
    size_t);
107
int fido_assert_set_authdata_raw(fido_assert_t *, size_t, const unsigned char *,
108
    size_t);
109
int fido_assert_set_clientdata(fido_assert_t *, const unsigned char *, size_t);
110
int fido_assert_set_clientdata_hash(fido_assert_t *, const unsigned char *,
111
    size_t);
112
int fido_assert_set_count(fido_assert_t *, size_t);
113
int fido_assert_set_extensions(fido_assert_t *, int);
114
int fido_assert_set_hmac_salt(fido_assert_t *, const unsigned char *, size_t);
115
int fido_assert_set_hmac_secret(fido_assert_t *, size_t, const unsigned char *,
116
    size_t);
117
int fido_assert_set_options(fido_assert_t *, bool, bool);
118
int fido_assert_set_rp(fido_assert_t *, const char *);
119
int fido_assert_set_up(fido_assert_t *, fido_opt_t);
120
int fido_assert_set_uv(fido_assert_t *, fido_opt_t);
121
int fido_assert_set_sig(fido_assert_t *, size_t, const unsigned char *, size_t);
122
int fido_assert_verify(const fido_assert_t *, size_t, int, const void *);
123
int fido_cbor_info_algorithm_cose(const fido_cbor_info_t *, size_t);
124
int fido_cred_exclude(fido_cred_t *, const unsigned char *, size_t);
125
int fido_cred_prot(const fido_cred_t *);
126
int fido_cred_set_attstmt(fido_cred_t *, const unsigned char *, size_t);
127
int fido_cred_set_authdata(fido_cred_t *, const unsigned char *, size_t);
128
int fido_cred_set_authdata_raw(fido_cred_t *, const unsigned char *, size_t);
129
int fido_cred_set_blob(fido_cred_t *, const unsigned char *, size_t);
130
int fido_cred_set_clientdata(fido_cred_t *, const unsigned char *, size_t);
131
int fido_cred_set_clientdata_hash(fido_cred_t *, const unsigned char *, size_t);
132
int fido_cred_set_extensions(fido_cred_t *, int);
133
int fido_cred_set_fmt(fido_cred_t *, const char *);
134
int fido_cred_set_id(fido_cred_t *, const unsigned char *, size_t);
135
int fido_cred_set_options(fido_cred_t *, bool, bool);
136
int fido_cred_set_pin_minlen(fido_cred_t *, size_t);
137
int fido_cred_set_prot(fido_cred_t *, int);
138
int fido_cred_set_rk(fido_cred_t *, fido_opt_t);
139
int fido_cred_set_rp(fido_cred_t *, const char *, const char *);
140
int fido_cred_set_sig(fido_cred_t *, const unsigned char *, size_t);
141
int fido_cred_set_type(fido_cred_t *, int);
142
int fido_cred_set_uv(fido_cred_t *, fido_opt_t);
143
int fido_cred_type(const fido_cred_t *);
144
int fido_cred_set_user(fido_cred_t *, const unsigned char *, size_t,
145
    const char *, const char *, const char *);
146
int fido_cred_set_x509(fido_cred_t *, const unsigned char *, size_t);
147
int fido_cred_verify(const fido_cred_t *);
148
int fido_cred_verify_self(const fido_cred_t *);
149
#ifdef _FIDO_SIGSET_DEFINED
150
int fido_dev_set_sigmask(fido_dev_t *, const fido_sigset_t *);
151
#endif
152
int fido_dev_cancel(fido_dev_t *);
153
int fido_dev_close(fido_dev_t *);
154
int fido_dev_get_assert(fido_dev_t *, fido_assert_t *, const char *);
155
int fido_dev_get_cbor_info(fido_dev_t *, fido_cbor_info_t *);
156
int fido_dev_get_retry_count(fido_dev_t *, int *);
157
int fido_dev_get_uv_retry_count(fido_dev_t *, int *);
158
int fido_dev_get_touch_begin(fido_dev_t *);
159
int fido_dev_get_touch_status(fido_dev_t *, int *, int);
160
int fido_dev_info_manifest(fido_dev_info_t *, size_t, size_t *);
161
int fido_dev_info_set(fido_dev_info_t *, size_t, const char *, const char *,
162
    const char *, const fido_dev_io_t *, const fido_dev_transport_t *);
163
int fido_dev_make_cred(fido_dev_t *, fido_cred_t *, const char *);
164
int fido_dev_open_with_info(fido_dev_t *);
165
int fido_dev_open(fido_dev_t *, const char *);
166
int fido_dev_reset(fido_dev_t *);
167
int fido_dev_set_io_functions(fido_dev_t *, const fido_dev_io_t *);
168
int fido_dev_set_pin(fido_dev_t *, const char *, const char *);
169
int fido_dev_set_transport_functions(fido_dev_t *, const fido_dev_transport_t *);
170
int fido_dev_set_timeout(fido_dev_t *, int);
171
172
size_t fido_assert_authdata_len(const fido_assert_t *, size_t);
173
size_t fido_assert_clientdata_hash_len(const fido_assert_t *);
174
size_t fido_assert_count(const fido_assert_t *);
175
size_t fido_assert_hmac_secret_len(const fido_assert_t *, size_t);
176
size_t fido_assert_id_len(const fido_assert_t *, size_t);
177
size_t fido_assert_largeblob_key_len(const fido_assert_t *, size_t);
178
size_t fido_assert_sig_len(const fido_assert_t *, size_t);
179
size_t fido_assert_user_id_len(const fido_assert_t *, size_t);
180
size_t fido_assert_blob_len(const fido_assert_t *, size_t);
181
size_t fido_cbor_info_aaguid_len(const fido_cbor_info_t *);
182
size_t fido_cbor_info_algorithm_count(const fido_cbor_info_t *);
183
size_t fido_cbor_info_certs_len(const fido_cbor_info_t *);
184
size_t fido_cbor_info_extensions_len(const fido_cbor_info_t *);
185
size_t fido_cbor_info_options_len(const fido_cbor_info_t *);
186
size_t fido_cbor_info_protocols_len(const fido_cbor_info_t *);
187
size_t fido_cbor_info_transports_len(const fido_cbor_info_t *);
188
size_t fido_cbor_info_versions_len(const fido_cbor_info_t *);
189
size_t fido_cred_aaguid_len(const fido_cred_t *);
190
size_t fido_cred_attstmt_len(const fido_cred_t *);
191
size_t fido_cred_authdata_len(const fido_cred_t *);
192
size_t fido_cred_authdata_raw_len(const fido_cred_t *);
193
size_t fido_cred_clientdata_hash_len(const fido_cred_t *);
194
size_t fido_cred_id_len(const fido_cred_t *);
195
size_t fido_cred_largeblob_key_len(const fido_cred_t *);
196
size_t fido_cred_pin_minlen(const fido_cred_t *);
197
size_t fido_cred_pubkey_len(const fido_cred_t *);
198
size_t fido_cred_sig_len(const fido_cred_t *);
199
size_t fido_cred_user_id_len(const fido_cred_t *);
200
size_t fido_cred_x5c_len(const fido_cred_t *);
201
202
uint8_t  fido_assert_flags(const fido_assert_t *, size_t);
203
uint32_t fido_assert_sigcount(const fido_assert_t *, size_t);
204
uint8_t  fido_cred_flags(const fido_cred_t *);
205
uint32_t fido_cred_sigcount(const fido_cred_t *);
206
uint8_t  fido_dev_protocol(const fido_dev_t *);
207
uint8_t  fido_dev_major(const fido_dev_t *);
208
uint8_t  fido_dev_minor(const fido_dev_t *);
209
uint8_t  fido_dev_build(const fido_dev_t *);
210
uint8_t  fido_dev_flags(const fido_dev_t *);
211
int16_t  fido_dev_info_vendor(const fido_dev_info_t *);
212
int16_t  fido_dev_info_product(const fido_dev_info_t *);
213
uint64_t fido_cbor_info_fwversion(const fido_cbor_info_t *);
214
uint64_t fido_cbor_info_maxcredbloblen(const fido_cbor_info_t *);
215
uint64_t fido_cbor_info_maxcredcntlst(const fido_cbor_info_t *);
216
uint64_t fido_cbor_info_maxcredidlen(const fido_cbor_info_t *);
217
uint64_t fido_cbor_info_maxlargeblob(const fido_cbor_info_t *);
218
uint64_t fido_cbor_info_maxmsgsiz(const fido_cbor_info_t *);
219
uint64_t fido_cbor_info_maxrpid_minpinlen(const fido_cbor_info_t *);
220
uint64_t fido_cbor_info_minpinlen(const fido_cbor_info_t *);
221
uint64_t fido_cbor_info_uv_attempts(const fido_cbor_info_t *);
222
uint64_t fido_cbor_info_uv_modality(const fido_cbor_info_t *);
223
int64_t  fido_cbor_info_rk_remaining(const fido_cbor_info_t *);
224
225
bool fido_dev_has_pin(const fido_dev_t *);
226
bool fido_dev_has_uv(const fido_dev_t *);
227
bool fido_dev_is_fido2(const fido_dev_t *);
228
bool fido_dev_is_winhello(const fido_dev_t *);
229
bool fido_dev_supports_credman(const fido_dev_t *);
230
bool fido_dev_supports_cred_prot(const fido_dev_t *);
231
bool fido_dev_supports_permissions(const fido_dev_t *);
232
bool fido_dev_supports_pin(const fido_dev_t *);
233
bool fido_dev_supports_uv(const fido_dev_t *);
234
bool fido_cbor_info_new_pin_required(const fido_cbor_info_t *);
235
236
int fido_dev_largeblob_get(fido_dev_t *, const unsigned char *, size_t,
237
    unsigned char **, size_t *);
238
int fido_dev_largeblob_set(fido_dev_t *, const unsigned char *, size_t,
239
    const unsigned char *, size_t, const char *);
240
int fido_dev_largeblob_remove(fido_dev_t *, const unsigned char *, size_t,
241
    const char *);
242
int fido_dev_largeblob_get_array(fido_dev_t *, unsigned char **, size_t *);
243
int fido_dev_largeblob_set_array(fido_dev_t *, const unsigned char *, size_t,
244
    const char *);
245
246
#ifdef __cplusplus
247
} /* extern "C" */
248
#endif /* __cplusplus */
249
250
#endif /* !_FIDO_H */