Skip to content

Conversation

@renovate
Copy link
Contributor

@renovate renovate bot commented Dec 11, 2024

This PR contains the following updates:

Package Change Age Confidence
@simplewebauthn/browser (source) ^10.0.0 -> ^13.0.0 age confidence

Release Notes

MasterKale/SimpleWebAuthn (@​simplewebauthn/browser)

v13.2.2

Compare Source

Changes

v13.2.0

Compare Source

Changes

  • [server] The return value from verifyRegistrationResponse() has been defined more strictly
    to communicate that registrationInfo will only ever be present if verified is true
    (#​715)
  • [server] verifyRegistrationResponse() can now verify attestations containing SHA256 hashes
    by using EC public keys with the P-384 curve
    (#​721)
  • [server] The Android SafetyNet "CTS profile match" system integrity check can now be disabled
    by setting attestationSafetyNetEnforceCTSCheck: false when calling
    verifyRegistrationResponse(). This check remains enforced by default
    (#​722)
  • [browser] [server] These libraries now have better support in Deno 2.2+ projects which use
    generic typing for Uint8Array via TypeScript 5.7.
    SimpleWebAuthn values of type Uint8Array_ are equivalent to Uint8Array in Deno 2.1 and
    earlier, and Uint8Array<ArrayBuffer> in Deno 2.2 and later.
    (#​717)

v13.1.2

Compare Source

Changes

  • [browser] [server] Exported the ResidentKeyRequirement type to help with type inference
    (#​704)

v13.1.0

Compare Source

Changes:

  • [server] The cross-fetch dependency has been removed from the project to silence in the
    console DeprecationWarning's about a "punycode" module
    (#​661)
  • [browser] startRegistration() and startAuthentication() will now warn about calls made
    using the pre-v11 call structure to encourage refactoring to use the current call structure, but
    still try to handle such calls the best they can
    (#​664)

v13.0.0

Compare Source

Hot on the heels of the last major release, v13 introduces support for registration hints! Refined
types and improved attestation trust anchor verification are also included. Last but not least, we
say goodbye to one of the project's packages for better docs and fewer dependencies to install. Read
on for more information, including refactor advice for dealing with the retirement of
@​simplewebauthn/types.

Changes:

  • [server] A new preferredAuthenticatorType argument can be set when calling
    generateRegistrationOptions() to generate options that encourage the browser to direct the user
    to register one of three types of authenticators: 'securityKey', 'localDevice', or
    'remoteDevice' (a.k.a. opinionated
    WebAuthn hints
    support) (#​653)
  • [browser] startRegistration() will recognize hints if specified in optionsJSON
    (#​652)
  • [server] Attestation verification now recognizes intermediate certificates as trust anchors
    (#​650)
  • [browser] [server] The types previously maintained in the types package are now included
    within the browser and server packages. See Breaking Changes below for more info
    (#​655)
Breaking Changes
@​typescript/types is being retired

Its types will now be included directly in @​simplewebauthn/browser and
@​simplewebauthn/server.

To refactor existing imports from /types, simply import them from /browser or /server
instead:

Before:

import type {
  AuthenticationResponseJSON,
  RegistrationResponseJSON,
  WebAuthnCredential,
} from '@&#8203;simplewebauthn/types'; // <--

After:

import type {
  AuthenticationResponseJSON,
  RegistrationResponseJSON,
  WebAuthnCredential,
} from '@&#8203;simplewebauthn/server'; // <--

[server] attestationType no longer accepts 'indirect'

The benefits of indirect attestation are too minimal to be useful for Relying Parties. In practice
it is almost never used over ignoring the concept completely with 'none' or needing to be
intentional and setting 'direct'.

RP's that have been specifying attestationType: 'indirect' when calling
generateRegistrationOptions() will need to refactor their code to either omit
attestationType (generateRegistrationOptions() will default to attestationType: 'none') or set
attestationType: 'direct' instead:

Before:

const options = await generateRegistrationOptions({
  // ...
  attestationType: 'indirect',
});

After:

const options = await generateRegistrationOptions({
  // ...
});

-or-

const options = await generateRegistrationOptions({
  // ...
  attestationType: 'direct',
});

v12.0.0

Compare Source

All SimpleWebAuthn packages are now available for installation from the
JavaScript Registry (JSR)! JSR is an "open-source package registry
for modern JavaScript and TypeScript" - you can read more about this new package registry and its
ESM-centric capabilities here.

All packages in v12.0.0 are functionally identical to v11.0.0! And JSR package hosting is in
addition to
existing package hosting on NPM. Nothing changes about package installation via
npm install. Read on for more information.

Packages
Changes
  • [browser] [server] [types] All packages can now be installed from JSR wherever JSR
    imports are supported (#​634)
  • [browser] Deno projects using frameworks like Fresh can now import and use
    @​simplewebauthn/browser (#​634)

To install from JSR, use npx jsr add @&#8203;simplewebauthn/... or deno add jsr:@&#8203;simplewebauthn/...
depending on which package manager is available.

Projects using npm for package management:
npx jsr add @&#8203;simplewebauthn/browser
npx jsr add @&#8203;simplewebauthn/server
npx jsr add @&#8203;simplewebauthn/types
Projects using deno for package management:
deno add jsr:@&#8203;simplewebauthn/browser
deno add jsr:@&#8203;simplewebauthn/server
deno add jsr:@&#8203;simplewebauthn/types
Projects using HTTPS modules via deno.land/x:

v12.0.0 officially deprecates importing SimpleWebAuthn from deno.land/x. See Breaking Changes
below for refactor guidance.

Breaking Changes

Importing SimpleWebAuthn packages from "https://deno.land/x/simplewebauthn/..." URLs is no longer
supported. Please use Deno's native support for JSR imports instead, available in projects running
Deno v1.42 and higher.

Before:

import { generateAuthenticationOptions } from 'https://deno.land/x/simplewebauthn/deno/server.ts';

After:

import { generateAuthenticationOptions } from 'jsr:@&#8203;simplewebauthn/server';

Alternatively, use deno add to install these packages from
JSR:

v11.0.0

Compare Source

Say hello to support for automatic passkey registration, support for valid conditional UI <input>
elements stashed away in web components, and to the new WebAuthnCredential type that modernizes
some logic within.

There are some breaking changes in this release! Please see Breaking Changes below for refactor
guidance.

Packages
Changes
  • [browser] [server] A new useAutoRegister argument has been added to startRegistration() to
    support attempts to automatically register passkeys for users who just completed non-passkey auth.
    verifyRegistrationResponse() has gained a new requireUserPresence option that can be set to
    false when verifying responses from startRegistration({ useAutoRegister: true, ... })
    (#​623)
  • [browser] A new verifyBrowserAutofillInput argument has been added to
    startAuthentication() to disable throwing an error when a correctly configured <input> element
    cannot be found (but perhaps a valid one is present in a web component shadow's DOM)
    (#​621)
  • [server] [types] The AuthenticatorDevice type has been renamed to WebAuthnCredential and
    has had its properties renamed. The return value out of verifyRegistrationResponse() and
    corresponding inputs into verifyAuthenticationResponse() have been updated accordingly. See
    Breaking Changes below for refactor guidance
    (#​625)
  • [server] verifyRegistrationResponse() now verifies that the authenticator data AAGUID
    matches the leaf cert's id-fido-gen-ce-aaguid extension AAGUID when it is present
    (#​609)
  • [server] TPM attestation verification recognizes the corrected TPM manufacturer identifier for
    IBM (#​610)
  • [server] Types for the defunct authenticator extensions uvm and dpk have been removed
    (#​611)
Breaking Changes
[browser] Positional arguments in startRegistration() and startAuthentication() have been replaced by a single object

Property names in the object match the names of the previously-positional arguments. To update
existing implementations, wrap existing options in an object with corresponding properties:

Before:

startRegistration(options);
startAuthentication(options, true);

After:

startRegistration({ optionsJSON: options });
startAuthentication({ optionsJSON: options, useBrowserAutofill: true });
[server] [types] The AuthenticatorDevice type has been renamed to WebAuthnCredential

AuthenticatorDevice.credentialID and AuthenticatorDevice.credentialPublicKey have been shortened
to WebAuthnCredential.id and WebAuthnCredential.publicKey respectively.

verifyRegistrationResponse() has been updated accordingly to return a new credential value of
type WebAuthnCredential. Update code that stores credentialID, credentialPublicKey, and
counter out of verifyRegistrationResponse() to store credential.id, credential.publicKey,
and credential.counter instead:

Before:

const { registrationInfo } = await verifyRegistrationResponse({...});

storeInDatabase(
  registrationInfo.credentialID,
  registrationInfo.credentialPublicKey,
  registrationInfo.counter,
  body.response.transports,
);

After:

const { registrationInfo } = await verifyRegistrationResponse({...});

storeInDatabase(
  registrationInfo.credential.id,
  registrationInfo.credential.publicKey,
  registrationInfo.credential.counter,
  registrationInfo.credential.transports,
);

Update calls to verifyAuthenticationResponse() to match the new credential argument that
replaces the authenticator argument:

Before:

import { AuthenticatorDevice } from '@&#8203;simplewebauthn/types';

const authenticator: AuthenticatorDevice = {
  credentialID: ...,
  credentialPublicKey: ...,
  counter: 0,
  transports: [...],
};

const verification = await verifyAuthenticationResponse({
  // ...
  authenticator,
});

After:

import { WebAuthnCredential } from '@&#8203;simplewebauthn/types';

const credential: WebAuthnCredential = {
  id: ...,
  publicKey: ...,
  counter: 0,
  transports: [...],
};

const verification = await verifyAuthenticationResponse({
  // ...
  credential,
});

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@github-actions github-actions bot added the chore Hmm... label Dec 11, 2024
@github-actions
Copy link

github-actions bot commented Dec 11, 2024

COMPARE TO master

Total Size Diff 📉 -53 Bytes

Diff by File
Name Diff
packages/experience/package.json 0 Bytes
pnpm-lock.yaml 📉 -53 Bytes

@github-actions
Copy link

This PR is stale because it has been open 10 for days with no activity. Remove stale label or comment or this will be closed in 5 days.

@github-actions github-actions bot added the stale label Feb 11, 2025
@renovate renovate bot force-pushed the renovate/simplewebauthn-browser-13.x branch from 1ce16bb to b00a8ac Compare April 1, 2025 09:26
@github-actions github-actions bot removed the stale label Apr 2, 2025
@renovate renovate bot force-pushed the renovate/simplewebauthn-browser-13.x branch 2 times, most recently from 9c689e9 to 9bb0a07 Compare April 11, 2025 21:13
@github-actions
Copy link

This PR is stale because it has been open for 30 days with no activity.

@github-actions github-actions bot added the stale label May 12, 2025
@github-actions github-actions bot added size/xs and removed size/xs labels Jul 21, 2025
@github-actions github-actions bot removed the stale label Jul 30, 2025
@renovate renovate bot force-pushed the renovate/simplewebauthn-browser-13.x branch from 9bb0a07 to e63e684 Compare August 10, 2025 13:08
@github-actions github-actions bot added size/xs and removed size/xs labels Aug 10, 2025
@renovate renovate bot force-pushed the renovate/simplewebauthn-browser-13.x branch from e63e684 to 64deae3 Compare August 13, 2025 14:04
@github-actions github-actions bot added size/xs and removed size/xs labels Aug 13, 2025
@renovate renovate bot force-pushed the renovate/simplewebauthn-browser-13.x branch from 64deae3 to 2b6bcc5 Compare August 19, 2025 11:46
@github-actions github-actions bot added size/xs and removed size/xs labels Aug 19, 2025
@renovate renovate bot force-pushed the renovate/simplewebauthn-browser-13.x branch from 2b6bcc5 to 47a6ecc Compare August 31, 2025 12:51
@github-actions github-actions bot added size/xs and removed size/xs labels Aug 31, 2025
@renovate renovate bot force-pushed the renovate/simplewebauthn-browser-13.x branch from 47a6ecc to c8a5722 Compare September 15, 2025 03:32
@github-actions github-actions bot added size/xs and removed size/xs labels Sep 15, 2025
@renovate renovate bot force-pushed the renovate/simplewebauthn-browser-13.x branch from c8a5722 to 8277c38 Compare September 25, 2025 16:50
@github-actions github-actions bot added size/xs and removed size/xs labels Sep 25, 2025
@renovate renovate bot force-pushed the renovate/simplewebauthn-browser-13.x branch from 8277c38 to a632af4 Compare October 4, 2025 21:37
@github-actions github-actions bot added size/xs and removed size/xs labels Oct 4, 2025
@renovate renovate bot force-pushed the renovate/simplewebauthn-browser-13.x branch from a632af4 to 4b581e7 Compare October 21, 2025 15:20
@github-actions github-actions bot added size/xs and removed size/xs labels Oct 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Development

Successfully merging this pull request may close these issues.

1 participant