ns-auth-sdk 1.2.4 → 1.2.6

package/README.md

@@ -1,9 +1,23 @@
-# NS Auth SSO
+# NS Auth SDK
+
+Decentralized SSO - Authentication, membership, and profile management.
+
+NSAuth enables client-side managing of private-keys with WebAuthn passkeys (FIDO2 credentials). By leveraging passkeys, users avoid traditional private‑key backups and password hassles, relying instead on biometric or device‑based authentication. The keys are compatible with common blockchains like Bitcoin and Ethereum and data is stored as events on public relays and can be encrypted.
+
+Two Approaches
+PRF Direct Method – Derive the private key directly from the PRF value produced by a passkey. Encryption Method – Encrypt an existing private key with a key derived from the passkey’s PRF output. WebAuthn PRF Extension The PRF (Pseudo‑Random Function) extension, part of WebAuthn Level 3, yields deterministic 32‑byte high‑entropy values from an authenticator’s internal private key and a supplied salt. The same credential ID and salt always generate the same PRF output, which never leaves the device except during authentication.
+
+Using PRF Values as Private Keys
+A 32‑byte PRF output can serve as a private key if it falls within the secp256k1 range (1 ≤ value < n). The chance of falling outside this range is astronomically low (~2⁻²²⁴), so explicit range checks are generally unnecessary.
+
+Restoration Steps
+Install the client on a new device. Fetch the latest kind 30100 event for the target public key. Extract the PWKBlob and decrypt it with the passkey’s PRF value. Use the recovered private key for signing. Multiple passkeys can each have their own PWKBlob, allowing redundancy across devices.
 
-SSO library for NS Auth - Authentication, membership, and profile management compatible with applesauce.
 
 ## Installation
 
+Install from [npm](https://www.npmjs.com/package/ns-auth-sdk):
+
 ```bash
 npm install ns-auth-sdk
 # or
@@ -12,35 +26,6 @@ pnpm install ns-auth-sdk
 yarn add ns-auth-sdk
 ```
 
-### Local Development
-
-For local development in a monorepo:
-
-```bash
-cd packages/ns-auth-sdk
-pnpm install
-pnpm build
-```
-
-Then in your main app's `package.json`:
-
-```json
-{
-  "dependencies": {
-    "ns-auth-sdk": "file:./packages/ns-auth-sdk"
-  }
-}
-```
-
-## Peer Dependencies
-
-This library requires the following peer dependencies:
-
-- `react` ^18.0.0
-- `react-dom` ^18.0.0
-- `applesauce-core` ^5.0.0
-- `nosskey-sdk` ^0.0.4
-
 ## Quick Start
 
 ### 1. Initialize Services
@@ -231,11 +216,3 @@ const relayService = new RelayService();
 relayService.initialize(eventStore);
 ```
 
-## TypeScript Support
-
-This library is written in TypeScript and includes full type definitions.
-
-## License
-
-MIT
-

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ns-auth-sdk",
-  "version": "1.2.4",
+  "version": "1.2.6",
   "description": "SSO library for NS Auth - Authentication, membership, and profile management compatible with applesauce",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",