From 173bfbf7886608a4a7abbfac6a42ac4bf4a3432d Mon Sep 17 00:00:00 2001 From: Colin Watson Date: Sun, 20 Sep 2020 16:14:20 +0100 Subject: New upstream version 1.5.0 --- man/fido_cred_new.3 | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 62 insertions(+), 3 deletions(-) (limited to 'man/fido_cred_new.3') diff --git a/man/fido_cred_new.3 b/man/fido_cred_new.3 index 22af60c..d2023eb 100644 --- a/man/fido_cred_new.3 +++ b/man/fido_cred_new.3 @@ -10,18 +10,28 @@ .Nm fido_cred_free , .Nm fido_cred_prot , .Nm fido_cred_fmt , +.Nm fido_cred_rp_id , +.Nm fido_cred_rp_name , +.Nm fido_cred_user_name , +.Nm fido_cred_display_name , .Nm fido_cred_authdata_ptr , .Nm fido_cred_clientdata_hash_ptr , .Nm fido_cred_id_ptr , +.Nm fido_cred_aaguid_ptr , .Nm fido_cred_pubkey_ptr , .Nm fido_cred_sig_ptr , +.Nm fido_cred_user_id_ptr , .Nm fido_cred_x5c_ptr , .Nm fido_cred_authdata_len , .Nm fido_cred_clientdata_hash_len , .Nm fido_cred_id_len , +.Nm fido_cred_aaguid_len , .Nm fido_cred_pubkey_len , .Nm fido_cred_sig_len , -.Nm fido_cred_x5c_len +.Nm fido_cred_user_id_len , +.Nm fido_cred_x5c_len , +.Nm fido_cred_type , +.Nm fido_cred_flags .Nd FIDO 2 credential API .Sh SYNOPSIS .In fido.h @@ -33,6 +43,14 @@ .Fn fido_cred_prot "fido_cred_t *cred" .Ft const char * .Fn fido_cred_fmt "const fido_cred_t *cred" +.Ft const char * +.Fn fido_cred_rp_id "const fido_cred_t *cred" +.Ft const char * +.Fn fido_cred_rp_name "const fido_cred_t *cred" +.Ft const char * +.Fn fido_cred_user_name "const fido_cred_t *cred" +.Ft const char * +.Fn fido_cred_display_name "const fido_cred_t *cred" .Ft const unsigned char * .Fn fido_cred_authdata_ptr "const fido_cred_t *cred" .Ft const unsigned char * @@ -40,10 +58,14 @@ .Ft const unsigned char * .Fn fido_cred_id_ptr "const fido_cred_t *cred" .Ft const unsigned char * +.Fn fido_cred_aaguid_ptr "const fido_cred_t *cred" +.Ft const unsigned char * .Fn fido_cred_pubkey_ptr "const fido_cred_t *cred" .Ft const unsigned char * .Fn fido_cred_sig_ptr "const fido_cred_t *cred" .Ft const unsigned char * +.Fn fido_cred_user_id_ptr "const fido_cred_t *cred" +.Ft const unsigned char * .Fn fido_cred_x5c_ptr "const fido_cred_t *cred" .Ft size_t .Fn fido_cred_authdata_len "const fido_cred_t *cred" @@ -52,11 +74,19 @@ .Ft size_t .Fn fido_cred_id_len "const fido_cred_t *cred" .Ft size_t +.Fn fido_cred_aaguid_len "const fido_cred_t *cred" +.Ft size_t .Fn fido_cred_pubkey_len "const fido_cred_t *cred" .Ft size_t .Fn fido_cred_sig_len "const fido_cred_t *cred" .Ft size_t +.Fn fido_cred_user_id_len "const fido_cred_t *cred" +.Ft size_t .Fn fido_cred_x5c_len "const fido_cred_t *cred" +.Ft int +.Fn fido_cred_type "const fido_cred_t *cred" +.Ft uint8_t +.Fn fido_cred_flags "const fido_cred_t *cred" .Sh DESCRIPTION FIDO 2 credentials are abstracted in .Em libfido2 @@ -120,15 +150,30 @@ or NULL if does not have a format set. .Pp The +.Fn fido_cred_rp_id , +.Fn fido_cred_rp_name , +.Fn fido_cred_user_name , +and +.Fn fido_cred_display_name +functions return pointers to NUL-terminated strings holding the +relying party ID, relying party name, user name, and user display +name attributes of +.Fa cred , +or NULL if the respective entry is not set. +.Pp +The .Fn fido_cred_authdata_ptr , .Fn fido_cred_clientdata_hash_ptr , .Fn fido_cred_id_ptr , +.Fn fido_cred_aaguid_ptr , .Fn fido_cred_pubkey_ptr , .Fn fido_cred_sig_ptr , +.Fn fido_cred_user_id_ptr , and .Fn fido_cred_x5c_ptr functions return pointers to the authenticator data, client data -hash, ID, public key, signature and x509 certificate parts of +hash, ID, authenticator attestation GUID, public key, signature, +user ID, and x509 certificate parts of .Fa cred , or NULL if the respective entry is not set. .Pp @@ -136,12 +181,25 @@ The corresponding length can be obtained by .Fn fido_cred_authdata_len , .Fn fido_cred_clientdata_hash_len , .Fn fido_cred_id_len , +.Fn fido_cred_aaguid_len , .Fn fido_cred_pubkey_len , +.Fn fido_cred_sig_len , +.Fn fido_cred_user_id_len , and -.Fn fido_cred_sig_len . +.Fn fido_cred_x5c_len . .Pp The authenticator data, x509 certificate, and signature parts of a credential are typically passed to a FIDO 2 server for verification. +.Pp +The +.Fn fido_cred_type +function returns the COSE algorithm of +.Fa cred . +.Pp +The +.Fn fido_cred_flags +function returns the authenticator data flags of +.Fa cred . .Sh RETURN VALUES The authenticator data returned by .Fn fido_cred_authdata_ptr @@ -152,6 +210,7 @@ If not NULL, pointers returned by .Fn fido_cred_authdata_ptr , .Fn fido_cred_clientdata_hash_ptr , .Fn fido_cred_id_ptr , +.Fn fido_cred_aaguid_ptr , .Fn fido_cred_pubkey_ptr , .Fn fido_cred_sig_ptr , and -- cgit v1.2.3