summaryrefslogtreecommitdiff
path: root/man/fido_assert_new.3
diff options
context:
space:
mode:
Diffstat (limited to 'man/fido_assert_new.3')
-rw-r--r--man/fido_assert_new.335
1 files changed, 31 insertions, 4 deletions
diff --git a/man/fido_assert_new.3 b/man/fido_assert_new.3
index 0c2f92f..b1b1f2f 100644
--- a/man/fido_assert_new.3
+++ b/man/fido_assert_new.3
@@ -9,6 +9,7 @@
9.Nm fido_assert_new , 9.Nm fido_assert_new ,
10.Nm fido_assert_free , 10.Nm fido_assert_free ,
11.Nm fido_assert_count , 11.Nm fido_assert_count ,
12.Nm fido_assert_rp_id ,
12.Nm fido_assert_user_display_name , 13.Nm fido_assert_user_display_name ,
13.Nm fido_assert_user_icon , 14.Nm fido_assert_user_icon ,
14.Nm fido_assert_user_name , 15.Nm fido_assert_user_name ,
@@ -17,12 +18,15 @@
17.Nm fido_assert_hmac_secret_ptr , 18.Nm fido_assert_hmac_secret_ptr ,
18.Nm fido_assert_user_id_ptr , 19.Nm fido_assert_user_id_ptr ,
19.Nm fido_assert_sig_ptr , 20.Nm fido_assert_sig_ptr ,
21.Nm fido_assert_id_ptr ,
20.Nm fido_assert_authdata_len , 22.Nm fido_assert_authdata_len ,
21.Nm fido_assert_clientdata_hash_len , 23.Nm fido_assert_clientdata_hash_len ,
22.Nm fido_assert_hmac_secret_len , 24.Nm fido_assert_hmac_secret_len ,
23.Nm fido_assert_user_id_len , 25.Nm fido_assert_user_id_len ,
24.Nm fido_assert_sig_len , 26.Nm fido_assert_sig_len ,
25.Nm fido_assert_sigcount 27.Nm fido_assert_id_len ,
28.Nm fido_assert_sigcount ,
29.Nm fido_assert_flags
26.Nd FIDO 2 assertion API 30.Nd FIDO 2 assertion API
27.Sh SYNOPSIS 31.Sh SYNOPSIS
28.In fido.h 32.In fido.h
@@ -33,6 +37,8 @@
33.Ft size_t 37.Ft size_t
34.Fn fido_assert_count "const fido_assert_t *assert" 38.Fn fido_assert_count "const fido_assert_t *assert"
35.Ft const char * 39.Ft const char *
40.Fn fido_assert_rp_id "const fido_assert_t *assert"
41.Ft const char *
36.Fn fido_assert_user_display_name "const fido_assert_t *assert" "size_t idx" 42.Fn fido_assert_user_display_name "const fido_assert_t *assert" "size_t idx"
37.Ft const char * 43.Ft const char *
38.Fn fido_assert_user_icon "const fido_assert_t *assert" "size_t idx" 44.Fn fido_assert_user_icon "const fido_assert_t *assert" "size_t idx"
@@ -48,6 +54,8 @@
48.Fn fido_assert_user_id_ptr "const fido_assert_t *assert" "size_t idx" 54.Fn fido_assert_user_id_ptr "const fido_assert_t *assert" "size_t idx"
49.Ft const unsigned char * 55.Ft const unsigned char *
50.Fn fido_assert_sig_ptr "const fido_assert_t *assert" "size_t idx" 56.Fn fido_assert_sig_ptr "const fido_assert_t *assert" "size_t idx"
57.Ft const unsigned char *
58.Fn fido_assert_id_ptr "const fido_assert_t *assert" "size_t idx"
51.Ft size_t 59.Ft size_t
52.Fn fido_assert_authdata_len "const fido_assert_t *assert" "size_t idx" 60.Fn fido_assert_authdata_len "const fido_assert_t *assert" "size_t idx"
53.Ft size_t 61.Ft size_t
@@ -58,8 +66,12 @@
58.Fn fido_assert_user_id_len "const fido_assert_t *assert" "size_t idx" 66.Fn fido_assert_user_id_len "const fido_assert_t *assert" "size_t idx"
59.Ft size_t 67.Ft size_t
60.Fn fido_assert_sig_len "const fido_assert_t *assert" "size_t idx" 68.Fn fido_assert_sig_len "const fido_assert_t *assert" "size_t idx"
69.Ft size_t
70.Fn fido_assert_id_len "const fido_assert_t *assert" "size_t idx"
61.Ft uint32_t 71.Ft uint32_t
62.Fn fido_assert_sigcount "const fido_assert_t *assert" "size_t idx" 72.Fn fido_assert_sigcount "const fido_assert_t *assert" "size_t idx"
73.Ft uint8_t
74.Fn fido_assert_flags "const fido_assert_t *assert" "size_t idx"
63.Sh DESCRIPTION 75.Sh DESCRIPTION
64FIDO 2 assertions are abstracted in 76FIDO 2 assertions are abstracted in
65.Em libfido2 77.Em libfido2
@@ -110,6 +122,12 @@ function returns the number of statements in
110.Fa assert . 122.Fa assert .
111.Pp 123.Pp
112The 124The
125.Fn fido_assert_rp_id
126function returns a pointer to a NUL-terminated string holding the
127relying party ID of
128.Fa assert .
129.Pp
130The
113.Fn fido_assert_user_display_name , 131.Fn fido_assert_user_display_name ,
114.Fn fido_assert_user_icon , 132.Fn fido_assert_user_icon ,
115and 133and
@@ -126,10 +144,11 @@ The
126.Fn fido_assert_user_id_ptr , 144.Fn fido_assert_user_id_ptr ,
127.Fn fido_assert_authdata_ptr , 145.Fn fido_assert_authdata_ptr ,
128.Fn fido_assert_hmac_secret_ptr , 146.Fn fido_assert_hmac_secret_ptr ,
147.Fn fido_assert_sig_ptr ,
129and 148and
130.Fn fido_assert_sig_ptr 149.Fn fido_assert_id_ptr
131functions return pointers to the user ID, authenticator data, 150functions return pointers to the user ID, authenticator data,
132hmac-secret, and signature attributes of statement 151hmac-secret, signature, and credential ID attributes of statement
133.Fa idx 152.Fa idx
134in 153in
135.Fa assert . 154.Fa assert .
@@ -137,8 +156,9 @@ The
137.Fn fido_assert_user_id_len , 156.Fn fido_assert_user_id_len ,
138.Fn fido_assert_authdata_len , 157.Fn fido_assert_authdata_len ,
139.Fn fido_assert_hmac_secret_len , 158.Fn fido_assert_hmac_secret_len ,
159.Fn fido_assert_sig_len ,
140and 160and
141.Fn fido_assert_sig_len 161.Fn fido_assert_id_len
142functions can be used to retrieve the corresponding length of a 162functions can be used to retrieve the corresponding length of a
143specific attribute. 163specific attribute.
144.Pp 164.Pp
@@ -149,6 +169,13 @@ function can be used to obtain the signature counter of statement
149in 169in
150.Fa assert . 170.Fa assert .
151.Pp 171.Pp
172The
173.Fn fido_assert_flags
174function returns the authenticator data flags of statement
175.Fa idx
176in
177.Fa assert .
178.Pp
152Please note that the first statement in 179Please note that the first statement in
153.Fa assert 180.Fa assert
154has an 181has an