Basic Keychain Access on Mac computers running Node.js

This module adds methods for basic Keychain access in Node.js by way of the security command-line tool.

Requirements

• Mac OS X 10.6+

Installation

npm install keychain

Examples

Generic Password Example

1var keychain = require('keychain');
2
3keychain.setPassword({ account: 'foo', service: 'FooBar', password: 'baz' }, function(err) {
4  keychain.getPassword({ account: 'foo', service: 'FooBar' }, function(err, pass) {
5    console.log('Password is', pass);
6    // Prints: Password is baz
7  });
8});

Internet Password Example

1var keychain = require('keychain');
2
3keychain.setPassword({ account: 'foo', service: 'FooBar.com', type: 'internet', password: 'baz' }, function(err) {
4  keychain.getPassword({ account: 'foo', service: 'FooBar.com', type: 'internet' }, function(err, pass) {
5    console.log('Password is', pass);
6    // Prints: Password is baz
7  });
8});

Usage

The available

1keychain.setPassword(options[, callback]);
2keychain.getPassword(options, callback);
3keychain.deletePassword(options[, callback]);
4keychain.createKeychain(options[, callback]);
5keychain.deleteKeychain(options[, callback]);
6keychain.setDefaultKeychain(options[, callback]);

Options

Available params you can pass to the options object:

Param	Description
account	Specify account name (required)
service	Specify service name (required)
password	Specify password to be added (required for setPassword)
type	The type of password to get or save. Supported values are generic and internet. See docs. Default: generic
keychainName	Specify the name of the keychain (required for 'createKeychain' and 'deleteKeychain')

Contributors

The following are the major contributors of node-keychain (in no specific order).

• Nicholas Penree (drudge)
• Tejesh Mehta (tjmehta)
• Benjamin Hutchins (benhutchins)
• Manuel de la Pena (mandel-macaque)

License

(The MIT License)

Copyright (c) 2013-2023 Nicholas Penree <nick@penree.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.