WebAuthn-Server

This is the server side package of WebAuthn. For full README, go to WebAuthn.

Install

npm install webauthn-server 

Documentation

There are three methods in webauthn-server: register, login, and verify.

register

Generate credential options with given user name. This will be sent to the frontend for generating credentials.

You should save the credentialOpt.challenge and use verify for preventing replay attacks.

const user = {
	name: 'NoobTW', // name is required.
};
const { user, credentialOpt } = register(user);

// saveCarefullyInSession(credentialOpt.challenge);
// sendToFrontend(credentialOpt)

login

Generates assertion given user.authenticators. This will be sent to the frontend for signature.

You should

• save the assertion.challenge and use verify for preventing replay attacks.
• set the Relying Party ID (rpid). It will usually be your domain. Default value is 'localhost'.

const user = await User.find({ name: 'NoobTW' });
console.log(user.authenticators);
const assertion = login(user, { rpId: 'localhost' });

verify

Verify the authentications.

Register

First, it checks if the challenge in the given session and given data are the same. Then it verifies the authenticator attestation response.

It'll return the user's authenticator info (PubKey, credentialId, ...). You should save it for login verification.

const session = { challenge }; // The challenge we just saved to prevent replay attacks. It verifies here.
const data = request.body; // The attestation response sent from the client side.
const result = await verify({
	session,
	data,
});

if (result.staus === 'ok') {
	// saveScarefullyInDatabase(result.authrInfo);
}

Login

First, it checks if the challenge in the given session and given data are the same. Then it verifies the signatures is valid with the given user's authenticator info.

const session = {
	challenge, // The challenge we just saved to prevent replay attaks. It verifies here.
	authenticators, // The user's authenticator info we just saved.
};
const data = request.body; // The signatures sent from the client side.
const result = await verify ({
	session,
	data,
});

if (result.status === 'ok') {
	// Login successfully.
}

Enviroments

You have to set proccess.env.RP_ID as your domain name.

process.env.RP_ID = 'noob.tw';