mirror of https://github.com/pgpainless/pgpainless.git synced 2024-12-23 11:27:57 +01:00

History

Paul Schaub a9a61bc799 Improve library usage of slf4j and logback. Logback-classic is now a test dependency and is additionally declared as OPTIONAL runtime dependency. Applications that don't want to use logback can now easily disable it by not explicitly depending on it.		2021-10-29 20:28:14 +02:00
..
src	SOP: Add convenience methods to deal with byte arrays	2021-10-10 16:34:17 +02:00
build.gradle	Improve library usage of slf4j and logback.	2021-10-29 20:28:14 +02:00
README.md	Reuse compliance	2021-10-07 16:28:31 +02:00

README.md

SOP-Java-Picocli

Implementation of the Stateless OpenPGP Command Line Interface specification. This terminal application allows generation of OpenPGP keys, extraction of public key certificates, armoring and de-armoring of data, as well as - of course - encryption/decryption of messages and creation/verification of signatures.

Install a SOP backend

This module comes without a SOP backend, so in order to function you need to extend it with an implementation of the interfaces defined in sop-java. An implementation using PGPainless can be found in the module pgpainless-sop, but it is of course possible to provide your own implementation.

Just install your SOP backend by calling

// static method call prior to execution of the main method
SopCLI.setSopInstance(yourSopImpl);

Usage

To get an overview of available commands of the application, execute

java -jar sop-java-picocli-XXX.jar help

If you just want to get started encrypting messages, see the module pgpainless-cli which initializes sop-java-picocli with pgpainless-sop, so you can get started right away without the need to manually wire stuff up.

Enjoy!