Class PdfEncryption

java.lang.Object
com.aowagie.text.pdf.PdfEncryption

class PdfEncryption extends Object
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private static final int
     
    static final int
     
    private final ARCFOUREncryption
     
    private int
     
    private byte[]
     
    private boolean
    Indicates if the encryption is only necessary for embedded files.
    private boolean
     
    private final byte[]
    Work area to prepare the object/generation bytes
    private byte[]
    The encryption key for a particular object/generation
    private int
    The generic key length.
    private int
    The encryption key length for a particular object/generation
    The message digest algorithm MD5
    private static final byte[]
     
    private byte[]
    The global encryption key
    (package private) byte[]
     
    private byte[]
    The encryption key for the owner
    private static final byte[]
     
    (package private) int
     
    (package private) byte[]
     
    The public key security handler for certificate encryption
    private int
     
    private static final byte[]
     
    private static long
     
    private static final int
     
    private static final int
     
    (package private) byte[]
     
    (package private) byte[]
    The encryption key for the user
  • Constructor Summary

    Constructors
    Constructor
    Description
     
     
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addRecipient(Certificate cert, int permission)
     
    (package private) int
     
    (package private) void
    computeOAndOeAlg9(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.8
    private byte[]
    computeOwnerKey(byte[] userPad, byte[] ownerPad)
     
    (package private) void
    computePermsAlg10(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) void
    computeUAndUeAlg8(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.7
    static byte[]
     
    static PdfObject
    createInfoId(byte[] id)
     
    boolean
    decryptAndCheckPerms(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.3
    byte[]
    decryptByteArray(byte[] b)
     
    (package private) byte[]
    encryptByteArray(byte[] b)
     
    int
     
     
     
     
     
    (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.4
    boolean
    Indicates if only the embedded files have to be encrypted.
    boolean
     
    private byte[]
    padPassword(byte[] userPassword)
     
    void
    setCryptoMode(int mode, int kl)
     
    void
    setHashKey(int number, int generation)
     
    void
    setupAllKeys(byte[] userPassword, byte[] ownerPassword, int permissions)
     
    void
    setupByEncryptionKey(byte[] key, int keylength)
     
    private void
    setupByOwnerPad(byte[] documentID, byte[] ownerPad, byte[] userKey, byte[] ownerKey, int permissions)
     
    void
    setupByOwnerPassword(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.3
    void
    setupByOwnerPassword(byte[] documentID, byte[] ownerPassword, byte[] userKey, byte[] ownerKey, int permissions)
     
    private void
    setupByUserPad(byte[] documentID, byte[] userPad, byte[] ownerKey, int permissions)
     
    void
    setupByUserPassword(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.3
    void
    setupByUserPassword(byte[] documentID, byte[] userPassword, byte[] ownerKey, int permissions)
     
    private void
    setupGlobalEncryptionKey(byte[] documentID, byte[] userPad, byte[] ownerKey, int permissions)
    ownerKey, documentID must be setup
    private void
    mkey must be setup

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • STANDARD_ENCRYPTION_40

      private static final int STANDARD_ENCRYPTION_40
      See Also:
    • STANDARD_ENCRYPTION_128

      private static final int STANDARD_ENCRYPTION_128
      See Also:
    • AES_256_V3

      public static final int AES_256_V3
      See Also:
    • AES_128

      private static final int AES_128
      See Also:
    • 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 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 Details

    • PdfEncryption

      public PdfEncryption()
    • PdfEncryption

      public PdfEncryption(PdfEncryption enc)
  • Method Details

    • 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 GeneralSecurityException
      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.3
      Throws:
      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 GeneralSecurityException
      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.3
      Throws:
      GeneralSecurityException
    • setupByOwnerPad

      private void setupByOwnerPad(byte[] documentID, byte[] ownerPad, byte[] userKey, byte[] ownerKey, int permissions)
    • decryptAndCheckPerms

      public boolean decryptAndCheckPerms(byte[] permsValue) throws GeneralSecurityException
      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.3
      Throws:
      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(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(Certificate cert, int permission)
    • computeUAndUeAlg8

      void computeUAndUeAlg8(byte[] userPassword) throws GeneralSecurityException
      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.7
      Throws:
      GeneralSecurityException
    • computeOAndOeAlg9

      void computeOAndOeAlg9(byte[] ownerPassword) throws GeneralSecurityException
      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.8
      Throws:
      GeneralSecurityException
    • computePermsAlg10

      void computePermsAlg10(int permissions) throws GeneralSecurityException
      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
      Throws:
      GeneralSecurityException
    • hashAlg2B

      static byte[] hashAlg2B(byte[] input, byte[] salt, byte[] userKey) throws GeneralSecurityException
      implements Algorithm 2.B: Computing a hash (revision 6 and later) - ISO 32000-2 section 7.6.4.3.4
      Throws:
      GeneralSecurityException