@metamask-previews/passkey-controller 2.1.0-preview-924c21f38 → 2.1.0-preview-40d5fb1e2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +0 -21
- package/README.md +20 -83
- package/dist/PasskeyController-method-action-types.cjs.map +1 -1
- package/dist/PasskeyController-method-action-types.d.cts +7 -85
- package/dist/PasskeyController-method-action-types.d.cts.map +1 -1
- package/dist/PasskeyController-method-action-types.d.mts +7 -85
- package/dist/PasskeyController-method-action-types.d.mts.map +1 -1
- package/dist/PasskeyController-method-action-types.mjs.map +1 -1
- package/dist/PasskeyController.cjs +164 -328
- package/dist/PasskeyController.cjs.map +1 -1
- package/dist/PasskeyController.d.cts +50 -88
- package/dist/PasskeyController.d.cts.map +1 -1
- package/dist/PasskeyController.d.mts +50 -88
- package/dist/PasskeyController.d.mts.map +1 -1
- package/dist/PasskeyController.mjs +164 -328
- package/dist/PasskeyController.mjs.map +1 -1
- package/dist/constants.cjs +0 -4
- package/dist/constants.cjs.map +1 -1
- package/dist/constants.d.cts +1 -5
- package/dist/constants.d.cts.map +1 -1
- package/dist/constants.d.mts +1 -5
- package/dist/constants.d.mts.map +1 -1
- package/dist/constants.mjs +0 -4
- package/dist/constants.mjs.map +1 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +3 -2
- package/dist/index.d.cts.map +1 -1
- package/dist/index.d.mts +3 -2
- package/dist/index.d.mts.map +1 -1
- package/dist/index.mjs.map +1 -1
- package/dist/types.cjs +0 -1
- package/dist/types.cjs.map +1 -1
- package/dist/types.d.cts +0 -38
- package/dist/types.d.cts.map +1 -1
- package/dist/types.d.mts +0 -38
- package/dist/types.d.mts.map +1 -1
- package/dist/types.mjs +1 -1
- package/dist/types.mjs.map +1 -1
- package/package.json +2 -4
package/CHANGELOG.md
CHANGED
|
@@ -7,27 +7,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
7
7
|
|
|
8
8
|
## [Unreleased]
|
|
9
9
|
|
|
10
|
-
### Added
|
|
11
|
-
|
|
12
|
-
- Orchestrated passkey product flows on `PasskeyController` and their messenger actions. ([#9548](https://github.com/MetaMask/core/pull/9548))
|
|
13
|
-
- `unlockWithPasskey`
|
|
14
|
-
- `removePasskeyWithPasskeyVerification`
|
|
15
|
-
- `removePasskeyWithPasswordVerification`
|
|
16
|
-
- `changePasswordWithPasskeyVerification`
|
|
17
|
-
- `exportSeedPhraseWithPasskey`
|
|
18
|
-
- `exportAccountsWithPasskey`
|
|
19
|
-
- `PasskeyControllerOptions` with required `getIsOnboardingCompleted` constructor callback for enrollment step-up gating. ([#9548](https://github.com/MetaMask/core/pull/9548))
|
|
20
|
-
- Added new error constants, `PasskeyControllerErrorCode.VaultKeyRenewalFailed`, `PasskeyControllerErrorCode.EnrollmentPasswordRequired`, `PasskeyControllerErrorMessage.VaultKeyRenewalFailed` and `PasskeyControllerErrorMessage.EnrollmentPasswordRequired`. ([#9548](https://github.com/MetaMask/core/pull/9548))
|
|
21
|
-
- `@metamask/keyring-controller` dependency for KeyringController messenger action types used during orchestration. ([#9548](https://github.com/MetaMask/core/pull/9548))
|
|
22
|
-
|
|
23
|
-
### Changed
|
|
24
|
-
|
|
25
|
-
- **BREAKING:** `protectVaultKeyWithPasskey` no longer accepts `vaultKey`; the controller fetches the current encryption key via `KeyringController:exportEncryptionKey` and optionally verifies the wallet password when onboarding is complete. (([#9548](https://github.com/MetaMask/core/pull/9548)))
|
|
26
|
-
- **BREAKING:** `PasskeyController` constructor requires `getIsOnboardingCompleted`. (([#9548](https://github.com/MetaMask/core/pull/9548)))
|
|
27
|
-
- **BREAKING:** `removePasskey` and `PasskeyController:removePasskey` are no longer public; use `removePasskeyWithPasskeyVerification`, `removePasskeyWithPasswordVerification`, or `clearState`. ([#9548](https://github.com/MetaMask/core/pull/9548))
|
|
28
|
-
- `PasskeyControllerMessenger` may call a fixed set of KeyringController actions during orchestrated flows ([#9548](https://github.com/MetaMask/core/pull/9548))
|
|
29
|
-
- Orchestrated async passkey operations are serialized with an internal mutex to prevent concurrent vault/keyring races. ([#9548](https://github.com/MetaMask/core/pull/9548))
|
|
30
|
-
|
|
31
10
|
## [2.1.0]
|
|
32
11
|
|
|
33
12
|
### Added
|
package/README.md
CHANGED
|
@@ -34,8 +34,6 @@ Both strategies feed the input key material through **HKDF-SHA256** with the cre
|
|
|
34
34
|
|
|
35
35
|
### Setting up the controller
|
|
36
36
|
|
|
37
|
-
The restricted messenger must allow the KeyringController actions listed in [Keyring integration](#keyring-integration). Onboarding completion is supplied via constructor callback (not via messenger).
|
|
38
|
-
|
|
39
37
|
```typescript
|
|
40
38
|
import { PasskeyController } from '@metamask/passkey-controller';
|
|
41
39
|
import type { PasskeyControllerMessenger } from '@metamask/passkey-controller';
|
|
@@ -52,7 +50,6 @@ const controller = new PasskeyController({
|
|
|
52
50
|
// Optional — both default to `rpName` when omitted.
|
|
53
51
|
userName: 'My Wallet',
|
|
54
52
|
userDisplayName: 'My Wallet',
|
|
55
|
-
getIsOnboardingCompleted: () => onboardingController.state.completedOnboarding,
|
|
56
53
|
});
|
|
57
54
|
```
|
|
58
55
|
|
|
@@ -60,8 +57,6 @@ const controller = new PasskeyController({
|
|
|
60
57
|
|
|
61
58
|
### Passkey enrollment (registration)
|
|
62
59
|
|
|
63
|
-
`protectVaultKeyWithPasskey` fetches the current vault encryption key from KeyringController. When onboarding is complete, pass the wallet `password` for step-up verification first.
|
|
64
|
-
|
|
65
60
|
```typescript
|
|
66
61
|
// 1. Generate registration options (synchronous)
|
|
67
62
|
const regOptions = controller.generateRegistrationOptions();
|
|
@@ -79,72 +74,48 @@ const authResponse = await navigator.credentials.get({
|
|
|
79
74
|
publicKey: authOptions,
|
|
80
75
|
});
|
|
81
76
|
|
|
82
|
-
// 4. Verify registration + post-registration auth, then persist
|
|
77
|
+
// 4. Verify registration + post-registration auth once, then persist
|
|
83
78
|
await controller.protectVaultKeyWithPasskey({
|
|
84
79
|
registrationResponse: regResponse,
|
|
85
80
|
authenticationResponse: authResponse,
|
|
86
|
-
|
|
81
|
+
vaultKey: myVaultEncryptionKey,
|
|
87
82
|
});
|
|
88
83
|
```
|
|
89
84
|
|
|
90
85
|
### Passkey unlock (authentication)
|
|
91
86
|
|
|
92
|
-
Prefer `unlockWithPasskey`, which verifies the assertion and submits the vault key to KeyringController.
|
|
93
|
-
|
|
94
87
|
```typescript
|
|
88
|
+
// 1. Generate authentication options (synchronous)
|
|
95
89
|
const options = controller.generateAuthenticationOptions();
|
|
90
|
+
|
|
91
|
+
// 2. Pass options to the browser WebAuthn API
|
|
96
92
|
const response = await navigator.credentials.get({ publicKey: options });
|
|
97
93
|
|
|
98
|
-
|
|
94
|
+
// 3. Verify and retrieve the vault key
|
|
95
|
+
const vaultKey = await controller.retrieveVaultKeyWithPasskey(response);
|
|
99
96
|
```
|
|
100
97
|
|
|
101
|
-
###
|
|
102
|
-
|
|
103
|
-
These methods combine passkey verification with KeyringController calls. Use them from UI layers that already performed `navigator.credentials.get()`.
|
|
104
|
-
|
|
105
|
-
| Method | Purpose |
|
|
106
|
-
| --------------------------------------- | --------------------------------------------------------- |
|
|
107
|
-
| `unlockWithPasskey` | Unlock keyring after passkey assertion |
|
|
108
|
-
| `removePasskeyWithPasskeyVerification` | Remove passkey after assertion step-up |
|
|
109
|
-
| `removePasskeyWithPasswordVerification` | Remove passkey after password step-up |
|
|
110
|
-
| `changePasswordWithPasskeyVerification` | Change password; re-wrap vault key by default |
|
|
111
|
-
| `exportSeedPhraseWithPasskey` | Export SRP bytes after assertion step-up |
|
|
112
|
-
| `exportAccountsWithPasskey` | Export private keys for addresses after assertion step-up |
|
|
98
|
+
### Password change (vault key renewal)
|
|
113
99
|
|
|
114
100
|
```typescript
|
|
115
|
-
|
|
116
|
-
await
|
|
117
|
-
|
|
101
|
+
const options = controller.generateAuthenticationOptions();
|
|
102
|
+
const response = await navigator.credentials.get({ publicKey: options });
|
|
103
|
+
|
|
104
|
+
await controller.renewVaultKeyProtection({
|
|
118
105
|
authenticationResponse: response,
|
|
119
|
-
|
|
106
|
+
oldVaultKey: currentVaultKey,
|
|
107
|
+
newVaultKey: newVaultKey,
|
|
120
108
|
});
|
|
121
|
-
|
|
122
|
-
// Export seed phrase (raw Uint8Array; format in your app layer)
|
|
123
|
-
const seedPhrase = await controller.exportSeedPhraseWithPasskey(
|
|
124
|
-
response,
|
|
125
|
-
keyringId,
|
|
126
|
-
);
|
|
127
|
-
|
|
128
|
-
// Export private keys for multiple addresses (one assertion)
|
|
129
|
-
const privateKeys = await controller.exportAccountsWithPasskey(response, [
|
|
130
|
-
'0xabc…',
|
|
131
|
-
'0xdef…',
|
|
132
|
-
]);
|
|
133
109
|
```
|
|
134
110
|
|
|
135
|
-
### Low-level methods
|
|
136
|
-
|
|
137
|
-
`retrieveVaultKeyWithPasskey` and `renewVaultKeyProtection` remain available for advanced composition. Prefer the orchestrated methods above for standard product flows. Use `clearState` for wallet reset lifecycle.
|
|
138
|
-
|
|
139
111
|
### Checking enrollment and removing a passkey
|
|
140
112
|
|
|
141
113
|
```typescript
|
|
142
114
|
controller.isPasskeyEnrolled(); // boolean
|
|
143
115
|
|
|
144
|
-
|
|
145
|
-
await controller.removePasskeyWithPasswordVerification(password);
|
|
116
|
+
controller.removePasskey(); // user-facing unenroll; clears persisted passkey and in-flight ceremonies
|
|
146
117
|
|
|
147
|
-
controller.clearState(); // persisted reset + clears in-flight ceremony state; use for app lifecycle (e.g. wallet reset)
|
|
118
|
+
controller.clearState(); // same persisted reset + clears in-flight ceremony state; use for app lifecycle (e.g. wallet reset)
|
|
148
119
|
```
|
|
149
120
|
|
|
150
121
|
### Selectors
|
|
@@ -163,8 +134,7 @@ passkeyControllerSelectors.selectIsPasskeyEnrolled(state); // boolean
|
|
|
163
134
|
`PasskeyControllerError` is thrown for controller failures. Expected operational
|
|
164
135
|
cases use a stable `code` from `PasskeyControllerErrorCode` (for example:
|
|
165
136
|
`not_enrolled`, `already_enrolled`, `no_registration_ceremony`,
|
|
166
|
-
`authentication_verification_failed`, `missing_key_material`, `vault_key_decryption_failed
|
|
167
|
-
`vault_key_mismatch`, `vault_key_renewal_failed`, `enrollment_password_required`). Human-readable strings
|
|
137
|
+
`authentication_verification_failed`, `missing_key_material`, `vault_key_decryption_failed`). Human-readable strings
|
|
168
138
|
live on `PasskeyControllerErrorMessage`. Use `instanceof PasskeyControllerError`
|
|
169
139
|
and a defined `error.code` to tell these apart from malformed WebAuthn payloads
|
|
170
140
|
and other `Error` values. Thrown errors from the internal WebAuthn verify helpers
|
|
@@ -183,27 +153,9 @@ those controller errors (with `code`) and rethrows everything else.
|
|
|
183
153
|
|
|
184
154
|
### Messenger actions
|
|
185
155
|
|
|
186
|
-
| Action
|
|
187
|
-
|
|
|
188
|
-
| `PasskeyController:getState`
|
|
189
|
-
| `PasskeyController:isPasskeyEnrolled` | Enrollment boolean |
|
|
190
|
-
| `PasskeyController:generateRegistrationOptions` | WebAuthn `create()` options |
|
|
191
|
-
| `PasskeyController:generatePostRegistrationAuthenticationOptions` | WebAuthn `get()` after `create()` |
|
|
192
|
-
| `PasskeyController:generateAuthenticationOptions` | WebAuthn `get()` for unlock / step-up |
|
|
193
|
-
| `PasskeyController:protectVaultKeyWithPasskey` | Enroll: verify ceremonies + wrap vault key |
|
|
194
|
-
| `PasskeyController:retrieveVaultKeyWithPasskey` | Verify assertion + return vault key |
|
|
195
|
-
| `PasskeyController:unlockWithPasskey` | Unlock keyring via passkey |
|
|
196
|
-
| `PasskeyController:exportSeedPhraseWithPasskey` | Export SRP after passkey step-up |
|
|
197
|
-
| `PasskeyController:exportAccountsWithPasskey` | Export private keys after passkey step-up |
|
|
198
|
-
| `PasskeyController:verifyPasskeyAuthentication` | Boolean assertion verification |
|
|
199
|
-
| `PasskeyController:renewVaultKeyProtection` | Re-wrap vault key after rotation |
|
|
200
|
-
| `PasskeyController:changePasswordWithPasskeyVerification` | Change password with passkey step-up |
|
|
201
|
-
| `PasskeyController:removePasskeyWithPasskeyVerification` | Remove passkey after assertion step-up |
|
|
202
|
-
| `PasskeyController:removePasskeyWithPasswordVerification` | Remove passkey after password step-up |
|
|
203
|
-
| `PasskeyController:clearState` | Reset state |
|
|
204
|
-
| `PasskeyController:destroy` | Tear down messenger + ceremony state |
|
|
205
|
-
|
|
206
|
-
Corresponding `PasskeyController*Action` types are exported from the package entry point.
|
|
156
|
+
| Action | Handler |
|
|
157
|
+
| ---------------------------- | ------------------------------------ |
|
|
158
|
+
| `PasskeyController:getState` | Returns the current controller state |
|
|
207
159
|
|
|
208
160
|
For derived enrollment status outside of components that hold a controller
|
|
209
161
|
reference, use `passkeyControllerSelectors.selectIsPasskeyEnrolled` (see
|
|
@@ -215,21 +167,6 @@ reference, use `passkeyControllerSelectors.selectIsPasskeyEnrolled` (see
|
|
|
215
167
|
| -------------------------------- | ------------------------------------------------------------ |
|
|
216
168
|
| `PasskeyController:stateChanged` | Emitted when state changes (standard `BaseController` event) |
|
|
217
169
|
|
|
218
|
-
### Keyring integration
|
|
219
|
-
|
|
220
|
-
`PasskeyController` calls these KeyringController actions during orchestrated flows. Allow them on the restricted messenger at init:
|
|
221
|
-
|
|
222
|
-
| Messenger action |
|
|
223
|
-
| --------------------------------------- |
|
|
224
|
-
| `KeyringController:verifyPassword` |
|
|
225
|
-
| `KeyringController:exportEncryptionKey` |
|
|
226
|
-
| `KeyringController:submitEncryptionKey` |
|
|
227
|
-
| `KeyringController:changePassword` |
|
|
228
|
-
| `KeyringController:exportSeedPhrase` |
|
|
229
|
-
| `KeyringController:exportAccount` |
|
|
230
|
-
|
|
231
|
-
Onboarding completion is **not** read via messenger. Pass `getIsOnboardingCompleted` in the constructor (see [Setting up the controller](#setting-up-the-controller)).
|
|
232
|
-
|
|
233
170
|
## Contributing
|
|
234
171
|
|
|
235
172
|
This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme).
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PasskeyController-method-action-types.cjs","sourceRoot":"","sources":["../src/PasskeyController-method-action-types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { PasskeyController } from './PasskeyController';\n\n/**\n * Whether a passkey is enrolled and vault key material is stored.\n *\n * @returns `true` if enrolled, otherwise `false`.\n */\nexport type PasskeyControllerIsPasskeyEnrolledAction = {\n type: `PasskeyController:isPasskeyEnrolled`;\n handler: PasskeyController['isPasskeyEnrolled'];\n};\n\n/**\n * Builds WebAuthn credential creation options for passkey enrollment.\n *\n * @param creationOptionsConfig - Optional creation behavior.\n * @param creationOptionsConfig.prfAvailable - Request the PRF extension unless `false`. Defaults to `true`.\n * @returns Public key credential creation options for `navigator.credentials.create()`.\n */\nexport type PasskeyControllerGenerateRegistrationOptionsAction = {\n type: `PasskeyController:generateRegistrationOptions`;\n handler: PasskeyController['generateRegistrationOptions'];\n};\n\n/**\n * Builds WebAuthn credential request options for the post-registration\n * authentication step (between `create` and {@link protectVaultKeyWithPasskey}).\n *\n * @param params - Input for the pending registration ceremony.\n * @param params.registrationResponse - Result of `navigator.credentials.create()`.\n * @returns Public key credential request options for `navigator.credentials.get()`.\n */\nexport type PasskeyControllerGeneratePostRegistrationAuthenticationOptionsAction =\n {\n type: `PasskeyController:generatePostRegistrationAuthenticationOptions`;\n handler: PasskeyController['generatePostRegistrationAuthenticationOptions'];\n };\n\n/**\n * Builds WebAuthn credential request options for the enrolled passkey.\n *\n * @returns Public key credential request options for `navigator.credentials.get()`.\n */\nexport type PasskeyControllerGenerateAuthenticationOptionsAction = {\n type: `PasskeyController:generateAuthenticationOptions`;\n handler: PasskeyController['generateAuthenticationOptions'];\n};\n\n/**\n * Verifies registration and post-registration authentication, then stores the\n * vault key encrypted under the new passkey.\n *\n * Fetches the current vault encryption key from KeyringController before wrapping.\n * When onboarding is complete, requires `password` for step-up verification first.\n *\n * @param params - Enrollment completion inputs.\n * @param params.registrationResponse - Result of `navigator.credentials.create()`.\n * @param params.authenticationResponse - Result of `navigator.credentials.get()` after {@link generatePostRegistrationAuthenticationOptions}.\n * @param params.password - Wallet password when onboarding is complete (step-up).\n * @returns Resolves when enrollment completes.\n */\nexport type PasskeyControllerProtectVaultKeyWithPasskeyAction = {\n type: `PasskeyController:protectVaultKeyWithPasskey`;\n handler: PasskeyController['protectVaultKeyWithPasskey'];\n};\n\n/**\n * Verifies an authentication assertion and returns the decrypted vault key.\n *\n * Prefer orchestrated methods ({@link unlockWithPasskey},\n * {@link exportSeedPhraseWithPasskey}, {@link exportAccountsWithPasskey}) for product\n * flows instead of calling KeyringController with the returned key manually.\n *\n * @param authenticationResponse - Result of `navigator.credentials.get()`.\n * @returns The plaintext vault encryption key.\n */\nexport type PasskeyControllerRetrieveVaultKeyWithPasskeyAction = {\n type: `PasskeyController:retrieveVaultKeyWithPasskey`;\n handler: PasskeyController['retrieveVaultKeyWithPasskey'];\n};\n\n/**\n * Unlocks the keyring using a passkey authentication assertion.\n *\n * @param authenticationResponse - Result of `navigator.credentials.get()`.\n * @returns Resolves when the keyring is unlocked.\n */\nexport type PasskeyControllerUnlockWithPasskeyAction = {\n type: `PasskeyController:unlockWithPasskey`;\n handler: PasskeyController['unlockWithPasskey'];\n};\n\n/**\n * Exports the seed phrase after passkey step-up authentication.\n *\n * @param authenticationResponse - Result of `navigator.credentials.get()`.\n * @param keyringId - Optional keyring id; defaults to the primary HD keyring.\n * @returns Raw seed phrase bytes from KeyringController.\n */\nexport type PasskeyControllerExportSeedPhraseWithPasskeyAction = {\n type: `PasskeyController:exportSeedPhraseWithPasskey`;\n handler: PasskeyController['exportSeedPhraseWithPasskey'];\n};\n\n/**\n * Exports private keys for the given addresses after passkey step-up authentication.\n *\n * @param authenticationResponse - Result of `navigator.credentials.get()`.\n * @param addresses - Account addresses to export.\n * @returns Private keys in the same order as `addresses`.\n */\nexport type PasskeyControllerExportAccountsWithPasskeyAction = {\n type: `PasskeyController:exportAccountsWithPasskey`;\n handler: PasskeyController['exportAccountsWithPasskey'];\n};\n\n/**\n * Checks whether the given authentication assertion is valid for the enrolled passkey.\n *\n * On failure, returns `false` for {@link PasskeyControllerError} with a `code`;\n * other errors propagate.\n *\n * @param authenticationResponse - Result of `navigator.credentials.get()`.\n * @returns `true` if verification succeeds, otherwise `false`.\n */\nexport type PasskeyControllerVerifyPasskeyAuthenticationAction = {\n type: `PasskeyController:verifyPasskeyAuthentication`;\n handler: PasskeyController['verifyPasskeyAuthentication'];\n};\n\n/**\n * Re-wraps the vault key after rotation. Updates persisted `encryptedVaultKey` on success.\n *\n * Does not verify WebAuthn or ceremony state—call only after your layer has authenticated\n * the user (passkey `get()` + verified assertion, or verified password). On passkey paths,\n * pass the same `authenticationResponse` you just verified (e.g. from\n * {@link retrieveVaultKeyWithPasskey} / {@link verifyPasskeyAuthentication}).\n *\n * For password change with passkey step-up, prefer\n * {@link changePasswordWithPasskeyVerification}, which orchestrates keyring export,\n * `changePassword`, and re-wrap in one call.\n *\n * @param params - Re-wrap inputs.\n * @param params.authenticationResponse - Used to derive the wrapping key.\n * @param params.oldVaultKey - Expected current vault key.\n * @param params.newVaultKey - New vault key to encrypt under the passkey.\n * @returns Resolves when the passkey record is updated.\n */\nexport type PasskeyControllerRenewVaultKeyProtectionAction = {\n type: `PasskeyController:renewVaultKeyProtection`;\n handler: PasskeyController['renewVaultKeyProtection'];\n};\n\n/**\n * Changes the wallet password after passkey step-up authentication.\n *\n * When `renewVaultKeyProtection` is `true` (default), re-wraps the vault key under the\n * passkey after rotation. When `false`, removes the passkey instead.\n *\n * @param params - Change-password inputs.\n * @param params.newPassword - New wallet password.\n * @param params.authenticationResponse - Result of `navigator.credentials.get()`.\n * @param params.options - Optional flow controls.\n * @param params.options.renewVaultKeyProtection - Re-wrap vault key after password change.\n * @returns Resolves when the password change completes.\n */\nexport type PasskeyControllerChangePasswordWithPasskeyVerificationAction = {\n type: `PasskeyController:changePasswordWithPasskeyVerification`;\n handler: PasskeyController['changePasswordWithPasskeyVerification'];\n};\n\n/**\n * Removes the enrolled passkey after verifying a passkey authentication assertion.\n *\n * @param authenticationResponse - Result of `navigator.credentials.get()`.\n * @returns Resolves when the passkey is removed.\n */\nexport type PasskeyControllerRemovePasskeyWithPasskeyVerificationAction = {\n type: `PasskeyController:removePasskeyWithPasskeyVerification`;\n handler: PasskeyController['removePasskeyWithPasskeyVerification'];\n};\n\n/**\n * Removes the enrolled passkey after verifying the wallet password.\n *\n * @param password - Wallet password for step-up verification.\n * @returns Resolves when the passkey is removed.\n */\nexport type PasskeyControllerRemovePasskeyWithPasswordVerificationAction = {\n type: `PasskeyController:removePasskeyWithPasswordVerification`;\n handler: PasskeyController['removePasskeyWithPasswordVerification'];\n};\n\n/**\n * Resets state and clears in-flight registration/authentication ceremonies.\n *\n * For user-facing passkey removal with step-up, use\n * {@link removePasskeyWithPasskeyVerification} or\n * {@link removePasskeyWithPasswordVerification}.\n */\nexport type PasskeyControllerClearStateAction = {\n type: `PasskeyController:clearState`;\n handler: PasskeyController['clearState'];\n};\n\n/**\n * Releases all in-flight ceremony state and tears down the messenger.\n */\nexport type PasskeyControllerDestroyAction = {\n type: `PasskeyController:destroy`;\n handler: PasskeyController['destroy'];\n};\n\n/**\n * Union of all PasskeyController action types.\n */\nexport type PasskeyControllerMethodActions =\n | PasskeyControllerIsPasskeyEnrolledAction\n | PasskeyControllerGenerateRegistrationOptionsAction\n | PasskeyControllerGeneratePostRegistrationAuthenticationOptionsAction\n | PasskeyControllerGenerateAuthenticationOptionsAction\n | PasskeyControllerProtectVaultKeyWithPasskeyAction\n | PasskeyControllerRetrieveVaultKeyWithPasskeyAction\n | PasskeyControllerUnlockWithPasskeyAction\n | PasskeyControllerExportSeedPhraseWithPasskeyAction\n | PasskeyControllerExportAccountsWithPasskeyAction\n | PasskeyControllerVerifyPasskeyAuthenticationAction\n | PasskeyControllerRenewVaultKeyProtectionAction\n | PasskeyControllerChangePasswordWithPasskeyVerificationAction\n | PasskeyControllerRemovePasskeyWithPasskeyVerificationAction\n | PasskeyControllerRemovePasskeyWithPasswordVerificationAction\n | PasskeyControllerClearStateAction\n | PasskeyControllerDestroyAction;\n"]}
|
|
1
|
+
{"version":3,"file":"PasskeyController-method-action-types.cjs","sourceRoot":"","sources":["../src/PasskeyController-method-action-types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { PasskeyController } from './PasskeyController';\n\n/**\n * Whether a passkey is enrolled and vault key material is stored.\n *\n * @returns `true` if enrolled, otherwise `false`.\n */\nexport type PasskeyControllerIsPasskeyEnrolledAction = {\n type: `PasskeyController:isPasskeyEnrolled`;\n handler: PasskeyController['isPasskeyEnrolled'];\n};\n\n/**\n * Builds WebAuthn credential creation options for passkey enrollment.\n *\n * @param creationOptionsConfig - Optional creation behavior.\n * @param creationOptionsConfig.prfAvailable - Request the PRF extension unless `false`. Defaults to `true`.\n * @returns Public key credential creation options for `navigator.credentials.create()`.\n */\nexport type PasskeyControllerGenerateRegistrationOptionsAction = {\n type: `PasskeyController:generateRegistrationOptions`;\n handler: PasskeyController['generateRegistrationOptions'];\n};\n\n/**\n * Builds WebAuthn credential request options for the post-registration\n * authentication step (between `create` and {@link protectVaultKeyWithPasskey}).\n *\n * @param params - Input for the pending registration ceremony.\n * @param params.registrationResponse - Result of `navigator.credentials.create()`.\n * @returns Public key credential request options for `navigator.credentials.get()`.\n */\nexport type PasskeyControllerGeneratePostRegistrationAuthenticationOptionsAction =\n {\n type: `PasskeyController:generatePostRegistrationAuthenticationOptions`;\n handler: PasskeyController['generatePostRegistrationAuthenticationOptions'];\n };\n\n/**\n * Builds WebAuthn credential request options for the enrolled passkey.\n *\n * @returns Public key credential request options for `navigator.credentials.get()`.\n */\nexport type PasskeyControllerGenerateAuthenticationOptionsAction = {\n type: `PasskeyController:generateAuthenticationOptions`;\n handler: PasskeyController['generateAuthenticationOptions'];\n};\n\n/**\n * Verifies registration and post-registration authentication, then stores the\n * vault key encrypted under the new passkey.\n *\n * @param params - Enrollment completion inputs.\n * @param params.registrationResponse - Result of `navigator.credentials.create()`.\n * @param params.authenticationResponse - Result of `navigator.credentials.get()` after {@link generatePostRegistrationAuthenticationOptions}.\n * @param params.vaultKey - Vault encryption key to encrypt and persist.\n */\nexport type PasskeyControllerProtectVaultKeyWithPasskeyAction = {\n type: `PasskeyController:protectVaultKeyWithPasskey`;\n handler: PasskeyController['protectVaultKeyWithPasskey'];\n};\n\n/**\n * Verifies an authentication assertion and returns the decrypted vault key.\n *\n * @param authenticationResponse - Result of `navigator.credentials.get()`.\n * @returns The plaintext vault encryption key.\n */\nexport type PasskeyControllerRetrieveVaultKeyWithPasskeyAction = {\n type: `PasskeyController:retrieveVaultKeyWithPasskey`;\n handler: PasskeyController['retrieveVaultKeyWithPasskey'];\n};\n\n/**\n * Checks whether the given authentication assertion is valid for the enrolled passkey.\n *\n * On failure, returns `false` for {@link PasskeyControllerError} with a `code`;\n * other errors propagate.\n *\n * @param authenticationResponse - Result of `navigator.credentials.get()`.\n * @returns `true` if verification succeeds, otherwise `false`.\n */\nexport type PasskeyControllerVerifyPasskeyAuthenticationAction = {\n type: `PasskeyController:verifyPasskeyAuthentication`;\n handler: PasskeyController['verifyPasskeyAuthentication'];\n};\n\n/**\n * Re-wraps the vault key after rotation. Updates persisted `encryptedVaultKey` on success.\n *\n * Does not verify WebAuthn or ceremony state—call only after your layer has authenticated\n * the user (passkey `get()` + verified assertion, or verified password). On passkey paths,\n * pass the same `authenticationResponse` you just verified (e.g. from\n * {@link retrieveVaultKeyWithPasskey} / {@link verifyPasskeyAuthentication}).\n *\n * @param params - Re-wrap inputs.\n * @param params.authenticationResponse - Used to derive the wrapping key.\n * @param params.oldVaultKey - Expected current vault key.\n * @param params.newVaultKey - New vault key to encrypt under the passkey.\n */\nexport type PasskeyControllerRenewVaultKeyProtectionAction = {\n type: `PasskeyController:renewVaultKeyProtection`;\n handler: PasskeyController['renewVaultKeyProtection'];\n};\n\n/**\n * Clears enrolled passkey state and in-flight ceremonies. Call only after the same\n * auth gate as renewal (verified passkey assertion or password).\n */\nexport type PasskeyControllerRemovePasskeyAction = {\n type: `PasskeyController:removePasskey`;\n handler: PasskeyController['removePasskey'];\n};\n\n/**\n * Resets state and clears in-flight registration/authentication ceremonies.\n */\nexport type PasskeyControllerClearStateAction = {\n type: `PasskeyController:clearState`;\n handler: PasskeyController['clearState'];\n};\n\n/**\n * Releases all in-flight ceremony state and tears down the messenger.\n */\nexport type PasskeyControllerDestroyAction = {\n type: `PasskeyController:destroy`;\n handler: PasskeyController['destroy'];\n};\n\n/**\n * Union of all PasskeyController action types.\n */\nexport type PasskeyControllerMethodActions =\n | PasskeyControllerIsPasskeyEnrolledAction\n | PasskeyControllerGenerateRegistrationOptionsAction\n | PasskeyControllerGeneratePostRegistrationAuthenticationOptionsAction\n | PasskeyControllerGenerateAuthenticationOptionsAction\n | PasskeyControllerProtectVaultKeyWithPasskeyAction\n | PasskeyControllerRetrieveVaultKeyWithPasskeyAction\n | PasskeyControllerVerifyPasskeyAuthenticationAction\n | PasskeyControllerRenewVaultKeyProtectionAction\n | PasskeyControllerRemovePasskeyAction\n | PasskeyControllerClearStateAction\n | PasskeyControllerDestroyAction;\n"]}
|
|
@@ -48,14 +48,10 @@ export type PasskeyControllerGenerateAuthenticationOptionsAction = {
|
|
|
48
48
|
* Verifies registration and post-registration authentication, then stores the
|
|
49
49
|
* vault key encrypted under the new passkey.
|
|
50
50
|
*
|
|
51
|
-
* Fetches the current vault encryption key from KeyringController before wrapping.
|
|
52
|
-
* When onboarding is complete, requires `password` for step-up verification first.
|
|
53
|
-
*
|
|
54
51
|
* @param params - Enrollment completion inputs.
|
|
55
52
|
* @param params.registrationResponse - Result of `navigator.credentials.create()`.
|
|
56
53
|
* @param params.authenticationResponse - Result of `navigator.credentials.get()` after {@link generatePostRegistrationAuthenticationOptions}.
|
|
57
|
-
* @param params.
|
|
58
|
-
* @returns Resolves when enrollment completes.
|
|
54
|
+
* @param params.vaultKey - Vault encryption key to encrypt and persist.
|
|
59
55
|
*/
|
|
60
56
|
export type PasskeyControllerProtectVaultKeyWithPasskeyAction = {
|
|
61
57
|
type: `PasskeyController:protectVaultKeyWithPasskey`;
|
|
@@ -64,10 +60,6 @@ export type PasskeyControllerProtectVaultKeyWithPasskeyAction = {
|
|
|
64
60
|
/**
|
|
65
61
|
* Verifies an authentication assertion and returns the decrypted vault key.
|
|
66
62
|
*
|
|
67
|
-
* Prefer orchestrated methods ({@link unlockWithPasskey},
|
|
68
|
-
* {@link exportSeedPhraseWithPasskey}, {@link exportAccountsWithPasskey}) for product
|
|
69
|
-
* flows instead of calling KeyringController with the returned key manually.
|
|
70
|
-
*
|
|
71
63
|
* @param authenticationResponse - Result of `navigator.credentials.get()`.
|
|
72
64
|
* @returns The plaintext vault encryption key.
|
|
73
65
|
*/
|
|
@@ -75,38 +67,6 @@ export type PasskeyControllerRetrieveVaultKeyWithPasskeyAction = {
|
|
|
75
67
|
type: `PasskeyController:retrieveVaultKeyWithPasskey`;
|
|
76
68
|
handler: PasskeyController['retrieveVaultKeyWithPasskey'];
|
|
77
69
|
};
|
|
78
|
-
/**
|
|
79
|
-
* Unlocks the keyring using a passkey authentication assertion.
|
|
80
|
-
*
|
|
81
|
-
* @param authenticationResponse - Result of `navigator.credentials.get()`.
|
|
82
|
-
* @returns Resolves when the keyring is unlocked.
|
|
83
|
-
*/
|
|
84
|
-
export type PasskeyControllerUnlockWithPasskeyAction = {
|
|
85
|
-
type: `PasskeyController:unlockWithPasskey`;
|
|
86
|
-
handler: PasskeyController['unlockWithPasskey'];
|
|
87
|
-
};
|
|
88
|
-
/**
|
|
89
|
-
* Exports the seed phrase after passkey step-up authentication.
|
|
90
|
-
*
|
|
91
|
-
* @param authenticationResponse - Result of `navigator.credentials.get()`.
|
|
92
|
-
* @param keyringId - Optional keyring id; defaults to the primary HD keyring.
|
|
93
|
-
* @returns Raw seed phrase bytes from KeyringController.
|
|
94
|
-
*/
|
|
95
|
-
export type PasskeyControllerExportSeedPhraseWithPasskeyAction = {
|
|
96
|
-
type: `PasskeyController:exportSeedPhraseWithPasskey`;
|
|
97
|
-
handler: PasskeyController['exportSeedPhraseWithPasskey'];
|
|
98
|
-
};
|
|
99
|
-
/**
|
|
100
|
-
* Exports private keys for the given addresses after passkey step-up authentication.
|
|
101
|
-
*
|
|
102
|
-
* @param authenticationResponse - Result of `navigator.credentials.get()`.
|
|
103
|
-
* @param addresses - Account addresses to export.
|
|
104
|
-
* @returns Private keys in the same order as `addresses`.
|
|
105
|
-
*/
|
|
106
|
-
export type PasskeyControllerExportAccountsWithPasskeyAction = {
|
|
107
|
-
type: `PasskeyController:exportAccountsWithPasskey`;
|
|
108
|
-
handler: PasskeyController['exportAccountsWithPasskey'];
|
|
109
|
-
};
|
|
110
70
|
/**
|
|
111
71
|
* Checks whether the given authentication assertion is valid for the enrolled passkey.
|
|
112
72
|
*
|
|
@@ -128,63 +88,25 @@ export type PasskeyControllerVerifyPasskeyAuthenticationAction = {
|
|
|
128
88
|
* pass the same `authenticationResponse` you just verified (e.g. from
|
|
129
89
|
* {@link retrieveVaultKeyWithPasskey} / {@link verifyPasskeyAuthentication}).
|
|
130
90
|
*
|
|
131
|
-
* For password change with passkey step-up, prefer
|
|
132
|
-
* {@link changePasswordWithPasskeyVerification}, which orchestrates keyring export,
|
|
133
|
-
* `changePassword`, and re-wrap in one call.
|
|
134
|
-
*
|
|
135
91
|
* @param params - Re-wrap inputs.
|
|
136
92
|
* @param params.authenticationResponse - Used to derive the wrapping key.
|
|
137
93
|
* @param params.oldVaultKey - Expected current vault key.
|
|
138
94
|
* @param params.newVaultKey - New vault key to encrypt under the passkey.
|
|
139
|
-
* @returns Resolves when the passkey record is updated.
|
|
140
95
|
*/
|
|
141
96
|
export type PasskeyControllerRenewVaultKeyProtectionAction = {
|
|
142
97
|
type: `PasskeyController:renewVaultKeyProtection`;
|
|
143
98
|
handler: PasskeyController['renewVaultKeyProtection'];
|
|
144
99
|
};
|
|
145
100
|
/**
|
|
146
|
-
*
|
|
147
|
-
*
|
|
148
|
-
* When `renewVaultKeyProtection` is `true` (default), re-wraps the vault key under the
|
|
149
|
-
* passkey after rotation. When `false`, removes the passkey instead.
|
|
150
|
-
*
|
|
151
|
-
* @param params - Change-password inputs.
|
|
152
|
-
* @param params.newPassword - New wallet password.
|
|
153
|
-
* @param params.authenticationResponse - Result of `navigator.credentials.get()`.
|
|
154
|
-
* @param params.options - Optional flow controls.
|
|
155
|
-
* @param params.options.renewVaultKeyProtection - Re-wrap vault key after password change.
|
|
156
|
-
* @returns Resolves when the password change completes.
|
|
101
|
+
* Clears enrolled passkey state and in-flight ceremonies. Call only after the same
|
|
102
|
+
* auth gate as renewal (verified passkey assertion or password).
|
|
157
103
|
*/
|
|
158
|
-
export type
|
|
159
|
-
type: `PasskeyController:
|
|
160
|
-
handler: PasskeyController['
|
|
161
|
-
};
|
|
162
|
-
/**
|
|
163
|
-
* Removes the enrolled passkey after verifying a passkey authentication assertion.
|
|
164
|
-
*
|
|
165
|
-
* @param authenticationResponse - Result of `navigator.credentials.get()`.
|
|
166
|
-
* @returns Resolves when the passkey is removed.
|
|
167
|
-
*/
|
|
168
|
-
export type PasskeyControllerRemovePasskeyWithPasskeyVerificationAction = {
|
|
169
|
-
type: `PasskeyController:removePasskeyWithPasskeyVerification`;
|
|
170
|
-
handler: PasskeyController['removePasskeyWithPasskeyVerification'];
|
|
171
|
-
};
|
|
172
|
-
/**
|
|
173
|
-
* Removes the enrolled passkey after verifying the wallet password.
|
|
174
|
-
*
|
|
175
|
-
* @param password - Wallet password for step-up verification.
|
|
176
|
-
* @returns Resolves when the passkey is removed.
|
|
177
|
-
*/
|
|
178
|
-
export type PasskeyControllerRemovePasskeyWithPasswordVerificationAction = {
|
|
179
|
-
type: `PasskeyController:removePasskeyWithPasswordVerification`;
|
|
180
|
-
handler: PasskeyController['removePasskeyWithPasswordVerification'];
|
|
104
|
+
export type PasskeyControllerRemovePasskeyAction = {
|
|
105
|
+
type: `PasskeyController:removePasskey`;
|
|
106
|
+
handler: PasskeyController['removePasskey'];
|
|
181
107
|
};
|
|
182
108
|
/**
|
|
183
109
|
* Resets state and clears in-flight registration/authentication ceremonies.
|
|
184
|
-
*
|
|
185
|
-
* For user-facing passkey removal with step-up, use
|
|
186
|
-
* {@link removePasskeyWithPasskeyVerification} or
|
|
187
|
-
* {@link removePasskeyWithPasswordVerification}.
|
|
188
110
|
*/
|
|
189
111
|
export type PasskeyControllerClearStateAction = {
|
|
190
112
|
type: `PasskeyController:clearState`;
|
|
@@ -200,5 +122,5 @@ export type PasskeyControllerDestroyAction = {
|
|
|
200
122
|
/**
|
|
201
123
|
* Union of all PasskeyController action types.
|
|
202
124
|
*/
|
|
203
|
-
export type PasskeyControllerMethodActions = PasskeyControllerIsPasskeyEnrolledAction | PasskeyControllerGenerateRegistrationOptionsAction | PasskeyControllerGeneratePostRegistrationAuthenticationOptionsAction | PasskeyControllerGenerateAuthenticationOptionsAction | PasskeyControllerProtectVaultKeyWithPasskeyAction | PasskeyControllerRetrieveVaultKeyWithPasskeyAction |
|
|
125
|
+
export type PasskeyControllerMethodActions = PasskeyControllerIsPasskeyEnrolledAction | PasskeyControllerGenerateRegistrationOptionsAction | PasskeyControllerGeneratePostRegistrationAuthenticationOptionsAction | PasskeyControllerGenerateAuthenticationOptionsAction | PasskeyControllerProtectVaultKeyWithPasskeyAction | PasskeyControllerRetrieveVaultKeyWithPasskeyAction | PasskeyControllerVerifyPasskeyAuthenticationAction | PasskeyControllerRenewVaultKeyProtectionAction | PasskeyControllerRemovePasskeyAction | PasskeyControllerClearStateAction | PasskeyControllerDestroyAction;
|
|
204
126
|
//# sourceMappingURL=PasskeyController-method-action-types.d.cts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PasskeyController-method-action-types.d.cts","sourceRoot":"","sources":["../src/PasskeyController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,gCAA4B;AAE7D;;;;GAIG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACrD,IAAI,EAAE,qCAAqC,CAAC;IAC5C,OAAO,EAAE,iBAAiB,CAAC,mBAAmB,CAAC,CAAC;CACjD,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,kDAAkD,GAAG;IAC/D,IAAI,EAAE,+CAA+C,CAAC;IACtD,OAAO,EAAE,iBAAiB,CAAC,6BAA6B,CAAC,CAAC;CAC3D,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,oEAAoE,GAC9E;IACE,IAAI,EAAE,iEAAiE,CAAC;IACxE,OAAO,EAAE,iBAAiB,CAAC,+CAA+C,CAAC,CAAC;CAC7E,CAAC;AAEJ;;;;GAIG;AACH,MAAM,MAAM,oDAAoD,GAAG;IACjE,IAAI,EAAE,iDAAiD,CAAC;IACxD,OAAO,EAAE,iBAAiB,CAAC,+BAA+B,CAAC,CAAC;CAC7D,CAAC;AAEF
|
|
1
|
+
{"version":3,"file":"PasskeyController-method-action-types.d.cts","sourceRoot":"","sources":["../src/PasskeyController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,gCAA4B;AAE7D;;;;GAIG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACrD,IAAI,EAAE,qCAAqC,CAAC;IAC5C,OAAO,EAAE,iBAAiB,CAAC,mBAAmB,CAAC,CAAC;CACjD,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,kDAAkD,GAAG;IAC/D,IAAI,EAAE,+CAA+C,CAAC;IACtD,OAAO,EAAE,iBAAiB,CAAC,6BAA6B,CAAC,CAAC;CAC3D,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,oEAAoE,GAC9E;IACE,IAAI,EAAE,iEAAiE,CAAC;IACxE,OAAO,EAAE,iBAAiB,CAAC,+CAA+C,CAAC,CAAC;CAC7E,CAAC;AAEJ;;;;GAIG;AACH,MAAM,MAAM,oDAAoD,GAAG;IACjE,IAAI,EAAE,iDAAiD,CAAC;IACxD,OAAO,EAAE,iBAAiB,CAAC,+BAA+B,CAAC,CAAC;CAC7D,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,iDAAiD,GAAG;IAC9D,IAAI,EAAE,8CAA8C,CAAC;IACrD,OAAO,EAAE,iBAAiB,CAAC,4BAA4B,CAAC,CAAC;CAC1D,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,kDAAkD,GAAG;IAC/D,IAAI,EAAE,+CAA+C,CAAC;IACtD,OAAO,EAAE,iBAAiB,CAAC,6BAA6B,CAAC,CAAC;CAC3D,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,kDAAkD,GAAG;IAC/D,IAAI,EAAE,+CAA+C,CAAC;IACtD,OAAO,EAAE,iBAAiB,CAAC,6BAA6B,CAAC,CAAC;CAC3D,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,8CAA8C,GAAG;IAC3D,IAAI,EAAE,2CAA2C,CAAC;IAClD,OAAO,EAAE,iBAAiB,CAAC,yBAAyB,CAAC,CAAC;CACvD,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,oCAAoC,GAAG;IACjD,IAAI,EAAE,iCAAiC,CAAC;IACxC,OAAO,EAAE,iBAAiB,CAAC,eAAe,CAAC,CAAC;CAC7C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,8BAA8B,CAAC;IACrC,OAAO,EAAE,iBAAiB,CAAC,YAAY,CAAC,CAAC;CAC1C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C,IAAI,EAAE,2BAA2B,CAAC;IAClC,OAAO,EAAE,iBAAiB,CAAC,SAAS,CAAC,CAAC;CACvC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,8BAA8B,GACtC,wCAAwC,GACxC,kDAAkD,GAClD,oEAAoE,GACpE,oDAAoD,GACpD,iDAAiD,GACjD,kDAAkD,GAClD,kDAAkD,GAClD,8CAA8C,GAC9C,oCAAoC,GACpC,iCAAiC,GACjC,8BAA8B,CAAC"}
|
|
@@ -48,14 +48,10 @@ export type PasskeyControllerGenerateAuthenticationOptionsAction = {
|
|
|
48
48
|
* Verifies registration and post-registration authentication, then stores the
|
|
49
49
|
* vault key encrypted under the new passkey.
|
|
50
50
|
*
|
|
51
|
-
* Fetches the current vault encryption key from KeyringController before wrapping.
|
|
52
|
-
* When onboarding is complete, requires `password` for step-up verification first.
|
|
53
|
-
*
|
|
54
51
|
* @param params - Enrollment completion inputs.
|
|
55
52
|
* @param params.registrationResponse - Result of `navigator.credentials.create()`.
|
|
56
53
|
* @param params.authenticationResponse - Result of `navigator.credentials.get()` after {@link generatePostRegistrationAuthenticationOptions}.
|
|
57
|
-
* @param params.
|
|
58
|
-
* @returns Resolves when enrollment completes.
|
|
54
|
+
* @param params.vaultKey - Vault encryption key to encrypt and persist.
|
|
59
55
|
*/
|
|
60
56
|
export type PasskeyControllerProtectVaultKeyWithPasskeyAction = {
|
|
61
57
|
type: `PasskeyController:protectVaultKeyWithPasskey`;
|
|
@@ -64,10 +60,6 @@ export type PasskeyControllerProtectVaultKeyWithPasskeyAction = {
|
|
|
64
60
|
/**
|
|
65
61
|
* Verifies an authentication assertion and returns the decrypted vault key.
|
|
66
62
|
*
|
|
67
|
-
* Prefer orchestrated methods ({@link unlockWithPasskey},
|
|
68
|
-
* {@link exportSeedPhraseWithPasskey}, {@link exportAccountsWithPasskey}) for product
|
|
69
|
-
* flows instead of calling KeyringController with the returned key manually.
|
|
70
|
-
*
|
|
71
63
|
* @param authenticationResponse - Result of `navigator.credentials.get()`.
|
|
72
64
|
* @returns The plaintext vault encryption key.
|
|
73
65
|
*/
|
|
@@ -75,38 +67,6 @@ export type PasskeyControllerRetrieveVaultKeyWithPasskeyAction = {
|
|
|
75
67
|
type: `PasskeyController:retrieveVaultKeyWithPasskey`;
|
|
76
68
|
handler: PasskeyController['retrieveVaultKeyWithPasskey'];
|
|
77
69
|
};
|
|
78
|
-
/**
|
|
79
|
-
* Unlocks the keyring using a passkey authentication assertion.
|
|
80
|
-
*
|
|
81
|
-
* @param authenticationResponse - Result of `navigator.credentials.get()`.
|
|
82
|
-
* @returns Resolves when the keyring is unlocked.
|
|
83
|
-
*/
|
|
84
|
-
export type PasskeyControllerUnlockWithPasskeyAction = {
|
|
85
|
-
type: `PasskeyController:unlockWithPasskey`;
|
|
86
|
-
handler: PasskeyController['unlockWithPasskey'];
|
|
87
|
-
};
|
|
88
|
-
/**
|
|
89
|
-
* Exports the seed phrase after passkey step-up authentication.
|
|
90
|
-
*
|
|
91
|
-
* @param authenticationResponse - Result of `navigator.credentials.get()`.
|
|
92
|
-
* @param keyringId - Optional keyring id; defaults to the primary HD keyring.
|
|
93
|
-
* @returns Raw seed phrase bytes from KeyringController.
|
|
94
|
-
*/
|
|
95
|
-
export type PasskeyControllerExportSeedPhraseWithPasskeyAction = {
|
|
96
|
-
type: `PasskeyController:exportSeedPhraseWithPasskey`;
|
|
97
|
-
handler: PasskeyController['exportSeedPhraseWithPasskey'];
|
|
98
|
-
};
|
|
99
|
-
/**
|
|
100
|
-
* Exports private keys for the given addresses after passkey step-up authentication.
|
|
101
|
-
*
|
|
102
|
-
* @param authenticationResponse - Result of `navigator.credentials.get()`.
|
|
103
|
-
* @param addresses - Account addresses to export.
|
|
104
|
-
* @returns Private keys in the same order as `addresses`.
|
|
105
|
-
*/
|
|
106
|
-
export type PasskeyControllerExportAccountsWithPasskeyAction = {
|
|
107
|
-
type: `PasskeyController:exportAccountsWithPasskey`;
|
|
108
|
-
handler: PasskeyController['exportAccountsWithPasskey'];
|
|
109
|
-
};
|
|
110
70
|
/**
|
|
111
71
|
* Checks whether the given authentication assertion is valid for the enrolled passkey.
|
|
112
72
|
*
|
|
@@ -128,63 +88,25 @@ export type PasskeyControllerVerifyPasskeyAuthenticationAction = {
|
|
|
128
88
|
* pass the same `authenticationResponse` you just verified (e.g. from
|
|
129
89
|
* {@link retrieveVaultKeyWithPasskey} / {@link verifyPasskeyAuthentication}).
|
|
130
90
|
*
|
|
131
|
-
* For password change with passkey step-up, prefer
|
|
132
|
-
* {@link changePasswordWithPasskeyVerification}, which orchestrates keyring export,
|
|
133
|
-
* `changePassword`, and re-wrap in one call.
|
|
134
|
-
*
|
|
135
91
|
* @param params - Re-wrap inputs.
|
|
136
92
|
* @param params.authenticationResponse - Used to derive the wrapping key.
|
|
137
93
|
* @param params.oldVaultKey - Expected current vault key.
|
|
138
94
|
* @param params.newVaultKey - New vault key to encrypt under the passkey.
|
|
139
|
-
* @returns Resolves when the passkey record is updated.
|
|
140
95
|
*/
|
|
141
96
|
export type PasskeyControllerRenewVaultKeyProtectionAction = {
|
|
142
97
|
type: `PasskeyController:renewVaultKeyProtection`;
|
|
143
98
|
handler: PasskeyController['renewVaultKeyProtection'];
|
|
144
99
|
};
|
|
145
100
|
/**
|
|
146
|
-
*
|
|
147
|
-
*
|
|
148
|
-
* When `renewVaultKeyProtection` is `true` (default), re-wraps the vault key under the
|
|
149
|
-
* passkey after rotation. When `false`, removes the passkey instead.
|
|
150
|
-
*
|
|
151
|
-
* @param params - Change-password inputs.
|
|
152
|
-
* @param params.newPassword - New wallet password.
|
|
153
|
-
* @param params.authenticationResponse - Result of `navigator.credentials.get()`.
|
|
154
|
-
* @param params.options - Optional flow controls.
|
|
155
|
-
* @param params.options.renewVaultKeyProtection - Re-wrap vault key after password change.
|
|
156
|
-
* @returns Resolves when the password change completes.
|
|
101
|
+
* Clears enrolled passkey state and in-flight ceremonies. Call only after the same
|
|
102
|
+
* auth gate as renewal (verified passkey assertion or password).
|
|
157
103
|
*/
|
|
158
|
-
export type
|
|
159
|
-
type: `PasskeyController:
|
|
160
|
-
handler: PasskeyController['
|
|
161
|
-
};
|
|
162
|
-
/**
|
|
163
|
-
* Removes the enrolled passkey after verifying a passkey authentication assertion.
|
|
164
|
-
*
|
|
165
|
-
* @param authenticationResponse - Result of `navigator.credentials.get()`.
|
|
166
|
-
* @returns Resolves when the passkey is removed.
|
|
167
|
-
*/
|
|
168
|
-
export type PasskeyControllerRemovePasskeyWithPasskeyVerificationAction = {
|
|
169
|
-
type: `PasskeyController:removePasskeyWithPasskeyVerification`;
|
|
170
|
-
handler: PasskeyController['removePasskeyWithPasskeyVerification'];
|
|
171
|
-
};
|
|
172
|
-
/**
|
|
173
|
-
* Removes the enrolled passkey after verifying the wallet password.
|
|
174
|
-
*
|
|
175
|
-
* @param password - Wallet password for step-up verification.
|
|
176
|
-
* @returns Resolves when the passkey is removed.
|
|
177
|
-
*/
|
|
178
|
-
export type PasskeyControllerRemovePasskeyWithPasswordVerificationAction = {
|
|
179
|
-
type: `PasskeyController:removePasskeyWithPasswordVerification`;
|
|
180
|
-
handler: PasskeyController['removePasskeyWithPasswordVerification'];
|
|
104
|
+
export type PasskeyControllerRemovePasskeyAction = {
|
|
105
|
+
type: `PasskeyController:removePasskey`;
|
|
106
|
+
handler: PasskeyController['removePasskey'];
|
|
181
107
|
};
|
|
182
108
|
/**
|
|
183
109
|
* Resets state and clears in-flight registration/authentication ceremonies.
|
|
184
|
-
*
|
|
185
|
-
* For user-facing passkey removal with step-up, use
|
|
186
|
-
* {@link removePasskeyWithPasskeyVerification} or
|
|
187
|
-
* {@link removePasskeyWithPasswordVerification}.
|
|
188
110
|
*/
|
|
189
111
|
export type PasskeyControllerClearStateAction = {
|
|
190
112
|
type: `PasskeyController:clearState`;
|
|
@@ -200,5 +122,5 @@ export type PasskeyControllerDestroyAction = {
|
|
|
200
122
|
/**
|
|
201
123
|
* Union of all PasskeyController action types.
|
|
202
124
|
*/
|
|
203
|
-
export type PasskeyControllerMethodActions = PasskeyControllerIsPasskeyEnrolledAction | PasskeyControllerGenerateRegistrationOptionsAction | PasskeyControllerGeneratePostRegistrationAuthenticationOptionsAction | PasskeyControllerGenerateAuthenticationOptionsAction | PasskeyControllerProtectVaultKeyWithPasskeyAction | PasskeyControllerRetrieveVaultKeyWithPasskeyAction |
|
|
125
|
+
export type PasskeyControllerMethodActions = PasskeyControllerIsPasskeyEnrolledAction | PasskeyControllerGenerateRegistrationOptionsAction | PasskeyControllerGeneratePostRegistrationAuthenticationOptionsAction | PasskeyControllerGenerateAuthenticationOptionsAction | PasskeyControllerProtectVaultKeyWithPasskeyAction | PasskeyControllerRetrieveVaultKeyWithPasskeyAction | PasskeyControllerVerifyPasskeyAuthenticationAction | PasskeyControllerRenewVaultKeyProtectionAction | PasskeyControllerRemovePasskeyAction | PasskeyControllerClearStateAction | PasskeyControllerDestroyAction;
|
|
204
126
|
//# sourceMappingURL=PasskeyController-method-action-types.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PasskeyController-method-action-types.d.mts","sourceRoot":"","sources":["../src/PasskeyController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,gCAA4B;AAE7D;;;;GAIG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACrD,IAAI,EAAE,qCAAqC,CAAC;IAC5C,OAAO,EAAE,iBAAiB,CAAC,mBAAmB,CAAC,CAAC;CACjD,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,kDAAkD,GAAG;IAC/D,IAAI,EAAE,+CAA+C,CAAC;IACtD,OAAO,EAAE,iBAAiB,CAAC,6BAA6B,CAAC,CAAC;CAC3D,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,oEAAoE,GAC9E;IACE,IAAI,EAAE,iEAAiE,CAAC;IACxE,OAAO,EAAE,iBAAiB,CAAC,+CAA+C,CAAC,CAAC;CAC7E,CAAC;AAEJ;;;;GAIG;AACH,MAAM,MAAM,oDAAoD,GAAG;IACjE,IAAI,EAAE,iDAAiD,CAAC;IACxD,OAAO,EAAE,iBAAiB,CAAC,+BAA+B,CAAC,CAAC;CAC7D,CAAC;AAEF
|
|
1
|
+
{"version":3,"file":"PasskeyController-method-action-types.d.mts","sourceRoot":"","sources":["../src/PasskeyController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,gCAA4B;AAE7D;;;;GAIG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACrD,IAAI,EAAE,qCAAqC,CAAC;IAC5C,OAAO,EAAE,iBAAiB,CAAC,mBAAmB,CAAC,CAAC;CACjD,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,kDAAkD,GAAG;IAC/D,IAAI,EAAE,+CAA+C,CAAC;IACtD,OAAO,EAAE,iBAAiB,CAAC,6BAA6B,CAAC,CAAC;CAC3D,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,oEAAoE,GAC9E;IACE,IAAI,EAAE,iEAAiE,CAAC;IACxE,OAAO,EAAE,iBAAiB,CAAC,+CAA+C,CAAC,CAAC;CAC7E,CAAC;AAEJ;;;;GAIG;AACH,MAAM,MAAM,oDAAoD,GAAG;IACjE,IAAI,EAAE,iDAAiD,CAAC;IACxD,OAAO,EAAE,iBAAiB,CAAC,+BAA+B,CAAC,CAAC;CAC7D,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,iDAAiD,GAAG;IAC9D,IAAI,EAAE,8CAA8C,CAAC;IACrD,OAAO,EAAE,iBAAiB,CAAC,4BAA4B,CAAC,CAAC;CAC1D,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,kDAAkD,GAAG;IAC/D,IAAI,EAAE,+CAA+C,CAAC;IACtD,OAAO,EAAE,iBAAiB,CAAC,6BAA6B,CAAC,CAAC;CAC3D,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,kDAAkD,GAAG;IAC/D,IAAI,EAAE,+CAA+C,CAAC;IACtD,OAAO,EAAE,iBAAiB,CAAC,6BAA6B,CAAC,CAAC;CAC3D,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,8CAA8C,GAAG;IAC3D,IAAI,EAAE,2CAA2C,CAAC;IAClD,OAAO,EAAE,iBAAiB,CAAC,yBAAyB,CAAC,CAAC;CACvD,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,oCAAoC,GAAG;IACjD,IAAI,EAAE,iCAAiC,CAAC;IACxC,OAAO,EAAE,iBAAiB,CAAC,eAAe,CAAC,CAAC;CAC7C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,8BAA8B,CAAC;IACrC,OAAO,EAAE,iBAAiB,CAAC,YAAY,CAAC,CAAC;CAC1C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C,IAAI,EAAE,2BAA2B,CAAC;IAClC,OAAO,EAAE,iBAAiB,CAAC,SAAS,CAAC,CAAC;CACvC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,8BAA8B,GACtC,wCAAwC,GACxC,kDAAkD,GAClD,oEAAoE,GACpE,oDAAoD,GACpD,iDAAiD,GACjD,kDAAkD,GAClD,kDAAkD,GAClD,8CAA8C,GAC9C,oCAAoC,GACpC,iCAAiC,GACjC,8BAA8B,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PasskeyController-method-action-types.mjs","sourceRoot":"","sources":["../src/PasskeyController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { PasskeyController } from './PasskeyController';\n\n/**\n * Whether a passkey is enrolled and vault key material is stored.\n *\n * @returns `true` if enrolled, otherwise `false`.\n */\nexport type PasskeyControllerIsPasskeyEnrolledAction = {\n type: `PasskeyController:isPasskeyEnrolled`;\n handler: PasskeyController['isPasskeyEnrolled'];\n};\n\n/**\n * Builds WebAuthn credential creation options for passkey enrollment.\n *\n * @param creationOptionsConfig - Optional creation behavior.\n * @param creationOptionsConfig.prfAvailable - Request the PRF extension unless `false`. Defaults to `true`.\n * @returns Public key credential creation options for `navigator.credentials.create()`.\n */\nexport type PasskeyControllerGenerateRegistrationOptionsAction = {\n type: `PasskeyController:generateRegistrationOptions`;\n handler: PasskeyController['generateRegistrationOptions'];\n};\n\n/**\n * Builds WebAuthn credential request options for the post-registration\n * authentication step (between `create` and {@link protectVaultKeyWithPasskey}).\n *\n * @param params - Input for the pending registration ceremony.\n * @param params.registrationResponse - Result of `navigator.credentials.create()`.\n * @returns Public key credential request options for `navigator.credentials.get()`.\n */\nexport type PasskeyControllerGeneratePostRegistrationAuthenticationOptionsAction =\n {\n type: `PasskeyController:generatePostRegistrationAuthenticationOptions`;\n handler: PasskeyController['generatePostRegistrationAuthenticationOptions'];\n };\n\n/**\n * Builds WebAuthn credential request options for the enrolled passkey.\n *\n * @returns Public key credential request options for `navigator.credentials.get()`.\n */\nexport type PasskeyControllerGenerateAuthenticationOptionsAction = {\n type: `PasskeyController:generateAuthenticationOptions`;\n handler: PasskeyController['generateAuthenticationOptions'];\n};\n\n/**\n * Verifies registration and post-registration authentication, then stores the\n * vault key encrypted under the new passkey.\n *\n * Fetches the current vault encryption key from KeyringController before wrapping.\n * When onboarding is complete, requires `password` for step-up verification first.\n *\n * @param params - Enrollment completion inputs.\n * @param params.registrationResponse - Result of `navigator.credentials.create()`.\n * @param params.authenticationResponse - Result of `navigator.credentials.get()` after {@link generatePostRegistrationAuthenticationOptions}.\n * @param params.password - Wallet password when onboarding is complete (step-up).\n * @returns Resolves when enrollment completes.\n */\nexport type PasskeyControllerProtectVaultKeyWithPasskeyAction = {\n type: `PasskeyController:protectVaultKeyWithPasskey`;\n handler: PasskeyController['protectVaultKeyWithPasskey'];\n};\n\n/**\n * Verifies an authentication assertion and returns the decrypted vault key.\n *\n * Prefer orchestrated methods ({@link unlockWithPasskey},\n * {@link exportSeedPhraseWithPasskey}, {@link exportAccountsWithPasskey}) for product\n * flows instead of calling KeyringController with the returned key manually.\n *\n * @param authenticationResponse - Result of `navigator.credentials.get()`.\n * @returns The plaintext vault encryption key.\n */\nexport type PasskeyControllerRetrieveVaultKeyWithPasskeyAction = {\n type: `PasskeyController:retrieveVaultKeyWithPasskey`;\n handler: PasskeyController['retrieveVaultKeyWithPasskey'];\n};\n\n/**\n * Unlocks the keyring using a passkey authentication assertion.\n *\n * @param authenticationResponse - Result of `navigator.credentials.get()`.\n * @returns Resolves when the keyring is unlocked.\n */\nexport type PasskeyControllerUnlockWithPasskeyAction = {\n type: `PasskeyController:unlockWithPasskey`;\n handler: PasskeyController['unlockWithPasskey'];\n};\n\n/**\n * Exports the seed phrase after passkey step-up authentication.\n *\n * @param authenticationResponse - Result of `navigator.credentials.get()`.\n * @param keyringId - Optional keyring id; defaults to the primary HD keyring.\n * @returns Raw seed phrase bytes from KeyringController.\n */\nexport type PasskeyControllerExportSeedPhraseWithPasskeyAction = {\n type: `PasskeyController:exportSeedPhraseWithPasskey`;\n handler: PasskeyController['exportSeedPhraseWithPasskey'];\n};\n\n/**\n * Exports private keys for the given addresses after passkey step-up authentication.\n *\n * @param authenticationResponse - Result of `navigator.credentials.get()`.\n * @param addresses - Account addresses to export.\n * @returns Private keys in the same order as `addresses`.\n */\nexport type PasskeyControllerExportAccountsWithPasskeyAction = {\n type: `PasskeyController:exportAccountsWithPasskey`;\n handler: PasskeyController['exportAccountsWithPasskey'];\n};\n\n/**\n * Checks whether the given authentication assertion is valid for the enrolled passkey.\n *\n * On failure, returns `false` for {@link PasskeyControllerError} with a `code`;\n * other errors propagate.\n *\n * @param authenticationResponse - Result of `navigator.credentials.get()`.\n * @returns `true` if verification succeeds, otherwise `false`.\n */\nexport type PasskeyControllerVerifyPasskeyAuthenticationAction = {\n type: `PasskeyController:verifyPasskeyAuthentication`;\n handler: PasskeyController['verifyPasskeyAuthentication'];\n};\n\n/**\n * Re-wraps the vault key after rotation. Updates persisted `encryptedVaultKey` on success.\n *\n * Does not verify WebAuthn or ceremony state—call only after your layer has authenticated\n * the user (passkey `get()` + verified assertion, or verified password). On passkey paths,\n * pass the same `authenticationResponse` you just verified (e.g. from\n * {@link retrieveVaultKeyWithPasskey} / {@link verifyPasskeyAuthentication}).\n *\n * For password change with passkey step-up, prefer\n * {@link changePasswordWithPasskeyVerification}, which orchestrates keyring export,\n * `changePassword`, and re-wrap in one call.\n *\n * @param params - Re-wrap inputs.\n * @param params.authenticationResponse - Used to derive the wrapping key.\n * @param params.oldVaultKey - Expected current vault key.\n * @param params.newVaultKey - New vault key to encrypt under the passkey.\n * @returns Resolves when the passkey record is updated.\n */\nexport type PasskeyControllerRenewVaultKeyProtectionAction = {\n type: `PasskeyController:renewVaultKeyProtection`;\n handler: PasskeyController['renewVaultKeyProtection'];\n};\n\n/**\n * Changes the wallet password after passkey step-up authentication.\n *\n * When `renewVaultKeyProtection` is `true` (default), re-wraps the vault key under the\n * passkey after rotation. When `false`, removes the passkey instead.\n *\n * @param params - Change-password inputs.\n * @param params.newPassword - New wallet password.\n * @param params.authenticationResponse - Result of `navigator.credentials.get()`.\n * @param params.options - Optional flow controls.\n * @param params.options.renewVaultKeyProtection - Re-wrap vault key after password change.\n * @returns Resolves when the password change completes.\n */\nexport type PasskeyControllerChangePasswordWithPasskeyVerificationAction = {\n type: `PasskeyController:changePasswordWithPasskeyVerification`;\n handler: PasskeyController['changePasswordWithPasskeyVerification'];\n};\n\n/**\n * Removes the enrolled passkey after verifying a passkey authentication assertion.\n *\n * @param authenticationResponse - Result of `navigator.credentials.get()`.\n * @returns Resolves when the passkey is removed.\n */\nexport type PasskeyControllerRemovePasskeyWithPasskeyVerificationAction = {\n type: `PasskeyController:removePasskeyWithPasskeyVerification`;\n handler: PasskeyController['removePasskeyWithPasskeyVerification'];\n};\n\n/**\n * Removes the enrolled passkey after verifying the wallet password.\n *\n * @param password - Wallet password for step-up verification.\n * @returns Resolves when the passkey is removed.\n */\nexport type PasskeyControllerRemovePasskeyWithPasswordVerificationAction = {\n type: `PasskeyController:removePasskeyWithPasswordVerification`;\n handler: PasskeyController['removePasskeyWithPasswordVerification'];\n};\n\n/**\n * Resets state and clears in-flight registration/authentication ceremonies.\n *\n * For user-facing passkey removal with step-up, use\n * {@link removePasskeyWithPasskeyVerification} or\n * {@link removePasskeyWithPasswordVerification}.\n */\nexport type PasskeyControllerClearStateAction = {\n type: `PasskeyController:clearState`;\n handler: PasskeyController['clearState'];\n};\n\n/**\n * Releases all in-flight ceremony state and tears down the messenger.\n */\nexport type PasskeyControllerDestroyAction = {\n type: `PasskeyController:destroy`;\n handler: PasskeyController['destroy'];\n};\n\n/**\n * Union of all PasskeyController action types.\n */\nexport type PasskeyControllerMethodActions =\n | PasskeyControllerIsPasskeyEnrolledAction\n | PasskeyControllerGenerateRegistrationOptionsAction\n | PasskeyControllerGeneratePostRegistrationAuthenticationOptionsAction\n | PasskeyControllerGenerateAuthenticationOptionsAction\n | PasskeyControllerProtectVaultKeyWithPasskeyAction\n | PasskeyControllerRetrieveVaultKeyWithPasskeyAction\n | PasskeyControllerUnlockWithPasskeyAction\n | PasskeyControllerExportSeedPhraseWithPasskeyAction\n | PasskeyControllerExportAccountsWithPasskeyAction\n | PasskeyControllerVerifyPasskeyAuthenticationAction\n | PasskeyControllerRenewVaultKeyProtectionAction\n | PasskeyControllerChangePasswordWithPasskeyVerificationAction\n | PasskeyControllerRemovePasskeyWithPasskeyVerificationAction\n | PasskeyControllerRemovePasskeyWithPasswordVerificationAction\n | PasskeyControllerClearStateAction\n | PasskeyControllerDestroyAction;\n"]}
|
|
1
|
+
{"version":3,"file":"PasskeyController-method-action-types.mjs","sourceRoot":"","sources":["../src/PasskeyController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { PasskeyController } from './PasskeyController';\n\n/**\n * Whether a passkey is enrolled and vault key material is stored.\n *\n * @returns `true` if enrolled, otherwise `false`.\n */\nexport type PasskeyControllerIsPasskeyEnrolledAction = {\n type: `PasskeyController:isPasskeyEnrolled`;\n handler: PasskeyController['isPasskeyEnrolled'];\n};\n\n/**\n * Builds WebAuthn credential creation options for passkey enrollment.\n *\n * @param creationOptionsConfig - Optional creation behavior.\n * @param creationOptionsConfig.prfAvailable - Request the PRF extension unless `false`. Defaults to `true`.\n * @returns Public key credential creation options for `navigator.credentials.create()`.\n */\nexport type PasskeyControllerGenerateRegistrationOptionsAction = {\n type: `PasskeyController:generateRegistrationOptions`;\n handler: PasskeyController['generateRegistrationOptions'];\n};\n\n/**\n * Builds WebAuthn credential request options for the post-registration\n * authentication step (between `create` and {@link protectVaultKeyWithPasskey}).\n *\n * @param params - Input for the pending registration ceremony.\n * @param params.registrationResponse - Result of `navigator.credentials.create()`.\n * @returns Public key credential request options for `navigator.credentials.get()`.\n */\nexport type PasskeyControllerGeneratePostRegistrationAuthenticationOptionsAction =\n {\n type: `PasskeyController:generatePostRegistrationAuthenticationOptions`;\n handler: PasskeyController['generatePostRegistrationAuthenticationOptions'];\n };\n\n/**\n * Builds WebAuthn credential request options for the enrolled passkey.\n *\n * @returns Public key credential request options for `navigator.credentials.get()`.\n */\nexport type PasskeyControllerGenerateAuthenticationOptionsAction = {\n type: `PasskeyController:generateAuthenticationOptions`;\n handler: PasskeyController['generateAuthenticationOptions'];\n};\n\n/**\n * Verifies registration and post-registration authentication, then stores the\n * vault key encrypted under the new passkey.\n *\n * @param params - Enrollment completion inputs.\n * @param params.registrationResponse - Result of `navigator.credentials.create()`.\n * @param params.authenticationResponse - Result of `navigator.credentials.get()` after {@link generatePostRegistrationAuthenticationOptions}.\n * @param params.vaultKey - Vault encryption key to encrypt and persist.\n */\nexport type PasskeyControllerProtectVaultKeyWithPasskeyAction = {\n type: `PasskeyController:protectVaultKeyWithPasskey`;\n handler: PasskeyController['protectVaultKeyWithPasskey'];\n};\n\n/**\n * Verifies an authentication assertion and returns the decrypted vault key.\n *\n * @param authenticationResponse - Result of `navigator.credentials.get()`.\n * @returns The plaintext vault encryption key.\n */\nexport type PasskeyControllerRetrieveVaultKeyWithPasskeyAction = {\n type: `PasskeyController:retrieveVaultKeyWithPasskey`;\n handler: PasskeyController['retrieveVaultKeyWithPasskey'];\n};\n\n/**\n * Checks whether the given authentication assertion is valid for the enrolled passkey.\n *\n * On failure, returns `false` for {@link PasskeyControllerError} with a `code`;\n * other errors propagate.\n *\n * @param authenticationResponse - Result of `navigator.credentials.get()`.\n * @returns `true` if verification succeeds, otherwise `false`.\n */\nexport type PasskeyControllerVerifyPasskeyAuthenticationAction = {\n type: `PasskeyController:verifyPasskeyAuthentication`;\n handler: PasskeyController['verifyPasskeyAuthentication'];\n};\n\n/**\n * Re-wraps the vault key after rotation. Updates persisted `encryptedVaultKey` on success.\n *\n * Does not verify WebAuthn or ceremony state—call only after your layer has authenticated\n * the user (passkey `get()` + verified assertion, or verified password). On passkey paths,\n * pass the same `authenticationResponse` you just verified (e.g. from\n * {@link retrieveVaultKeyWithPasskey} / {@link verifyPasskeyAuthentication}).\n *\n * @param params - Re-wrap inputs.\n * @param params.authenticationResponse - Used to derive the wrapping key.\n * @param params.oldVaultKey - Expected current vault key.\n * @param params.newVaultKey - New vault key to encrypt under the passkey.\n */\nexport type PasskeyControllerRenewVaultKeyProtectionAction = {\n type: `PasskeyController:renewVaultKeyProtection`;\n handler: PasskeyController['renewVaultKeyProtection'];\n};\n\n/**\n * Clears enrolled passkey state and in-flight ceremonies. Call only after the same\n * auth gate as renewal (verified passkey assertion or password).\n */\nexport type PasskeyControllerRemovePasskeyAction = {\n type: `PasskeyController:removePasskey`;\n handler: PasskeyController['removePasskey'];\n};\n\n/**\n * Resets state and clears in-flight registration/authentication ceremonies.\n */\nexport type PasskeyControllerClearStateAction = {\n type: `PasskeyController:clearState`;\n handler: PasskeyController['clearState'];\n};\n\n/**\n * Releases all in-flight ceremony state and tears down the messenger.\n */\nexport type PasskeyControllerDestroyAction = {\n type: `PasskeyController:destroy`;\n handler: PasskeyController['destroy'];\n};\n\n/**\n * Union of all PasskeyController action types.\n */\nexport type PasskeyControllerMethodActions =\n | PasskeyControllerIsPasskeyEnrolledAction\n | PasskeyControllerGenerateRegistrationOptionsAction\n | PasskeyControllerGeneratePostRegistrationAuthenticationOptionsAction\n | PasskeyControllerGenerateAuthenticationOptionsAction\n | PasskeyControllerProtectVaultKeyWithPasskeyAction\n | PasskeyControllerRetrieveVaultKeyWithPasskeyAction\n | PasskeyControllerVerifyPasskeyAuthenticationAction\n | PasskeyControllerRenewVaultKeyProtectionAction\n | PasskeyControllerRemovePasskeyAction\n | PasskeyControllerClearStateAction\n | PasskeyControllerDestroyAction;\n"]}
|