Skip to content

Commit 6eb339a

Browse files
committed
Fix errors in token binding JavaDocs
1 parent 062e660 commit 6eb339a

File tree

3 files changed

+7
-3
lines changed

3 files changed

+7
-3
lines changed

NEWS

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,10 @@ Fixes:
6060
* Added missing JavaDoc for `id` and `name` methods of initial
6161
`RelyingPartyIdentityBuilder` stages.
6262
* Added and improved JavaDoc for required builder methods.
63+
* Javadoc for `TokenBindingInfo.id` incorrectly stated that the value is
64+
base64url encoded.
65+
* Javadoc for `TokenBindingStatus.PRESENT` incorrectly referenced its own
66+
(private) `id` member instead of `TokenBindingInfo.id`.
6367

6468

6569
== Version 1.10.1 ==

webauthn-server-core/src/main/java/com/yubico/webauthn/data/TokenBindingInfo.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ public class TokenBindingInfo {
4646
@NonNull private final TokenBindingStatus status;
4747

4848
/**
49-
* This member MUST be present if {@link #status} is present, and MUST be a base64url encoding of
50-
* the Token Binding ID that was used when communicating with the Relying Party.
49+
* This member MUST be present if {@link #status} is {@link TokenBindingStatus#PRESENT PRESENT},
50+
* and MUST be the Token Binding ID that was used when communicating with the Relying Party.
5151
*/
5252
private final ByteArray id;
5353

webauthn-server-core/src/main/java/com/yubico/webauthn/data/TokenBindingStatus.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ public enum TokenBindingStatus implements JsonStringSerializable {
4848

4949
/**
5050
* Indicates token binding was used when communicating with the Relying Party. In this case, the
51-
* {@link TokenBindingStatus#id} member MUST be present.
51+
* {@link TokenBindingInfo#getId()} member MUST be present.
5252
*/
5353
PRESENT("present"),
5454

0 commit comments

Comments
 (0)