Skip to content

Latest commit

 

History

History
177 lines (132 loc) · 7.03 KB

README.en.md

File metadata and controls

177 lines (132 loc) · 7.03 KB

Table of Contents

  1. Introduction
  2. Features
  3. Installation
  4. Usage
  5. CLI Usage
  6. Contribution
  7. License
  8. Acknowledge
  9. Donate
  10. Changelog

Introduction

Go-crypt is a simple cryptography tool that aims to provide secure encryption and decryption solutions using PBKDF2, zlib, and AES-256-GCM algorithms. It is designed to protect the confidentiality of sensitive text by encrypting and decrypting data.

Features

Go-crypt offers the following features:

  • Utilizes PBKDF2, zlib, and AES-256-GCM algorithms for strong and secure encryption.
  • Secure and reliable decryption process to restore data to its original form.
  • Can be integrated into TypeScript code.
  • Provides CLI options to encrypt or decrypt from the terminal.

Installation

To install Go-crypt locally, follow these installation steps:

npm install @barudakrosul/gcrypt

To install globally, use:

npm install -g @barudakrosul/gcrypt

Usage

To start using Go-crypt, import the module first:

1. CommonJS

const gcrypt = require("@barudakrosul/gcrypt");

2. ESM (ECMAScript Modules)

import gcrypt from "@barudakrosul/gcrypt";

Example of usage:

const text = "Secret text message!";
const pass = "SecretPasswordKey";

const encrypted = gcrypt.encrypt(text, pass);
const decrypted = gcrypt.decrypt(encrypted, pass);

console.log("Encrypted:", encrypted.toString("utf-8"));
console.log("Decrypted:", decrypted);

CLI Usage

To use this tool from the command line, you can use the gcrypt command with the following options:

Option

Description

-h or --help

Display help for this command.

-V or --version

Display the current version.

-f or --file

Enter the file name to encrypt or decrypt.

-o or --output

Save the encryption or decryption result with another desired name.

-v or --verbose

Enable verbose mode (text captions).

-d or --decrypt

Start decrypting file or standard input data.

-p or --passkey

Enter a strong password for encryption or a specific password for decryption (default: 12345678).

-c or --stdout

Display the result of file encryption or decryption to the terminal.

If no filename is given, gcrypt will encrypt or decrypt from standard input to standard output. You can combine short options, such as -v -c which is the same as -vc or -cv.

Example of CLI usage:

$ gcrypt --file script.js

Example if using the --passkey option:

$ gcrypt --file script.js --passkey secretskey

Example of encryption of standard input:

$ printf "Secret text message!" | gcrypt

Contribution

Contributions to Go-crypt are greatly appreciated! Whether reporting bugs, suggesting new features, or contributing to code improvements.

License

Go-crypt is licensed under the AGPL-3.0 License - see the LICENSE file for details.

Acknowledge

Go-crypt appreciates the support and contributions of the following individuals and open source projects:

  • @FajarKim - Lead developer and creator of the application.
  • Open source community - For valuable contributions to the tools and libraries used in this project.

Donate

We really appreciate your support to continue developing this project. If you find this project useful, you can support us with a donation:

Ko-fi Trakteer

Every donation, no matter the amount, means a lot to us. Thank you for your support! ❤️

Changelog

Keep up with the latest changes and updates of Go-crypt by referring to Catatan Perubahan.

Thank you for choosing Go-crypt! We aim to provide a secure and reliable solution for encrypting and decrypting text in a variety of environments.

Stand with Palestine