Shield

Abstract

1. Introduction

Under the Apache-2.0 License, Shield is a utility for encrypting and decrypting files in your project. It uses AES-256 encryption via the openssl command line tool.

2. Objective

Shield - File Encryption & Decryption in your Project

This project demonstrates how Go can be applied to a real-world Cybersecurity & Ethical Hacking problem.

4. Technology Stack

5. System Requirements

General requirements for this technology stack — check the README for exact versions.

• Go 1.20 or later
• Git (to clone the repository)

6. Installation & Setup

git clone https://github.com/shyce/shield.git
cd shield

1. Create a ~/.ssh/vault file with a secure password and chmod 600 ~/.ssh/vault. This is used to encrypt and decrypt files in the repository and should be shared between developers of your project.
2. Create a .shield file at the root of your project. This file will list all the glob patterns for files you want to encrypt. Each pattern should be on a new line. For example:
3. Any file with the .secret extension in the root directory.
4. Any .txt file in any secrets directory at any level.
5. Any .pem file in any directory or sub-directory under a root-level secrets directory.
6. Any files in the test directory in the root of your project.
7. The temp.secret file in the root directory.
8. Any files in any vendors directory at any level.

./shield --install

*.secret
    **/secrets/*.txt
    secrets/**/*.pem

test/*
    temp.secret
    **/vendors/**

Full setup instructions are in the project README.

7. Future Enhancements

Suggested extensions you can add to make this your own project.

• Add logging and alert notifications (email / Telegram)
• Write a threat model document for the tool
• Package it with Docker for safe lab testing

8. Viva / Review Questions

Common questions examiners ask for projects in this domain.

1. Which threat or attack does this project defend against?
2. What detection or protection technique is used and what are its limits?
3. How are false positives and false negatives handled?
4. Which cryptographic algorithms or security standards are involved?
5. What legal and ethical rules apply when testing a tool like this?

9. Source Code & License

This project is developed by shyce and published on GitHub under the Apache License 2.0. Please follow the license terms and credit the original author when you use or modify this code.