UNPKG

1.38 kBMarkdownView Raw
1# Cloud Keychain for Node.js (v0.1)
2
3This is a small library to make it easy to work with
4 [1Password's](http://agilebits.com/onepassword) .cloudKeychain files.
5
6This implementation is based on the
7 [official Agile Bits documentation](http://learn.agilebits.com/1Password4/Security/keychain-design.html)
8 and also the python library [OnePasswordPy](http://github.com/roguelazer/onepasswordpy).
9
10*IMPORTANT NOTE*: I am not in any way affiliated with AgileBits, the makers
11 of 1Password. Their software is awesome and you should probably go buy it.
12 Please don't sue me!
13
14Currently supported:
15
16- Unlock keychain using Master Password
17- Load items from band_*.js files
18- Unlock item overview, keys and details
19- Create keychains and items
20
21
22Todo:
23
24- Find out how to calcuate the HMAC of items correctly
25- Actually do something with item data (instead of just handing back the raw
26JSON)
27
28## Installation
29
30Install via NPM:
31
32 npm install 1passwordjs
33
34Then require it:
35
36 Keychain = require('1passwordjs')
37 keychain = new Keychain()
38 keychain.open('./1password.cloudkeychain')
39 keychain.unlock('password')
40
41
42## Tests
43
44Tests are written using [Mocha](http://visionmedia.github.com/mocha/).
45To run the tests
46
47 mocha --compilers coffee:coffee-script tests
48
49License
50-------
51This work is licensed under the ISC license.
\No newline at end of file