@ngx-firebase-web-authn/functions
v15.7.1
Published
An unofficial AngularFire extension for authentication with WebAuthn passkeys.
Downloads
31
Readme
@ngx-firebase-web-authn/functions
An unofficial AngularFire extension for authentication with WebAuthn passkeys.
Deprecated: This project is now FirebaseWebAuthn version 9.
This package contains a Firebase Function used to facilitate registering, authenticating, reauthenticating WebAuthn passkeys, and clearing data if the user cancels the process or unlinks a passkey.
Public keys are stored in the webAuthnUsers
collection in Firestore. Setup doesn't require you to modify any Firestore rules. Your app should use a separate users
/profiles
collection to store user information.
Deployment
From your Firebase Functions package root, run:
% npm install @ngx-firebase-web-authn/functions --save
Re-export the function from your functions/index.ts
file.
import { initializeApp } from 'firebase-admin/app';
initializeApp();
export { ngxFirebaseWebAuthn } from '@ngx-firebase-web-authn/functions';
// Other functions...
Deploy your Firebase Functions:
% firebase deploy --only functions
Usage
For the browser to reach ngxFirebaseWebAuthn, modify your firebase.json
to include a rewrite on each app where you'd like to use passkeys.
{
"hosting": [
{
"target": "...",
"rewrites": [
{
"source": "/ngxFirebaseWebAuthn",
"function": "ngxFirebaseWebAuthn"
}
]
}
]
}
Google Cloud setup
- Enable the Anonymous authentication provider in Firebase if you are not using it already.
- Add the
Service Account Token Creator
role to your Firebase Functions' service account in GCP IAM project permissions. This is either theDefault compute service account
or theApp Engine default service account
, and can be seen under "Runtime service account" in GCP Cloud Function configuration after deployment.