API Docs for: 0.2.0
Show:

lockbox Class

Defined in: src/main.coffee:26

The main Lockbox module.

Methods

decrypt

(
  • key
  • data
)
Buffer

Defined in src/main.coffee:133

Decrypt a data packet.

Throws:

Parameters:

  • key ursa.Key

    The key to decrypt with.

  • data String | Buffer

    The data to decrypt.

Returns:

Buffer:

The decrypted data.

encrypt

(
  • key
  • data
)
Buffer

Defined in src/main.coffee:120

Encrypt a data packet.

Parameters:

  • key ursa.Key

    The key to encrypt with.

  • data String | Buffer

    The data to encrypt.

Returns:

Buffer:

The encrypted data.

Properties

BoundCipher

Function

Defined in src/main.coffee:34

The bound bi-directional cipher class.

BoundDecryptionCipher

Function

Defined in src/main.coffee:41

The bound decryption cipher class.

BoundEncryptionCipher

Function

Defined in src/main.coffee:48

The bound encryption cipher class.

Cipher

Function

Defined in src/main.coffee:55

The bi-directional cipher class.

DecryptionCipher

Function

Defined in src/main.coffee:62

The decryption cipher class.

EncryptionCipher

Function

Defined in src/main.coffee:69

The bound encryption cipher class.

exception.DecryptionFailedException

Function

Defined in src/main.coffee:85

The decryption failed exception class.

exception.InvalidPrivateKeyException

Function

Defined in src/main.coffee:92

The invalid private key exception class.

exception.InvalidPublicKeyException

Function

Defined in src/main.coffee:99

The invalid public key exception class.

exception.ReadException

Function

Defined in src/main.coffee:106

The read exception class.

keyFactory

lockbox.KeyFactory

Defined in src/main.coffee:113

A key factory instance.

KeyFactory

Function

Defined in src/main.coffee:76

The key factory class.