Skip to content

Commit 4a8fa68

Browse files
committed
Update README.md
1 parent 3f46211 commit 4a8fa68

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ A Tauri plugin for biometric authentication (Touch ID, Face ID, Windows Hello, f
1111
- 🔐 Biometric authentication (Touch ID, Face ID, Windows Hello, fingerprint)
1212
- 📱 Full support for iOS and Android
1313
- 🖥️ Desktop support for macOS (Touch ID) and Windows (Windows Hello)
14-
- 🔑 Secure data storage with biometric protection (Android/iOS/macOS only)
14+
- 🔑 Secure data storage with biometric protection (Android/iOS/macOS/Windows)
1515
- 🎛️ Fallback to device passcode/password
1616
- 🛡️ Native security best practices
1717
- ⚡ Proper error handling with detailed error codes
@@ -116,7 +116,7 @@ try {
116116
}
117117
```
118118

119-
### Store Secure Data (macOS/iOS only)
119+
### Store Secure Data
120120

121121
```typescript
122122
import { setData, getData, hasData, removeData } from '@choochmeque/tauri-plugin-biometry-api';
@@ -151,8 +151,6 @@ await removeData({
151151
});
152152
```
153153

154-
**Note:** Data storage methods are not supported on Windows and will return a `notSupported` error.
155-
156154
## API Reference
157155

158156
### Types
@@ -234,7 +232,9 @@ Removes secure data.
234232
### Windows
235233

236234
- Supports Windows Hello (fingerprint, face, PIN)
237-
- Authentication only (data storage methods return "not supported" error)
235+
- Full secure data storage using Windows Hello credentials
236+
- Data is encrypted using AES-256 with Windows Hello protected keys
237+
- **Note:** `setData` will prompt for Windows Hello authentication when storing data
238238
- Automatically focuses Windows Hello dialog
239239
- Returns `BiometryType.Auto` as it uses Windows Hello's automatic selection
240240

@@ -261,10 +261,10 @@ Common error codes returned by the plugin:
261261

262262
## Security Considerations
263263

264-
- All secure data is stored in the system keychain (macOS/iOS) or Android Keystore
264+
- All secure data is stored in the system keychain (macOS/iOS), Android Keystore, or Windows Credential Manager
265265
- Data is encrypted and can only be accessed after successful biometric authentication
266266
- The plugin follows platform-specific security best practices
267-
- Windows currently supports authentication only, not secure data storage
267+
- Windows uses AES-256 encryption with keys derived from Windows Hello credentials
268268
- **macOS Code Signing:** Your app must be properly code-signed to use keychain storage on macOS. Development builds may work with ad-hoc signing, but production apps require valid Developer ID or App Store signing
269269
- Consider implementing additional application-level encryption for highly sensitive data
270270

0 commit comments

Comments
 (0)