Overview Package Class Use Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.pdfbox.pdmodel.encryption

Class StandardSecurityHandler

public class StandardSecurityHandler
extends SecurityHandler
The class implements the standard security handler as decribed in the PDF specifications. This security handler protects document with password.
Version:
$Revision: 1.3 $
Authors:
Ben Litchfield
Benoit Guillon (benoit.guillon@snv.jussieu.fr)
See Also:
to see how to protect document with this security handler.

Field Summary

static byte[]
ENCRYPT_PADDING
Standard padding for encryption.
static String
FILTER
Type of security handler.
static Class
PROTECTION_POLICY_CLASS
Protection policy class for this handler.

Fields inherited from class org.pdfbox.pdmodel.encryption.SecurityHandler

currentAccessPermission, document, encryptionKey, keyLength, rc4, version

Constructor Summary

StandardSecurityHandler()
Constructor.
StandardSecurityHandler(StandardProtectionPolicy p)
Constructor used for encryption.

Method Summary

byte[]
computeEncryptedKey(byte[] password, byte[] o, int permissions, byte[] id, int encRevision, int length)
Compute the encryption key.
byte[]
computeOwnerPassword(byte[] ownerPassword, byte[] userPassword, int encRevision, int length)
Compute the owner entry in the encryption dictionary.
byte[]
computeUserPassword(byte[] password, byte[] o, int permissions, byte[] id, int encRevision, int length)
This will compute the user password hash.
void
decryptDocument(PDDocument doc, DecryptionMaterial decryptionMaterial)
Decrypt the document.
byte[]
getUserPassword(byte[] ownerPassword, byte[] o, int encRevision, long length)
Get the user password based on the owner password.
boolean
isOwnerPassword(byte[] ownerPassword, byte[] u, byte[] o, int permissions, byte[] id, int encRevision, int length)
Check for owner password.
boolean
isUserPassword(byte[] password, byte[] u, byte[] o, int permissions, byte[] id, int encRevision, int length)
Check if a plaintext password is the user password.
void
prepareDocumentForEncryption(PDDocument doc)
Prepare document for encryption.

Methods inherited from class org.pdfbox.pdmodel.encryption.SecurityHandler

decryptDocument, decryptStream, decryptString, encryptData, getCurrentAccessPermission, getKeyLength, prepareDocumentForEncryption, proceedDecryption, setKeyLength

Field Details

ENCRYPT_PADDING

public static final byte[] ENCRYPT_PADDING
Standard padding for encryption.

FILTER

public static final String FILTER
Type of security handler.

PROTECTION_POLICY_CLASS

public static final Class PROTECTION_POLICY_CLASS
Protection policy class for this handler.

Constructor Details

StandardSecurityHandler

public StandardSecurityHandler()
Constructor.

StandardSecurityHandler

public StandardSecurityHandler(StandardProtectionPolicy p)
Constructor used for encryption.
Parameters:
p - The protection policy.

Method Details

computeEncryptedKey

public final byte[] computeEncryptedKey(byte[] password,
                                        byte[] o,
                                        int permissions,
                                        byte[] id,
                                        int encRevision,
                                        int length)
            throws CryptographyException
Compute the encryption key.
Parameters:
password - The password to compute the encrypted key.
o - The o entry of the encryption dictionary.
permissions - The permissions for the document.
id - The document id.
encRevision - The revision of the encryption algorithm.
length - The length of the encryption key.
Returns:
The encrypted key bytes.
Throws:
CryptographyException - If there is an error with encryption.

computeOwnerPassword

public final byte[] computeOwnerPassword(byte[] ownerPassword,
                                         byte[] userPassword,
                                         int encRevision,
                                         int length)
            throws CryptographyException,
                   IOException
Compute the owner entry in the encryption dictionary.
Parameters:
ownerPassword - The plaintext owner password.
userPassword - The plaintext user password.
encRevision - The revision number of the encryption algorithm.
length - The length of the encryption key.
Returns:
The o entry of the encryption dictionary.
Throws:
CryptographyException - If there is an error with encryption.

computeUserPassword

public final byte[] computeUserPassword(byte[] password,
                                        byte[] o,
                                        int permissions,
                                        byte[] id,
                                        int encRevision,
                                        int length)
            throws CryptographyException,
                   IOException
This will compute the user password hash.
Parameters:
password - The plain text password.
o - The owner password hash.
permissions - The document permissions.
id - The document id.
encRevision - The revision of the encryption.
length - The length of the encryption key.
Returns:
The user password.
Throws:
CryptographyException - If there is an error computing the user password.

decryptDocument

public void decryptDocument(PDDocument doc,
                            DecryptionMaterial decryptionMaterial)
            throws CryptographyException,
                   IOException
Decrypt the document.
Overrides:
decryptDocument in interface SecurityHandler
Parameters:
doc - The document to be decrypted.
decryptionMaterial - Information used to decrypt the document.
Throws:
CryptographyException - If there is an error with decryption.

getUserPassword

public final byte[] getUserPassword(byte[] ownerPassword,
                                    byte[] o,
                                    int encRevision,
                                    long length)
            throws CryptographyException,
                   IOException
Get the user password based on the owner password.
Parameters:
ownerPassword - The plaintext owner password.
o - The o entry of the encryption dictionary.
encRevision - The encryption revision number.
length - The key length.
Returns:
The u entry of the encryption dictionary.
Throws:
CryptographyException - If there is an error generating the user password.

isOwnerPassword

public final boolean isOwnerPassword(byte[] ownerPassword,
                                     byte[] u,
                                     byte[] o,
                                     int permissions,
                                     byte[] id,
                                     int encRevision,
                                     int length)
            throws CryptographyException,
                   IOException
Check for owner password.
Parameters:
ownerPassword - The owner password.
u - The u entry of the encryption dictionary.
o - The o entry of the encryption dictionary.
permissions - The set of permissions on the document.
id - The document id.
encRevision - The encryption algorithm revision.
length - The encryption key length.
Returns:
True If the ownerPassword param is the owner password.
Throws:
CryptographyException - If there is an error during encryption.

isUserPassword

public final boolean isUserPassword(byte[] password,
                                    byte[] u,
                                    byte[] o,
                                    int permissions,
                                    byte[] id,
                                    int encRevision,
                                    int length)
            throws CryptographyException,
                   IOException
Check if a plaintext password is the user password.
Parameters:
password - The plaintext password.
u - The u entry of the encryption dictionary.
o - The o entry of the encryption dictionary.
permissions - The permissions set in the the PDF.
id - The document id used for encryption.
encRevision - The revision of the encryption algorithm.
length - The length of the encryption key.
Returns:
true If the plaintext password is the user password.
Throws:
CryptographyException - If there is an error during encryption.

prepareDocumentForEncryption

public void prepareDocumentForEncryption(PDDocument doc)
            throws CryptographyException,
                   IOException
Prepare document for encryption.
Overrides:
prepareDocumentForEncryption in interface SecurityHandler
Parameters:
doc - The documeent to encrypt.
Throws:
CryptographyException - If there is an error with decryption.

Overview Package Class Use Tree Index Deprecated About