https://github.com/mikescops/node-native-keychain
🔐 Node.js native macos keychain module written in Swift
https://github.com/mikescops/node-native-keychain
keychain koffi macos napi node nodejs
Last synced: 2 months ago
JSON representation
🔐 Node.js native macos keychain module written in Swift
- Host: GitHub
- URL: https://github.com/mikescops/node-native-keychain
- Owner: Mikescops
- License: mit
- Created: 2024-04-03T09:02:30.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-07-11T14:37:58.000Z (12 months ago)
- Last Synced: 2025-08-09T11:44:07.670Z (11 months ago)
- Topics: keychain, koffi, macos, napi, node, nodejs
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/native-keychain
- Size: 227 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Node Native Keychain
This is a TypeScript library to store and retrieve secure information from the macos keychain. It is a wrapper around the native keychain APIs on macOS built in Swift and bindings with Koffi.
## Installation
```bash
npm install native-keychain
```
## Usage
> **Note:** For the moment, we only store [Generic passwords](https://developer.apple.com/documentation/security/ksecclassgenericpassword) in the keychain.
```typescript
import * as keychain from 'native-keychain';
keychain.setPassword({
service: 'my-service',
account: 'my-account',
password: 'my-password'
});
const secret = await keychain.getPassword({
service: 'my-service',
account: 'my-account',
requireBiometrics: true
}); // 'my-password'
```
## Available methods
| Method | Description | Output |
| ------------------------------- | -------------------------------------- | ------------------ |
| `getPassword` | Retrieve a password from the keychain. | `Promise` |
| `setPassword` | Store a password in the keychain. | `void` |
| `deletePassword` | Delete a password from the keychain. | `void` |
| `isBiometricsSupported` | Check if biometrics is supported. | `boolean` |
| `requestBiometricsVerification` | Request biometrics verification. | `Promise` |
## Development
### Running Tests
```bash
npm run test
```
**Note:** The tests require user interaction for biometric authentication. When prompted, please authenticate using Touch ID, Face ID, or your system password to complete the biometric verification tests.
The test suite includes:
- Biometric support verification
- Password storage and retrieval with accounts
- Biometric-protected password operations
- Cleanup and error handling
### Building
```bash
npm run build
```
### Linting
```bash
npm run lint
```
## Maintainer
| [](https://pixelswap.fr 'Personal Website') |
| --------------------------------------------------------------------------------------------------------------------------- |
| [Corentin Mors](https://pixelswap.fr/) |