org.pdfbox.pdmodel.encryption

Class SecurityHandler

Known Direct Subclasses:
PublicKeySecurityHandler, StandardSecurityHandler

public abstract class SecurityHandler
extends java.lang.Object

This class represents a security handler as described in the PDF specifications. A security handler is responsible of documents protection.
Version:
$Revision: 1.4 $
Authors:
Ben Litchfield
Benoit Guillon (benoit.guillon@snv.jussieu.fr)

Field Summary

protected AccessPermission
currentAccessPermission
The access permission granted to the current user for the document.
protected PDDocument
document
The document whose security is handled by this security handler.
protected byte[]
encryptionKey
The encryption key that will used to encrypt / decrypt.
protected int
keyLength
The length of the secret key used to encrypt the document.
protected ARCFour
rc4
The RC4 implementation used for cryptographic functions.
protected int
version
The value of V field of the Encryption dictionary.

Method Summary

abstract void
decryptDocument(PDDocument doc, DecryptionMaterial mat)
Prepare the document for decryption.
void
decryptStream(COSStream stream, long objNum, long genNum)
This will decrypt a stream.
void
decryptString(COSString string, long objNum, long genNum)
This will decrypt a string.
void
encryptData(long objectNumber, long genNumber, InputStream data, OutputStream output)
Encrypt a set of data.
AccessPermission
getCurrentAccessPermission()
Returns the access permissions that were computed during document decryption.
int
getKeyLength()
Getter of the property keyLength.
abstract void
prepareDocumentForEncryption(PDDocument doc)
Prepare the document for encryption.
protected void
proceedDecryption()
This method must be called by an implementation of this class to really proceed to decryption.
void
setKeyLength(int keyLen)
Setter of the property keyLength.

Field Details

currentAccessPermission

protected AccessPermission currentAccessPermission
The access permission granted to the current user for the document. These permissions are computed during decryption and are in read only mode.

document

protected PDDocument document
The document whose security is handled by this security handler.

encryptionKey

protected byte[] encryptionKey
The encryption key that will used to encrypt / decrypt.

keyLength

protected int keyLength
The length of the secret key used to encrypt the document.

rc4

protected ARCFour rc4
The RC4 implementation used for cryptographic functions.

version

protected int version
The value of V field of the Encryption dictionary.

Method Details

decryptDocument

public abstract void decryptDocument(PDDocument doc,
                                     DecryptionMaterial mat)
            throws CryptographyException,
                   IOException
Prepare the document for decryption.
Parameters:
doc - The document to decrypt.
mat - Information required to decrypt the document.
Throws:
CryptographyException - If there is an error while preparing.

decryptStream

public void decryptStream(COSStream stream,
                          long objNum,
                          long genNum)
            throws CryptographyException,
                   IOException
This will decrypt a stream.
Parameters:
stream - The stream to decrypt.
objNum - The object number.
genNum - The object generation number.
Throws:
CryptographyException - If there is an error getting the stream.

decryptString

public void decryptString(COSString string,
                          long objNum,
                          long genNum)
            throws CryptographyException,
                   IOException
This will decrypt a string.
Parameters:
string - the string to decrypt.
objNum - The object number.
genNum - The object generation number.
Throws:
CryptographyException - If an error occurs during decryption.

encryptData

public void encryptData(long objectNumber,
                        long genNumber,
                        InputStream data,
                        OutputStream output)
            throws CryptographyException,
                   IOException
Encrypt a set of data.
Parameters:
objectNumber - The data object number.
genNumber - The data generation number.
data - The data to encrypt.
output - The output to write the encrypted data to.
Throws:
CryptographyException - If there is an error during the encryption.

getCurrentAccessPermission

public AccessPermission getCurrentAccessPermission()
Returns the access permissions that were computed during document decryption. The returned object is in read only mode.
Returns:
the access permissions or null if the document was not decrypted.

getKeyLength

public int getKeyLength()
Getter of the property keyLength.
Returns:
Returns the keyLength.

prepareDocumentForEncryption

public abstract void prepareDocumentForEncryption(PDDocument doc)
            throws CryptographyException,
                   IOException
Prepare the document for encryption.
Parameters:
doc - The document that will be encrypted.
Throws:
CryptographyException - If there is an error while preparing.

proceedDecryption

protected void proceedDecryption()
            throws IOException,
                   CryptographyException
This method must be called by an implementation of this class to really proceed to decryption.
Throws:
CryptographyException - If there is an error in the decryption.

setKeyLength

public void setKeyLength(int keyLen)
Setter of the property keyLength.
Parameters:
keyLen - The keyLength to set.