PGPainless/pgpainless
PGPainless
/
pgpainless
mirror of https://github.com/pgpainless/pgpainless.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Update documentation to use new MessageMetadata class

This commit is contained in:
Paul Schaub 2022-12-05 14:00:34 +01:00
parent 218da50da3
commit e168ac6f55
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/source/pgpainless-core/quickstart.md
View File

@ -242,7 +242,7 @@ or the passphrase.
### Decrypt and/or Verify a Message ### Decrypt and/or Verify a Message
Decryption and verification of a message is both done using the same API. Decryption and verification of a message is both done using the same API.
Whether a message was actually signed / encrypted can be determined after the message has been processed by checking Whether a message was actually signed / encrypted can be determined after the message has been processed by checking
the `OpenPgpMetadata` object which can be obtained from the `DecryptionStream`. the `MessageMetadata` object which can be obtained from the `DecryptionStream`.
To configure the decryption / verification process, the `ConsumerOptions` object is used: To configure the decryption / verification process, the `ConsumerOptions` object is used:
@ -283,16 +283,16 @@ Streams.pipeAll(consumerStream, plaintext);
consumerStream.close(); // important! consumerStream.close(); // important!
// The result will contain metadata of the message // The result will contain metadata of the message
OpenPgpMetadata result = consumerStream.getResult(); MessageMetadata result = consumerStream.getMetadata();
``` ```
After the message has been processed, you can consult the `OpenPgpMetadata` object to determine the nature of the message: After the message has been processed, you can consult the `MessageMetadata` object to determine the nature of the message:
```java ```java
boolean wasEncrypted = result.isEncrypted(); boolean wasEncrypted = result.isEncrypted();
SubkeyIdentifier decryptionKey = result.getDecryptionKey(); SubkeyIdentifier decryptionKey = result.getDecryptionKey();
Map<SubkeyIdentifier, PGPSignature> validSignatures = result.getVerifiedSignatures(); List<SignatureVerification> validSignatures = result.getVerifiedSignatures();
boolean wasSignedByCert = result.containsVerifiedSignatureFrom(certificate); boolean wasSignedByCert = result.isVerifiedSignedBy(certificate);
// For files: // For files:
String fileName = result.getFileName(); String fileName = result.getFileName();
@ -323,6 +323,6 @@ DecryptionStream verificationStream = PGPainless.decryptAndOrVerify()
Streams.drain(verificationStream); // push all the data through the stream Streams.drain(verificationStream); // push all the data through the stream
verificationStream.close(); // finish verification verificationStream.close(); // finish verification
OpenPgpMetadata result = verificationStream.getResult(); // get metadata of signed message MessageMetadata result = verificationStream.getMetadata(); // get metadata of signed message
assertTrue(result.containsVerifiedSignatureFrom(certificate)); // check if message was in fact signed assertTrue(result.isVerifiedSignedBy(certificate)); // check if message was in fact signed
``` ```