triplesec

Triple Security for the browser and Node.js

  • Owner: keybase/triplesec
  • Platform:
  • License:: MIT License
  • Category::
  • Topic:
  • Like:
    0
      Compare:

Github stars Tracking Chart

node-triplesec

A CommonJS module for symmetric key encryption of smallish secrets

How to install

npm install triplesec

How to Use

One-shot Mode

{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:

{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).

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

Full API Documentation

Documentation generated by codo
is available here.

Main metrics

Overview
Name With Ownerkeybase/triplesec
Primary LanguageJavaScript
Program languageMakefile (Language Count: 8)
Platform
License:MIT License
所有者活动
Created At2013-08-28 15:40:48
Pushed At2023-04-15 14:09:22
Last Commit At2020-03-24 10:28:09
Release Count36
Last Release Namev4.0.3 (Posted on 2019-02-01 16:23:56)
First Release Namev0.0.1 (Posted on 2013-09-16 16:16:08)
用户参与
Stargazers Count401
Watchers Count21
Fork Count47
Commits Count589
Has Issues Enabled
Issues Count68
Issue Open Count23
Pull Requests Count11
Pull Requests Open Count8
Pull Requests Close Count3
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private