mirror of
https://github.com/pgpainless/pgpainless.git
synced 2024-11-18 10:22:05 +01:00
78 lines
2.2 KiB
Markdown
78 lines
2.2 KiB
Markdown
<!--
|
|
SPDX-FileCopyrightText: 2021 Paul Schaub <vanitasvitae@fsfe.org>
|
|
|
|
SPDX-License-Identifier: Apache-2.0
|
|
-->
|
|
|
|
# PGPainless-SOP
|
|
|
|
[](https://datatracker.ietf.org/doc/html/draft-dkg-openpgp-stateless-cli-03)
|
|
[](https://search.maven.org/artifact/org.pgpainless/pgpainless-sop)
|
|
[](https://javadoc.io/doc/org.pgpainless/pgpainless-sop)
|
|
|
|
Implementation of the Stateless OpenPGP Protocol using PGPainless.
|
|
|
|
This module implements `sop-java` using `pgpainless-core`.
|
|
If your code depends on `sop-java`, this module can be used as a realization of those interfaces.
|
|
|
|
## Get started
|
|
|
|
To start using pgpainless-sop in your code, include the following lines in your build script:
|
|
```
|
|
// If you use Gradle
|
|
...
|
|
dependencies {
|
|
...
|
|
implementation "org.pgpainless:pgpainless-sop:1.2.2"
|
|
...
|
|
}
|
|
|
|
// If you use Maven
|
|
...
|
|
<dependencies>
|
|
...
|
|
<dependency>
|
|
<groupId>org.pgpainless</groupId>
|
|
<artifactId>pgpainless-sop</artifactId>
|
|
<version>1.2.2</version>
|
|
</dependency>
|
|
...
|
|
</dependencies>
|
|
```
|
|
|
|
`pgpainless-sop` will transitively pull in its dependencies, such as `sop-java` and `pgpainless-core`.
|
|
|
|
## Usage Examples
|
|
```java
|
|
SOP sop = new SOPImpl();
|
|
|
|
// Generate an OpenPGP key
|
|
byte[] key = sop.generateKey()
|
|
.userId("Alice <alice@example.org>")
|
|
.generate()
|
|
.getBytes();
|
|
|
|
// Extract the certificate (public key)
|
|
byte[] cert = sop.extractCert()
|
|
.key(key)
|
|
.getBytes();
|
|
|
|
// Encrypt a message
|
|
byte[] message = ...
|
|
byte[] encrypted = sop.encrypt()
|
|
.withCert(cert)
|
|
.signWith(key)
|
|
.plaintext(message)
|
|
.getBytes();
|
|
|
|
// Decrypt a message
|
|
ByteArrayAndResult<DecryptionResult> messageAndVerifications = sop.decrypt()
|
|
.verifyWith(cert)
|
|
.withKey(key)
|
|
.ciphertext(encrypted)
|
|
.toByteArrayAndResult();
|
|
byte[] decrypted = messageAndVerifications.getBytes();
|
|
// Signature Verifications
|
|
DecryptionResult messageInfo = messageAndVerifications.getResult();
|
|
List<Verification> signatureVerifications = messageInfo.getVerifications();
|
|
```
|