Package org.docx4j.org.apache.poi.poifs.crypt

Class EncryptionHeader

java.lang.Object
org.docx4j.org.apache.poi.poifs.crypt.EncryptionHeader
All Implemented Interfaces:
Duplicatable, GenericRecord
Direct Known Subclasses:
AgileEncryptionHeader, BinaryRC4EncryptionHeader, StandardEncryptionHeader, XOREncryptionHeader
public abstract class EncryptionHeader extends Object implements GenericRecord, Duplicatable
Reads and processes OOXML Encryption Headers The constants are largely based on ZIP constants.

  • Constructor Details

    • EncryptionHeader

      protected EncryptionHeader()

    • EncryptionHeader

      protected EncryptionHeader(EncryptionHeader other)

  • Method Details

    • getChainingMode

      public ChainingMode getChainingMode()

    • setChainingMode

      protected void setChainingMode(ChainingMode chainingMode)

    • getFlags

      public int getFlags()

    • setFlags

      public void setFlags(int flags)

    • getSizeExtra

      public int getSizeExtra()

    • setSizeExtra

      public void setSizeExtra(int sizeExtra)

    • getCipherAlgorithm

      public CipherAlgorithm getCipherAlgorithm()

    • setCipherAlgorithm

      public void setCipherAlgorithm(CipherAlgorithm cipherAlgorithm)

    • getHashAlgorithm

      public HashAlgorithm getHashAlgorithm()

    • setHashAlgorithm

      public void setHashAlgorithm(HashAlgorithm hashAlgorithm)

    • getKeySize

      public int getKeySize()

    • setKeySize

      public void setKeySize(int keyBits)
      Sets the keySize (in bits). Before calling this method, make sure to set the cipherAlgorithm, as the amount of keyBits gets validated against the list of allowed keyBits of the corresponding cipherAlgorithm

    • getBlockSize

      public int getBlockSize()

    • setBlockSize

      public void setBlockSize(int blockSize)

    • getKeySalt

      public byte[] getKeySalt()

    • setKeySalt

      public void setKeySalt(byte[] salt)

    • getCipherProvider

      public CipherProvider getCipherProvider()

    • setCipherProvider

      public void setCipherProvider(CipherProvider providerType)

    • getCspName

      public String getCspName()

    • setCspName

      public void setCspName(String cspName)

    • copy

      public abstract EncryptionHeader copy()
      Specified by:
      copy in interface Duplicatable
      Returns:
      a deep copy of the implementing class / instance

    • getGenericProperties

      public Map<String,Supplier<?>> getGenericProperties()
      Specified by:
      getGenericProperties in interface GenericRecord