# xkeychain

> Basic cross-platform Keychain access

Latest version **0.0.6** (published 2015-08-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install xkeychain
pnpm add xkeychain
yarn add xkeychain
bun add xkeychain
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.6 |
| Published | 2015-08-25 |
| First published | 2014-04-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 10 |
| Author | Michael Voorhaen |
| Maintainers | mvhaen |
| Keywords | osx, keychain, password, mac |

## Links

- npm: https://www.npmjs.com/package/xkeychain
- Repository: git@github.com:mvhaen/node-xkeychain
- Homepage: https://github.com/mvhaen/node-xkeychain
- Issues: https://github.com/mvhaen/node-xkeychain/issues
- npm.io page: https://npm.io/package/xkeychain

## Recent versions

- 0.0.6 (latest) — 2015-08-25
- 0.0.5 — 2014-04-22
- 0.0.4 — 2014-04-22
- 0.0.3 — 2014-04-22

## README

#  Basic Cross-Platorm Keychain Access for Node.js 

  This module adds methods for basic Keychain access in Node.js **This is in-development and is not feature complete.**
  
  For MAC only support check out the xkeychain npm module (https://github.com/drudge/node-keychain).

## Requirements

 * Mac OS X 10.6+
 * Windows XP or higher
 * Ubuntu Linux (uses GNOME keyring).

## Installation

    npm install xkeychain
    
## Example

```javascript
var keychain = require('keychain');

keychain.setPassword({ account: 'foo', service: 'FooBar', password: 'baz' }, function(err) {
  keychain.getPassword({ account: 'foo', service: 'FooBar' }, function(err, pass) {
    console.log('Password is', pass);
    // Prints: Password is baz
  });
});
```

## Contributors

This module was originally implemented by Nicholas Penree ([drudge](http://github.com/drudge)) as node-keychain. This module focuses on OS X while this one focuses on supporting multiple OSes at once.

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

  * Michael Vooorhaen ([mvhaen](http://github.com/mvhaen))

## License 

(The MIT License)

Copyright (c) 2011 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.

---
_Source: https://npm.io/package/xkeychain · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._