@simplewebauthn/typescript-types - npm Package Versions

v0.10.4

Packages:

• @simplewebauthn/browser@0.10.4
• @simplewebauthn/server@0.10.4
• @simplewebauthn/typescript-types@0.10.4

Changes:

• [server] Unpin dependency versions
• [server] Upgrade dependencies and devDependencies
• [typescript-types] Pull in TypeScript DOM lib types on build
• [docs] Upgrade TypeDoc for better API docs

v0.10.0 - The one you can use your face with

Packages:

• @simplewebauthn/browser@0.10.0
• @simplewebauthn/server@0.10.0
• @simplewebauthn/typescript-types@0.10.0

Changes:

• [server] Add support for "apple" attestations to support iOS Face ID and Touch ID
• [server] [browser] Enable specifying transports per credential for allowCredentials and excludeCredentials
• [browser] Return authenticator's transports (when available) as transports in response from startAttestation()
• [typescript-types] Add new AuthenticatorAttestationResponseFuture type for better typing of credential response methods (getTransports(), getAuthenticatorData(), etc...)

Breaking Changes

• [server] Existing implementations of generateAttestationOptions() and generateAssertionOptions() must be updated to specify credentials with their own transports:

generateAttestationOptions()

// OLD
const options = generateAttestationOptions({
  excludedCredentialIDs: devices.map((dev) => dev.credentialID),
  suggestedTransports: ['usb', 'ble', 'nfc', 'internal'],
});

// NEW
const options = generateAttestationOptions({
  excludeCredentials: devices.map((dev) => ({
    id: dev.credentialID,
    type: 'public-key',
    transports: dev.transports,
  })),
});

generateAssertionOptions()

// OLD
const options = generateAssertionOptions({
  allowedCredentialIDs: user.devices.map((dev) => dev.credentialID),
  suggestedTransports: ['usb', 'ble', 'nfc', 'internal'],
});

// NEW
const options = generateAssertionOptions({
  allowCredentials: devices.map((dev) => ({
    id: dev.credentialID,
    type: 'public-key',
    transports: dev.transports,
  })),
});

v0.9.0 - The one that knows RSA from EC2

Packages:

• @simplewebauthn/browser@0.9.0
• @simplewebauthn/server@0.9.0
• @simplewebauthn/typescript-types@0.9.0

Changes:

• [server] Add support for attestations and assertions containing RSA public keys.
• [browser] Version sync.
• [typescript-types] Version sync.

Breaking Changes

• [server] authenticatorInfo.base64PublicKey returned by verifyAttestationResponse() is now the entire public key buffer instead of a pared down form of it (it's still returned base64url-encoded). This helps ensure support for existing public keys, as well as future public key formats that may be introduced in the future. Public keys previously returned by this method must be upgraded via this "upgrader" script to work with future assertions.
• [server] The serviceName argument for generateAttestationOptions() has been renamed to rpName. This brings it in line with the existing rpID argument and maps more obviously to its respective property within the returned options.

v0.8.2

Packages:

• @simplewebauthn/browser@0.8.2
• @simplewebauthn/server@0.8.2
• @simplewebauthn/typescript-types@0.8.2

Changes:

• [server] Return explicit defaults for authenticatorSelection in return value from generateAttestationOptions() for enhanced device compatibility.
• [browser] Version sync.
• [typescript-types] Version sync.

v0.8.0 - The one with better challenges

Packages:

• @simplewebauthn/browser@0.8.0
• @simplewebauthn/server@0.8.0
• @simplewebauthn/typescript-types@0.8.0

Changes:

• [server] The challenge parameter of generateAttestationOptions() and generateAssertionOptions() is now optional.
  • When undefined the library will generate a random challenge. This value will be base64url-encoded in preparation for transit to the front end.
  • When defined the value will be directly encoded to base64url in preparation for transit to the front end.
• [browser] startAttestation() and startAssertion() now convert the base64url-encoded options.challenge to a buffer before passing it to the authenticator.

Breaking Changes

• [server] verifyAttestationResponse() and verifyAssertionResponse() now require the base64url-encoded challenge to be passed in as expectedChallenge:

Before:

const challenge = 'someChallenge';

const opts = generateAttestationOptions({
  ...atteOpts,
  challenge,
});

const verification = verifyAttestationResponse({
  ...atteResp,
  // Raw original value
  expectedChallenge: challenge,
});

After:

const challenge = 'someChallenge';

const opts = generateAttestationOptions({
  ...atteOpts,
  // This is now optional
  challenge,
});

const verification = verifyAttestationResponse({
  ...atteResp,
  // Now expected to be the base64url-encoded `challenge` returned
  // by `generateAttestationOptions()`
  expectedChallenge: opts.challenge,
});

v0.7.1

Packages:

• @simplewebauthn/browser@0.7.1
• @simplewebauthn/server@0.7.1
• @simplewebauthn/typescript-types@0.7.1

Changes:

• Fixed broken README and Homepage links in package listings on NPMJS.com

v0.7.0 - The one that passes FIDO conformance testing

Packages:

• @simplewebauthn/browser@0.7.0
• @simplewebauthn/server@0.7.0
• @simplewebauthn/typescript-types@0.7.0

Changes:

• [server] Add support for TPM attestations
• [server] Add support for Android Key attestations
• [server] Add support for authenticator metadata statements and the FIDO Metadata Service (MDS)

Breaking Changes

• [server] The return type of verifyAttestationResponse() changed from boolean to Promise<boolean>. This was necessary to support querying FIDO MDS for an authenticator metadata statement during attestation verification.
• [server] The optional requireUserVerification parameter of verifyAssertionResponse() has been replaced with the new optional fidoUserVerification parameter. This enables greater control over user verification when verifying assertions.

v0.6.0 - The one with better response verification

Packages:

• @simplewebauthn/browser@0.6.0
• @simplewebauthn/server@0.6.0
• @simplewebauthn/typescript-types@0.6.0

Changes:

• [server] (BREAKING) Server's verifyAttestationResponse() and verifyAssertionResponse() methods now take a single arguments object.
• [server] These methods now include the ability to require user verification during attestation and assertion verification via the new requireUserVerification argument.