Java WebAuthn Server

https://github.com/yubico/java-webauthn-server
Admin
Server-side Web Authentication library for Java providing implementations of Relying Party...
Tokens:171,616
Snippets:890
Trust Score:9.5
License:BSD-2-Clause
Update:1 day ago
Show doc for...
Tokens:
Raw
### Example output from Set up JDK step

Source: https://github.com/yubico/java-webauthn-server/blob/main/doc/releasing.md

Example output from the 'Set up JDK' step showing the installed Java distribution. Used to determine the Java version for the release-verify-signatures workflow.

```text
Installed distributions
  Resolved Java 25.0.4+7 from tool-cache
  Setting Java 25.0.4+7 as the default
  Creating toolchains.xml for JDK version 25 from temurin
  Writing to /home/runner/.m2/toolchains.xml

  Java configuration:
    Distribution: temurin
    Version: 25.0.4+7
    Path: /opt/hostedtoolcache/Java_Temurin-Hotspot_jdk/25.0.4-7/x64
```

--------------------------------

### Replace StandardMetadataService with FidoMetadataService (1.x example)

Source: https://github.com/yubico/java-webauthn-server/blob/main/webauthn-server-attestation/doc/Migrating_from_v1.adoc

Example of constructing StandardMetadataService in version 1.x. This is the old approach that has been removed in 2.0.

```java
MetadataService metadataService =
    new StandardMetadataService(
        StandardMetadataService.createDefaultAttestationResolver(
            StandardMetadataService.createDefaultTrustResolver()
    ));
```

--------------------------------

### Install text-encoding via Bower

Source: https://github.com/yubico/java-webauthn-server/blob/main/webauthn-server-demo/src/main/webapp/lib/text-encoding-0.7.0/README.md

Install the text-encoding package using Bower for front-end projects.

```js
bower install text-encoding
```

--------------------------------

### Replace StandardMetadataService with FidoMetadataService (2.0 example)

Source: https://github.com/yubico/java-webauthn-server/blob/main/webauthn-server-attestation/doc/Migrating_from_v1.adoc

Example of constructing FidoMetadataService in version 2.0. Uses FidoMetadataDownloader with legal header, trust root cache, and blob cache. Note that FidoMetadataService does not automatically update the BLOB; you may need to periodically re-run loadCachedBlob() or refreshBlob() and reconstruct the service.

```java
FidoMetadataService metadataService = FidoMetadataService.builder()
    .useBlob(FidoMetadataDownloader.builder()
        .expectLegalHeader("Retrieval and use of this BLOB indicates acceptance of the appropriate agreement located at https://fidoalliance.org/metadata/metadata-legal-terms/")
        .useDefaultTrustRoot()
        .useTrustRootCacheFile(new File("fido-mds-trust-root-cache.bin"))
        .useDefaultBlob()
        .useBlobCacheFile(new File("fido-mds-blob-cache.bin"))
        .build()
        .loadCachedBlob()
    )
    .build();
```

--------------------------------

### Retrieve attestation metadata using FidoMetadataService.findEntries (2.0 Java example)

Source: https://github.com/yubico/java-webauthn-server/blob/main/webauthn-server-attestation/doc/Migrating_from_v1.adoc

In 2.0, the attestation metadata is retrieved separately using FidoMetadataService.findEntries after a successful registration. This example shows how to get the authenticator description from the resulting MetadataBLOBPayloadEntry.

```java
FidoMetadataService mds = /* ... */;
RegistrationResult result = rp.finishRegistration(/* ... */);
Optional<String> authenticatorName = mds.findEntries(result)
    .stream()
    .findAny()
    .flatMap(MetadataBLOBPayloadEntry::getMetadataStatement)
    .flatMap(MetadataStatement::getDescription);
```

--------------------------------

### Install text-encoding via npm

Source: https://github.com/yubico/java-webauthn-server/blob/main/webauthn-server-demo/src/main/webapp/lib/text-encoding-0.7.0/README.md

Install the text-encoding package using npm. This is the standard way to add the library to a Node.js project.

```js
npm install text-encoding
```

--------------------------------

### Replace Attestation with MetadataBLOBPayloadEntry in front-end (1.x diff)

Source: https://github.com/yubico/java-webauthn-server/blob/main/webauthn-server-attestation/doc/Migrating_from_v1.adoc

Shows the 1.x front-end code that accesses the attestation metadata's deviceProperties to get the authenticator description.

```diff
 var registrationResult = fetch(/* ... */).then(response => response.json());
-var authenticatorName = registrationResult.attestationMetadata?.deviceProperties?.description;
```

--------------------------------

### Retrieve attestation metadata from RegistrationResult (1.x Java example)

Source: https://github.com/yubico/java-webauthn-server/blob/main/webauthn-server-attestation/doc/Migrating_from_v1.adoc

In 1.x, RegistrationResult could include an Attestation object with attestation metadata. This example shows how to extract the authenticator description from the attestation metadata using getAttestationMetadata and getDeviceProperties.

```java
RegistrationResult result = rp.finishRegistration(/* ... */);
Optional<String> authenticatorName = result.getAttestationMetadata()
  .flatMap(Attestation::getDeviceProperties)
  .map(deviceProps -> deviceProps.get("description"));
```

--------------------------------

### JReleaser configuration properties for publishing

Source: https://github.com/yubico/java-webauthn-server/blob/main/doc/development.md

Example configuration for $HOME/.jreleaser/config.properties. The username and password values are meaningless random data, not real secrets. JRELEASER_GITHUB_TOKEN is required but its value does not need to be valid.

```properties
JRELEASER_MAVENCENTRAL_USERNAME=PYgw7b
JRELEASER_MAVENCENTRAL_PASSWORD=QxExuJ0wwfBzbXVOsaSTUTBkXH8Fa2dFo
JRELEASER_GPG_KEYNAME=2D6753CFF0B0FB32F9EEBA485B9688125FF0B636
JRELEASER_MAVENCENTRAL_STAGE=FULL
JRELEASER_GITHUB_TOKEN=nope
```

--------------------------------

### Add Bouncy Castle security provider

Source: https://github.com/yubico/java-webauthn-server/blob/main/doc/Migrating_from_v1.adoc

Required setup before instantiating RelyingParty. Adds the BouncyCastleProvider to the JVM security providers.

```java
import org.bouncycastle.jce.provider.BouncyCastleProvider;

Security.addProvider(new BouncyCastleProvider());
```

--------------------------------

### Replace Attestation with MetadataBLOBPayloadEntry in front-end (2.0 diff)

Source: https://github.com/yubico/java-webauthn-server/blob/main/webauthn-server-attestation/doc/Migrating_from_v1.adoc

Shows the 2.0 front-end code that accesses the attestation metadata's metadataStatement to get the authenticator description, reflecting the change from Attestation to MetadataBLOBPayloadEntry.

```diff
 var registrationResult = fetch(/* ... */).then(response => response.json());
+var authenticatorName = registrationResult.attestationMetadata?.metadataStatement?.description;
```

--------------------------------

### Run tests with Gradle

Source: https://github.com/yubico/java-webauthn-server/blob/main/doc/releasing.md

Runs the full test suite and checks using Gradle. This is step 3 of the release procedure.

```bash
$ ./gradlew clean check
```

--------------------------------

### Create release branch and merge main

Source: https://github.com/yubico/java-webauthn-server/blob/main/doc/releasing.md

Creates a release branch from the previous release tag and merges main with --no-ff.

```bash
$ git checkout 1.3.0
$ git checkout -b release-1.4.0
$ git merge --no-ff main
```

--------------------------------

### Build FidoMetadataDownloader and FidoMetadataService

Source: https://github.com/yubico/java-webauthn-server/blob/main/webauthn-server-attestation/README.adoc

Constructs a FidoMetadataDownloader with a legal header, default trust root and blob, cache files, and verifyDownloadsOnly(true). Then builds a FidoMetadataService using the downloaded blob. Note: FidoMetadataDownloader is not thread safe; ensure only one loadCachedBlob() or refreshBlob() call at a time.

```java
FidoMetadataDownloader downloader = FidoMetadataDownloader.builder()
  .expectLegalHeader("Lorem ipsum dolor sit amet")
  .useDefaultTrustRoot()
  .useTrustRootCacheFile(new File("/var/cache/webauthn-server/fido-mds-trust-root.bin"))
  .useDefaultBlob()
  .useBlobCacheFile(new File("/var/cache/webauthn-server/fido-mds-blob.bin"))
  .verifyDownloadsOnly(true)  // Recommended, otherwise cache may expire if BLOB certificate expires
                              // See: https://github.com/Yubico/java-webauthn-server/issues/294
  .build();

FidoMetadataService mds = FidoMetadataService.builder()
  .useBlob(downloader.loadCachedBlob())
  .build();
```

--------------------------------

### Verify artifact checksums

Source: https://github.com/yubico/java-webauthn-server/blob/main/doc/releasing.md

Builds the primary JAR and verifies the checksums against the downloaded artifact. Uses the VERSION environment variable.

```bash
$ VERSION=0.1.0-SNAPSHOT ./gradlew primaryPublishJar
$ sha256sum -c java-webauthn-server-artifacts-25-temurin.sha256sum
```

--------------------------------

### Push to main directly

Source: https://github.com/yubico/java-webauthn-server/blob/main/doc/releasing.md

Pushes changes directly to main when the README still reflects the latest non-pre-release version.

```bash
$ git push origin main
```

--------------------------------

### Publish to Sonatype Maven Central

Source: https://github.com/yubico/java-webauthn-server/blob/main/doc/releasing.md

Publishes the project to Sonatype Maven Central Portal using Gradle and jreleaser.

```bash
$ ./gradlew publish jreleaserDeploy
```

--------------------------------

### Create and push release branch

Source: https://github.com/yubico/java-webauthn-server/blob/main/doc/releasing.md

Creates a release branch and pushes it to GitHub. Used when the README needs updating for the pre-release.

```bash
$ git checkout -b release-1.4.0
$ git push origin release-1.4.0
```

--------------------------------

### Rename imports from com.yubico.fido.metadata to com.yubico.webauthn.extension.uvm

Source: https://github.com/yubico/java-webauthn-server/blob/main/doc/Migrating_from_v1.adoc

Shows the diff for updating imports of KeyProtectionType, MatcherProtectionType, and UserVerificationMethod to the new package to avoid split package name clash in JPMS.

```diff
-import com.yubico.fido.metadata.KeyProtectionType;
-import com.yubico.fido.metadata.MatcherProtectionType;
-import com.yubico.fido.metadata.UserVerificationMethod;
+import com.yubico.webauthn.extension.uvm.KeyProtectionType;
+import com.yubico.webauthn.extension.uvm.MatcherProtectionType;
+import com.yubico.webauthn.extension.uvm.UserVerificationMethod;

```

--------------------------------

### Streaming decode with TextDecoder

Source: https://github.com/yubico/java-webauthn-server/blob/main/webauthn-server-demo/src/main/webapp/lib/text-encoding-0.7.0/README.md

Demonstrates how to decode a stream of chunks using the TextDecoder with the stream option, and then finish the stream.

```js
  var string = "", decoder = new TextDecoder(encoding), buffer;
  while (buffer = next_chunk()) {
    string += decoder.decode(buffer, {stream:true});
  }
  string += decoder.decode(); // finish the stream
```

--------------------------------

### Update release-verify-signatures workflow

Source: https://github.com/yubico/java-webauthn-server/blob/main/doc/releasing.md

YAML snippet showing how to update the Java version in the release-verify-signatures workflow based on the JDK output.

```yaml
strategy:
  matrix:
    java: ["25.0.4"]
```

--------------------------------

### Tag release candidate

Source: https://github.com/yubico/java-webauthn-server/blob/main/doc/releasing.md

Creates an annotated, signed tag for a release candidate.

```bash
$ git tag -a -s 1.4.0-RC1 -m "Pre-release 1.4.0-RC1"
```

--------------------------------

### Push release tag

Source: https://github.com/yubico/java-webauthn-server/blob/main/doc/releasing.md

Pushes the release tag to GitHub.

```bash
$ git push origin 1.4.0-RC1
```

--------------------------------

### Push tag to GitHub

Source: https://github.com/yubico/java-webauthn-server/blob/main/doc/releasing.md

Pushes the release tag to the remote repository.

```bash
$ git push origin 1.4.0
```

--------------------------------

### Basic usage of TextEncoder and TextDecoder

Source: https://github.com/yubico/java-webauthn-server/blob/main/webauthn-server-demo/src/main/webapp/lib/text-encoding-0.7.0/README.md

Shows how to encode a string to a Uint8Array and decode a Uint8Array back to a string using the TextEncoder and TextDecoder APIs.

```js
  var uint8array = new TextEncoder().encode(string);
  var string = new TextDecoder(encoding).decode(uint8array);
```

--------------------------------

### Configure RelyingParty with attestation trust source

Source: https://github.com/yubico/java-webauthn-server/blob/main/webauthn-server-attestation/README.adoc

Sets the FidoMetadataService as the attestationTrustSource, requests direct attestation conveyance, and optionally allows untrusted attestation (default true).

```java
RelyingParty rp = RelyingParty.builder()
  .identity(/* ... */)
  .credentialRepository(/* ... */)
  .attestationTrustSource(mds)
  .attestationConveyancePreference(AttestationConveyancePreference.DIRECT)
  .allowUntrustedAttestation(true) // Optional step: set to true (default) or false
  .build();
```

--------------------------------

### Replace requireResidentKey(false) with residentKey(ResidentKeyRequirement.DISCOURAGED)

Source: https://github.com/yubico/java-webauthn-server/blob/main/doc/Migrating_from_v1.adoc

Shows the diff for replacing requireResidentKey(false) with residentKey(ResidentKeyRequirement.DISCOURAGED) in AuthenticatorSelectionCriteria builder.

```diff
 RelyingParty rp = /* ... */;
 PublicKeyCredentialCreationOptions pkcco = rp.startRegistration(
   StartRegistrationOptions
     .builder()
     .user(userId)
     .authenticatorSelection(
       AuthenticatorSelectionCriteria
         .builder()
-        .requireResidentKey(false)
+        .residentKey(ResidentKeyRequirement.DISCOURAGED)
         .build()
     )
     .build()
 );

```

--------------------------------

### Add webauthn-server-attestation dependency

Source: https://github.com/yubico/java-webauthn-server/blob/main/webauthn-server-attestation/README.adoc

Gradle dependency declaration for the webauthn-server-attestation module version 2.10.1.

```groovy
implementation("com.yubico:webauthn-server-attestation:2.10.1")
```

--------------------------------

### Remove getWarnings() calls

Source: https://github.com/yubico/java-webauthn-server/blob/main/doc/Migrating_from_v1.adoc

The getWarnings() methods are now always empty; warnings are logged via SLF4J. The diff shows the loops to delete.

```diff
 RelyingParty rp = /* ... */;

 RegistrationResult result = rp.finishRegistration(/* ... */);
-for (String warning : result.getWarnings()) {
-    // Do something...
-}

 AssertionResult result = rp.finishAssertion(/* ... */);
-for (String warning : result.getWarnings()) {
-    // Do something...
-}
```

--------------------------------

### Replace metadataService with attestationTrustSource in RelyingParty builder (1.x to 2.0 diff)

Source: https://github.com/yubico/java-webauthn-server/blob/main/webauthn-server-attestation/doc/Migrating_from_v1.adoc

Shows the change from the deprecated metadataService method to the new attestationTrustSource method in the RelyingParty builder. The 1.x code uses metadataService and allowUntrustedAttestation(true), while the 2.0 code replaces metadataService with attestationTrustSource(metadataService).

```diff
 RelyingParty rp = RelyingParty.builder()
     .identity(rpIdentity)
     .credentialRepository(credentialRepo)
     .attestationConveyancePreference(AttestationConveyancePreference.DIRECT)
-    .metadataService(metadataService))
     .allowUntrustedAttestation(true)
     .build();
```

```diff
 RelyingParty rp = RelyingParty.builder()
     .identity(rpIdentity)
     .credentialRepository(credentialRepo)
     .attestationConveyancePreference(AttestationConveyancePreference.DIRECT)
+    .attestationTrustSource(metadataService)
     .allowUntrustedAttestation(true)
     .build();
```

--------------------------------

### Update getter usage for Optional return types

Source: https://github.com/yubico/java-webauthn-server/blob/main/doc/Migrating_from_v1.adoc

The getters for userVerification and residentKey now return Optional values. Use flatMap instead of map on the Optional returned by getAuthenticatorSelectionCriteria, and compare with Optional.of instead of direct equality.

```diff
 PublicKeyCredentialCreationOptions pkcco = /* ... */;
 if (pkcco
         .getAuthenticatorSelectionCriteria()
-        .map(AuthenticatorSelectionCriteria::getUserVerification)
+        .flatMap(AuthenticatorSelectionCriteria::getUserVerification)
         .equals(Optional.of(UserVerificationRequirement.REQUIRED))) {
     // Do something...
 }
 if (pkcco
         .getAuthenticatorSelectionCriteria()
-        .map(AuthenticatorSelectionCriteria::getResidentKey)
+        .flatMap(AuthenticatorSelectionCriteria::getResidentKey)
         .equals(Optional.of(ResidentKeyRequirement.REQUIRED))) {
     // Do something...
 }

 PublicKeyCredentialRequestOptions pkcro = /* ... */;
 if (pkcro
         .getUserVerification()
-        == UserVerificationRequirement.REQUIRED)) {
+        .equals(Optional.of(UserVerificationRequirement.REQUIRED))) {
     // Do something...
 }

```

--------------------------------

### Retrieve authenticator metadata with FidoMetadataService.findEntries()

Source: https://github.com/yubico/java-webauthn-server/blob/main/webauthn-server-attestation/README.adoc

Use this snippet to retrieve additional authenticator metadata for new registrations. The findEntries method returns a set of MetadataBLOBPayloadEntry objects that can be used for further processing.

```java
RelyingParty rp = /* ... */;
RegistrationResult result = rp.finishRegistration(/* ... */);

Set<MetadataBLOBPayloadEntry> metadata = mds.findEntries(result);
```

--------------------------------

### Tag the merge commit

Source: https://github.com/yubico/java-webauthn-server/blob/main/doc/releasing.md

Creates an annotated, signed tag for the release version.

```bash
$ git tag -a -s 1.4.0 -m "Release 1.4.0"
```

--------------------------------

### Replace requireResidentKey(true) with residentKey(ResidentKeyRequirement.REQUIRED)

Source: https://github.com/yubico/java-webauthn-server/blob/main/doc/Migrating_from_v1.adoc

Shows the diff for replacing requireResidentKey(true) with residentKey(ResidentKeyRequirement.REQUIRED) in AuthenticatorSelectionCriteria builder.

```diff
 RelyingParty rp = /* ... */;
 PublicKeyCredentialCreationOptions pkcco = rp.startRegistration(
   StartRegistrationOptions
     .builder()
     .user(userId)
     .authenticatorSelection(
       AuthenticatorSelectionCriteria
         .builder()
-        .requireResidentKey(true)
+        .residentKey(ResidentKeyRequirement.REQUIRED)
         .build()
     )
     .build()
 );

```

--------------------------------

### Check attestation trust with RegistrationResult.isAttestationTrusted()

Source: https://github.com/yubico/java-webauthn-server/blob/main/webauthn-server-attestation/README.adoc

Use this snippet after completing a registration to determine whether the authenticator's attestation statement was verified by trusted attestation certificates from the FIDO Metadata Service. The result is a boolean indicating trust, allowing you to branch your logic accordingly.

```java
RelyingParty rp = /* ... */;
RegistrationResult result = rp.finishRegistration(/* ... */);

if (result.isAttestationTrusted()) {
  // Do something...
} else {
  // Do something else...
}
```

--------------------------------

### Gradle dependency for webauthn-server-attestation

Source: https://github.com/yubico/java-webauthn-server/blob/main/webauthn-server-attestation/README.adoc

Add the webauthn-server-attestation module as a dependency in your Gradle build. Use version 2.10.1.

```groovy
implementation 'com.yubico:webauthn-server-attestation:2.10.1'
```

--------------------------------

### Force polyfill usage by nullifying native TextEncoder

Source: https://github.com/yubico/java-webauthn-server/blob/main/webauthn-server-demo/src/main/webapp/lib/text-encoding-0.7.0/README.md

Sets window.TextEncoder and window.TextDecoder to null before loading the polyfill to ensure the polyfill is used instead of native implementations.

```html
<script>
window.TextEncoder = window.TextDecoder = null;
</script>
```

--------------------------------

### HTML page usage for text-encoding

Source: https://github.com/yubico/java-webauthn-server/blob/main/webauthn-server-demo/src/main/webapp/lib/text-encoding-0.7.0/README.md

Include the encoding-indexes.js and encoding.js scripts in an HTML page. The encoding-indexes.js file is required for non-UTF encodings.

```html
  <!-- Required for non-UTF encodings -->
  <script src="encoding-indexes.js"></script>
  <script src="encoding.js"></script>
```

--------------------------------

### Gradle dependency change from webauthn-server-core-minimal to webauthn-server-core

Source: https://github.com/yubico/java-webauthn-server/blob/main/doc/Migrating_from_v1.adoc

Update the Gradle dependency to replace webauthn-server-core-minimal with webauthn-server-core and version 2.4.0-RC2. This is required for migration to v2.0.

```diff
-compile 'com.yubico:webauthn-server-core-minimal:1.12.2'
+compile 'com.yubico:webauthn-server-core:2.4.0-RC2'
```

--------------------------------

### Remove allowUnrequestedExtensions setting

Source: https://github.com/yubico/java-webauthn-server/blob/main/doc/Migrating_from_v1.adoc

The setting is removed and now always enabled. The diff shows the line to delete from the RelyingParty builder.

```diff
 RelyingParty rp = RelyingParty
     .builder()
     .identity(rpIdentity)
     .credentialRepository(credentialRepo)
-    .allowUnrequestedExtensions(true)
     .build()
```

--------------------------------

### Non-standard legacy encoding with TextEncoder

Source: https://github.com/yubico/java-webauthn-server/blob/main/webauthn-server-demo/src/main/webapp/lib/text-encoding-0.7.0/README.md

Shows how to force non-standard legacy encoding by passing the NONSTANDARD_allowLegacyEncoding option to TextEncoder. Note this won't work if the browser natively supports TextEncoder.

```js
var uint8array = new TextEncoder(
  'windows-1252', { NONSTANDARD_allowLegacyEncoding: true }).encode(text);
```

--------------------------------

### Maven dependency change from webauthn-server-core-minimal to webauthn-server-core

Source: https://github.com/yubico/java-webauthn-server/blob/main/doc/Migrating_from_v1.adoc

Update the Maven dependency to replace webauthn-server-core-minimal with webauthn-server-core and version 2.4.0-RC2. This is required for migration to v2.0.

```diff
 <dependency>
   <groupId>com.yubico</groupId>
-  <artifactId>webauthn-server-core-minimal</artifactId>
-  <version>1.12.2</version>
+  <artifactId>webauthn-server-core</artifactId>
+  <version>2.4.0-RC2</version>
   <scope>compile</scope>
 </dependency>
```

--------------------------------

### Maven dependency for webauthn-server-attestation

Source: https://github.com/yubico/java-webauthn-server/blob/main/webauthn-server-attestation/README.adoc

Add the webauthn-server-attestation module as a compile-scoped dependency in your Maven project. Use version 2.10.1.

```xml
<dependency>
  <groupId>com.yubico</groupId>
  <artifactId>webauthn-server-attestation</artifactId>
  <version>2.10.1</version>
  <scope>compile</scope>
</dependency>
```

--------------------------------

### Merge release branch back to main

Source: https://github.com/yubico/java-webauthn-server/blob/main/doc/releasing.md

Merges the release branch back to main with --ff-only and deletes the branch.

```bash
$ git checkout main
$ git merge --ff-only release-1.4.0
$ git branch -d release-1.4.0
```

--------------------------------

### TextEncoder.encode()

Source: https://github.com/yubico/java-webauthn-server/blob/main/webauthn-server-demo/src/main/webapp/lib/text-encoding-0.7.0/README.md

Encodes a string into a Uint8Array using the specified encoding (default utf-8). Supports an optional dictionary with a stream option for legacy encodings.

```APIDOC
## TextEncoder.encode()

### Description
Encodes a string into a Uint8Array using the specified encoding (default utf-8). Supports an optional dictionary with a stream option for legacy encodings.

### Method
encode

### Parameters
- **string** (string) - Required - The string to encode.
- **options** (object) - Optional - Dictionary with `stream` option for legacy encodings.

### Request Example
```js
var uint8array = new TextEncoder().encode(string);
```

### Response
#### Success Response
- **Uint8Array** - The encoded binary data.

#### Response Example
```js
Uint8Array [ 104, 101, 108, 108, 111 ]
```
```

--------------------------------

### TextEncoder with NONSTANDARD_allowLegacyEncoding

Source: https://github.com/yubico/java-webauthn-server/blob/main/webauthn-server-demo/src/main/webapp/lib/text-encoding-0.7.0/README.md

Non-standard behavior to allow encoding to legacy encodings by passing the `NONSTANDARD_allowLegacyEncoding` option to TextEncoder.

```APIDOC
## TextEncoder with NONSTANDARD_allowLegacyEncoding

### Description
Non-standard behavior to allow encoding to legacy encodings by passing the `NONSTANDARD_allowLegacyEncoding` option to TextEncoder.

### Method
encode

### Parameters
- **label** (string) - Required - The encoding label (e.g., 'windows-1252').
- **options** (object) - Required - Dictionary with `NONSTANDARD_allowLegacyEncoding: true`.

### Request Example
```js
var uint8array = new TextEncoder(
  'windows-1252', { NONSTANDARD_allowLegacyEncoding: true }).encode(text);
```

### Response
#### Success Response
- **Uint8Array** - The encoded binary data.

#### Response Example
```js
Uint8Array [ ... ]
```
```

--------------------------------

### Gradle dependency for BouncyCastle JCA provider

Source: https://github.com/yubico/java-webauthn-server/blob/main/doc/Migrating_from_v1.adoc

Add the BouncyCastle JCA provider dependency for EdDSA support on JRE 14 and earlier. This is needed because the library no longer depends on BouncyCastle explicitly.

```groovy
implementation 'org.bouncycastle:bcprov-jdk15on:1.70'
```

--------------------------------

### TextDecoder.decode()

Source: https://github.com/yubico/java-webauthn-server/blob/main/webauthn-server-demo/src/main/webapp/lib/text-encoding-0.7.0/README.md

Decodes a Uint8Array into a string using the specified encoding. Supports streaming decode with the `stream` option.

```APIDOC
## TextDecoder.decode()

### Description
Decodes a Uint8Array into a string using the specified encoding. Supports streaming decode with the `stream` option.

### Method
decode

### Parameters
- **buffer** (Uint8Array) - Required - The binary data to decode.
- **options** (object) - Optional - Dictionary with `stream` option for streaming decode.

### Request Example
```js
var string = new TextDecoder(encoding).decode(uint8array);
```

### Response
#### Success Response
- **string** - The decoded string.

#### Response Example
```js
"hello"
```
```

--------------------------------

### Maven dependency for BouncyCastle JCA provider

Source: https://github.com/yubico/java-webauthn-server/blob/main/doc/Migrating_from_v1.adoc

Add the BouncyCastle JCA provider dependency for EdDSA support on JRE 14 and earlier. This is needed because the library no longer depends on BouncyCastle explicitly.

```xml
<dependency>
    <groupId>org.bouncycastle</groupId>
    <artifactId>bcprov-jdk15on</artifactId>
    <version>1.70</version>
    <scope>compile</scope>
</dependency>
```

--------------------------------

### Amend changes into merge commit

Source: https://github.com/yubico/java-webauthn-server/blob/main/doc/releasing.md

Stages the files that need version updates and amends the merge commit, resetting the author.

```bash
$ git add NEWS README */README .github/workflows/release-verify-signatures.yml
$ git commit --amend --reset-author
```

--------------------------------

### Remove icon field from RelyingPartyIdentity and UserIdentity

Source: https://github.com/yubico/java-webauthn-server/blob/main/doc/Migrating_from_v1.adoc

The icon field was removed in WebAuthn Level 2 and has no replacement. The diff shows the lines to delete.

```diff
 RelyingPartyIdentity rpIdentity = RelyingPartyIdentity.builder()
     .id("example.org")
     .name("Example Service")
-    .icon(new URL("https://example.org/favicon.ico"))
     .build();

 UserIdentity userIdentity = UserIdentity.builder()
     .name("test@example.org")
     .displayName("Test User")
     .id(new ByteArray(new byte[] { 1, 2, 3, 4 }))
-    .icon(new URL("https://example.org/user.png"))
     .build();
```

--------------------------------

### Remove AttestationType.ECDAA case

Source: https://github.com/yubico/java-webauthn-server/blob/main/doc/Migrating_from_v1.adoc

The ECDAA attestation type was removed from WebAuthn Level 2 and could never be returned. The diff shows the case to delete from the switch statement.

```diff
 RelyingParty rp = /* ... */;
 RegistrationResult result = rp.finishRegistration(/* ... */);
 switch (result.getAttestationType()) {
-    case ECDAA:
-        // Do something...
-        break;
-
     default:
         // Do something else...
         break;
 }
```
Tokens:
Raw