Module org.sejda.sambox

Package org.sejda.sambox.pdmodel.encryption

Class PublicKeySecurityHandler

java.lang.Object

org.sejda.sambox.pdmodel.encryption.SecurityHandler

org.sejda.sambox.pdmodel.encryption.PublicKeySecurityHandler

public final class PublicKeySecurityHandler
extends SecurityHandler

This class implements the public key security handler described in the PDF specification.

See Also:

• to see how to protect document with this security handler.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FILTER	The filter name.
private PublicKeyProtectionPolicy	policy

Fields inherited from class org.sejda.sambox.pdmodel.encryption.SecurityHandler

keyLength

Constructor Summary

Constructors

Constructor	Description
PublicKeySecurityHandler()	Constructor.
PublicKeySecurityHandler(PublicKeyProtectionPolicy p)	Constructor used for encryption.

Method Summary

Modifier and Type	Method	Description
private void	appendCertInfo(StringBuilder extraInfo, org.bouncycastle.cms.KeyTransRecipientId ktRid, X509Certificate certificate, org.bouncycastle.cert.X509CertificateHolder materialCert)
void	prepareForDecryption(PDEncryption encryption, COSArray documentIDArray, DecryptionMaterial decryptionMaterial)	Prepares everything to decrypt the document.

Methods inherited from class org.sejda.sambox.pdmodel.encryption.SecurityHandler

decrypt, decryptDataRC4, decryptDataRC4, decryptStream, getCurrentAccessPermission, getEncryptionKey, getKeyLength, isAES, isDecryptMetadata, setAES, setCurrentAccessPermission, setDecryptMetadata, setEncryptionKey, setKeyLength, setStreamFilterName, setStringFilterName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

FILTER

public static final String FILTER

The filter name.

See Also:

• Constant Field Values

policy

private PublicKeyProtectionPolicy policy

Constructor Details

PublicKeySecurityHandler

public PublicKeySecurityHandler()

Constructor.

PublicKeySecurityHandler

public PublicKeySecurityHandler(PublicKeyProtectionPolicy p)

Constructor used for encryption.

Parameters:

p - The protection policy.

Method Details

prepareForDecryption

public void prepareForDecryption(PDEncryption encryption,
 COSArray documentIDArray,
 DecryptionMaterial decryptionMaterial)
                          throws IOException

Prepares everything to decrypt the document.

Specified by:

prepareForDecryption in class SecurityHandler

Parameters:

encryption - encryption dictionary, can be retrieved via PDDocument.getEncryption()

documentIDArray - document id which is returned via COSDocument.getDocumentID() (not used by this handler)

decryptionMaterial - Information used to decrypt the document.

Throws:

IOException - If there is an error accessing data. If verbose mode is enabled, the exception message will provide more details why the match wasn't successful.

appendCertInfo

private void appendCertInfo(StringBuilder extraInfo,
 org.bouncycastle.cms.KeyTransRecipientId ktRid,
 X509Certificate certificate,
 org.bouncycastle.cert.X509CertificateHolder materialCert)