2022-01-15 14:45:13 +01:00
|
|
|
<!--
|
|
|
|
|
SPDX-FileCopyrightText: 2021 Paul Schaub <vanitasvitae@fsfe.org>
|
|
|
|
|
|
|
|
|
|
SPDX-License-Identifier: Apache-2.0
|
|
|
|
|
-->
|
|
|
|
|
|
2022-01-11 13:46:05 +01:00
|
|
|
# SOP for Java
|
|
|
|
|
|
2022-01-15 14:55:02 +01:00
|
|
|
[](https://travis-ci.com/pgpainless/sop-java)
|
|
|
|
|
[](https://search.maven.org/artifact/org.pgpainless/sop-java)
|
2022-05-07 22:17:41 +02:00
|
|
|
[](https://datatracker.ietf.org/doc/draft-dkg-openpgp-stateless-cli/)
|
2022-01-15 14:55:02 +01:00
|
|
|
[](https://coveralls.io/github/pgpainless/sop-java?branch=master)
|
|
|
|
|
[](https://api.reuse.software/info/github.com/pgpainless/sop-java)
|
|
|
|
|
|
2022-05-07 22:17:41 +02:00
|
|
|
The [Stateless OpenPGP Protocol](https://datatracker.ietf.org/doc/draft-dkg-openpgp-stateless-cli/) specification
|
2022-01-11 13:46:05 +01:00
|
|
|
defines a generic stateless CLI for dealing with OpenPGP messages.
|
|
|
|
|
Its goal is to provide a minimal, yet powerful API for the most common OpenPGP related operations.
|
|
|
|
|
|
2022-04-11 14:50:28 +02:00
|
|
|
## Modules
|
2022-01-11 13:46:05 +01:00
|
|
|
|
2022-04-11 14:50:28 +02:00
|
|
|
The repository contains the following modules:
|
|
|
|
|
|
|
|
|
|
* [sop-java](/sop-java) defines a set of Java interfaces describing the Stateless OpenPGP Protocol.
|
|
|
|
|
* [sop-java-picocli](/sop-java-picocli) contains a wrapper application that transforms the `sop-java` API into a command line application
|
2022-01-11 13:46:05 +01:00
|
|
|
compatible with the SOP-CLI specification.
|
|
|
|
|
|
|
|
|
|
## Known Implementations
|
|
|
|
|
(Please expand!)
|
|
|
|
|
|
|
|
|
|
| Project | Description |
|
|
|
|
|
|---------------------------------------------------------------------------------------|-----------------------------------------------|
|
|
|
|
|
| [pgpainless-sop](https://github.com/pgpainless/pgpainless/tree/master/pgpainless-sop) | Implementation of `sop-java` using PGPainless |
|
|
|
|
|
|
|
|
|
|
### Implementations in other languages
|
|
|
|
|
| Project | Language |
|
|
|
|
|
|-------------------------------------------------|----------|
|
|
|
|
|
| [sop-rs](https://sequoia-pgp.gitlab.io/sop-rs/) | Rust |
|
2022-05-07 22:17:41 +02:00
|
|
|
| [SOP for python](https://pypi.org/project/sop/) | Python |
|
