Files
k7/README.md

41 lines
1.9 KiB
Markdown
Raw Normal View History

2020-11-03 18:07:08 +01:00
**K7** is an application for minimal remote management of GPG keys on a web server.
2019-10-25 20:16:43 +02:00
2020-11-03 18:07:08 +01:00
It is developed in C++ as a NetBeans project on the [WebToolkit](https://www.webtoolkit.eu/)(Wt) libraries.
It allows to view, import, delete and certify keys. Certification trust level can also be changed.
Key generation, changing expiry date and adding user identities are not (yet) implemented.
2019-10-25 20:16:43 +02:00
These keys can then be used by other Wt applications, or applications based on other libraries, to encrypt and sign data. As such, it suits my personal needs.
2020-11-03 18:07:08 +01:00
K7 is released under the GPL version 2 license. It does not intend nor need to be a full blown key manager.
**BUILDING**
2019-10-25 20:16:43 +02:00
As a NetBeans project, a Makefile exists in the project root.
2019-10-25 20:22:58 +02:00
2019-10-25 20:16:43 +02:00
cd /path/to/K7
2019-10-25 20:22:58 +02:00
2019-10-25 20:16:43 +02:00
make CONF=Debug #linked to wthttp here
2019-10-25 20:22:58 +02:00
2020-11-03 18:07:08 +01:00
make CONF=Release #linked to wtfcgi here (consider linking to wthttp rather)
2019-10-25 20:16:43 +02:00
2020-11-03 18:07:08 +01:00
**INSTALLING AND RUNNING**
2019-10-25 20:16:43 +02:00
2020-11-03 18:07:08 +01:00
Please see Wt's manuals about the *many* modes of installing and running Wt applications.
2019-10-25 20:25:27 +02:00
In particular, K7 needs the environment variable WT_APP_ROOT that should point to the directory containing configuration and translation files. In the project's tree, it's WTAPPROOT/K7.
2019-10-25 20:16:43 +02:00
2020-11-03 18:07:08 +01:00
**MAIN CONFIGURATION FILE**
2019-10-25 20:16:43 +02:00
This file is hard coded as k7config.json, and must be found in WT_APP_ROOT.
It controls access to the application. All users must authenticate by sending a client X509 certificate, and access is allowed if the subject's common name is listed as a JSON key in the configuration file.
2020-11-03 18:07:08 +01:00
An allowed user can always view keys. He can optionally import any GPG key, and delete GPG public keys. Key editing is also controlled in the configuration file.
An allowed user can optionally delete private GPG keys that he controls.
2019-10-25 20:16:43 +02:00
2020-11-03 18:07:08 +01:00
**TRANSLATION FILES**
2019-10-25 20:16:43 +02:00
2020-11-03 18:07:08 +01:00
K7.xml contains user facing strings for English default language. K7_fr.xml is translated in French.
2019-10-25 20:16:43 +02:00
2020-11-03 18:07:08 +01:00
*DISCLAIMER*
2019-10-25 20:16:43 +02:00
As usual, use at your own risks or don't use. I don't claim that K7 is fit for any purpose. Programming is just my hobby.