PGPainless/pgpainless
PGPainless/pgpainless
1
0
Fork 0
mirror of https://github.com/pgpainless/pgpainless.git synced 2024-10-18 20:26:00 +02:00
Code Issues Releases Wiki Activity

Update README

Browse source
This commit is contained in:
Paul Schaub 2024-10-14 12:27:04 +02:00
parent 62c661e254
commit 3388d908a1
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -8,7 +8,7 @@ SPDX-License-Identifier: Apache-2.0
[![Build Status](https://github.com/pgpainless/pgpainless/actions/workflows/gradle_push.yml/badge.svg)](https://github.com/pgpainless/pgpainless/actions/workflows/gradle_push.yml) [![Build Status](https://github.com/pgpainless/pgpainless/actions/workflows/gradle_push.yml/badge.svg)](https://github.com/pgpainless/pgpainless/actions/workflows/gradle_push.yml)
[![Coverage Status](https://coveralls.io/repos/github/pgpainless/pgpainless/badge.svg?branch=main)](https://coveralls.io/github/pgpainless/pgpainless?branch=main) [![Coverage Status](https://coveralls.io/repos/github/pgpainless/pgpainless/badge.svg?branch=main)](https://coveralls.io/github/pgpainless/pgpainless?branch=main)
[![Interoperability Test-Suite](https://badgen.net/badge/Sequoia%20Test%20Suite/%231/green)](https://tests.sequoia-pgp.org/) [![Interoperability Test-Suite](https://badgen.net/badge/Sequoia%20Test%20Suite/results/green)](https://tests.sequoia-pgp.org/)
[![PGP](https://img.shields.io/badge/pgp-A027%20DB2F%203E1E%20118A-blue)](https://keyoxide.org/7F9116FEA90A5983936C7CFAA027DB2F3E1E118A) [![PGP](https://img.shields.io/badge/pgp-A027%20DB2F%203E1E%20118A-blue)](https://keyoxide.org/7F9116FEA90A5983936C7CFAA027DB2F3E1E118A)
[![REUSE status](https://api.reuse.software/badge/github.com/pgpainless/pgpainless)](https://api.reuse.software/info/github.com/pgpainless/pgpainless) [![REUSE status](https://api.reuse.software/badge/github.com/pgpainless/pgpainless)](https://api.reuse.software/info/github.com/pgpainless/pgpainless)
[![Documentation Status](https://readthedocs.org/projects/pgpainless/badge/?version=latest)](https://pgpainless.readthedocs.io/en/latest/?badge=latest) [![Documentation Status](https://readthedocs.org/projects/pgpainless/badge/?version=latest)](https://pgpainless.readthedocs.io/en/latest/?badge=latest)
@ -132,7 +132,7 @@ Still it allows you to manually specify which algorithms to use of course.
.addRecipient(aliceKey) .addRecipient(aliceKey)
.addRecipient(bobsKey) .addRecipient(bobsKey)
// optionally encrypt to a passphrase // optionally encrypt to a passphrase
.addPassphrase(Passphrase.fromPassword("password123")) .addMessagePassphrase(Passphrase.fromPassword("password123"))
// optionally override symmetric encryption algorithm // optionally override symmetric encryption algorithm
.overrideEncryptionAlgorithm(SymmetricKeyAlgorithm.AES_192), .overrideEncryptionAlgorithm(SymmetricKeyAlgorithm.AES_192),
new SigningOptions() new SigningOptions()
@ -164,7 +164,7 @@ This behaviour can be modified though using the `Policy` class.
DecryptionStream decryptionStream = PGPainless.decryptAndOrVerify() DecryptionStream decryptionStream = PGPainless.decryptAndOrVerify()
.onInputStream(encryptedInputStream) .onInputStream(encryptedInputStream)
.withOptions(new ConsumerOptions() .withOptions(new ConsumerOptions()
.addDecryptionKey(bobSecKeys, secretKeyProtector) .addMessagePassphrase(bobSecKeys, secretKeyProtector)
.addVerificationCert(alicePubKeys) .addVerificationCert(alicePubKeys)
); );
@ -191,7 +191,7 @@ repositories {
} }
dependencies { dependencies {
implementation 'org.pgpainless:pgpainless-core:1.6.6' implementation 'org.pgpainless:pgpainless-core:1.7.0'
} }
``` ```