@shgysk8zer0/aes-gcm v1.0.8

@shgysk8zer0/aes-gcm

A JWK-base crypto library using AES-GCM secret keys

• Code of Conduct
• Contributing

Description

A JWK-based crypto library using AES-GCM secret keys. This library provides a set of functions for generating, encrypting, decrypting, signing, and verifying cryptographic keys and data. It supports various cryptographic algorithms and formats, making it easy to handle secure data operations in JavaScript.

Installation

Using npm

npm install @shgysk8zer0/aes-gcm

Using unpkg.com

<script type="importmap">
{
  "imports": {
    "@shgysk8zer0/aes-gcm": "https://unpkg.com/@shgysk8zer0/aes-gcm?module"
  }
}
</script>
<script type="module">
  import { generateSecretKey } from '@shgysk8zer0/aes-gcm';

  const key = await generateSecretKey();
  console.log(key);
</script>

Usage Examples

Generating a Secret Key

import { generateSecretKey } from '@shgysk8zer0/aes-gcm';

const key = await generateSecretKey();
console.log(key);

Documentation for generateSecretKey

Encrypting and Decrypting Data

import { encrypt, decrypt, TEXT } from '@shgysk8zer0/aes-gcm';

const key = await generateSecretKey();
const data = 'Hello, World!';
const encrypted = await encrypt(key, data);
const decrypted = await decrypt(key, encrypted, { output: TEXT });

console.log(decrypted); // 'Hello, World!'

Documentation for encrypt and Documentation for decrypt

Encrypting and Decrypting Files

import { encryptFile, decryptFile } from '@shgysk8zer0/aes-gcm';

const key = await generateSecretKey();
const file = new File(['Hello, World!'], 'hello.txt', { type: 'text/plain' });
const encryptedFile = await encryptFile(key, file);
const decryptedFile = await decryptFile(key, encryptedFile);

console.log(await decryptedFile.text()); // 'Hello, World!'

Documentation for encryptFile and Documentation for decryptFile

Creating a Secret Key from a Password

import { createSecretKeyFromPassword } from '@shgysk8zer0/aes-gcm';

const password = 'super-secret-password';
const key = await createSecretKeyFromPassword(password);
console.log(key);

Documentation for createSecretKeyFromPassword

Hashing Data

import { hash, HEX } from '@shgysk8zer0/aes-gcm';

const data = 'Hello, World!';
const hashed = await hash(data, { output: HEX });

console.log(hashed);

Documentation for hash

Signing and Verifying Data

import { sign, verifySignature } from '@shgysk8zer0/aes-gcm';

const key = await generateSecretKey();
const data = 'Hello, World!';
const signature = await sign(key, data);
const isValid = await verifySignature(key, data, signature);

console.log(isValid); // true

Documentation for sign and Documentation for verifySignature

API Documentation

Methods

Options

Generate Secret Key

generateSecretKey(options)

Encrypt Data

encrypt(key, thing, options)

Decrypt Data

decrypt(key, thing, options)

Create Secret Key from Password

createSecretKeyFromPassword(pass, options)

Hash Data

hash(thing, options)

Sign Data

sign(key, thing, options)

Verify Signature

verifySignature(key, source, signature, options)

Encrypt File

encryptFile(key, file, name)

Decrypt File

decryptFile(key, file)