Package com.aowagie.text.pdf
Class PdfEncryption
- java.lang.Object
-
- com.aowagie.text.pdf.PdfEncryption
-
class PdfEncryption extends java.lang.Object
-
-
Field Summary
Fields Modifier and Type Field Description private static intAES_128static intAES_256_V3private ARCFOUREncryptionarcfourprivate intcryptoModeprivate byte[]documentIDprivate booleanembeddedFilesOnlyIndicates if the encryption is only necessary for embedded files.private booleanencryptMetadataprivate byte[]extraWork area to prepare the object/generation bytesprivate byte[]keyThe encryption key for a particular object/generationprivate intkeyLengthThe generic key length.private intkeySizeThe encryption key length for a particular object/generationprivate java.security.MessageDigestmd5The message digest algorithm MD5private static byte[]metadataPadprivate byte[]mkeyThe global encryption key(package private) byte[]oeKeyprivate byte[]ownerKeyThe encryption key for the ownerprivate static byte[]pad(package private) intpermissions(package private) byte[]permsprivate PdfPublicKeySecurityHandlerpublicKeyHandlerThe public key security handler for certificate encryptionprivate intrevisionprivate static byte[]saltprivate static longseqprivate static intSTANDARD_ENCRYPTION_128private static intSTANDARD_ENCRYPTION_40(package private) byte[]ueKey(package private) byte[]userKeyThe encryption key for the user
-
Constructor Summary
Constructors Constructor Description PdfEncryption()PdfEncryption(PdfEncryption enc)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddRecipient(java.security.cert.Certificate cert, int permission)(package private) intcalculateStreamSize(int n)(package private) voidcomputeOAndOeAlg9(byte[] ownerPassword)implements Algorithm 9: Computing the encryption dictionary’s O (owner password) and OE (owner encryption) values (Security handlers of revision 6) - ISO 32000-2 section 7.6.4.4.8private byte[]computeOwnerKey(byte[] userPad, byte[] ownerPad)(package private) voidcomputePermsAlg10(int permissions)implements Algorithm 10: Computing the encryption dictionary’s Perms (permissions) value (Security handlers of revision 6) - ISO 32000-2 section 7.6.4.4.9(package private) voidcomputeUAndUeAlg8(byte[] userPassword)implements Algorithm 8: Computing the encryption dictionary’s U (user password) and UE (user encryption) values (Security handlers of revision 6) - ISO 32000-2 section 7.6.4.4.7static byte[]createDocumentId()static PdfObjectcreateInfoId(byte[] id)booleandecryptAndCheckPerms(byte[] permsValue)implements step f of Algorithm 2.A: Retrieving the file encryption key from an encrypted document in order to decrypt it (revision 6 and later) - ISO 32000-2 section 7.6.4.3.3byte[]decryptByteArray(byte[] b)(package private) byte[]encryptByteArray(byte[] b)intgetCryptoMode()StandardDecryptiongetDecryptor()PdfDictionarygetEncryptionDictionary()OutputStreamEncryptiongetEncryptionStream(java.io.OutputStream os)PdfObjectgetFileID()(package private) static byte[]hashAlg2B(byte[] input, byte[] salt, byte[] userKey)implements Algorithm 2.B: Computing a hash (revision 6 and later) - ISO 32000-2 section 7.6.4.3.4booleanisEmbeddedFilesOnly()Indicates if only the embedded files have to be encrypted.booleanisMetadataEncrypted()private byte[]padPassword(byte[] userPassword)voidsetCryptoMode(int mode, int kl)voidsetHashKey(int number, int generation)voidsetupAllKeys(byte[] userPassword, byte[] ownerPassword, int permissions)voidsetupByEncryptionKey(byte[] key, int keylength)private voidsetupByOwnerPad(byte[] documentID, byte[] ownerPad, byte[] userKey, byte[] ownerKey, int permissions)voidsetupByOwnerPassword(byte[] documentID, byte[] ownerPassword, byte[] uValue, byte[] ueValue, byte[] oValue, byte[] oeValue, int permissions)implements step d of Algorithm 2.A: Retrieving the file encryption key from an encrypted document in order to decrypt it (revision 6 and later) - ISO 32000-2 section 7.6.4.3.3voidsetupByOwnerPassword(byte[] documentID, byte[] ownerPassword, byte[] userKey, byte[] ownerKey, int permissions)private voidsetupByUserPad(byte[] documentID, byte[] userPad, byte[] ownerKey, int permissions)voidsetupByUserPassword(byte[] documentID, byte[] userPassword, byte[] uValue, byte[] ueValue, byte[] oValue, byte[] oeValue, int permissions)implements step e of Algorithm 2.A: Retrieving the file encryption key from an encrypted document in order to decrypt it (revision 6 and later) - ISO 32000-2 section 7.6.4.3.3voidsetupByUserPassword(byte[] documentID, byte[] userPassword, byte[] ownerKey, int permissions)private voidsetupGlobalEncryptionKey(byte[] documentID, byte[] userPad, byte[] ownerKey, int permissions)ownerKey, documentID must be setupprivate voidsetupUserKey()mkey must be setup
-
-
-
Field Detail
-
STANDARD_ENCRYPTION_40
private static final int STANDARD_ENCRYPTION_40
- See Also:
- Constant Field Values
-
STANDARD_ENCRYPTION_128
private static final int STANDARD_ENCRYPTION_128
- See Also:
- Constant Field Values
-
AES_256_V3
public static final int AES_256_V3
- See Also:
- Constant Field Values
-
AES_128
private static final int AES_128
- See Also:
- Constant Field Values
-
pad
private static final byte[] pad
-
salt
private static final byte[] salt
-
metadataPad
private static final byte[] metadataPad
-
key
private byte[] key
The encryption key for a particular object/generation
-
keySize
private int keySize
The encryption key length for a particular object/generation
-
mkey
private byte[] mkey
The global encryption key
-
extra
private final byte[] extra
Work area to prepare the object/generation bytes
-
md5
private java.security.MessageDigest md5
The message digest algorithm MD5
-
ownerKey
private byte[] ownerKey
The encryption key for the owner
-
userKey
byte[] userKey
The encryption key for the user
-
publicKeyHandler
private PdfPublicKeySecurityHandler publicKeyHandler
The public key security handler for certificate encryption
-
permissions
int permissions
-
documentID
private byte[] documentID
-
seq
private static long seq
-
revision
private int revision
-
arcfour
private final ARCFOUREncryption arcfour
-
keyLength
private int keyLength
The generic key length. It may be 40 or 128.
-
oeKey
byte[] oeKey
-
ueKey
byte[] ueKey
-
perms
byte[] perms
-
encryptMetadata
private boolean encryptMetadata
-
embeddedFilesOnly
private boolean embeddedFilesOnly
Indicates if the encryption is only necessary for embedded files.- Since:
- 2.1.3
-
cryptoMode
private int cryptoMode
-
-
Constructor Detail
-
PdfEncryption
public PdfEncryption()
-
PdfEncryption
public PdfEncryption(PdfEncryption enc)
-
-
Method Detail
-
setCryptoMode
public void setCryptoMode(int mode, int kl)
-
getCryptoMode
public int getCryptoMode()
-
isMetadataEncrypted
public boolean isMetadataEncrypted()
-
isEmbeddedFilesOnly
public boolean isEmbeddedFilesOnly()
Indicates if only the embedded files have to be encrypted.- Returns:
- if true only the embedded files will be encrypted
- Since:
- 2.1.3
-
padPassword
private byte[] padPassword(byte[] userPassword)
-
computeOwnerKey
private byte[] computeOwnerKey(byte[] userPad, byte[] ownerPad)
-
setupGlobalEncryptionKey
private void setupGlobalEncryptionKey(byte[] documentID, byte[] userPad, byte[] ownerKey, int permissions)ownerKey, documentID must be setup
-
setupUserKey
private void setupUserKey()
mkey must be setup
-
setupAllKeys
public void setupAllKeys(byte[] userPassword, byte[] ownerPassword, int permissions)
-
createDocumentId
public static byte[] createDocumentId()
-
setupByUserPassword
public void setupByUserPassword(byte[] documentID, byte[] userPassword, byte[] ownerKey, int permissions)
-
setupByUserPassword
public void setupByUserPassword(byte[] documentID, byte[] userPassword, byte[] uValue, byte[] ueValue, byte[] oValue, byte[] oeValue, int permissions) throws java.security.GeneralSecurityExceptionimplements step e of Algorithm 2.A: Retrieving the file encryption key from an encrypted document in order to decrypt it (revision 6 and later) - ISO 32000-2 section 7.6.4.3.3- Throws:
java.security.GeneralSecurityException
-
setupByUserPad
private void setupByUserPad(byte[] documentID, byte[] userPad, byte[] ownerKey, int permissions)
-
setupByOwnerPassword
public void setupByOwnerPassword(byte[] documentID, byte[] ownerPassword, byte[] userKey, byte[] ownerKey, int permissions)
-
setupByOwnerPassword
public void setupByOwnerPassword(byte[] documentID, byte[] ownerPassword, byte[] uValue, byte[] ueValue, byte[] oValue, byte[] oeValue, int permissions) throws java.security.GeneralSecurityExceptionimplements step d of Algorithm 2.A: Retrieving the file encryption key from an encrypted document in order to decrypt it (revision 6 and later) - ISO 32000-2 section 7.6.4.3.3- Throws:
java.security.GeneralSecurityException
-
setupByOwnerPad
private void setupByOwnerPad(byte[] documentID, byte[] ownerPad, byte[] userKey, byte[] ownerKey, int permissions)
-
decryptAndCheckPerms
public boolean decryptAndCheckPerms(byte[] permsValue) throws java.security.GeneralSecurityExceptionimplements step f of Algorithm 2.A: Retrieving the file encryption key from an encrypted document in order to decrypt it (revision 6 and later) - ISO 32000-2 section 7.6.4.3.3- Throws:
java.security.GeneralSecurityException
-
setupByEncryptionKey
public void setupByEncryptionKey(byte[] key, int keylength)
-
setHashKey
public void setHashKey(int number, int generation)
-
createInfoId
public static PdfObject createInfoId(byte[] id)
-
getEncryptionDictionary
public PdfDictionary getEncryptionDictionary()
-
getFileID
public PdfObject getFileID()
-
getEncryptionStream
public OutputStreamEncryption getEncryptionStream(java.io.OutputStream os)
-
calculateStreamSize
int calculateStreamSize(int n)
-
encryptByteArray
byte[] encryptByteArray(byte[] b)
-
getDecryptor
public StandardDecryption getDecryptor()
-
decryptByteArray
public byte[] decryptByteArray(byte[] b)
-
addRecipient
public void addRecipient(java.security.cert.Certificate cert, int permission)
-
computeUAndUeAlg8
void computeUAndUeAlg8(byte[] userPassword) throws java.security.GeneralSecurityExceptionimplements Algorithm 8: Computing the encryption dictionary’s U (user password) and UE (user encryption) values (Security handlers of revision 6) - ISO 32000-2 section 7.6.4.4.7- Throws:
java.security.GeneralSecurityException
-
computeOAndOeAlg9
void computeOAndOeAlg9(byte[] ownerPassword) throws java.security.GeneralSecurityExceptionimplements Algorithm 9: Computing the encryption dictionary’s O (owner password) and OE (owner encryption) values (Security handlers of revision 6) - ISO 32000-2 section 7.6.4.4.8- Throws:
java.security.GeneralSecurityException
-
computePermsAlg10
void computePermsAlg10(int permissions) throws java.security.GeneralSecurityExceptionimplements Algorithm 10: Computing the encryption dictionary’s Perms (permissions) value (Security handlers of revision 6) - ISO 32000-2 section 7.6.4.4.9- Throws:
java.security.GeneralSecurityException
-
hashAlg2B
static byte[] hashAlg2B(byte[] input, byte[] salt, byte[] userKey) throws java.security.GeneralSecurityExceptionimplements Algorithm 2.B: Computing a hash (revision 6 and later) - ISO 32000-2 section 7.6.4.3.4- Throws:
java.security.GeneralSecurityException
-
-