pbkdf2-opgp-key

opgp-service keys encrypted with a pbkdf2-sha512 digest.

Pbkdf2OpgpKey instances encapsulate a private OpgpProxyKey. ES5. TypeScript support. 1.1kb gzip.

example

import getPbkdf2OpgpKeyFactory from 'pbkdf2-opgp-key'
import getOpgpService from 'opgp-service'
import debug = require('debug')
debug.enable('example:*')
 
const opgp = getOpgpService()
const getPbkdf2OpgpKey = getPbkdf2OpgpKeyFactory(opgp, {
  // keysize: 2048, locked: false (defaults)
  pbkdf2: {
    salt: 32, // generate random 32-byte long string, encoding: base64 (default)
    iterations: 8192, // min 8192, default 65536
    length: 64 // min 32, max 64, default 64
    // digest is always 'sha512'
  }
})
 
debug('example:')('generate key...')
const key = getPbkdf2OpgpKey('j.doe@example.com', 'secret passphrase')
key.then(debug('example:key:'))
// { key: OpgpProxyKey, pbkdf2: { salt: "...", ... }, unlock: Function, toArmor: Function, clone: Function }
 
const armor = key.then(key => key.toArmor())
armor.then(debug('example:armor:'))
// { armor: "-----BEGIN PGP PRIVATE KEY BLOCK----- ...", pbkdf2: { salt: "...", ... } }
 
armor.then(armor => getPbkdf2OpgpKey(armor, 'secret passphrase'))
.then(debug('example:from-armor:'))
// { key: OpgpProxyKey, pbkdf2: { salt: "...", ... }, unlock: Function, toArmor: Function, clone: Function }

the files of this example are available in this repository.

view a live version of this example in your browser console, or clone this repository and run the following commands from a terminal:

npm install
npm run example

API v2.0 stable

ES5 and Typescript compatible. coded in Typescript 3, transpiled to ES5.

secure Pbkdf2OpgpKey instances can either be randomly generated, or imported from an armored representation. the corresponding factory is instantiated with the exported builder.

Pbkdf2OpgpKey instances currently expose a single method: unlock (passphrase: string): Promise<Pbkdf2OpgpKeyClass>

browse the API's public type declarations.

for a detailed specification of the API, run the unit tests in your browser.

CONTRIBUTING

see the contribution guidelines

LICENSE

Copyright 2017 Stéphane M. Catala

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and Limitations under the License.