README.md

keygaen

Sign, verify, encrypt and decrypt data with PGP in your browser.

⚠️ keygaen has not yet been audited! While we try to make keygaen as secure as possible, it has not yet undergone a formal security audit by a third party. Please keep this in mind if you use it for security-critical applications. ⚠️

Overview

keygaen is an app to work with PGP without having to install anything on your local system.

Installation

The web app is available on GitHub releases in the form of a static .tar.gz archive; to deploy it, simply upload it to a CDN or copy it to a web server. For most users, this shouldn't be necessary though; thanks to @maxence-charriere's go-app package, keygaen is a progressive web app. By simply visiting the public deployment once, it will be available for offline use whenever you need it:

Screenshots

Click on an image to see a larger version.

Acknowledgements

• This project would not have been possible were it not for @maxence-charriere's go-app package; if you enjoy using keygaen, please donate to him!
• The open source PatternFly design system provides the components for the project.
• GopenPGP is the PGP library in use.

Contributing

To contribute, please use the GitHub flow and follow our Code of Conduct.

To build and start a development version of keygaen locally, run the following:

$ git clone https://github.com/pojntfx/keygaen.git
$ cd keygaen
$ make depend
$ make run-pwa/keygaen-pwa

Have any questions or need help? Chat with us on Matrix!

License

keygaen (c) 2023 Felicitas Pojtinger and contributors

SPDX-License-Identifier: AGPL-3.0