Skip to content

Commit 160f56d

Browse files
committed
typos, other minor fixes
1 parent d9574d2 commit 160f56d

File tree

3 files changed

+12
-14
lines changed

3 files changed

+12
-14
lines changed

docs/users-manual/application-otp/challenge-response.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,7 @@ bytes of additional data are not important—they are merely added as padding so
5959
with a 16-byte key using the AES encryption algorithm (AES requires that data be encrypted in blocks of the same size as
6060
the encryption key). The resulting Yubico OTP (as a byte array) becomes the response.
6161

62-
For HMAC-SHA1 challenge-response, an application will send the YubiKey a challenge of up to 64 bytes in size, which will be digested (
63-
hashed) with a 20-byte secret key, resulting in a 20-byte response (the HMAC-SHA1 hash value). Responses can be received
62+
For HMAC-SHA1 challenge-response, an application will send the YubiKey a challenge of up to 64 bytes in size, which will be digested (hashed) with a 20-byte secret key, resulting in a 20-byte response (the HMAC-SHA1 hash value). Responses can be received
6463
by an application as a byte array or a 6-10 digit numeric code. With HMAC-SHA1, the challenge can be either an
6564
application-specified byte array or the current Unix time.
6665

@@ -109,7 +108,7 @@ The SDK’s challenge-response functionality centers around the following two me
109108

110109
``ConfigureChallengeResponse()`` allows you to configure an OTP application slot on a YubiKey to receive a challenge
111110
from a host and process it based on a specific algorithm and secret key. ``CalculateChallengeResponse()`` allows a host
112-
to send a challenge to a YubiKey and then receive the response from the YubiKey.
111+
to send a challenge to a YubiKey and then receive its response.
113112

114113
### ConfigureChallengeResponse()
115114

@@ -176,10 +175,10 @@ The SDK will throw an exception if you call both ``UseTotp()`` and ``UseChalleng
176175
> slot is configured to perform Yubico OTP, the challenge must
177176
> be [6 bytes](xref:Yubico.YubiKey.Otp.Operations.CalculateChallengeResponse.YubicoOtpChallengeSize) long. If the slot
178177
> is
179-
> configured for HMAC-SHA1, the HOTP challenge must
178+
> configured for HMAC-SHA1, the challenge must
180179
> be [64 bytes](xref:Yubico.YubiKey.Otp.Operations.CalculateChallengeResponse.MaxHmacChallengeSize) long. However, if
181180
> the
182-
> slot has been configured with ``UseSmallChallenge()``, an HOTP challenge smaller than 64 bytes is acceptable. The
181+
> slot has been configured with ``UseSmallChallenge()``, a challenge smaller than 64 bytes is acceptable. The
183182
> SDK will throw an exception if the challenge size does not match the YubiKey slot's configuration.
184183
185184
For a full list of the methods in the ``CalculateChallengeResponse`` class, see

docs/users-manual/application-otp/how-to-calculate-a-challenge-response-code.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ The response from a YubiKey can be received via one of three methods:
4545

4646
1. [GetCode()](xref:Yubico.YubiKey.Otp.Operations.CalculateChallengeResponse.GetCode%28System.Int32%29): returns a
4747
string object containing [six](xref:Yubico.YubiKey.Otp.Operations.CalculateChallengeResponse.MinOtpDigits)
48-
to [ten](xref:Yubico.YubiKey.Otp.Operations.CalculateChallengeResponse.MaxOtpDigits) 32-bit integers. A 6-digit code
48+
to [ten](xref:Yubico.YubiKey.Otp.Operations.CalculateChallengeResponse.MaxOtpDigits) numeric digits. A 6-digit code
4949
will be returned by default unless a larger number is specified when calling this method (for
5050
example, ``GetCode(8)``).
5151
1. [GetDataBytes()](xref:Yubico.YubiKey.Otp.Operations.CalculateChallengeResponse.GetDataBytes): returns a byte array.
@@ -109,7 +109,7 @@ var yubiKey = yubiKeyList.First();
109109

110110
In this example, we send an HMAC-SHA1 challenge (``hmacChal``) to the short press slot of the YubiKey
111111
with [UseChallenge()](xref:Yubico.YubiKey.Otp.Operations.CalculateChallengeResponse.UseChallenge%28System.Byte%5B%5D%29)
112-
and get the response as a string object containing eight 32-bit integers via ``GetCode()``.
112+
and get the response as a string object containing eight numeric digits via ``GetCode()``.
113113

114114
In addition, we
115115
use [UseTouchNotifier()](xref:Yubico.YubiKey.Otp.Operations.CalculateChallengeResponse.UseTouchNotifier%28System.Action%29)

docs/users-manual/application-otp/how-to-program-a-challenge-response-credential.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,8 @@ result). Due to this truncation, it’s important to use the setting that will b
6666
code.
6767

6868
> [!NOTE]
69-
> You can still use challenges smaller than 64 bytes without setting the short challenge mode by simply padding the end
70-
> of the challenge with zeros. Again, it’s important that both sides of the operation agree on the length of the
69+
> You can use challenges smaller than 64 bytes without setting the short challenge mode by padding the end
70+
> of the challenge with zeros. Regardless, both sides of the operation must agree on the length of the
7171
> challenge.
7272
7373
## Requiring touch
@@ -80,11 +80,10 @@ To enable this setting, add
8080
the [UseButton()](xref:Yubico.YubiKey.Otp.Operations.ConfigureChallengeResponse.UseButton(System.Boolean)) method to
8181
your ``ConfigureChallengeResponse()`` operation.
8282

83-
> [!NOTE]
84-
> If a YubiKey has been configured to require a button touch, you must make sure to alert the user of this requirement
85-
> during a challenge-response operation. This can be accomplished by calling
86-
> the [UseTouchNotifier()](xref:Yubico.YubiKey.Otp.Operations.CalculateChallengeResponse.UseTouchNotifier(System.Action))
87-
> method when sending a challenge to a YubiKey via ``CalculateChallengeResponse()``.
83+
If a YubiKey has been configured to require a button touch, you must make sure to alert the user of this requirement
84+
during a challenge-response operation. This can be accomplished by calling
85+
the [UseTouchNotifier()](xref:Yubico.YubiKey.Otp.Operations.CalculateChallengeResponse.UseTouchNotifier(System.Action))
86+
method when sending a challenge to a YubiKey via ``CalculateChallengeResponse()``.
8887

8988
## ConfigureChallengeResponse examples
9089

0 commit comments

Comments
 (0)