Skip to content

Commit 6c9b2ba

Browse files
committed
Add some missing JavaDocs for extensions
1 parent 169519b commit 6c9b2ba

File tree

3 files changed

+48
-1
lines changed

3 files changed

+48
-1
lines changed

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,16 @@ public Optional<Boolean> getAppid() {
9898
return Optional.ofNullable(appid);
9999
}
100100

101+
/**
102+
* The extension output for the <a
103+
* href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#sctn-large-blob-extension">Large blob
104+
* storage (<code>largeBlob</code>) extension</a>, if any.
105+
*
106+
* @see com.yubico.webauthn.data.Extensions.LargeBlob.LargeBlobRegistrationOutput
107+
* @see <a
108+
* href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#sctn-large-blob-extension">§10.5.Large
109+
* blob storage extension (largeBlob)</a>
110+
*/
101111
public Optional<Extensions.LargeBlob.LargeBlobAuthenticationOutput> getLargeBlob() {
102112
return Optional.ofNullable(largeBlob);
103113
}

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,18 @@ public Set<String> getExtensionIds() {
8787
return ids;
8888
}
8989

90+
/**
91+
* The extension output for the <a
92+
* href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#sctn-appid-exclude-extension">FIDO
93+
* AppID Exclusion (<code>appidExclude</code>) Extension</a>, if any.
94+
*
95+
* <p>This value is generally not useful, as it only communicates whether the client supports the
96+
* extension.
97+
*
98+
* @see <a
99+
* href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#sctn-appid-exclude-extension">§10.2.FIDO
100+
* AppID Exclusion Extension (appidExclude)</a>
101+
*/
90102
public Optional<Boolean> getAppidExclude() {
91103
return Optional.ofNullable(appidExclude);
92104
}

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

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,28 @@
1919
import lombok.experimental.UtilityClass;
2020
import lombok.extern.slf4j.Slf4j;
2121

22+
/** Definitions for WebAuthn extensions. */
2223
@Slf4j
2324
@UtilityClass
2425
public class Extensions {
2526

27+
/**
28+
* Definitions for the FIDO AppID Extension (<code>appid</code>).
29+
*
30+
* @see <a href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#sctn-appid-extension">§10.1.
31+
* FIDO AppID Extension (appid)</a>
32+
*/
2633
public static class Appid {
2734
public static final String EXTENSION_ID = "appid";
2835
}
2936

37+
/**
38+
* Definitions for the 10.2. FIDO AppID Exclusion Extension (<code>appidExclude</code>).
39+
*
40+
* @see <a
41+
* href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#sctn-appid-exclude-extension">10.2.
42+
* FIDO AppID Exclusion Extension (appidExclude)</a>
43+
*/
3044
public static class AppidExclude {
3145
public static final String EXTENSION_ID = "appidExclude";
3246
}
@@ -373,8 +387,19 @@ public Optional<Boolean> getWritten() {
373387
* User Verification Method Extension (uvm)</a>
374388
*/
375389
public static class Uvm {
376-
public static final String EXTENSION_ID = "uvm";
390+
static final String EXTENSION_ID = "uvm";
377391

392+
/**
393+
* A <code>uvmEntry</code> as defined in <a
394+
* href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#sctn-uvm-extension">§10.3. User
395+
* Verification Method Extension (uvm)</a>.
396+
*
397+
* @see <a href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#sctn-uvm-extension">§10.3.
398+
* User Verification Method Extension (uvm)</a>
399+
* @see UserVerificationMethod
400+
* @see KeyProtectionType
401+
* @see MatcherProtectionType
402+
*/
378403
@Value
379404
public static class UvmEntry {
380405
private final UserVerificationMethod userVerificationMethod;

0 commit comments

Comments
 (0)