Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Native Password Node Module

2.1.0

latest commit d1604a60d0
Cheng Zhao zcbenz authored
Failed to load latest commit information.
script Do not run specs.
spec findPassword doesn't guarentee to return first password.
src Require .node file directly
.gitignore
.npmignore Initial commit
.travis.yml make CI build faster
Gruntfile.coffee
LICENSE.md Add LICENSE.md
README.md Add keyring note
binding.gyp Ignore deprecations on Linux
package.json 2.1.0

README.md

keytar - Node module to manage system keychain

A native Node module to get, add, replace, and delete passwords in system's keychain. On OS X the passwords are managed by the Keychain, on Linux they are managed by Gnome Keyring and on Windows they are managed by Credential Vault.

Installing

npm install keytar

On Linux

Currently this library uses the gnome-keyring so you may need to run sudo apt-get install libgnome-keyring-dev before npm installing.

Building

  • Clone the repository
  • Run npm install
  • Run grunt to compile the native and CoffeeScript code
  • Run grunt test to run the specs

Docs

keytar = require 'keytar'

getPassword(service, account)

Get the stored password for the service and account.

service - The string service name.

account - The string account name.

Returns the string password or null on failures.

addPassword(service, account, password)

Add the password for the service and account to the keychain.

service - The string service name.

account - The string account name.

password - The string password.

Returns true on success, false on failure.

deletePassword(service, account)

Delete the stored password for the service and account.

service - The string service name.

account - The string account name.

Returns the string password or null on failures.

replacePassword(service, account, password)

Replace the password for the service and account in the keychain.

This is a simple convenience function that internally calls deletePassword(service, account) followed by addPassword(service, account, password).

service - The string service name.

account - The string account name.

password - The string password.

Returns true on success, false on failure.

findPassword(service)

Find a password for the service in the keychain.

service - The string service name.

Returns the string password or null on failures.

Something went wrong with that request. Please try again.