Skip to content

extract additional methods in SecurityHandler to reduce checks number #424

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

Open
valerybokov wants to merge 1 commit into
base: trunk
Choose a base branch
from
Open

extract additional methods in SecurityHandler to reduce checks number #424

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
65 changes: 48 additions & 17 deletions pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/SecurityHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -441,6 +441,28 @@ private SecureRandom getSecureRandom()
return new SecureRandom();
}

/**
* This will dispatch to the correct method.
*
* @param string The string to decrypt.
* @param objNum The object number.
* @param genNum The object generation Number.
*
* @return the encrypted/decrypted COS object
*/
public COSBase decrypt(COSString string, long objNum, long genNum)
{
// PDFBOX-4477: only cache strings and streams, this improves speed and memory footprint
if (objects.contains(string))
{
return string;
}
// replace the given COSString object with the encrypted/decrypted version
COSBase decryptedString = decryptString(string, objNum, genNum);
objects.add(decryptedString);
return decryptedString;
}

/**
* This will dispatch to the correct method.
*
Expand All @@ -457,16 +479,9 @@ public COSBase decrypt(COSBase obj, long objNum, long genNum) throws IOException
// PDFBOX-4477: only cache strings and streams, this improves speed and memory footprint
if (obj instanceof COSString)
{
if (objects.contains(obj))
{
return obj;
}
// replace the given COSString object with the encrypted/decrypted version
COSBase decryptedString = decryptString((COSString) obj, objNum, genNum);
objects.add(decryptedString);
return decryptedString;
return decrypt((COSString)obj, objNum, genNum);
}
if (obj instanceof COSStream)
else if (obj instanceof COSStream)
{
if (objects.contains(obj))
{
Expand All @@ -477,11 +492,11 @@ public COSBase decrypt(COSBase obj, long objNum, long genNum) throws IOException
}
else if (obj instanceof COSDictionary)
{
decryptDictionary((COSDictionary) obj, objNum, genNum);
return decrypt((COSDictionary) obj, objNum, genNum);
}
else if (obj instanceof COSArray)
{
decryptArray((COSArray) obj, objNum, genNum);
return decrypt((COSArray) obj, objNum, genNum);
}
return obj;
}
Expand Down Expand Up @@ -536,7 +551,7 @@ public void decryptStream(COSStream stream, long objNum, long genNum) throws IOE
return;
}
}
decryptDictionary(stream, objNum, genNum);
decrypt(stream, objNum, genNum);
// the input and the output stream of a still encrypted COSStream aren't no longer based
// on the same object so that it is safe to omit the intermediate ByteArrayStream
try (InputStream encryptedStream = stream.createRawInputStream(); //
Expand Down Expand Up @@ -589,14 +604,16 @@ public void encryptStream(COSStream stream, long objNum, int genNum) throws IOEx
* @param objNum The object number.
* @param genNum The object generation number.
*
* @return the encrypted/decrypted COS object
*
* @throws IOException If there is an error creating a new string.
*/
private void decryptDictionary(COSDictionary dictionary, long objNum, long genNum) throws IOException
private COSBase decrypt(COSDictionary dictionary, long objNum, long genNum) throws IOException
{
if (dictionary.getItem(COSName.CF) != null)
{
// PDFBOX-2936: avoid orphan /CF dictionaries found in US govt "I-" files
return;
return dictionary;
}
COSName type = dictionary.getCOSName(COSName.TYPE);
boolean isSignature = COSName.SIG.equals(type) || COSName.DOC_TIME_STAMP.equals(type) ||
Expand All @@ -613,11 +630,21 @@ private void decryptDictionary(COSDictionary dictionary, long objNum, long genNu
}
COSBase value = entry.getValue();
// within a dictionary only the following kind of COS objects have to be decrypted
if (value instanceof COSString || value instanceof COSArray || value instanceof COSDictionary)
if (value instanceof COSString)
{
entry.setValue(decrypt(value, objNum, genNum));
entry.setValue(decrypt((COSString)value, objNum, genNum));
}
else if (value instanceof COSArray)
{
entry.setValue(decrypt((COSArray) value, objNum, genNum));
}
else if (value instanceof COSDictionary)
{
entry.setValue(decrypt((COSDictionary)value, objNum, genNum));
}
}

return dictionary;
}

/**
Expand Down Expand Up @@ -678,14 +705,18 @@ public COSBase encryptString(COSString string, long objNum, int genNum) throws I
* @param objNum The object number.
* @param genNum The object generation number.
*
* @return the encrypted/decrypted COS object
*
* @throws IOException If there is an error accessing the data.
*/
private void decryptArray(COSArray array, long objNum, long genNum) throws IOException
private COSBase decrypt(COSArray array, long objNum, long genNum) throws IOException
{
for (int i = 0; i < array.size(); i++)
{
array.set(i, decrypt(array.get(i), objNum, genNum));
}

return array;
}

/**
Expand Down