Repository files navigation

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.

npm install keytar

Currently this library useslibsecret so you may need to install it before runningnpm 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

• Clone the repository
• Runnpm install
• Runnpm test to run the tests

Each release ofkeytar includes prebuilt binaries for the versions of Node and Electron that are actively supported by these projects. Please refer to the release documentation forNode andElectron to see what is supported currently.

• Rust

constkeytar=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.

Get the stored password for theservice andaccount.

service - The string service name.

account - The string account name.

Yields the string password ornull if an entry for the given service and account was not found.

Save thepassword for theservice andaccount 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.

Delete the stored password for theservice andaccount.

service - The string service name.

account - The string account name.

Yieldstrue if a password was deleted, orfalse if an entry with the given service and account was not found.

Find all accounts and password for theservice in the keychain.

service - The string service name.

Yields an array of{ account: 'foo', password: 'bar' }.

Find a password for theservice in the keychain. This is ideal for scenarios where anaccount is not required.

service - The string service name.

Yields the string password, ornull if an entry for the given service was not found.