go-encryptor

command module
v1.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 25, 2023 License: MIT Imports: 1 Imported by: 0

README

go-encryptor

build status build status go version GoReportCard Github all releases

A encryptor to encrypt files using passwords.

Features

  • Can encrypt any file or folder
  • AES-256 encryption
  • Password based encryption
  • XChaCha20-Poly1305 encryption

Tip: To encrypt folders, create a tarball of the folder then encrypt it (Recommanded)

tar -cf folder.tar folder ...

Build

To build the application, you need to have Go installed on your machine.

go build

Usage

Encrypt a file,

go-encryptor encrypt "filename"

Decrypt a file,

go-encryptor decrypt "filename"

Use k flag in both encrypt & decrypt to keep the file.

go-encryptor encrypt -k "filename"

or

go-encryptor encrypt --keep "filename"

More

Encrypt a file with a specific encryption method using a password,

go-encryptor encrypt --method "aes" --password "password" "filename"

or

go-encryptor encrypt -m "aes" -p "password" "filename"

Decrypt a file and print the output to stdout and pipe it to another command,

go-encryptor decrypt -p "password" --print "filename" | [command]

    go-encryptor: A file encryptor.
    go-encryptor is created to be as simple as possible to help you
    encrypt and decrypt files.

    Usage:
    go-encryptor [command]

    Available Commands:
    decrypt     Decrypt encrypted file
    encrypt     Encrypt file or folder
    help        Help about any command
    version     Prints version

    Flags:
    -h, --help   help for go-encryptor

    Use "go-encryptor [command] --help" for more information about a command.

Installing

Download for your platform

or Install from snap

sudo snap install go-encryptor

Benchmarks

For AES-256 encryption (time go-encryptor en -m "aes" -p "Password" alpine.iso) ,

alpine.iso encrypted successfully.

________________________________________________________
Executed in    3.42 secs    fish           external
   usr time    3.19 secs  277.00 micros    3.19 secs
   sys time    0.32 secs   99.00 micros    0.32 secs

alpine.iso decrypted successfully.

________________________________________________________
Executed in    3.40 secs    fish           external
   usr time    3.18 secs  347.00 micros    3.18 secs
   sys time    0.25 secs  126.00 micros    0.25 secs

For XChaCha20-Poly1305 encryption (time go-encryptor en -m "xchacha" -p "Password" alpine.iso) ,

alpine.iso encrypted successfully.

________________________________________________________
Executed in  802.34 millis    fish           external
   usr time  898.45 millis  414.00 micros  898.04 millis
   sys time  296.73 millis  135.00 micros  296.60 millis


alpine.iso decrypted successfully.

________________________________________________________
Executed in  755.63 millis    fish           external
   usr time  804.23 millis    0.00 micros  804.23 millis
   sys time  365.06 millis  584.00 micros  364.48 millis

License

This application is licensed under MIT, Copyright © 2021 Injamul Mohammad Mollah mrinjamul@gmail.com

Documentation

Overview

Copyright © 2021 Injamul Mohammad Mollah <mrinjamul@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Directories

Path Synopsis
Package utils ...
Package utils ...

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL