Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Logging, shortcuts and other improvements #34

Merged
merged 4 commits into from
Mar 11, 2021
Merged

Logging, shortcuts and other improvements #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
40cce5b
Added encryptor/decryptor flag to control non-essential logging
Mar 5, 2021
d7c826c
Added shortcut for encrypting bytes data array
Mar 6, 2021
f1a1070
Added FileMetadata#equals/hashCode implementation
Mar 6, 2021
50ce266
Stricter visibility for FileMetadata related fields
Mar 6, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 67 additions & 15 deletions src/main/java/org/c02e/jpgpj/Decryptor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ public class Decryptor {
public static final int DEFAULT_MAX_FILE_BUFFER_SIZE = 0x100000; // 1MB
public static final boolean DEFAULT_VERIFICATION_REQUIRED = true;
public static final int DEFAULT_COPY_FILE_BUFFER_SIZE = 0x4000;
public static final boolean DEFAULT_LOGGING_ENABLED = false;

protected boolean verificationRequired = DEFAULT_VERIFICATION_REQUIRED;
protected char[] symmetricPassphraseChars;
Expand All @@ -85,6 +86,7 @@ public class Decryptor {
protected String symmetricPassphrase;
protected int maxFileBufferSize = DEFAULT_MAX_FILE_BUFFER_SIZE; //1MB
protected int copyFileBufferSize = DEFAULT_COPY_FILE_BUFFER_SIZE;
protected boolean loggingEnabled = DEFAULT_LOGGING_ENABLED;
protected Ring ring;
protected final Logger log = LoggerFactory.getLogger(Decryptor.class.getName());

Expand Down Expand Up @@ -254,6 +256,32 @@ public Decryptor withRing(Ring x) {
return this;
}

/**
* @return {@code true} if logging a brief summary of the execution
* every time decryption is executed (e.g. file name/path, size, compression
* type, etc.). <B>Note:</B> errors/warnings logging are not affected by
* this setting
*/
public boolean isLoggingEnabled() {
return loggingEnabled;
}

/**
* @param enabled {@code true} if should log a brief summary of the execution
* every time decryption is executed (e.g. file name/path, size, compression
* type, etc.). <B>Note:</B> errors/warnings logging are not affected by
* this setting
*/
public void setLoggingEnabled(boolean enabled) {
loggingEnabled = enabled;
}

/** @see #setLoggingEnabled(boolean) */
public Decryptor withLoggingEnabled(boolean enabled) {
setLoggingEnabled(enabled);
return this;
}

/**
* Zeroes-out the cached passphrase for all keys,
* and releases the extracted private key material for garbage collection.
Expand Down Expand Up @@ -328,7 +356,9 @@ public FileMetadata decrypt(Path ciphertext, Path plaintext)

// delete old output file
if (Files.deleteIfExists(plaintext)) {
log.debug("decrypt({}) deleted {}", ciphertext, plaintext);
if (isLoggingEnabled()) {
log.debug("decrypt({}) deleted {}", ciphertext, plaintext);
}
}

long inputSize = Files.size(ciphertext);
Expand All @@ -341,7 +371,9 @@ public FileMetadata decrypt(Path ciphertext, Path plaintext)
// delete output file if anything went wrong
try {
if (Files.deleteIfExists(plaintext)) {
log.debug("decrypt({}) cleaned up {}", ciphertext, plaintext);
if (isLoggingEnabled()) {
log.debug("decrypt({}) cleaned up {}", ciphertext, plaintext);
}
}
} catch (IOException ioe) {
log.warn("decrypt({}) cannot clean up {}", ciphertext, plaintext, ioe);
Expand Down Expand Up @@ -458,10 +490,13 @@ protected List<FileMetadata> unpack(Iterator<?> packets, OutputStream plaintext)
List<FileMetadata> meta = new ArrayList<FileMetadata>();
List<Verifier> verifiers = new ArrayList<Verifier>();

boolean logUnpacking = isLoggingEnabled();
while (packets.hasNext()) {
Object packet = packets.next();

log.trace("unpack {}", packet.getClass());
if (logUnpacking) {
log.trace("unpack {}", packet.getClass());
}

if (packet instanceof PGPMarker) {
// no-op
Expand Down Expand Up @@ -500,7 +535,10 @@ protected List<FileMetadata> unpack(Iterator<?> packets, OutputStream plaintext)
throw new PGPException("unexpected packet: " + packet.getClass());
}
}
log.trace("unpacked all");

if (logUnpacking) {
log.trace("unpacked all");
}

// fail if verification required and any signature is bad
verify(verifiers, meta);
Expand Down Expand Up @@ -550,6 +588,7 @@ protected InputStream decrypt(Iterator<?> data)
PGPPBEEncryptedData pbe = null;

Ring decryptRing = getRing();
boolean logDecryption = isLoggingEnabled();
while (data.hasNext()) {
Object o = data.next();

Expand All @@ -565,11 +604,15 @@ protected InputStream decrypt(Iterator<?> data)
if (isUsableForDecryption(subkey))
return decrypt(pke, subkey);

log.info("not using decryption key {}", subkey);
if (logDecryption) {
log.info("not using decryption key {}", subkey);
}
}

if (Util.isEmpty(keys))
log.info("not found decryption key {}", Util.formatKeyId(id));
if (logDecryption) {
log.info("not found decryption key {}", Util.formatKeyId(id));
}

} else if (o instanceof PGPPBEEncryptedData) {
// try first symmetric-key option at the end
Expand All @@ -588,8 +631,9 @@ protected InputStream decrypt(PGPPublicKeyEncryptedData data, Subkey subkey)
throws IOException, PGPException {
if (data == null || subkey == null)
throw new DecryptionException("no suitable decryption key found");

log.info("using decryption key {}", subkey);
if (isLoggingEnabled()) {
log.info("using decryption key {}", subkey);
}

return data.getDataStream(buildPublicKeyDecryptor(subkey));
}
Expand Down Expand Up @@ -658,8 +702,9 @@ protected void verify(List<Verifier> verifiers, List<FileMetadata> meta)
if (!verifier.verify())
throw new VerificationException(
"bad signature for key " + verifier.key);
else
if (isLoggingEnabled()) {
log.debug("good signature for key {}", verifier.key);
}

Key key = verifier.getSignedBy();
for (FileMetadata file : meta) {
Expand Down Expand Up @@ -818,24 +863,31 @@ public Key getSignedBy() throws PGPException {
* Finds verification subkey by ID in this Decryptor's ring, or null.
* If found, also sets "key" field to subkey's key.
*/
private Subkey findVerificationSubkey(Long id) {
protected Subkey findVerificationSubkey(Long id) {
Ring decryptorRing = getRing();
List<Key> keys = decryptorRing.findAll(id);

boolean logVerification = isLoggingEnabled();
for (Key key: keys) {
Subkey subkey = key.findById(id);

if (subkey != null && subkey.isForVerification()) {
log.info("using verification key {}", subkey);
if (logVerification) {
log.info("using verification key {} for ID={}", subkey, Util.formatKeyId(id));
}
this.key = key;
return subkey;
}

log.info("not using verification key {}", subkey);
if (logVerification) {
log.info("not using verification key {} for ID={}", subkey, Util.formatKeyId(id));
}
}

if (Util.isEmpty(keys))
log.info("not found verification key {}", Util.formatKeyId(id));
if (Util.isEmpty(keys)) {
if (logVerification) {
log.info("not found verification key {}", Util.formatKeyId(id));
}
}

return null;
}
Expand Down
Loading