npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

fido2-js

v1.0.1

Published

Low-level library for parsing and verifying FIDO2 attestation and assertion responses on the server

Downloads

40

Readme

FIDO2.js

fido2-js is a low-level library for parsing and verifying FIDO2 attestation and assertion responses on the server.

Depends on cbor-x, Node.js Buffer and crypto module. Hence, can't run in the browser.

Doesn't provide means of generating requests for the client, but that isn't hard to do on your own anyway.

Example

const { parse, verify } = require('fido2-js');
// or
import { parse, verify } from 'fido2-js';

try {
    // for the returned object to actually be of attestation,
    // client data type must be 'webauthn.create'.
    // it should be also stated that parse method can throw on malformed input
    const parsedAttestation = parse({ ... });

    verify(parsedAttestation, {
        type: 'webauthn.create',
        challenge,
        origins: [origin],
        userFactor: ['verified', 'present'],
    });

    publicKey = parsedAttestation.jwk();

    console.log('assertion succeeded');
} catch (err) {
    console.error('assertion failed', err.message);
}

try {
    // will return the thrown Error object on failure, if any
    verify(
        parse({ ... }),
        {
            type: 'webauthn.get',
            challenge,
            origins: [origin],
            publicKey, // can also pass a jwk or anything that would usually go in node:crypto.verify
            counter: 0,
            userFactor: ['verified', 'present'], // can also just pass 'either'
            userHandle: /* base64 string or some byte array */,
        },
    );

    if (err) {
        console.error('attestation failed', err.message);
    } else {
        console.log('attestation succeeded');
    }
}

Security considerations

This library is not perfect. parse and verify methods are synchronous, opening up a possibility of a DoS attack that may clog Node's event loop. To mitigate that you could try limiting the payload size your server can receive; rate limiting webauthn endpoints, etc.

TODO:

  • Verify attestation formats. Help needed!
  • Support more key types in JWK parser. (Currently only EC, OKP and RSA are supported).

Contributing

Web security is a sensitive topic. This package, unfortunately, cannot be considered to be most progressive at it. If you encounter any bugs or imperfections, don't hesitate to open a GitHub issue.

Also, if you're knowledgeable in FIDO2 protocol, you're invited to audit the code and in case of finding nuances or potential for improvement open a PR. If it is parsing or verification that you're changing, then supply a link to the respective WebAuthn resource according to which you made the change.

License

MIT.