Coverage Report

Created: 2022-07-22 12:05

/libfido2/src/extern.h
Line
Count
Source (jump to first uncovered line)
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 _EXTERN_H
8
#define _EXTERN_H
9
10
#ifdef __MINGW32__
11
#include <sys/types.h>
12
#endif
13
14
#ifdef HAVE_SIGNAL_H
15
#include <signal.h>
16
#endif
17
18
#include <stdint.h>
19
20
#include "fido/types.h"
21
#include "blob.h"
22
23
#ifdef __cplusplus
24
extern "C" {
25
#endif /* __cplusplus */
26
27
/* aes256 */
28
int aes256_cbc_dec(const fido_dev_t *dev, const fido_blob_t *,
29
    const fido_blob_t *, fido_blob_t *);
30
int aes256_cbc_enc(const fido_dev_t *dev, const fido_blob_t *,
31
    const fido_blob_t *, fido_blob_t *);
32
int aes256_gcm_dec(const fido_blob_t *, const fido_blob_t *,
33
    const fido_blob_t *, const fido_blob_t *, fido_blob_t *);
34
int aes256_gcm_enc(const fido_blob_t *, const fido_blob_t *,
35
    const fido_blob_t *, const fido_blob_t *, fido_blob_t *);
36
37
/* cbor encoding functions */
38
cbor_item_t *cbor_build_uint(const uint64_t);
39
cbor_item_t *cbor_flatten_vector(cbor_item_t **, size_t);
40
cbor_item_t *cbor_encode_assert_opt(fido_opt_t, fido_opt_t);
41
cbor_item_t *cbor_encode_change_pin_auth(const fido_dev_t *,
42
    const fido_blob_t *, const fido_blob_t *, const fido_blob_t *);
43
cbor_item_t *cbor_encode_cred_ext(const fido_cred_ext_t *, const fido_blob_t *);
44
cbor_item_t *cbor_encode_assert_ext(fido_dev_t *,
45
    const fido_assert_ext_t *, const fido_blob_t *, const es256_pk_t *);
46
cbor_item_t *cbor_encode_cred_opt(fido_opt_t, fido_opt_t);
47
cbor_item_t *cbor_encode_pin_auth(const fido_dev_t *, const fido_blob_t *,
48
    const fido_blob_t *);
49
cbor_item_t *cbor_encode_pin_opt(const fido_dev_t *);
50
cbor_item_t *cbor_encode_pubkey(const fido_blob_t *);
51
cbor_item_t *cbor_encode_pubkey_list(const fido_blob_array_t *);
52
cbor_item_t *cbor_encode_pubkey_param(int);
53
cbor_item_t *cbor_encode_rp_entity(const fido_rp_t *);
54
cbor_item_t *cbor_encode_str_array(const fido_str_array_t *);
55
cbor_item_t *cbor_encode_user_entity(const fido_user_t *);
56
cbor_item_t *es256_pk_encode(const es256_pk_t *, int);
57
58
/* cbor decoding functions */
59
int cbor_decode_attstmt(const cbor_item_t *, fido_attstmt_t *);
60
int cbor_decode_bool(const cbor_item_t *, bool *);
61
int cbor_decode_cred_authdata(const cbor_item_t *, int, fido_blob_t *,
62
    fido_authdata_t *, fido_attcred_t *, fido_cred_ext_t *);
63
int cbor_decode_assert_authdata(const cbor_item_t *, fido_blob_t *,
64
    fido_authdata_t *, fido_assert_extattr_t *);
65
int cbor_decode_cred_id(const cbor_item_t *, fido_blob_t *);
66
int cbor_decode_fmt(const cbor_item_t *, char **);
67
int cbor_decode_pubkey(const cbor_item_t *, int *, void *);
68
int cbor_decode_rp_entity(const cbor_item_t *, fido_rp_t *);
69
int cbor_decode_uint64(const cbor_item_t *, uint64_t *);
70
int cbor_decode_user(const cbor_item_t *, fido_user_t *);
71
int es256_pk_decode(const cbor_item_t *, es256_pk_t *);
72
int es384_pk_decode(const cbor_item_t *, es384_pk_t *);
73
int rs256_pk_decode(const cbor_item_t *, rs256_pk_t *);
74
int eddsa_pk_decode(const cbor_item_t *, eddsa_pk_t *);
75
76
/* auxiliary cbor routines */
77
int cbor_add_bool(cbor_item_t *, const char *, fido_opt_t);
78
int cbor_add_bytestring(cbor_item_t *, const char *, const unsigned char *,
79
    size_t);
80
int cbor_add_string(cbor_item_t *, const char *, const char *);
81
int cbor_array_iter(const cbor_item_t *, void *, int(*)(const cbor_item_t *,
82
    void *));
83
int cbor_build_frame(uint8_t, cbor_item_t *[], size_t, fido_blob_t *);
84
int cbor_bytestring_copy(const cbor_item_t *, unsigned char **, size_t *);
85
int cbor_map_iter(const cbor_item_t *, void *, int(*)(const cbor_item_t *,
86
    const cbor_item_t *, void *));
87
int cbor_string_copy(const cbor_item_t *, char **);
88
int cbor_parse_reply(const unsigned char *, size_t, void *,
89
    int(*)(const cbor_item_t *, const cbor_item_t *, void *));
90
int cbor_add_uv_params(fido_dev_t *, uint8_t, const fido_blob_t *,
91
    const es256_pk_t *, const fido_blob_t *, const char *, const char *,
92
    cbor_item_t **, cbor_item_t **, int *);
93
void cbor_vector_free(cbor_item_t **, size_t);
94
int cbor_array_append(cbor_item_t **, cbor_item_t *);
95
int cbor_array_drop(cbor_item_t **, size_t);
96
97
/* deflate */
98
int fido_compress(fido_blob_t *, const fido_blob_t *);
99
int fido_uncompress(fido_blob_t *, const fido_blob_t *, size_t);
100
101
#ifndef nitems
102
29.7k
#define nitems(_a)      (sizeof((_a)) / sizeof((_a)[0]))
103
#endif
104
105
/* buf */
106
int fido_buf_read(const unsigned char **, size_t *, void *, size_t);
107
int fido_buf_write(unsigned char **, size_t *, const void *, size_t);
108
109
/* hid i/o */
110
void *fido_hid_open(const char *);
111
void  fido_hid_close(void *);
112
int fido_hid_read(void *, unsigned char *, size_t, int);
113
int fido_hid_write(void *, const unsigned char *, size_t);
114
int fido_hid_get_usage(const uint8_t *, size_t, uint32_t *);
115
int fido_hid_get_report_len(const uint8_t *, size_t, size_t *, size_t *);
116
int fido_hid_unix_open(const char *);
117
int fido_hid_unix_wait(int, int, const fido_sigset_t *);
118
int fido_hid_set_sigmask(void *, const fido_sigset_t *);
119
size_t fido_hid_report_in_len(void *);
120
size_t fido_hid_report_out_len(void *);
121
122
/* nfc i/o */
123
bool fido_is_nfc(const char *);
124
bool nfc_is_fido(const char *);
125
void *fido_nfc_open(const char *);
126
void  fido_nfc_close(void *);
127
int fido_nfc_read(void *, unsigned char *, size_t, int);
128
int fido_nfc_write(void *, const unsigned char *, size_t);
129
int fido_nfc_rx(fido_dev_t *, uint8_t, unsigned char *, size_t, int);
130
int fido_nfc_tx(fido_dev_t *, uint8_t, const unsigned char *, size_t);
131
int fido_nfc_set_sigmask(void *, const fido_sigset_t *);
132
int fido_dev_set_nfc(fido_dev_t *);
133
134
/* pcsc i/o */
135
bool fido_is_pcsc(const char *);
136
void *fido_pcsc_open(const char *);
137
void  fido_pcsc_close(void *);
138
int fido_pcsc_read(void *, unsigned char *, size_t, int);
139
int fido_pcsc_write(void *, const unsigned char *, size_t);
140
int fido_pcsc_rx(fido_dev_t *, uint8_t, unsigned char *, size_t, int);
141
int fido_pcsc_tx(fido_dev_t *, uint8_t, const unsigned char *, size_t);
142
int fido_dev_set_pcsc(fido_dev_t *);
143
144
/* windows hello */
145
int fido_winhello_manifest(fido_dev_info_t *, size_t, size_t *);
146
int fido_winhello_open(fido_dev_t *);
147
int fido_winhello_close(fido_dev_t *);
148
int fido_winhello_cancel(fido_dev_t *);
149
int fido_winhello_get_assert(fido_dev_t *, fido_assert_t *, const char *, int);
150
int fido_winhello_get_cbor_info(fido_dev_t *, fido_cbor_info_t *);
151
int fido_winhello_make_cred(fido_dev_t *, fido_cred_t *, const char *, int);
152
153
/* generic i/o */
154
int fido_rx_cbor_status(fido_dev_t *, int *);
155
int fido_rx(fido_dev_t *, uint8_t, void *, size_t, int *);
156
int fido_tx(fido_dev_t *, uint8_t, const void *, size_t, int *);
157
158
/* log */
159
#ifdef FIDO_NO_DIAGNOSTIC
160
#define fido_log_init(...)      do { /* nothing */ } while (0)
161
#define fido_log_debug(...)     do { /* nothing */ } while (0)
162
#define fido_log_xxd(...)       do { /* nothing */ } while (0)
163
#define fido_log_error(...)     do { /* nothing */ } while (0)
164
#else
165
#ifdef __GNUC__
166
void fido_log_init(void);
167
void fido_log_debug(const char *, ...)
168
    __attribute__((__format__ (printf, 1, 2)));
169
void fido_log_xxd(const void *, size_t, const char *, ...)
170
    __attribute__((__format__ (printf, 3, 4)));
171
void fido_log_error(int, const char *, ...)
172
    __attribute__((__format__ (printf, 2, 3)));
173
#else
174
void fido_log_init(void);
175
void fido_log_debug(const char *, ...);
176
void fido_log_xxd(const void *, size_t, const char *, ...);
177
void fido_log_error(int, const char *, ...);
178
#endif /* __GNUC__ */
179
#endif /* FIDO_NO_DIAGNOSTIC */
180
181
/* u2f */
182
int u2f_register(fido_dev_t *, fido_cred_t *, int *);
183
int u2f_authenticate(fido_dev_t *, fido_assert_t *, int *);
184
int u2f_get_touch_begin(fido_dev_t *, int *);
185
int u2f_get_touch_status(fido_dev_t *, int *, int *);
186
187
/* unexposed fido ops */
188
uint8_t fido_dev_get_pin_protocol(const fido_dev_t *);
189
int fido_dev_authkey(fido_dev_t *, es256_pk_t *, int *);
190
int fido_dev_get_cbor_info_wait(fido_dev_t *, fido_cbor_info_t *, int *);
191
int fido_dev_get_uv_token(fido_dev_t *, uint8_t, const char *,
192
    const fido_blob_t *, const es256_pk_t *, const char *, fido_blob_t *,
193
    int *);
194
uint64_t fido_dev_maxmsgsize(const fido_dev_t *);
195
int fido_do_ecdh(fido_dev_t *, es256_pk_t **, fido_blob_t **, int *);
196
197
/* types */
198
void fido_algo_array_free(fido_algo_array_t *);
199
void fido_byte_array_free(fido_byte_array_t *);
200
void fido_cert_array_free(fido_cert_array_t *);
201
void fido_opt_array_free(fido_opt_array_t *);
202
void fido_str_array_free(fido_str_array_t *);
203
void fido_algo_free(fido_algo_t *);
204
int fido_str_array_pack(fido_str_array_t *, const char * const *, size_t);
205
206
/* misc */
207
void fido_assert_reset_rx(fido_assert_t *);
208
void fido_assert_reset_tx(fido_assert_t *);
209
void fido_cred_reset_rx(fido_cred_t *);
210
void fido_cred_reset_tx(fido_cred_t *);
211
void fido_cbor_info_reset(fido_cbor_info_t *);
212
int fido_blob_serialise(fido_blob_t *, const cbor_item_t *);
213
int fido_check_flags(uint8_t, fido_opt_t, fido_opt_t);
214
int fido_check_rp_id(const char *, const unsigned char *);
215
int fido_get_random(void *, size_t);
216
int fido_sha256(fido_blob_t *, const u_char *, size_t);
217
int fido_time_now(struct timespec *);
218
int fido_time_delta(const struct timespec *, int *);
219
int fido_to_uint64(const char *, int, uint64_t *);
220
221
/* crypto */
222
int es256_verify_sig(const fido_blob_t *, EVP_PKEY *, const fido_blob_t *);
223
int es384_verify_sig(const fido_blob_t *, EVP_PKEY *, const fido_blob_t *);
224
int rs256_verify_sig(const fido_blob_t *, EVP_PKEY *, const fido_blob_t *);
225
int eddsa_verify_sig(const fido_blob_t *, EVP_PKEY *, const fido_blob_t *);
226
int rs1_verify_sig(const fido_blob_t *, EVP_PKEY *, const fido_blob_t *);
227
int es256_pk_verify_sig(const fido_blob_t *, const es256_pk_t *,
228
    const fido_blob_t *);
229
int es384_pk_verify_sig(const fido_blob_t *, const es384_pk_t *,
230
    const fido_blob_t *);
231
int rs256_pk_verify_sig(const fido_blob_t *, const rs256_pk_t *,
232
    const fido_blob_t *);
233
int eddsa_pk_verify_sig(const fido_blob_t *, const eddsa_pk_t *,
234
    const fido_blob_t *);
235
int fido_get_signed_hash(int, fido_blob_t *, const fido_blob_t *,
236
    const fido_blob_t *);
237
int fido_get_signed_hash_tpm(fido_blob_t *, const fido_blob_t *,
238
    const fido_blob_t *, const fido_attstmt_t *, const fido_attcred_t *);
239
240
/* device manifest functions */
241
int fido_hid_manifest(fido_dev_info_t *, size_t, size_t *);
242
int fido_nfc_manifest(fido_dev_info_t *, size_t, size_t *);
243
int fido_pcsc_manifest(fido_dev_info_t *, size_t, size_t *);
244
245
/* fuzzing instrumentation */
246
#ifdef FIDO_FUZZ
247
uint32_t uniform_random(uint32_t);
248
#endif
249
250
/* internal device capability flags */
251
4.34k
#define FIDO_DEV_PIN_SET        0x001
252
6.69k
#define FIDO_DEV_PIN_UNSET      0x002
253
4.47k
#define FIDO_DEV_CRED_PROT      0x004
254
4.30k
#define FIDO_DEV_CREDMAN        0x008
255
10.8k
#define FIDO_DEV_PIN_PROTOCOL1  0x010
256
10.7k
#define FIDO_DEV_PIN_PROTOCOL2  0x020
257
4.34k
#define FIDO_DEV_UV_SET         0x040
258
2.27k
#define FIDO_DEV_UV_UNSET       0x080
259
2.59k
#define FIDO_DEV_TOKEN_PERMS    0x100
260
0
#define FIDO_DEV_WINHELLO       0x200
261
262
/* miscellanea */
263
2.95k
#define FIDO_DUMMY_CLIENTDATA   ""
264
1.53k
#define FIDO_DUMMY_RP_ID        "localhost"
265
88
#define FIDO_DUMMY_USER_NAME    "dummy"
266
1.51k
#define FIDO_DUMMY_USER_ID      1
267
#define FIDO_WINHELLO_PATH      "windows://hello"
268
2.80M
#define FIDO_NFC_PREFIX         "nfc:"
269
991k
#define FIDO_PCSC_PREFIX        "pcsc:"
270
271
#ifdef __cplusplus
272
} /* extern "C" */
273
#endif /* __cplusplus */
274
275
#endif /* !_EXTERN_H */