Skip to content
Native Password Node Module
Branch: master
Clone or download
Latest commit 99d3058 Feb 21, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docker/i386 remove diagnostic helpers Jul 3, 2018
lib Adds a findCredentials method which yields an array of account/passwo… Dec 13, 2017
script Rename auth token variable Feb 28, 2018
spec
src switch over to nan-specific string abstraction that bypasses v8 versi… Feb 6, 2019
.babelrc
.gitignore
.npmignore Restore .npmignore Feb 28, 2018
.travis.yml
LICENSE.md
README.md updated README to drop warning about ABI issue Feb 5, 2019
appveyor.yml
binding.gyp
keytar.d.ts
package-lock.json
package.json

README.md

keytar - Node module to manage system keychain

Travis Build Status Windows Build Status Dependency Status

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

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.

You can’t perform that action at this time.