WebAuthn-Client

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

Install

npm install webauthn-clt

Documentation

There are two methods in webauthn-client: register and login.

:::info ℹ️ We are currently using axios to fulfill the HTTP request. This may be changed in the future. :::

register

Request the credential options from server, generates the credentials using navigator.credentials.create, and sends back to server.

const registerOptions = {
	REGISTER_URL: '/api/register',                // OPTIONAL: the server path to request the credential options.
	REGISTER_RESP_URL: '/api/register_response',  // OPTIONAL: the server path to verify the authenticator response.
};
const response = await register(name, registerOptions);
if (response) {
	// registered successfully.
}

login

Request assertion from server, signs the assertion with the user credentials, and sends it back to server for verification.

const loginOptions = {
	LOGIN_URL: '/api/login',                // OPTIONAL: the server path to request the assertion.
	LOGIN_RESP_URL: '/api/login_response',  // OPTIONAL: the server path to verify the signature.
};
const response = await login(name, loginOptions);
if (response) {
	// login successfully.
}