@passlock/client
v0.9.30
Published
Passkey authentication and social login for web apps (Typescript). Framework agnostic
Downloads
554
Maintainers
Readme
Features
Passkeys and the WebAuthn API are quite complex. I've taken an opinionated approach to simplify things for you. Following the 80/20 principle, I've tried to focus on the features most valuable to developers and users.
🔐 Primary or secondary authentication - 2FA or a complete replacement for passwords
🚀 Social login - Supporting Apple & Google. GitHub coming soon..
☝🏻 Biometrics - Frictionless facial or fingerprint recognition for your webapps
🖥️ Management console - Suspend users, disable or revoke passkeys and more..
🕵️ Audit trail - View a full audit trail for each user
🖥️ Dev console - Something not working? check the web console for details
👌 Headless components - You have 100% control over the UI
Screenshots
Usage
Register a passkey
import { Passlock, PasslockError } from '@passlock/client'
// you can find these details in the settings area of your Passlock console
const tenancyId = '...'
const clientId = '...'
const passlock = new Passlock({ tenancyId, clientId })
// to register a new passkey, call registerPasskey(). We're using placeholders for
// the user data. You should grab this from an HTML form, React store, Redux etc.
const [email, givenName, familyName] = ["[email protected]", "John", "Doe"]
// Passlock doesn't throw but instead returns a union: result | error
const result = await passlock.registerPasskey({ email, givenName, familyName })
// ensure we're error free
if (!PasslockError.isError(result)) {
// send the token to your backend (json/fetch or hidden form field etc)
console.log('Token: %s', result.token)
}
Authenticate using a passkey
import { Passlock, PasslockError } from '@passlock/client'
const tenancyId = '...'
const clientId = '...'
const passlock = new Passlock({ tenancyId, clientId })
const result = await passlock.authenticatePasskey()
if (!PasslockError.isError(result)) {
// send the token to your backend for verification
console.log('Token: %s', result.token)
}
Backend verification
Verify the token and obtain the passkey registration or authentication details. You can make a simple GET request to https://api.passlock.dev/{tenancyId}/token/{token}
or use the @passlock/node library:
import { Passlock } from '@passlock/node'
// API Keys can be found in your passlock console
const passlock = new Passlock({ tenancyId, apiKey })
// token comes from your frontend
const principal = await passlock.fetchPrincipal({ token })
// get the user id
console.log(principal.user.id)
More information
Please see the tutorial and documentation