set/k7
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md.

Browse Source
This commit is contained in:
SET
2020-11-03 18:07:08 +01:00
parent 0bb61b7119
commit 757dd7401e
2 changed files with 24 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@@ -1,15 +1,15 @@
K7 is an application for minimal remote management of GPG keys on a web server.
It allows to view, import and delete keys.
It does not intend nor need to be a full blown key manager.
Key generation and editing is not implemented, and it probably cannot be done this way.
**K7** is an application for minimal remote management of GPG keys on a web server.
K7 is developed as a NetBeans project on the [WebToolkit](https://www.webtoolkit.eu/)(Wt) libraries.
It is released under the GPL version 2 license.
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.
The intent is solely to add and delete keys in the default GPG keyring of the running user.
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.
BUILDING
K7 is released under the GPL version 2 license. It does not intend nor need to be a full blown key manager.
**BUILDING**
As a NetBeans project, a Makefile exists in the project root.
@@ -17,24 +17,24 @@ cd /path/to/K7
make CONF=Debug #linked to wthttp here
make CONF=Release #linked to wtfcgi
make CONF=Release #linked to wtfcgi here (consider linking to wthttp rather)
INSTALLING AND RUNNING
**INSTALLING AND RUNNING**
Please see Wt's manuals about the modes of installing and running Wt applications.
Please see Wt's manuals about the *many* modes of installing and running Wt applications.
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.
MAIN CONFIGURATION FILE
**MAIN CONFIGURATION FILE**
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.
An allowed user can always view keys. He can optionally import any GPG key, and delete GPG public keys.
An allowed user can optionally delete private GPG keys. For this, a full key identifier must be declared in a JSON array in the configuration file. This should be a normal key identifier, a short key identifier or a fingerprint, but always a full identifier.
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.
TRANSLATION FILES
**TRANSLATION FILES**
K7.xml contains user facing strings for English default language. K7_fr.xml is translated in French.
DISCLAIMER
*DISCLAIMER*
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.

10
nbproject/private/private.xml
View File

@@ -7,10 +7,14 @@
<editor-bookmarks xmlns="http://www.netbeans.org/ns/editor-bookmarks/2" lastBookmarkId="0"/>
<open-files xmlns="http://www.netbeans.org/ns/projectui-open-files/2">
<group>
<file>file:/home/user/Documents/published/K7/WTAPPROOT/K7/K7_fr.xml</file>
<file>file:/home/user/Documents/published/K7/K7Main.cpp</file>
<file>file:/home/user/Documents/published/K7/PopupDeleter.h</file>
<file>file:/home/user/Documents/published/K7/K7Main.h</file>
<file>file:/home/user/Documents/published/K7/WTAPPROOT/K7/K7.xml</file>
<file>file:/home/user/Documents/published/K7/PopupUploader.h</file>
<file>file:/home/user/Documents/published/K7/K7Main.cpp</file>
<file>file:/home/user/Documents/published/K7/PopupCertifyUserId.cpp</file>
<file>file:/home/user/Documents/published/K7/PopupUploader.cpp</file>
<file>file:/home/user/Documents/published/K7/PopupCertifyUserId.h</file>
<file>file:/home/user/Documents/published/K7/PopupDeleter.cpp</file>
</group>
</open-files>
</project-private>