@crpdo/crypto

@crpdo/crypto

if you know, you know

@crpdo/crypto is a comprehensive cryptographic module part of the larger crpdo project. It is a set of cryptographic functions designed for encryption, decryption and other security related tasks. This module includes three sub-modules, namely Nacl, Mnemonic, and the main Crypto container class.

Installation

npm install @crpdo/crypto

Usage

Crypto Container Class

Import the module in your JavaScript file:

const Crypto = require('@crpdo/crypto')

// constant time comparison
const equal = Crypto.verify('a', 'a')

// generate random bytes
const bytes = Crypto.randomBytes()

// etc..

Sub-Modules

Nacl

Nacl is a high-speed software library for network communication, encryption, decryption, signatures, etc. It includes various functionalities like public and secret key cryptography.

Usage

const Nacl = require('@crpdo/crypto/nacl')

const key = Nacl.createSignKey()
const signature = Nacl.sign('data', key.privateKey)
const validSignature = Nacl.verify('data', signature, key.publicKey)

Mnemonic

Mnemonic is a module responsible for generating and handling mnemonics. It can be used for creating secure and memorable passwords.

Usage

const Mnemonic = require('@crpdo/crypto/mnemonic')

const phrase = Mnemonic.createMnemonic()
const isValid = Mnemonic.validateMnemonic(phrase)

Documentation

• API Reference

Tests

In order to run the test suite, simply clone the repository and install its dependencies:

git clone https://gitlab.com/frenware/core/crpdo/crypto.git
cd basd
npm install

To run the tests:

npm test

Contributing

Thank you! Please see our contributing guidelines for details.

Donations

If you find this project useful and want to help support further development, please send us some coin. We greatly appreciate any and all contributions. Thank you!

Bitcoin (BTC):

1JUb1yNFH6wjGekRUW6Dfgyg4J4h6wKKdF

Monero (XMR):

46uV2fMZT3EWkBrGUgszJCcbqFqEvqrB4bZBJwsbx7yA8e2WBakXzJSUK8aqT4GoqERzbg4oKT2SiPeCgjzVH6VpSQ5y7KQ

License

@crpdo/crypto is MIT licensed.