Add "hybrid" transport

Author: emlun

NEWS

@@ -27,6 +27,7 @@ New features:
   some JCA providers to accept attestation certificates with critical
   certificate policy extensions. See the JavaDoc for
   `TrustRootsResultBuilder.policyTreeValidator(Predicate)` for more information.
+* (Experimental) Added constant `AuthenticatorTransport.HYBRID`.
 
 Fixes:
 

README

@@ -60,7 +60,8 @@ The library will log warnings if you try to configure it for algorithms with no
 This library uses link:https://semver.org/[semantic versioning].
 The public API consists of all public classes, methods and fields in the `com.yubico.webauthn` package and its subpackages,
 i.e., everything covered by the
-link:https://developers.yubico.com/java-webauthn-server/JavaDoc/webauthn-server-core/2.0.0/com/yubico/webauthn/package-summary.html[Javadoc].
+link:https://developers.yubico.com/java-webauthn-server/JavaDoc/webauthn-server-core/2.0.0/com/yubico/webauthn/package-summary.html[Javadoc],
+*with the exception* of things annotated with `@Deprecated`.
 
 Package-private classes and methods are NOT part of the public API.
 The `com.yubico:yubico-util` module is NOT part of the public API.

webauthn-server-attestation/README.adoc

@@ -109,7 +109,8 @@ compile 'com.yubico:webauthn-server-attestation:2.0.0'
 This library uses link:https://semver.org/[semantic versioning].
 The public API consists of all public classes, methods and fields in the `com.yubico.fido.metadata` package and its subpackages,
 i.e., everything covered by the
-link:https://developers.yubico.com/java-webauthn-server/JavaDoc/webauthn-server-attestation/2.0.0/com/yubico/fido/metadata/package-summary.html[Javadoc].
+link:https://developers.yubico.com/java-webauthn-server/JavaDoc/webauthn-server-attestation/2.0.0/com/yubico/fido/metadata/package-summary.html[Javadoc],
+*with the exception* of things annotated with `@Deprecated`.
 
 Package-private classes and methods are NOT part of the public API.
 The `com.yubico:yubico-util` module is NOT part of the public API.

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

@@ -58,23 +58,54 @@ public class AuthenticatorTransport implements Comparable<AuthenticatorTransport
 
   @JsonValue @NonNull private final String id;
 
-  /** Indicates the respective authenticator can be contacted over removable USB. */
+  /**
+   * Indicates the respective authenticator can be contacted over removable USB.
+   *
+   * @see <a
+   *     href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#dom-authenticatortransport-usb">5.8.4.
+   *     Authenticator Transport Enumeration (enum AuthenticatorTransport)</a>
+   */
   public static final AuthenticatorTransport USB = new AuthenticatorTransport("usb");
 
   /**
    * Indicates the respective authenticator can be contacted over Near Field Communication (NFC).
+   *
+   * @see <a
+   *     href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#dom-authenticatortransport-nfc">5.8.4.
+   *     Authenticator Transport Enumeration (enum AuthenticatorTransport)</a>
    */
   public static final AuthenticatorTransport NFC = new AuthenticatorTransport("nfc");
 
   /**
    * Indicates the respective authenticator can be contacted over Bluetooth Smart (Bluetooth Low
    * Energy / BLE).
+   *
+   * @see <a
+   *     href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#dom-authenticatortransport-ble">5.8.4.
+   *     Authenticator Transport Enumeration (enum AuthenticatorTransport)</a>
    */
   public static final AuthenticatorTransport BLE = new AuthenticatorTransport("ble");
 
+  /**
+   * Indicates the respective authenticator can be contacted using a combination of (often separate)
+   * data-transport and proximity mechanisms. This supports, for example, authentication on a
+   * desktop computer using a smartphone.
+   *
+   * @deprecated EXPERIMENTAL: This feature is from a not yet mature standard; it could change as
+   *     the standard matures.
+   * @see <a href="https://w3c.github.io/webauthn/#dom-authenticatortransport-hybrid">5.8.4.
+   *     Authenticator Transport Enumeration (enum AuthenticatorTransport)</a>
+   */
+  @Deprecated
+  public static final AuthenticatorTransport HYBRID = new AuthenticatorTransport("hybrid");
+
   /**
    * Indicates the respective authenticator is contacted using a client device-specific transport.
    * These authenticators are not removable from the client device.
+   *
+   * @see <a
+   *     href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#dom-authenticatortransport-internal">5.8.4.
+   *     Authenticator Transport Enumeration (enum AuthenticatorTransport)</a>
    */
   public static final AuthenticatorTransport INTERNAL = new AuthenticatorTransport("internal");
 
@@ -83,13 +114,13 @@ public class AuthenticatorTransport implements Comparable<AuthenticatorTransport
    *     this implementation.
    */
   public static AuthenticatorTransport[] values() {
-    return new AuthenticatorTransport[] {USB, NFC, BLE, INTERNAL};
+    return new AuthenticatorTransport[] {USB, NFC, BLE, HYBRID, INTERNAL};
   }
 
   /**
    * @return If <code>id</code> is the same as that of any of {@link #USB}, {@link #NFC}, {@link
-   *     #BLE} or {@link #INTERNAL}, returns that constant instance. Otherwise returns a new
-   *     instance containing <code>id</code>.
+   *     #BLE}, {@link #HYBRID} or {@link #INTERNAL}, returns that constant instance. Otherwise
+   *     returns a new instance containing <code>id</code>.
    * @see #valueOf(String)
    */
   @JsonCreator
@@ -101,8 +132,8 @@ public static AuthenticatorTransport of(@NonNull String id) {
   }
 
   /**
-   * @return If <code>name</code> equals <code>"USB"</code>, <code>"NFC"</code>, <code>"BLE"</code>
-   *     or <code>"INTERNAL"</code>, returns the constant by that name.
+   * @return If <code>name</code> equals <code>"USB"</code>, <code>"NFC"</code>, <code>"BLE"</code>,
+   *     <code>"HYBRID"</code> or <code>"INTERNAL"</code>, returns the constant by that name.
    * @throws IllegalArgumentException if <code>name</code> is anything else.
    * @see #of(String)
    */
@@ -114,6 +145,8 @@ public static AuthenticatorTransport valueOf(String name) {
         return NFC;
       case "BLE":
         return BLE;
+      case "HYBRID":
+        return HYBRID;
       case "INTERNAL":
         return INTERNAL;
       default:

webauthn-server-core/src/test/scala/com/yubico/webauthn/data/AuthenticatorTransportSpec.scala

@@ -48,13 +48,16 @@ class AuthenticatorTransportSpec
       it("BLE.") {
         AuthenticatorTransport.BLE.getId should equal("ble")
       }
+      it("HYBRID.") {
+        AuthenticatorTransport.HYBRID.getId should equal("hybrid")
+      }
       it("INTERNAL.") {
         AuthenticatorTransport.INTERNAL.getId should equal("internal")
       }
     }
 
     it("has a values() function.") {
-      AuthenticatorTransport.values().length should equal(4)
+      AuthenticatorTransport.values().length should equal(5)
       AuthenticatorTransport.values() should not be theSameInstanceAs(
         AuthenticatorTransport.values()
       )
@@ -70,6 +73,9 @@ class AuthenticatorTransportSpec
       AuthenticatorTransport.valueOf(
         "BLE"
       ) should be theSameInstanceAs AuthenticatorTransport.BLE
+      AuthenticatorTransport.valueOf(
+        "HYBRID"
+      ) should be theSameInstanceAs AuthenticatorTransport.HYBRID
       AuthenticatorTransport.valueOf(
         "INTERNAL"
       ) should be theSameInstanceAs AuthenticatorTransport.INTERNAL