https://github.com/armen-jean-andreasian/file-encryptor-for-ruby

openssl-based file encryptor for Ruby
https://github.com/armen-jean-andreasian/file-encryptor-for-ruby

encryption rails ruby

Last synced: 12 days ago
JSON representation

openssl-based file encryptor for Ruby

• Host: GitHub
• URL: https://github.com/armen-jean-andreasian/file-encryptor-for-ruby
• Owner: Armen-Jean-Andreasian
• Created: 2024-10-16T13:00:23.000Z (about 1 month ago)
• Default Branch: master
• Last Pushed: 2024-10-16T14:21:00.000Z (about 1 month ago)
• Last Synced: 2024-11-03T15:04:09.433Z (12 days ago)
• Topics: encryption, rails, ruby
• Language: Ruby
• Homepage:
• Size: 16.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# File Encryptor for Ruby

---

## Intro

This script encrypts your files using **AES-256-CBC** with a custom `key`, deletes them (optionally), and generates new encrypted files, which your are free to share.

- It's especially useful for encrypting sensitive data, such as secrets, that you need to gitignore or add to a remote host.

- This allows you to securely share files while maintaining the confidentiality of sensitive information.

---

## Important Security Note

**If you lose your custom key, you will lose access to your encrypted files.** This script is framework-independent and isolated.

For example, even if you set the Rails app's `master.key` as the `key` for this encryptor, if you generate a new `master.key` for your Rails app, it will not unlock your previously encrypted files, and you will lose them forever.

---

## INFO

1. The Files: `.env.test`, `.env.development`, `config/master.key` are for demonstrational purposes only. You don't need to expose any of those files anywhere.

2. The script uses `openssl` lib only, which is built-in. 

---

## Usage

1. Open [env_retriever.rb](env_retriever.rb) edit the line 64, add the files you need to encrypt.

2. **Encrypt the `.env` file(s)**:

    - Run the encryption script to encrypt the `.env` files.

    - Add the original `.env` files to `.gitignore` or delete them to prevent them from being pushed to version control.

    - Push the encrypted `.env.enc` files to GitHub instead.

3. **Decrypt when needed** (optional):

    - Decrypt the `.env.enc` files during the deployment or when needed by using the provided decryption method.

    - Ideally you can delete the methods related to decryption.

---

## Integration

You can integrate the decryptor into your application depending on your preference:

1. Add the decryptor script to your app's root directory via the terminal.

      

   - To encrypt:

   ```bash

   ruby -r './env_retriever.rb' -e 'EnvRetriever.encrypt_files'

   ```

   

   - To decrypt:

   ```bash

   ruby -r './env_retriever.rb' -e 'EnvRetriever.decrypt_files'

   ```

2. Integrate it into your application’s core logic (e.g., `application.rb` in a Rails app), initializers, etc.

   - Using import `require_relative`

   - Just move the modules straight into file.

---

## Playground

1. clone the repo

2. ```bash

   ruby -r './env_retriever.rb' -e 'EnvRetriever.encrypt_files'

   ```

3. ```bash

   ruby -r './env_retriever.rb' -e 'EnvRetriever.decrypt_files'

   ```

4. Works? You're good to go.