https://github.com/keybase/triplesec

Triple Security for the browser and Node.js
https://github.com/keybase/triplesec

Last synced: 3 months ago
JSON representation

Triple Security for the browser and Node.js

• Host: GitHub
• URL: https://github.com/keybase/triplesec
• Owner: keybase
• License: mit
• Created: 2013-08-28T15:40:48.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2023-04-15T14:09:22.000Z (over 1 year ago)
• Last Synced: 2024-08-01T04:10:00.512Z (3 months ago)
• Language: JavaScript
• Homepage: https://keybase.io/triplesec
• Size: 35 MB
• Stars: 401
• Watchers: 23
• Forks: 48
• Open Issues: 30
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# node-triplesec

A CommonJS module for symmetric key encryption of smallish secrets

## How to install

```sh

npm install triplesec

```

## How to Use

### One-shot Mode

```coffeescript

{encrypt, decrypt} = require 'triplesec'

key = new Buffer 'top-secret-pw'

pt0 = new Buffer 'the secret!'

pt1 = new Buffer pt0

encrypt { key, data : pt1 }, (err, ciphertext) ->

	decrypt { key, data : ciphertext }, (err, pt2) ->

		console.log "Right back the start! #{pt0} is #{pt2}"

```

### Reusable Derived Keys

The most expensive part of TripleSec is to derive keys from your

given passphrase.  This is intentionally so to make it more expensive

to crack your password in the case that your ciphertext is stolen. 

However, you can spread this expense over multiple encryptions

if you plan to be encrypting more than once:

```coffeescript

{Encryptor, Decryptor} = require 'triplesec'

key = new Buffer 'top-secret-pw'

enc = new Encryptor { key }

dec = new Decryptor { key }

pt0 = new Buffer 'the secret!'

pt1 = new Buffer pt0

pt2 = new Buffer pt0

enc.run { data : pt1 }, (err, ct1) ->

	enc.run { data : pt2 }, (err, ct2) ->

		dec.run { data : ct1 }, (err, pt3) ->

			dec.run { data : ct2 }, (err, pt4) ->

				console.log "Right back the start! #{pt0} is #{pt3} is #{pt4}"

```

If you want to resalt derived keys with every encryption, you should explicitly

ask for that. Otherwise, salt will be reused to speed up encryption

(and decryption).

```coffeescript

enc.run { data : pt1 }, (err, ct1) ->

	enc.resalt {}, () ->

		enc.run { data : pt2 }, (err, ct2) ->

```

### Full API Documentation

Documentation generated by [codo](https://github.com/netzpirat/codo)

is available [here](http://keybase.github.io/triplesec/codo/index.html).