Skip to content

README.md

Latest commit

 

History

History
58 lines (46 loc) · 1.71 KB

README.md

File metadata and controls

58 lines (46 loc) · 1.71 KB

Keyzy

Keyzy is a desktop application built with Electron (Node.js) for easily encrypting and decrypting PGP messages to plain-text.

It provides a user-friendly interface for managing local Personal PGP Keys including creating, editing, deleting and exporting public and secret keys, encrypting plain text messages and decrypting PGP-encrypted messages using your own Personal Keys.

Features

  • Generate new PGP keys
  • Edit existing keys
  • Encrypt plain text to PGP-encrypted text output
  • Decrypt PGP-encrypted text to plain-text
  • List and manage existing keys
  • Secure key storage using native GPG command-line interface

Project Structure

index.html       # Main HTML file
index.js         # Electron main process
preload.js       # Preload script for secure context bridging
renderer.js      # Renderer process logic
gpg.js           # GPG key management logic / GPG Commandline Wrapper

Getting Started

Prerequisites

  • gpg - Installed by default on most Linux Distributions
    • sudo apt install gnupg
  • Node.js (v16 or later recommended)
  • npm

Installation

  1. Clone the repository: 
    git clone <repository-url>
cd Keyzy
  2. Install dependencies: 
    npm install

Running the App

npm start

Alternatively, run "Launch Program" or "Debug Main Process" in VS Code.

Usage

  • Launch the app and use the interface to generate or manage GPG keys.
  • All key operations are handled securely using the system's GPG installation.

Contributing

Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.

License

MIT