@turnkey/react-native-passkey-stamper
TypeScript icon, indicating that this package has built-in type declarations

1.0.19 • Public • Published

@turnkey/react-native-passkey-stamper

npm

This package contains a React Native passkey stamper. It uses react-native-passkey to do the heavy lifting. This stamper is meant to be used with @turnkey/http

Installation

  • Install both react-native-passkey and @turnkey/react-native-passkey-stamper (this package) in your React Native project.
  • Set up provisioning correctly to make sure your app is signed (needed for passkey functionality)
  • Serve an apple-app-site-association file from your domain to reference your application. See more details here
  • Add a new "Associated Domains" capability for web credentials (webcredentials:your.site.com)

Usage

Create a new passkey

import { createPasskey } from "@turnkey/react-native-passkey-stamper";
import { v4 as uuidv4 } from "uuid";

// Returns authenticator params that can be used with sub-org creation, user creation, etc.
const authenticatorParams = await createPasskey({
  // Won't be visible to users, this is the name of the Turnkey resource
  authenticatorName: "End-User Passkey",
  rp: {
    id: "your.site.com",
    name: "Your App",
  },
  user: {
    // This ID isn't visible to users
    // NOTE: For Android, this must be a valid base64-encoded string
    id: uuidv4(),
    // ...but name and display names are. This is what's shown in the passkey prompt
    name: "Some Name",
    // displayName should be the same as "name"
    displayName: "Some Name",
  },
});

Use an existing passkey

import { PasskeyStamper } from "@turnkey/react-native-passkey-stamper";
import { TurnkeyClient } from "@turnkey/http";

const stamper = new PasskeyStamper({
  rpId: "your.site.com",
});

// New HTTP client able to sign with passkeys!
const httpClient = new TurnkeyClient(
  { baseUrl: "https://api.turnkey.com" },
  stamper
);

// Now, send authenticated requests
httpClient.signTransaction(...)

Demo app

Head over to this repository for a fully functional React Native app built with Expo.

Versions

Current Tags

VersionDownloads (Last 7 Days)Tag
1.0.191,694latest

Version History

VersionDownloads (Last 7 Days)Published
1.0.191,694
1.0.18282
1.0.172,099
1.0.16455
1.0.1530,265
1.0.14220
1.0.136
1.0.1229
1.0.113
1.0.10427
1.0.911
1.0.81
1.0.70
1.0.60
1.0.50
1.0.40
1.0.30
1.0.21
1.0.135
1.0.0193
0.2.160
0.2.15271
0.2.140
0.2.130
0.2.120
0.2.110
0.2.100
0.2.90
0.2.80
0.2.70
0.2.60
0.2.52
0.2.40
0.2.30
0.2.20
0.2.10
0.2.00
0.1.00

Package Sidebar

Install

npm i @turnkey/react-native-passkey-stamper

Weekly Downloads

35,994

Version

1.0.19

License

Apache-2.0

Unpacked Size

55.1 kB

Total Files

17

Last publish

Collaborators

  • omkar_turnkey
  • andrewtk
  • tdawson
  • moe-dev
  • zanetk
  • r-n-o
  • jack-kearney-tkhq
  • bcturnkey