Giter VIP home page Giter VIP logo

secretsmd's Introduction

Secrets MD ๐Ÿ”‘

Introduction ๐ŸŒŸ

Secrets md POC is a command-line application designed for encrypting and decrypting Markdown files. This Proof of Concept (POC) combines advanced security features with an interactive CLI interface, using the Rust programming language. It's built for users who seek a secure way to handle Markdown documents, ensuring confidentiality through robust encryption.

Key Features ๐Ÿ› ๏ธ

  • Markdown File Encryption/Decryption: Encrypts .md files into .md.enc format with strong AES-256 encryption. And vise-versa.
  • Interactive CLI: Offers a user-friendly, interactive command-line interface for effortless encryption and decryption operations.
  • Password Protection: Utilizes a password-based encryption system, complemented by an optional hint feature for password recall.
  • Security First: Implements OpenSSL for encryption, ensuring a high level of security.

Installation ๐Ÿš€

  • Prerequisites: Ensure you have Rust and Cargo installed on your system.
  • Clone the Repository: git clone [repository-url]
  • Run the Application: Navigate to the project directory and run cargo run

Usage ๐Ÿ“–

  • Encrypt a Markdown File:
    • Choose 'Encrypt a .md file' from the menu.
    • Follow the prompts to select a file, enter a password, and an optional hint.
  • Decrypt a Markdown File:
    • Select 'Decrypt a .md.enc file'.
    • Choose the file and enter the correct password to decrypt.

Testing ๐Ÿงช

  • Run cargo test to execute the test suite and verify the application's functionality.

Contributing ๐Ÿ’ก

Contributions are welcome to refine and expand the capabilities of Secrets md POC. Feel free to suggest improvements, report bugs, or submit pull requests for new features or enhancements.

Security Disclaimer โš ๏ธ

The static SALT and IV values in the code are for demonstration purposes only. In a production environment, it's crucial to use dynamically generated, unique values for each encryption instance to ensure optimal security.

secretsmd's People

Contributors

i7n3 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.