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-08-01 17:09:39 +02:00
[](https://ci.codeberg.org/PGPainless/sop-java)
2024-03-21 13:43:12 +01:00
[](https://datatracker.ietf.org/doc/draft-dkg-openpgp-stateless-cli/10/)
2022-08-01 17:09:39 +02:00
[](https://coveralls.io/github/pgpainless/sop-java?branch=main)
2022-01-15 14:55:02 +01:00
[](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-11-07 17:26:05 +01:00
[](https://repology.org/project/pgpainless/versions)
[](https://search.maven.org/artifact/org.pgpainless/sop-java)
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.
2024-03-21 13:43:25 +01:00
* [external-sop ](/external-sop ) contains an API implementation that can be used to forward API calls to a SOP executable,
allowing to delegate the implementation logic to an arbitrary SOP CLI implementation.
2022-01-11 13:46:05 +01:00
## Known Implementations
(Please expand!)
2023-01-12 15:37:36 +01:00
| Project | Description |
|-------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------|
| [pgpainless-sop ](https://github.com/pgpainless/pgpainless/tree/main/pgpainless-sop ) | Implementation of `sop-java` using PGPainless |
| [external-sop ](https://github.com/pgpainless/sop-java/tree/main/external-sop ) | Implementation of `sop-java` that allows binding to external SOP binaries such as `sqop` |
2025-01-28 12:12:04 +01:00
| [bcsop ](https://codeberg.org/PGPainless/bc-sop ) | Implementation of `sop-java` using vanilla Bouncy Castle |
2022-01-11 13:46:05 +01:00
### Implementations in other languages
2025-01-28 12:12:17 +01:00
| Project | Language |
|---------------------------------------------------|----------|
| [sop-rs ](https://sequoia-pgp.gitlab.io/sop-rs/ ) | Rust |
| [SOP for python ](https://pypi.org/project/sop/ ) | Python |
| [rpgpie-sop ](https://crates.io/crates/rpgpie-sop ) | Rust |