@abdellatif.dev/cryptjs

Warning: This library is not production-ready and is still in alpha. Use with caution and expect breaking changes.

• Cryptjs
  • Features
  • Installation
    • Using pnpm
    • Using npm
    • Using yarn
  • Usage
    • Example: Hashing with SHA-512
    • Example: Hashing with SHA-256
  • Supported Algorithms
  • Contributing
    • Steps for Contributing
  • License
  • Acknowledgments
    • Key Points:
  • TODO

Cryptjs

cryptjs is a JavaScript/TypeScript library that brings cryptographic functionality from Dart to the web. It is a port of Dart's cryptography libraries, allowing you to perform various cryptographic operations such as hashing, encryption, and decryption, all within your JavaScript/TypeScript projects.

Features

• Hashing: SHA-256, SHA-512.
• Ported from Dart: Brings Dart's reliable cryptography to JavaScript/TypeScript

Installation

Using pnpm

pnpm install @abdellatif.dev/cryptjs

Using npm

npm install @abdellatif.dev/cryptjs

Using yarn

yarn add @abdellatif.dev/cryptjs

Usage

Once installed, you can import and use cryptjs in your JavaScript/TypeScript code.

Example: Hashing with SHA-512

const Cryptjs = require("@abdellatif.dev/cryptjs");

/** @type {string} */
const message = "Hello, world!";
/** @type {string} */
const salt = "Salt";
/** @type {Cryptjs.Sha} */
const hash = Cryptjs.sha512(message, salt);

console.log("SHA-512 Hash:", hash.toString());

import Cryptjs from "@abdellatif.dev/cryptjs";

const message: string = "Hello, world!";
const salt: string = "Salt";
const hash: Cryptjs.Sha = Cryptjs.sha512(message, salt);

console.log("SHA-512 Hash:", hash.toString());

Example: Hashing with SHA-256

const Cryptjs = require("@abdellatif.dev/cryptjs");

/** @type {string} */
const message = "Hello, world!";
/** @type {string} */
const salt = "Salt";
/** @type {Cryptjs.Sha} */
const hash = Cryptjs.sha256(message, salt);

console.log("SHA-256 Hash:", hash.toString());

import Cryptjs from "@abdellatif.dev/cryptjs";

const message: string = "Hello, world!";
const salt: string = "Salt";
const hash: Cryptjs.Sha = Cryptjs.sha256(message, salt);

console.log("SHA-256 Hash:", hash.toString());

Supported Algorithms

• SHA-256.
• SHA-512.

Contributing

Contributions are welcome! If you have an idea for an improvement or find a bug, please fork the repository and submit a pull request.

Steps for Contributing

1. Fork the repository
2. Clone your fork locally
3. Make your changes or fix bugs
4. Ensure that tests are passing (if applicable)
5. Submit a pull request

License

cryptjs is open source software, licensed under the MIT License. See the LICENSE file for more information.

Acknowledgments

This project is a port of Dart's cryptography libraries to JavaScript/TypeScript, and it leverages established cryptographic algorithms to ensure security and reliability.

Key Points:

• The library name (cryptjs) is used throughout.
• It starts with an overview of features.
• Shows how to install and use it.
• Includes API references and code examples for common cryptographic functions.
• Encourages contributions from other developers.

You can adjust the examples, features, and details depending on the specific functions your library supports!

TODO

• [x] add sha256
• [x] types support
• [ ] make salt optional and generate salt
• [ ] secure random and not secure random
• [ ] add min and max rounds

const minRounds = 1000;
const maxRounds = 999999999;
const defaultRounds = 5000;

• [ ] tests use something like jest