Apache POI - Common 5.3.0 · org.apache.poi.poifs.crypt.EncryptionInfo

Field Summary

Modifier and Type	Field and Description
private Decryptor	decryptor
public static final String	ENCRYPTION_INFO_ENTRY Document entry name for encryption info xml descriptor
private final int	encryptionFlags
private final EncryptionMode	encryptionMode
private Encryptor	encryptor
public static final BitField	flagAES A value that MUST be 1 if the protected content is an ECMA-376 document ECMA-376.
public static final BitField	flagCryptoAPI A flag that specifies whether CryptoAPI RC4 or ECMA-376 encryption ECMA-376 is used.
public static final BitField	flagDocProps A value that MUST be 0 if document properties are encrypted.
public static final BitField	flagExternal A value that MUST be 1 if extensible encryption is used.
private static final int[]	FLAGS_MASKS
private static final String[]	FLAGS_NAMES
private EncryptionHeader	header
private EncryptionVerifier	verifier
private final int	versionMajor
private final int	versionMinor

Constructor Summary

Access	Constructor and Description
public	EncryptionInfo(POIFSFileSystem fs) Opens for decryption
public	EncryptionInfo(DirectoryNode dir) Opens for decryption
public	EncryptionInfo(LittleEndianInput dis, EncryptionMode preferredEncryptionMode)
public	EncryptionInfo(EncryptionMode encryptionMode) Prepares for encryption, using the given Encryption Mode, and all other parameters as default.
public	EncryptionInfo(EncryptionMode see `EncryptionMode` for values, `EncryptionMode#cryptoAPI` is for internal use only, as its record based encryptionMode, CipherAlgorithm the cipher algorithm cipherAlgorithm, HashAlgorithm the hash algorithm hashAlgorithm, int the bit count of the key keyBits, int the size of a cipher block blockSize, ChainingMode the chaining mode chainingMode) Constructs an EncryptionInfo from scratch
public	EncryptionInfo(EncryptionInfo other)

Method Summary

Modifier and Type	Method and Description
public EncryptionInfo	copy()
private static EncryptionInfoBuilder	Returns: an encryption info builder getBuilder(EncryptionMode the encryption mode encryptionMode) Create the builder instance
public Decryptor	getDecryptor()
public int	getEncryptionFlags()
public EncryptionMode	getEncryptionMode()
public Encryptor	getEncryptor()
public Map<String, Supplier<?>>	getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.
public EncryptionHeader	getHeader()
public EncryptionVerifier	getVerifier()
public int	getVersionMajor()
public int	getVersionMinor()
public boolean	Returns: true, if Document Summary / Summary are encrypted and stored in the `EncryptedStream` stream, otherwise the Summaries aren't encrypted and located in their usual streams isDocPropsEncrypted()
public void	setDecryptor(Decryptor decryptor)
public void	setEncryptor(Encryptor encryptor)
public void	setHeader(EncryptionHeader header)
public void	setVerifier(EncryptionVerifier verifier)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

decryptor	back to summary
private Decryptor decryptor

ENCRYPTION_INFO_ENTRY	back to summary
public static final String ENCRYPTION_INFO_ENTRY Document entry name for encryption info xml descriptor

encryptionFlags	back to summary
private final int encryptionFlags

encryptionMode	back to summary
private final EncryptionMode encryptionMode

encryptor	back to summary
private Encryptor encryptor

flagAES	back to summary
public static final BitField flagAES A value that MUST be 1 if the protected content is an ECMA-376 document ECMA-376. If the fAES bit is 1, the fCryptoAPI bit MUST also be 1.

flagCryptoAPI	back to summary
public static final BitField flagCryptoAPI A flag that specifies whether CryptoAPI RC4 or ECMA-376 encryption ECMA-376 is used. It MUST be 1 unless flagExternal is 1. If flagExternal is 1, it MUST be 0.

flagDocProps	back to summary
public static final BitField flagDocProps A value that MUST be 0 if document properties are encrypted. The encryption of document properties is specified in section 2.3.5.4. Annotations @SuppressWarnings:WeakerAccess

flagExternal	back to summary
public static final BitField flagExternal A value that MUST be 1 if extensible encryption is used. If this value is 1, the value of every other field in this structure MUST be 0. Annotations @SuppressWarnings:WeakerAccess

FLAGS_MASKS	back to summary
private static final int[] FLAGS_MASKS

FLAGS_NAMES	back to summary
private static final String[] FLAGS_NAMES

header	back to summary
private EncryptionHeader header

verifier	back to summary
private EncryptionVerifier verifier

versionMajor	back to summary
private final int versionMajor

versionMinor	back to summary
private final int versionMinor

Constructor Detail

EncryptionInfo	back to summary
public EncryptionInfo(POIFSFileSystem fs) throws IOException Opens for decryption

EncryptionInfo	back to summary
public EncryptionInfo(DirectoryNode dir) throws IOException Opens for decryption

EncryptionInfo	back to summary
public EncryptionInfo(LittleEndianInput dis, EncryptionMode preferredEncryptionMode) throws IOException

EncryptionInfo back to summary

EncryptionInfo	back to summary
public EncryptionInfo(EncryptionMode encryptionMode) Prepares for encryption, using the given Encryption Mode, and all other parameters as default. See Also `EncryptionInfo(EncryptionMode, CipherAlgorithm, HashAlgorithm, int, int, ChainingMode)`

public EncryptionInfo(EncryptionMode encryptionMode)

Prepares for encryption, using the given Encryption Mode, and all other parameters as default.

See Also: EncryptionInfo(EncryptionMode, CipherAlgorithm, HashAlgorithm, int, int, ChainingMode)

EncryptionInfo back to summary

EncryptionInfo	back to summary
public EncryptionInfo(EncryptionMode encryptionMode, CipherAlgorithm cipherAlgorithm, HashAlgorithm hashAlgorithm, int keyBits, int blockSize, ChainingMode chainingMode) Constructs an EncryptionInfo from scratch Parameters encryptionMode:EncryptionMode see `EncryptionMode` for values, `EncryptionMode#cryptoAPI` is for internal use only, as its record based cipherAlgorithm:CipherAlgorithm the cipher algorithm hashAlgorithm:HashAlgorithm the hash algorithm keyBits:int the bit count of the key blockSize:int the size of a cipher block chainingMode:ChainingMode the chaining mode Exceptions EncryptedDocumentException: if the given parameters mismatch, e.g. only certain combinations of keyBits, blockSize are allowed for a given `CipherAlgorithm`

public EncryptionInfo(EncryptionMode encryptionMode, CipherAlgorithm cipherAlgorithm, HashAlgorithm hashAlgorithm, int keyBits, int blockSize, ChainingMode chainingMode)

Constructs an EncryptionInfo from scratch

Parameters

encryptionMode:EncryptionMode: see EncryptionMode for values, EncryptionMode#cryptoAPI is for internal use only, as its record based
cipherAlgorithm:CipherAlgorithm: the cipher algorithm
hashAlgorithm:HashAlgorithm: the hash algorithm
keyBits:int: the bit count of the key
blockSize:int: the size of a cipher block
chainingMode:ChainingMode: the chaining mode

Exceptions

EncryptedDocumentException:: if the given parameters mismatch, e.g. only certain combinations of keyBits, blockSize are allowed for a given CipherAlgorithm

EncryptionInfo	back to summary
public EncryptionInfo(EncryptionInfo other)

Method Detail

copy	back to summary
public EncryptionInfo copy()

getBuilder	back to summary
private static EncryptionInfoBuilder getBuilder(EncryptionMode encryptionMode) Create the builder instance Parameters encryptionMode:EncryptionMode the encryption mode Returns:EncryptionInfoBuilder an encryption info builder

getBuilder

back to summary

private static EncryptionInfoBuilder getBuilder(EncryptionMode encryptionMode)

Create the builder instance

Parameters

encryptionMode:EncryptionMode: the encryption mode

Returns:EncryptionInfoBuilder

an encryption info builder

getDecryptor	back to summary
public Decryptor getDecryptor()

getEncryptionFlags	back to summary
public int getEncryptionFlags()

getEncryptionMode	back to summary
public EncryptionMode getEncryptionMode()

getEncryptor	back to summary
public Encryptor getEncryptor()

getGenericProperties	back to summary
public Map<String, Supplier<?>> getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties. Annotations @Override

getGenericProperties

back to summary

public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations

@Override

getHeader	back to summary
public EncryptionHeader getHeader()

getVerifier	back to summary
public EncryptionVerifier getVerifier()

getVersionMajor	back to summary
public int getVersionMajor()

getVersionMinor	back to summary
public int getVersionMinor()

isDocPropsEncrypted	back to summary
public boolean isDocPropsEncrypted() Returns:boolean true, if Document Summary / Summary are encrypted and stored in the `EncryptedStream` stream, otherwise the Summaries aren't encrypted and located in their usual streams

setDecryptor	back to summary
public void setDecryptor(Decryptor decryptor)

setEncryptor	back to summary
public void setEncryptor(Encryptor encryptor)

setHeader	back to summary
public void setHeader(EncryptionHeader header)

setVerifier	back to summary
public void setVerifier(EncryptionVerifier verifier)