@makepro-x/keytar
v7.10.2
Published
Bindings to native Mac/Linux/Windows password APIs
Downloads
16
Readme
keytar - Node module to manage system keychain
This is a fork of the original project since that was archived on December 15, 2022.
A native Node module to get, add, replace, and delete passwords in system's keychain. On macOS the passwords are managed by the Keychain, on Linux they are managed by the Secret Service API/libsecret, and on Windows they are managed by Credential Vault.
Installing
npm install keytar
On Linux
Currently this library uses libsecret
so you may need to install it before running npm install
.
Depending on your distribution, you will need to run the following command:
- Debian/Ubuntu:
sudo apt-get install libsecret-1-dev
- Red Hat-based:
sudo yum install libsecret-devel
- Arch Linux:
sudo pacman -S libsecret
Building
- Clone the repository
- Run
npm install
- Run
npm test
to run the tests
Supported versions
Each release of keytar
includes prebuilt binaries for the versions of Node and Electron that are actively supported by these projects. Please refer to the release documentation for Node and Electron to see what is supported currently.
Bindings from other languages
Docs
const keytar = require('keytar')
Every function in keytar is asynchronous and returns a promise. The promise will be rejected with any error that occurs or will be resolved with the function's "yields" value.
getPassword(service, account)
Get the stored password for the service
and account
.
service
- The string service name.
account
- The string account name.
Yields the string password or null
if an entry for the given service and account was not found.
setPassword(service, account, password)
Save the password
for the service
and account
to the keychain. Adds a new entry if necessary, or updates an existing entry if one exists.
service
- The string service name.
account
- The string account name.
password
- The string password.
Yields nothing.
deletePassword(service, account)
Delete the stored password for the service
and account
.
service
- The string service name.
account
- The string account name.
Yields true
if a password was deleted, or false
if an entry with the given service and account was not found.
findCredentials(service)
Find all accounts and password for the service
in the keychain.
service
- The string service name.
Yields an array of { account: 'foo', password: 'bar' }
.
findPassword(service)
Find a password for the service
in the keychain. This is ideal for scenarios where an account
is not required.
service
- The string service name.
Yields the string password, or null
if an entry for the given service was not found.