JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 11
  • Score
    100M100P100Q48326F
  • License MIT

Module to help access to FIDO Alliance Metadata Service v3.

Package Exports

  • fido-mds3

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (fido-mds3) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

fido-mds3

Node module for FIDO Alliance Metadata Service v3

Description

The FIDO Alliance Metadata Service (MDS) is a centralized repository of the Metadata Statement that is used by the relying parties to validate authenticator attestation and prove the genuineness of the device model.

This module helps to access MDS.

How to work:

  • Download Metadata Service BLOB file from FIDO Alliance site.
  • Verify signature(JWS) with FIDO Alliance root certificate.
  • Find Metadata Statement by an identifier of authenticator(e.g. AAGUID for FIDO2 authenticator).

Detail information about FIDO Alliance Metadata Service is here.

Alternatives

Usage

ESM

import FM3 from 'fido-mds3';

const Client = new FM3.Builder().build();
Client.findByAAGUID('9c835346-796b-4c27-8898-d6032f515cc5').then(data => {
  console.log(data);
});

CommonJS

const FM3 = require('fido-mds3');

const Client = new FM3.Builder().build();
Client.findByAAGUID('9c835346-796b-4c27-8898-d6032f515cc5').then(data => {
  console.log(data);
});
// {
//   aaguid: '9c835346-796b-4c27-8898-d6032f515cc5',
//   metadataStatement: {
//     legalHeader: 'https://fidoalliance.org/metadata/metadata-statement-legal-hea
// der/',
//   aaguid: '9c835346-796b-4c27-8898-d6032f515cc5',
//   description: 'Cryptnox FIDO2',
//   authenticatorVersion: 2,
//   protocolFamily: 'fido2',
//   schema: 3,
//       .
//       .
//       .
//   statusReports: [
//     {
//       status: 'FIDO_CERTIFIED_L1',
//       effectiveDate: '2021-01-02',
//       url: 'www.cryptnox.ch',
//       certificateNumber: 'FIDO20020200803001',
//       certificationPolicyVersion: '1.3.7',
//       certificationRequirementsVersion: '1.3.0'
//     }
//   ],
//   timeOfLastStatusChange: '2021-01-02'
// }

API

Class: Builder

Builder([config])

  • config

build()

  • returns Client

Class: Client

findByAAGUID(aaguid [, refresh])

Find Metadata about FIDO2 authenticator with AAGUID.

  • aaguid string
    • FIDO2 authenticator AAGUID
  • refresh boolean
    • if true force to fetch Metadata BLOB, if false depends on update date
  • returns object MetadataBLOBPayloadEntry

findByAAID(aaid [, refresh])

Find Metadata about FIDO UAF authenticator with AAID.

  • aaid string
    • FIDO UAF authenticator AAID
  • refresh boolean
    • if true force to fetch Metadata BLOB, if false depends on update date
  • returns object MetadataBLOBPayloadEntry

findByAttestationCertificateKeyIdentifier(attestationCertificateKeyIdentifier [, refresh])

Find Metadata about FIDO U2F authenticator with AAID.

  • aaid string
    • FIDO U2F authenticator AAID
  • refresh boolean
    • if true force to fetch Metadata BLOB, if false depends on update date
  • returns object MetadataBLOBPayloadEntry

findMetadata(identifier [, refresh])

Find Metadata about FIDO(FIDO2, FIDO UAF and FIDO U2F) authenticator by identifier(AAGUID, AAID or AttestationCertificateKeyIdentifier).

  • identifier string
    • FIDO authenticator's identifier
  • refresh boolean
    • if true force to fetch Metadata BLOB, if false depends on update date
  • returns object MetadataBLOBPayloadEntry

Install

npm install fido-mds3

Licence

MIT

Author

s1r-J