PGPainless/pgpainless
PGPainless/pgpainless
1
0
Fork 0
mirror of https://github.com/pgpainless/pgpainless.git synced 2024-11-23 12:52:07 +01:00
Code Issues Releases Wiki Activity

Add documentation to DecryptionStream(Interface)

Browse source
This commit is contained in:
Paul Schaub 2021-04-25 13:34:30 +02:00
parent 7916bf77d1
commit 0b3511486c
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311
2 changed files with 19 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
pgpainless-core/src/main/java/org/pgpainless/decryption_verification/DecryptionBuilderInterface.java
View file

@ -77,6 +77,12 @@ public interface DecryptionBuilderInterface {
*/ */
Verify decryptWith(@Nonnull Passphrase passphrase); Verify decryptWith(@Nonnull Passphrase passphrase);
/**
* Do not attempt to decrypt the provided data.
* Useful for signature verification of signed-only data.
*
* @return api handle
*/
Verify doNotDecrypt(); Verify doNotDecrypt();
} }

14
pgpainless-core/src/main/java/org/pgpainless/decryption_verification/DecryptionStream.java
View file

@ -25,6 +25,10 @@ import java.util.logging.Logger;
import org.bouncycastle.openpgp.PGPException; import org.bouncycastle.openpgp.PGPException;
import org.pgpainless.util.IntegrityProtectedInputStream; import org.pgpainless.util.IntegrityProtectedInputStream;
/**
* Decryption Stream that handles updating and verification of detached signatures,
* as well as verification of integrity-protected input streams once the stream gets closed.
*/
public class DecryptionStream extends InputStream { public class DecryptionStream extends InputStream {
private static final Logger LOGGER = Logger.getLogger(DecryptionStream.class.getName()); private static final Logger LOGGER = Logger.getLogger(DecryptionStream.class.getName());
@ -66,7 +70,7 @@ public class DecryptionStream extends InputStream {
this.isClosed = true; this.isClosed = true;
} }
void maybeVerifyDetachedSignatures() { private void maybeVerifyDetachedSignatures() {
for (DetachedSignature s : resultBuilder.getDetachedSignatures()) { for (DetachedSignature s : resultBuilder.getDetachedSignatures()) {
try { try {
s.setVerified(s.getSignature().verify()); s.setVerified(s.getSignature().verify());
@ -76,6 +80,14 @@ public class DecryptionStream extends InputStream {
} }
} }
/**
* Return the result of the decryption.
* The result contains metadata about the decryption, such as signatures, used keys and algorithms, as well as information
* about the decrypted file/stream.
*
* Can only be obtained once the stream got successfully closed ({@link #close()}).
* @return metadata
*/
public OpenPgpMetadata getResult() { public OpenPgpMetadata getResult() {
if (!isClosed) { if (!isClosed) {
throw new IllegalStateException("DecryptionStream MUST be closed before the result can be accessed."); throw new IllegalStateException("DecryptionStream MUST be closed before the result can be accessed.");