https://github.com/pramsh/cipher

Cipher is a Node.js cryptographic library offering SHA-256 hashing, AES-256 encryption/decryption, JWT creation/validation, and RSA key pair generation. 🌐 Enhance your application's security with flexible and robust cryptographic functionalities.
https://github.com/pramsh/cipher

cryptography digital-signature javascript jwt-auth jwt-token jwt-tokens nodejs rsa-key-pair rsa-signature sha256-crypt sha256-decryptor sha256-hash

Last synced: 20 days ago
JSON representation

Cipher is a Node.js cryptographic library offering SHA-256 hashing, AES-256 encryption/decryption, JWT creation/validation, and RSA key pair generation. 🌐 Enhance your application's security with flexible and robust cryptographic functionalities.

• Host: GitHub
• URL: https://github.com/pramsh/cipher
• Owner: Pramsh
• Created: 2024-10-24T21:40:37.000Z (25 days ago)
• Default Branch: master
• Last Pushed: 2024-10-24T23:14:18.000Z (24 days ago)
• Last Synced: 2024-10-26T11:07:06.368Z (23 days ago)
• Topics: cryptography, digital-signature, javascript, jwt-auth, jwt-token, jwt-tokens, nodejs, rsa-key-pair, rsa-signature, sha256-crypt, sha256-decryptor, sha256-hash
• Language: JavaScript
• Homepage:
• Size: 47.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Cipher Class

This `Cipher` class provides various cryptographic functionalities using Node.js's built-in `crypto` module. It supports hashing, JWT creation and validation, RSA key pair generation, and AES-256 encryption and decryption.

## Installation

To use this class, ensure you have Node.js installed.

## Usage

### Importing the Class

```javascript

const { Cipher } = require('./path/to/cipher');

```

### Initialization

Create an instance of the `Cipher` class by providing the necessary keys and tokens.

```javascript

const cipher = new Cipher(aes256Key, aes256Iv, appKey, appToken);

```

### Methods

#### `hash(input, [algorithm='sha256'])`

Generates a hash of the input using the specified algorithm.

```javascript

const hash = cipher.hash('your-input-string', 'sha256');

```

#### `CheckClientHeaders(clientAppKey, clientAppToken)`

Checks the validity of client headers.

```javascript

cipher.CheckClientHeaders(clientAppKey, clientAppToken)

    .then(isValid => console.log(isValid))

    .catch(error => console.error(error));

```

#### `createJWT(payload, jwtPrivateKey, [validationInputPromise])`

Creates a JWT with the given payload and private key. Optionally, a validation promise can be provided.

```javascript

cipher.createJWT(payload, jwtPrivateKey, validationInputPromise)

    .then(token => console.log(token))

    .catch(error => console.error(error));

```

#### `getSessionData(JWTtoken)`

Gets session data from a JWT.

```javascript

cipher.getSessionData(JWTtoken)

    .then(sessionData => console.log(sessionData))

    .catch(error => console.error(error));

```

#### `validateJWT(ip, jwt, jwtpublickey)`

Validates a JWT with the given IP and public key.

```javascript

cipher.validateJWT(ip, jwt, jwtpublickey, validationInputPromise)

    .then(isValid => console.log(isValid))

    .catch(error => console.error(error));

```

#### `RSAGenerateKeyPair([encodingPrivateKeyType], [encodingFormatBoth], [encodingPublicKeyType], [bitLength])`

Generates an RSA key pair.

```javascript

cipher.RSAGenerateKeyPair()

    .then(([publicKey, privateKey]) => console.log(publicKey, privateKey))

    .catch(error => console.error(error));

```

#### `RSAsignDocument(privateKey, dataToSign, [encodingFormat], [encodingType])`

Signs data using RSA.

```javascript

cipher.RSAsignDocument(privateKey, dataToSign)

    .then(signature => console.log(signature))

    .catch(error => console.error(error));

```

#### `RSAverifySignature(publicKey, dataToVerify, signature, [encodingFormat], [publicKeyType])`

Verifies an RSA signature.

```javascript

cipher.RSAverifySignature(publicKey, dataToVerify, signature)

    .then(isValid => console.log(isValid))

    .catch(error => console.error(error));

```

#### `AES256encrypt(text, salt)`

Encrypts text using AES-256-CBC.

```javascript

cipher.AES256encrypt('your-text', 'your-salt')

    .then(encryptedText => console.log(encryptedText))

    .catch(error => console.error(error));

```

#### `AES256decrypt(cryptedText, salt)`

Decrypts text using AES-256-CBC.

```javascript

cipher.AES256decrypt(encryptedText, 'your-salt')

    .then(decryptedText => console.log(decryptedText))

    .catch(error => console.error(error));

```

## Detailed Explanation of Salt Usage in AES256encrypt

The `AES256encrypt` method uses a salt to derive the key and IV for AES-256 encryption, ensuring unique and secure encryption for each salt value.

### Key and IV Derivation

The key and IV are derived using the `pbkdf2Sync` function from the `crypto` module with the following parameters:

- `this.#aes256Key`: AES-256 key.

- `this.#aes256Iv`: AES-256 IV.

- `salt`: Salt value.

- `100000`: Iterations for PBKDF2.

- `32`: Key length in bytes.

- `16`: IV length in bytes.

- `'sha512'`: Hash function.

### Encryption Process

The `AES256encrypt` method uses the derived key and IV to perform AES-256-CBC encryption:

- `text`: Text to encrypt.

- `salt`: Salt value.

- `createCipheriv('aes-256-cbc', key, iv)`: Creates a cipher object.

- `cipher.update(text, 'utf-8', 'hex') + cipher.final('hex')`: Encrypts the text.

### Example Usage

```javascript

const aes256Key = 'your-aes256-key';

const aes256Iv = 'your-aes256-iv';

const cipher = new Cipher(aes256Key, aes256Iv);

const textToEncrypt = 'Hello, World!';

const salt = 'random_salt';

cipher.AES256encrypt(textToEncrypt, salt)

    .then(encryptedText => console.log(encryptedText))

    .catch(error => console.error(error));

```

Using a unique salt for each encryption ensures different derived keys and IVs, enhancing security.

## License

This project is licensed under the MIT License.