1FIDO_ASSERT_NEW(3)       BSD Library Functions Manual       FIDO_ASSERT_NEW(3)
2

NAME

4     fido_assert_new, fido_assert_free, fido_assert_count,
5     fido_assert_user_display_name, fido_assert_user_icon,
6     fido_assert_user_name, fido_assert_authdata_ptr,
7     fido_assert_clientdata_hash_ptr, fido_assert_hmac_secret_ptr,
8     fido_assert_user_id_ptr, fido_assert_sig_ptr, fido_assert_authdata_len,
9     fido_assert_clientdata_hash_len, fido_assert_hmac_secret_len,
10     fido_assert_user_id_len, fido_assert_sig_len, fido_assert_sigcount — FIDO
11     2 assertion API
12

SYNOPSIS

14     #include <fido.h>
15
16     fido_assert_t *
17     fido_assert_new(void);
18
19     void
20     fido_assert_free(fido_assert_t **assert_p);
21
22     size_t
23     fido_assert_count(const fido_assert_t *assert);
24
25     const char *
26     fido_assert_user_display_name(const fido_assert_t *assert, size_t idx);
27
28     const char *
29     fido_assert_user_icon(const fido_assert_t *assert, size_t idx);
30
31     const char *
32     fido_assert_user_name(const fido_assert_t *assert, size_t idx);
33
34     const unsigned char *
35     fido_assert_authdata_ptr(const fido_assert_t *assert, size_t idx);
36
37     const unsigned char *
38     fido_assert_clientdata_hash_ptr(const fido_assert_t *assert);
39
40     const unsigned char *
41     fido_assert_hmac_secret_ptr(const fido_assert_t *assert, size_t idx);
42
43     const unsigned char *
44     fido_assert_user_id_ptr(const fido_assert_t *assert, size_t idx);
45
46     const unsigned char *
47     fido_assert_sig_ptr(const fido_assert_t *assert, size_t idx);
48
49     size_t
50     fido_assert_authdata_len(const fido_assert_t *assert, size_t idx);
51
52     size_t
53     fido_assert_clientdata_hash_len(const fido_assert_t *assert);
54
55     size_t
56     fido_assert_hmac_secret_len(const fido_assert_t *assert, size_t idx);
57
58     size_t
59     fido_assert_user_id_len(const fido_assert_t *assert, size_t idx);
60
61     size_t
62     fido_assert_sig_len(const fido_assert_t *assert, size_t idx);
63
64     uint32_t
65     fido_assert_sigcount(const fido_assert_t *assert, size_t idx);
66

DESCRIPTION

68     FIDO 2 assertions are abstracted in libfido2 by the fido_assert_t type.
69     The functions described in this page allow a fido_assert_t type to be
70     allocated, deallocated, and inspected.  For other operations on
71     fido_assert_t, please refer to fido_assert_set_authdata(3),
72     fido_assert_allow_cred(3), fido_assert_verify(3), and
73     fido_dev_get_assert(3).
74
75     The fido_assert_new() function returns a pointer to a newly allocated,
76     empty fido_assert_t type.  If memory cannot be allocated, NULL is
77     returned.
78
79     The fido_assert_free() function releases the memory backing *assert_p,
80     where *assert_p must have been previously allocated by fido_assert_new().
81     On return, *assert_p is set to NULL.  Either assert_p or *assert_p may be
82     NULL, in which case fido_assert_free() is a NOP.
83
84     The fido_assert_count() function returns the number of statements in
85     assert.
86
87     The fido_assert_user_display_name(), fido_assert_user_icon(), and
88     fido_assert_user_name(), functions return pointers to the user display
89     name, icon, and name attributes of statement idx in assert.  If not NULL,
90     the values returned by these functions point to NUL-terminated UTF-8
91     strings.
92
93     The fido_assert_user_id_ptr(), fido_assert_authdata_ptr(),
94     fido_assert_hmac_secret_ptr(), and fido_assert_sig_ptr() functions return
95     pointers to the user ID, authenticator data, hmac-secret, and signature
96     attributes of statement idx in assert.  The fido_assert_user_id_len(),
97     fido_assert_authdata_len(), fido_assert_hmac_secret_len(), and
98     fido_assert_sig_len() functions can be used to retrieve the corresponding
99     length of a specific attribute.
100
101     The fido_assert_sigcount() function can be used to obtain the signature
102     counter of statement idx in assert.
103
104     Please note that the first statement in assert has an idx (index) value
105     of 0.
106
107     The authenticator data and signature parts of an assertion statement are
108     typically passed to a FIDO 2 server for verification.
109
110     The fido_assert_clientdata_hash_ptr() function returns a pointer to the
111     client data hash of assert.  The corresponding length can be obtained by
112     fido_assert_clientdata_hash_len().
113

RETURN VALUES

115     The fido_assert_user_display_name(), fido_assert_user_icon(),
116     fido_assert_user_name(), fido_assert_authdata_ptr(),
117     fido_assert_clientdata_hash_ptr(), fido_assert_user_id_ptr(), and
118     fido_assert_sig_ptr() functions return NULL if the respective field in
119     assert is not set.  If not NULL, returned pointers are guaranteed to
120     exist until any API function that takes assert without the const quali‐
121     fier is invoked.
122

SEE ALSO

124     fido_assert_allow_cred(3), fido_assert_set_authdata(3),
125     fido_assert_verify(3), fido_dev_get_assert(3)
126
127BSD                              May 10, 2020                              BSD