lpgp 0.2.0

package/LICENSE

@@ -0,0 +1,52 @@
+Source Available Educational License
+
+Copyright (c) 2025 Layerbase, LLC
+
+IMPORTANT: This is NOT an open source license. The source code is made publicly
+available for educational purposes, security auditing, and learning only.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to use,
+copy, modify, and study the Software for educational and non-commercial purposes
+only, subject to the following conditions:
+
+1. PERMITTED USES:
+   - Educational and learning purposes
+   - Security auditing and code review
+   - Personal, non-commercial projects
+   - Academic research and teaching
+
+2. PROHIBITED USES:
+   - Commercial use of any kind
+   - Use by for-profit enterprises or organizations
+   - Integration into commercial products or services
+   - Use in production environments for business purposes
+   - Distribution or sale of the Software or derivatives for profit
+
+3. ATTRIBUTION:
+   The above copyright notice and this permission notice shall be included in all
+   copies or substantial portions of the Software.
+
+4. MODIFICATIONS:
+   You may create derivative works for educational purposes only. Any derivative
+   works must carry this same license and may not be used commercially.
+
+5. NO COMMERCIAL LICENSING:
+   Commercial use requires explicit written permission from the copyright holder.
+   Contact information for commercial licensing inquiries can be provided upon
+   request.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+This software is source-available for transparency and educational purposes,
+but is NOT open source as defined by the Open Source Initiative. It is designed
+as a learning project to explore PGP encryption, progressive enhancement, and
+building web applications that work without JavaScript.

package/README.md

@@ -0,0 +1,218 @@
+# LPGP
+
+Interactive CLI tool for PGP encryption/decryption with SQLite key management.
+
+> **Note:** This is a personal side project created to learn more about encryption and PGP. It's a work in progress and should be used for educational purposes.
+
+## Project Status
+
+This project is **actively being developed** as a learning exercise. While functional, it may contain bugs or security considerations that need addressing. Use at your own discretion and avoid using it for highly sensitive production data.
+
+## Features
+
+- **PGP Encryption/Decryption** - Secure message encryption using OpenPGP
+- **SQLite Key Management** - Store and manage multiple keypairs and contacts
+- **System Keychain Integration** - Passphrases stored securely in your OS keychain
+- **Clipboard Integration** - Seamlessly encrypt/decrypt from clipboard
+- **Multiple Input Methods** - Clipboard, text editor, or inline terminal input
+- **Cross-Platform Support** - Works on Linux, macOS, and Windows
+- **Smart Editor Detection** - Auto-detects available editors (VS Code, Vim, Nano, etc.)
+
+## Getting Started
+
+### Prerequisites
+
+- Node.js (v18 or higher recommended)
+- pnpm (v10.19.0 or higher)
+
+### Installation
+
+#### Option 1: Automated Installer (Recommended for Non-Developers)
+
+1. Clone the repository:
+
+```bash
+git clone https://github.com/robertjbass/lpgp.git
+cd lpgp
+```
+
+2. Run the installer:
+
+```bash
+./install.sh
+```
+
+The installer will:
+
+- Detect your operating system and shell
+- Check for Node.js and install it if missing (using nvm)
+- Check for pnpm and install it if missing
+- Install all dependencies and compile native modules
+- Build the project
+- Optionally create an `lpgp` command alias
+
+3. Run the tool and create or import your keys:
+
+```bash
+pnpm dev
+```
+
+Use the Key Management menu to generate new keypairs or import existing ones.
+
+#### Option 2: Manual Installation (For Developers)
+
+1. Clone the repository:
+
+```bash
+git clone https://github.com/robertjass/lpgp.git
+cd lpgp
+```
+
+2. Install dependencies:
+
+```bash
+pnpm install
+```
+
+This will install all Node.js dependencies including `better-sqlite3`, which requires native compilation.
+
+3. Build the project:
+
+```bash
+pnpm build
+```
+
+4. Database initialization:
+
+The SQLite database is automatically created on first run at `~/.lpgp/data.db`. No manual setup required!
+
+### Usage
+
+Run the PGP tool:
+
+```bash
+pnpm dev
+```
+
+You'll be greeted with an interactive menu:
+
+```
+╔════════════════════════════════════════╗
+║  🔐  PGP Encryption/Decryption Tool   ║
+╚════════════════════════════════════════╝
+
+? What would you like to do?
+  🔒 Encrypt a message
+  🔓 Decrypt a message
+  👋 Exit
+```
+
+## How It Works
+
+### Encrypting a Message
+
+1. Select "🔒 Encrypt a message"
+2. Choose your input method:
+   - **📋 Paste from clipboard** - Automatically encrypts text from your clipboard
+   - **📝 Use an editor** - Opens your preferred text editor
+   - **⌨️ Type inline** - Enter text directly (press Enter, then Ctrl+D to finish)
+3. The encrypted message is displayed and automatically copied to your clipboard
+
+### Decrypting a Message
+
+1. Select "🔓 Decrypt a message"
+2. Choose your input method for the encrypted text
+3. The decrypted message is displayed and automatically copied to your clipboard
+
+## Development
+
+### Available Scripts
+
+```bash
+# Run the PGP tool (development)
+pnpm dev
+
+# Format code with Prettier
+pnpm format
+
+# Build the TypeScript project
+pnpm build
+
+# Run the built project
+pnpm start
+```
+
+### Project Structure
+
+```
+lpgp/
+├── src/
+│   ├── pgp-tool.ts       # Main CLI entry point
+│   ├── encrypt.ts        # Encryption logic
+│   ├── decrypt.ts        # Decryption logic
+│   ├── key-manager.ts    # Key management UI
+│   ├── key-utils.ts      # Key utility functions
+│   ├── db.ts             # SQLite database layer
+│   ├── ui.ts             # Centralized UI styling
+│   └── schema.sql        # Database schema
+├── dist/                 # Built output (not in git)
+├── package.json
+├── tsconfig.json
+└── README.md
+```
+
+## Roadmap
+
+See [TODO.md](TODO.md) for the complete project roadmap. Completed and upcoming features:
+
+- SQLite database integration
+- System keychain passphrase storage
+- Key generation and management
+- Multi-recipient encryption
+- Contact management
+- File encryption/decryption (planned)
+- GPG keyring import (planned)
+
+## Security Considerations
+
+As this is a learning project, please note:
+
+- Passphrases are stored in your system keychain (macOS Keychain, Windows Credential Manager, etc.)
+- Keys are stored in SQLite database at `~/.lpgp/data.db`
+- The `.gitignore` excludes database and `.env` files
+- This tool has not undergone professional security audit
+- For production use, consider more secure key storage methods (e.g., hardware tokens)
+
+## Contributing
+
+This is primarily a personal learning project, but suggestions and feedback are welcome! Feel free to:
+
+- Open issues for bugs or feature requests
+- Submit pull requests with improvements
+- Share your experience using the tool
+
+## License
+
+**Source Available Educational License** - NOT Open Source
+
+This software is source-available for educational purposes, security auditing, and learning only. Commercial use and use by for-profit enterprises is prohibited without explicit permission. See the [LICENSE](LICENSE) file for full terms.
+
+The source code is publicly available to promote transparency, enable security audits, and support learning about encryption and web development - but this does not make it open source software.
+
+## Acknowledgments
+
+- Built with [OpenPGP.js](https://openpgpjs.org/) for encryption
+- [Inquirer.js](https://github.com/SBoudrias/Inquirer.js) for beautiful CLI prompts
+- [Chalk](https://github.com/chalk/chalk) for terminal styling
+- [Clipboardy](https://github.com/sindresorhus/clipboardy) for clipboard operations
+
+---
+
+**Learning Focus:** This project explores:
+
+- PGP encryption and cryptography fundamentals
+- Node.js CLI development with TypeScript
+- Security best practices for handling sensitive data
+- System keychain integration for secure credential storage
+
+It's a work in progress and will continue to evolve as I learn more about encryption and secure communication.

package/dist/config.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Get the application config directory path.
+ * Creates the directory if it doesn't exist.
+ *
+ * - Unix-like (macOS, Linux): ~/.lpgp
+ * - Windows: C:\Users\<username>\.lpgp
+ */
+export declare function getConfigDir(): string;
+/**
+ * Get the database file path.
+ */
+export declare function getDbPath(): string;
+/**
+ * Get the path to a file within the config directory.
+ */
+export declare function getConfigPath(filename: string): string;
+//# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAMA;;;;;;GAMG;AACH,wBAAgB,YAAY,IAAI,MAAM,CAQrC;AAED;;GAEG;AACH,wBAAgB,SAAS,IAAI,MAAM,CAElC;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAEtD"}

package/dist/config.js

@@ -0,0 +1,31 @@
+import { existsSync, mkdirSync } from 'fs';
+import { join } from 'path';
+import { homedir } from 'os';
+const APP_DIR_NAME = '.lpgp';
+/**
+ * Get the application config directory path.
+ * Creates the directory if it doesn't exist.
+ *
+ * - Unix-like (macOS, Linux): ~/.lpgp
+ * - Windows: C:\Users\<username>\.lpgp
+ */
+export function getConfigDir() {
+    const configDir = join(homedir(), APP_DIR_NAME);
+    if (!existsSync(configDir)) {
+        mkdirSync(configDir, { recursive: true });
+    }
+    return configDir;
+}
+/**
+ * Get the database file path.
+ */
+export function getDbPath() {
+    return join(getConfigDir(), 'data.db');
+}
+/**
+ * Get the path to a file within the config directory.
+ */
+export function getConfigPath(filename) {
+    return join(getConfigDir(), filename);
+}
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,IAAI,CAAA;AAC1C,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAC3B,OAAO,EAAE,OAAO,EAAE,MAAM,IAAI,CAAA;AAE5B,MAAM,YAAY,GAAG,OAAO,CAAA;AAE5B;;;;;;GAMG;AACH,MAAM,UAAU,YAAY;IAC1B,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,EAAE,EAAE,YAAY,CAAC,CAAA;IAE/C,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;QAC3B,SAAS,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;IAC3C,CAAC;IAED,OAAO,SAAS,CAAA;AAClB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,SAAS;IACvB,OAAO,IAAI,CAAC,YAAY,EAAE,EAAE,SAAS,CAAC,CAAA;AACxC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa,CAAC,QAAgB;IAC5C,OAAO,IAAI,CAAC,YAAY,EAAE,EAAE,QAAQ,CAAC,CAAA;AACvC,CAAC"}

package/dist/db.d.ts

@@ -0,0 +1,80 @@
+export type Keypair = {
+    id: number;
+    name: string;
+    email: string;
+    fingerprint: string;
+    public_key: string;
+    private_key: string;
+    passphrase_protected: boolean;
+    algorithm: string;
+    key_size: string;
+    can_sign: boolean;
+    can_encrypt: boolean;
+    can_certify: boolean;
+    can_authenticate: boolean;
+    expires_at: string | null;
+    revoked: boolean;
+    revocation_reason: string | null;
+    created_at: string;
+    updated_at: string;
+    last_used_at: string | null;
+    is_default: boolean;
+};
+export type Contact = {
+    id: number;
+    name: string;
+    email: string;
+    fingerprint: string;
+    public_key: string;
+    algorithm: string;
+    key_size: string;
+    trusted: boolean;
+    last_verified_at: string | null;
+    notes: string | null;
+    expires_at: string | null;
+    revoked: boolean;
+    created_at: string;
+    updated_at: string;
+};
+export type Settings = {
+    id: number;
+    default_keypair_id: number | null;
+    auto_sign_messages: boolean;
+    prefer_inline_pgp: boolean;
+    keyserver_url: string;
+};
+type Schema = {
+    keypair: Keypair[];
+    contact: Contact[];
+    settings: Settings;
+};
+export declare class Db {
+    private db;
+    constructor();
+    /**
+     * Migrate database from the old project-local location to ~/.lpgp
+     */
+    private migrateFromLegacyLocation;
+    private initializeSchema;
+    private migrateFromJson;
+    select<T extends keyof Schema>({ table, where, }: {
+        table: T;
+        where?: {
+            key: keyof Schema[T] extends keyof Schema[T] ? T extends 'settings' ? keyof Settings : keyof Keypair | keyof Contact : never;
+            compare: 'is' | 'is not' | 'like' | 'not like';
+            value: any;
+        };
+    }): T extends 'settings' ? Settings : Schema[T];
+    insert<T extends keyof Schema>(table: T, value: T extends 'settings' ? Partial<Omit<Settings, 'id'>> : T extends 'keypair' ? Omit<Keypair, 'id' | 'created_at' | 'updated_at'> : Omit<Contact, 'id' | 'created_at' | 'updated_at'>): T extends 'settings' ? Settings : T extends 'keypair' ? Keypair : Contact;
+    update<T extends keyof Schema>(table: T, where: {
+        key: T extends 'settings' ? keyof Settings : keyof Keypair | keyof Contact;
+        value: any;
+    }, updates: T extends 'settings' ? Partial<Settings> : T extends 'keypair' ? Partial<Keypair> : Partial<Contact>): void;
+    delete<T extends keyof Schema>(table: T, where: {
+        key: T extends 'settings' ? keyof Settings : keyof Keypair | keyof Contact;
+        value: any;
+    }): void;
+    close(): void;
+}
+export {};
+//# sourceMappingURL=db.d.ts.map

package/dist/db.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"db.d.ts","sourceRoot":"","sources":["../src/db.ts"],"names":[],"mappings":"AAsBA,MAAM,MAAM,OAAO,GAAG;IACpB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,MAAM,CAAA;IAClB,WAAW,EAAE,MAAM,CAAA;IACnB,oBAAoB,EAAE,OAAO,CAAA;IAC7B,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,OAAO,CAAA;IACjB,WAAW,EAAE,OAAO,CAAA;IACpB,WAAW,EAAE,OAAO,CAAA;IACpB,gBAAgB,EAAE,OAAO,CAAA;IACzB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,OAAO,EAAE,OAAO,CAAA;IAChB,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAA;IAChC,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,UAAU,EAAE,OAAO,CAAA;CACpB,CAAA;AAGD,MAAM,MAAM,OAAO,GAAG;IACpB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAA;IAC/B,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA;AAGD,MAAM,MAAM,QAAQ,GAAG;IACrB,EAAE,EAAE,MAAM,CAAA;IACV,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC,kBAAkB,EAAE,OAAO,CAAA;IAC3B,iBAAiB,EAAE,OAAO,CAAA;IAC1B,aAAa,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,KAAK,MAAM,GAAG;IACZ,OAAO,EAAE,OAAO,EAAE,CAAA;IAClB,OAAO,EAAE,OAAO,EAAE,CAAA;IAClB,QAAQ,EAAE,QAAQ,CAAA;CACnB,CAAA;AAWD,qBAAa,EAAE;IACb,OAAO,CAAC,EAAE,CAAmB;;IAsB7B;;OAEG;IACH,OAAO,CAAC,yBAAyB;IA6BjC,OAAO,CAAC,gBAAgB;IAKxB,OAAO,CAAC,eAAe;IAwHhB,MAAM,CAAC,CAAC,SAAS,MAAM,MAAM,EAAE,EACpC,KAAK,EACL,KAAK,GACN,EAAE;QACD,KAAK,EAAE,CAAC,CAAA;QACR,KAAK,CAAC,EAAE;YACN,GAAG,EAAE,MAAM,MAAM,CAAC,CAAC,CAAC,SAAS,MAAM,MAAM,CAAC,CAAC,CAAC,GACxC,CAAC,SAAS,UAAU,GAClB,MAAM,QAAQ,GACd,MAAM,OAAO,GAAG,MAAM,OAAO,GAC/B,KAAK,CAAA;YACT,OAAO,EAAE,IAAI,GAAG,QAAQ,GAAG,MAAM,GAAG,UAAU,CAAA;YAC9C,KAAK,EAAE,GAAG,CAAA;SACX,CAAA;KACF,GAAG,CAAC,SAAS,UAAU,GAAG,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC;IA6DxC,MAAM,CAAC,CAAC,SAAS,MAAM,MAAM,EAClC,KAAK,EAAE,CAAC,EACR,KAAK,EAAE,CAAC,SAAS,UAAU,GACvB,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,GAC7B,CAAC,SAAS,SAAS,GACjB,IAAI,CAAC,OAAO,EAAE,IAAI,GAAG,YAAY,GAAG,YAAY,CAAC,GACjD,IAAI,CAAC,OAAO,EAAE,IAAI,GAAG,YAAY,GAAG,YAAY,CAAC,GACtD,CAAC,SAAS,UAAU,GAAG,QAAQ,GAAG,CAAC,SAAS,SAAS,GAAG,OAAO,GAAG,OAAO;IAiDrE,MAAM,CAAC,CAAC,SAAS,MAAM,MAAM,EAClC,KAAK,EAAE,CAAC,EACR,KAAK,EAAE;QACL,GAAG,EAAE,CAAC,SAAS,UAAU,GACrB,MAAM,QAAQ,GACd,MAAM,OAAO,GAAG,MAAM,OAAO,CAAA;QACjC,KAAK,EAAE,GAAG,CAAA;KACX,EACD,OAAO,EAAE,CAAC,SAAS,UAAU,GACzB,OAAO,CAAC,QAAQ,CAAC,GACjB,CAAC,SAAS,SAAS,GACjB,OAAO,CAAC,OAAO,CAAC,GAChB,OAAO,CAAC,OAAO,CAAC,GACrB,IAAI;IAwCA,MAAM,CAAC,CAAC,SAAS,MAAM,MAAM,EAClC,KAAK,EAAE,CAAC,EACR,KAAK,EAAE;QACL,GAAG,EAAE,CAAC,SAAS,UAAU,GACrB,MAAM,QAAQ,GACd,MAAM,OAAO,GAAG,MAAM,OAAO,CAAA;QACjC,KAAK,EAAE,GAAG,CAAA;KACX,GACA,IAAI;IASA,KAAK,IAAI,IAAI;CAGrB"}