fido_assert_free(3)

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

NAME

4     fido_assert_new, fido_assert_free, fido_assert_count, fido_assert_rp_id,
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_id_ptr,
9     fido_assert_authdata_len, fido_assert_clientdata_hash_len,
10     fido_assert_hmac_secret_len, fido_assert_user_id_len,
11     fido_assert_sig_len, fido_assert_id_len, fido_assert_sigcount,
12     fido_assert_flags — FIDO 2 assertion API
13

SYNOPSIS

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

DESCRIPTION

81     FIDO 2 assertions are abstracted in libfido2 by the fido_assert_t type.
82     The functions described in this page allow a fido_assert_t type to be al‐
83     located, deallocated, and inspected.  For other operations on
84     fido_assert_t, please refer to fido_assert_set_authdata(3),
85     fido_assert_allow_cred(3), fido_assert_verify(3), and
86     fido_dev_get_assert(3).
87
88     The fido_assert_new() function returns a pointer to a newly allocated,
89     empty fido_assert_t type.  If memory cannot be allocated, NULL is re‐
90     turned.
91
92     The fido_assert_free() function releases the memory backing *assert_p,
93     where *assert_p must have been previously allocated by fido_assert_new().
94     On return, *assert_p is set to NULL.  Either assert_p or *assert_p may be
95     NULL, in which case fido_assert_free() is a NOP.
96
97     The fido_assert_count() function returns the number of statements in
98     assert.
99
100     The fido_assert_rp_id() function returns a pointer to a NUL-terminated
101     string holding the relying party ID of assert.
102
103     The fido_assert_user_display_name(), fido_assert_user_icon(), and
104     fido_assert_user_name(), functions return pointers to the user display
105     name, icon, and name attributes of statement idx in assert.  If not NULL,
106     the values returned by these functions point to NUL-terminated UTF-8
107     strings.
108
109     The fido_assert_user_id_ptr(), fido_assert_authdata_ptr(),
110     fido_assert_hmac_secret_ptr(), fido_assert_sig_ptr(), and
111     fido_assert_id_ptr() functions return pointers to the user ID, CBOR-en‐
112     coded authenticator data, hmac-secret, signature, and credential ID at‐
113     tributes of statement idx in assert.  The fido_assert_user_id_len(),
114     fido_assert_authdata_len(), fido_assert_hmac_secret_len(),
115     fido_assert_sig_len(), and fido_assert_id_len() functions can be used to
116     retrieve the corresponding length of a specific attribute.
117
118     The fido_assert_sigcount() function can be used to obtain the signature
119     counter of statement idx in assert.
120
121     The fido_assert_flags() function returns the authenticator data flags of
122     statement idx in assert.
123
124     Please note that the first statement in assert has an idx (index) value
125     of 0.
126
127     The authenticator data and signature parts of an assertion statement are
128     typically passed to a FIDO 2 server for verification.
129
130     The fido_assert_clientdata_hash_ptr() function returns a pointer to the
131     client data hash of assert.  The corresponding length can be obtained by
132     fido_assert_clientdata_hash_len().
133

RETURN VALUES

135     The authenticator data returned by fido_assert_authdata_ptr() is a CBOR-
136     encoded byte string, as obtained from the authenticator.
137
138     The fido_assert_user_display_name(), fido_assert_user_icon(),
139     fido_assert_user_name(), fido_assert_authdata_ptr(),
140     fido_assert_clientdata_hash_ptr(), fido_assert_user_id_ptr(), and
141     fido_assert_sig_ptr() functions return NULL if the respective field in
142     assert is not set.  If not NULL, returned pointers are guaranteed to ex‐
143     ist until any API function that takes assert without the const qualifier
144     is invoked.
145

NAME

SYNOPSIS

DESCRIPTION

RETURN VALUES

SEE ALSO