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

Modifier and Type	Field and Description
public static final String	DEFAULT_PASSWORD
public static final String	DEFAULT_POIFS_ENTRY
protected EncryptionInfo	encryptionInfo
private byte[]	integrityHmacKey
private byte[]	integrityHmacValue
private SecretKey	secretKey
private byte[]	verifier

Access	Constructor and Description
protected	Decryptor()
protected	Decryptor(Decryptor other)

Method Summary

Modifier and Type	Method and Description
public abstract Decryptor	copy()
protected int	getBlockSizeInBytes()
public abstract InputStream	Returns: decrypted stream getDataStream(DirectoryNode the node to read from dir) Return a stream with decrypted data.
public InputStream	Returns: decrypted stream getDataStream(InputStream the stream to be wrapped stream, int size, int initial/current byte position within the stream initialPos) Wraps a stream for decryption As we are handling streams and don't know the total length beforehand, it's the callers duty to care for the length of the entries.
public InputStream	getDataStream(POIFSFileSystem fs)
public EncryptionInfo	getEncryptionInfo()
public Map<String, Supplier<?>>	getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.
public static Decryptor	getInstance(EncryptionInfo info)
public byte[]	getIntegrityHmacKey()
public byte[]	getIntegrityHmacValue()
protected int	getKeySizeInBytes()
public abstract long	Returns: length of the encrypted data getLength() Returns the length of the encrypted data that can be safely read with `getDataStream(org.apache.poi.poifs.filesystem.DirectoryNode)`.
public SecretKey	getSecretKey()
public byte[]	getVerifier()
public Cipher	Returns: a new cipher object, if cipher was null, otherwise the reinitialized cipher initCipherForBlock(Cipher may be null, otherwise the given instance is reset to the new block index cipher, int the block index, e.g. the persist/slide id (hslf) block) Initializes a cipher object for a given block index for encryption
public void	setChunkSize(int the chunk size, i.e. the block size with the same encryption key chunkSize) Sets the chunk size of the data stream.
public void	setEncryptionInfo(EncryptionInfo encryptionInfo)
protected void	setIntegrityHmacKey(byte[] integrityHmacKey)
protected void	setIntegrityHmacValue(byte[] integrityHmacValue)
protected void	setSecretKey(SecretKey secretKey)
protected void	setVerifier(byte[] verifier)
public abstract boolean	verifyPassword(String password)

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

DEFAULT_PASSWORD	back to summary
public static final String DEFAULT_PASSWORD Annotations @SuppressWarnings:squid:S2068

DEFAULT_POIFS_ENTRY	back to summary
public static final String DEFAULT_POIFS_ENTRY

encryptionInfo	back to summary
protected EncryptionInfo encryptionInfo

integrityHmacKey	back to summary
private byte[] integrityHmacKey

integrityHmacValue	back to summary
private byte[] integrityHmacValue

secretKey	back to summary
private SecretKey secretKey

verifier	back to summary
private byte[] verifier

Decryptor	back to summary
protected Decryptor()

Decryptor	back to summary
protected Decryptor(Decryptor other)

Method Detail

copy	back to summary
public abstract Decryptor copy()

getBlockSizeInBytes	back to summary
protected int getBlockSizeInBytes() Annotations @SuppressWarnings:unused

getDataStream back to summary

getDataStream	back to summary
public abstract InputStream getDataStream(DirectoryNode dir) throws IOException, GeneralSecurityException Return a stream with decrypted data. Use `getLength()` to get the size of that data that can be safely read from the stream. Just reading to the end of the input stream is not sufficient because there are normally padding bytes that must be discarded Parameters dir:DirectoryNode the node to read from Returns:InputStream decrypted stream

public abstract InputStream getDataStream(DirectoryNode dir) throws IOException, GeneralSecurityException

Return a stream with decrypted data.

Use getLength() to get the size of that data that can be safely read from the stream. Just reading to the end of the input stream is not sufficient because there are normally padding bytes that must be discarded

Parameters

dir:DirectoryNode: the node to read from

Returns:InputStream

decrypted stream

getDataStream	back to summary
public InputStream getDataStream(InputStream stream, int size, int initialPos) throws IOException, GeneralSecurityException Wraps a stream for decryption As we are handling streams and don't know the total length beforehand, it's the callers duty to care for the length of the entries. Parameters stream:InputStream the stream to be wrapped initialPos:int initial/current byte position within the stream Returns:InputStream decrypted stream

getDataStream

back to summary

public InputStream getDataStream(InputStream stream, int size, int initialPos) throws IOException, GeneralSecurityException

Wraps a stream for decryption

As we are handling streams and don't know the total length beforehand, it's the callers duty to care for the length of the entries.

Parameters

stream:InputStream: the stream to be wrapped
initialPos:int: initial/current byte position within the stream

Returns:InputStream

decrypted stream

getDataStream	back to summary
public InputStream getDataStream(POIFSFileSystem fs) throws IOException, GeneralSecurityException

getEncryptionInfo	back to summary
public EncryptionInfo getEncryptionInfo()

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

getInstance	back to summary
public static Decryptor getInstance(EncryptionInfo info)

getIntegrityHmacKey	back to summary
public byte[] getIntegrityHmacKey()

getIntegrityHmacValue	back to summary
public byte[] getIntegrityHmacValue() Annotations @SuppressWarnings:unused

getKeySizeInBytes	back to summary
protected int getKeySizeInBytes()

getLength back to summary

getLength	back to summary
public abstract long getLength() Returns the length of the encrypted data that can be safely read with `getDataStream(org.apache.poi.poifs.filesystem.DirectoryNode)`. Just reading to the end of the input stream is not sufficient because there are normally padding bytes that must be discarded The length variable is initialized in `getDataStream(org.apache.poi.poifs.filesystem.DirectoryNode)`, an attempt to call getLength() prior to getDataStream() will result in IllegalStateException. Returns:long length of the encrypted data Exceptions IllegalStateException: if `getDataStream(org.apache.poi.poifs.filesystem.DirectoryNode)` was not called

public abstract long getLength()

Returns the length of the encrypted data that can be safely read with getDataStream(org.apache.poi.poifs.filesystem.DirectoryNode). Just reading to the end of the input stream is not sufficient because there are normally padding bytes that must be discarded

The length variable is initialized in getDataStream(org.apache.poi.poifs.filesystem.DirectoryNode), an attempt to call getLength() prior to getDataStream() will result in IllegalStateException.

Returns:long

length of the encrypted data

Exceptions

IllegalStateException:: if getDataStream(org.apache.poi.poifs.filesystem.DirectoryNode) was not called

getSecretKey	back to summary
public SecretKey getSecretKey()

getVerifier	back to summary
public byte[] getVerifier()

initCipherForBlock	back to summary
public Cipher initCipherForBlock(Cipher cipher, int block) throws GeneralSecurityException Initializes a cipher object for a given block index for encryption Parameters cipher:Cipher may be null, otherwise the given instance is reset to the new block index block:int the block index, e.g. the persist/slide id (hslf) Returns:Cipher a new cipher object, if cipher was null, otherwise the reinitialized cipher Exceptions GeneralSecurityException: if the cipher can't be initialized

initCipherForBlock

back to summary

public Cipher initCipherForBlock(Cipher cipher, int block) throws GeneralSecurityException

Initializes a cipher object for a given block index for encryption

Parameters

cipher:Cipher: may be null, otherwise the given instance is reset to the new block index
block:int: the block index, e.g. the persist/slide id (hslf)

Returns:Cipher

a new cipher object, if cipher was null, otherwise the reinitialized cipher

Exceptions

GeneralSecurityException:: if the cipher can't be initialized

setChunkSize	back to summary
public void setChunkSize(int chunkSize) Sets the chunk size of the data stream. Needs to be set before the data stream is requested. When not set, the implementation uses method specific default values Parameters chunkSize:int the chunk size, i.e. the block size with the same encryption key

setChunkSize

back to summary

public void setChunkSize(int chunkSize)

Sets the chunk size of the data stream. Needs to be set before the data stream is requested. When not set, the implementation uses method specific default values

Parameters

chunkSize:int: the chunk size, i.e. the block size with the same encryption key

setEncryptionInfo	back to summary
public void setEncryptionInfo(EncryptionInfo encryptionInfo)

setIntegrityHmacKey	back to summary
protected void setIntegrityHmacKey(byte[] integrityHmacKey)

setIntegrityHmacValue	back to summary
protected void setIntegrityHmacValue(byte[] integrityHmacValue)

setSecretKey	back to summary
protected void setSecretKey(SecretKey secretKey)

setVerifier	back to summary
protected void setVerifier(byte[] verifier)

verifyPassword	back to summary
public abstract boolean verifyPassword(String password) throws GeneralSecurityException

public abstract Class Decryptor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail