https://github.com/miqoas/kizuna

🐀🔐 A .NET Global Tool to quickly encrypt and decrypt files using AES-256-GCM
https://github.com/miqoas/kizuna

aes aes-256 dotnet encryption

Last synced: 2 months ago
JSON representation

🐀🔐 A .NET Global Tool to quickly encrypt and decrypt files using AES-256-GCM

• Host: GitHub
• URL: https://github.com/miqoas/kizuna
• Owner: miqoas
• License: mit
• Created: 2020-07-09T21:46:29.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-10-10T03:49:20.000Z (over 1 year ago)
• Last Synced: 2024-11-22T07:46:54.948Z (2 months ago)
• Topics: aes, aes-256, dotnet, encryption
• Language: C#
• Homepage:
• Size: 445 KB
• Stars: 16
• Watchers: 3
• Forks: 8
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# :rat::closed_lock_with_key: Kizuna

![forthebadge](.github/images/made-with-c-sharp.svg)

![forthebadge](.github/images/built-with-love.svg)

A .NET Core Tool to encrypt and decrypt files using AEAD AES-256-GCM, as well as generate an encryption key.

The tool was created to help encrypt configuration files for use with the .NET Core projects using the [Miqo.EncryptedJsonConfiguration](https://github.com/miqoas/Miqo.EncryptedJsonConfiguration) library. Kizuna can be used as a stand-alone tool to encrypt and decrypt files.

## Installation

Download and install the [.NET Core 3.1 SDK](https://www.microsoft.com/net/download)

or newer. Once installed, run the following command to run OtterKeys:

![dotnet tool install -g Kizuna](.github/images/command-install.png)

## Usage

Once installed you can call Kizuna from the command line:

![usage](.github/images/command-help.png)

> You can use the --help option to get more details about the commands and

their options.

### Creating a new encryption key

> Creating a new encryption key is as easy as typing:

![usage](.github/images/command-generate.png)

Kizuna will output the encryption key in the console.

The encryption key should be stored securely. Each of your projects/products should have it's own unique key if the key is used to encrypt a configuration file. Never check the encryption key into a source control.

### Encrypt a file

You can encrypt a file using the following command:

![usage](.github/images/command-encrypt.png)

Usage: `Kizuna encrypt -k {Key} {FileName}`

The file is replaced. Add the `-c` option to output the encrypted content to your console instead of writing to the file system.

### Decrypt a file

You can decrypt a file using the following command:

![usage](.github/images/command-decrypt.png)

Usage: `Kizuna decrypt -k {Key} {FileName}`

The file is replaced. Add the `-c` option to output the decrypted content to your console instead of writing to the file system.

## Acknowledgements

Kizuna uses some of the encryption code from the [CryptHash.NET](https://github.com/alecgn/crypthash-net/) (MIT license) library for it's AES-256-GCM operations.