Skip to content

Commit

Permalink
Docs: Update actions update to include bio verification
Browse files Browse the repository at this point in the history
  • Loading branch information
aveenismail committed Sep 19, 2024
1 parent f68be6f commit 639eff2
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 10 deletions.
7 changes: 4 additions & 3 deletions doc/Actions/key_generation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,10 @@ authentication, which is done by providing the management key. If no management
is provided, the tool will try to authenticate using the default management key.footnote:[It is strongly recommended to
change the Yubikey's PIN, PUK and management key before start using it]

While generating the certificate/certificate request does not require authentication,
it does require verifying the PIN code, which has to be done in an action that must
take place before the generation action, otherwise the operation will fail.
While generating the certificate/certificate request does not require authentication, the signing operation does
require verifying the PIN code or the fingerprint if the YubiKey supports Bio verification, which has to be done in an
action that must take place before the signing action, otherwise the operation will fail. Use `-a verify-pin` to
verify the PIN and `-a verify-bio` for fingerprint verification.

=== Parameters

Expand Down
3 changes: 2 additions & 1 deletion doc/Actions/signing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
=== Description
Signs input data

The signing operation requires verifying the PIN code, which is done using the "verify-pin" action
The signing operation requires verifying the PIN code or the fingerprint if the YubiKey supports Bio verification.
Use `-a verify-pin` to verify the PIN and `-a verify-bio` for fingerprint verification.

=== Parameters

Expand Down
6 changes: 3 additions & 3 deletions doc/Actions/test-decryption.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
=== Description
Tests decryption function.

"test-signature" and "test-decipher" are actions that require verifying the PIN code,
which has to be done in an action that must take place before the generation action,
otherwise the tests will fail.
`test-signature` and `test-decipher` are actions that require verifying the PIN code or the fingerprint if the YubiKey
supports Bio verification, which has to be done in an action that must take place before the generation action,
otherwise the tests will fail. Use `-a verify-pin` to verify the PIN and `-a verify-bio` for fingerprint verification.

Performing the test will require the certificate stored on the slot to test. This is
done using the "read-certificate" action first.
Expand Down
6 changes: 3 additions & 3 deletions doc/Actions/test-signature.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
=== Description
Tests signing functions.

"test-signature" and "test-decipher" are actions that require verifying the PIN code,
which has to be done in an action that must take place before the generation action,
otherwise the tests will fail.
`test-signature` and `test-decipher` are actions that require verifying the PIN code or the fingerprint if the YubiKey
supports Bio verification, which has to be done in an action that must take place before the generation action,
otherwise the tests will fail. Use `-a verify-pin` to verify the PIN and `-a verify-bio` for fingerprint verification.

Performing the test will require the certificate stored on the slot to test. This is
done using the "read-certificate" action first.
Expand Down

0 comments on commit 639eff2

Please sign in to comment.