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

Class Decryptor

java.lang.Object

org.docx4j.org.apache.poi.poifs.crypt.Decryptor

Direct Known Subclasses:

AgileDecryptor, BinaryRC4Decryptor, CryptoAPIDecryptor, StandardDecryptor

public abstract class Decryptor
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final EncryptionInfoBuilder	builder
static final String	DEFAULT_PASSWORD
static final String	DEFAULT_POIFS_ENTRY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Decryptor(EncryptionInfoBuilder builder)

Method Summary

Modifier and Type	Method	Description
protected int	getBlockSizeInBytes()
abstract InputStream	getDataStream(DirectoryNode dir)	Return a stream with decrypted data.
InputStream	getDataStream(NPOIFSFileSystem fs)
InputStream	getDataStream(OPOIFSFileSystem fs)
InputStream	getDataStream(POIFSFileSystem fs)
static Decryptor	getInstance(EncryptionInfo info)
byte[]	getIntegrityHmacKey()
byte[]	getIntegrityHmacValue()
protected int	getKeySizeInBytes()
abstract long	getLength()	Returns the length of the encrypted data that can be safely read with getDataStream(org.docx4j.org.apache.poi.poifs.filesystem.DirectoryNode).
SecretKey	getSecretKey()
byte[]	getVerifier()
protected void	setIntegrityHmacKey(byte[] integrityHmacKey)
protected void	setIntegrityHmacValue(byte[] integrityHmacValue)
protected void	setSecretKey(SecretKey secretKey)
protected void	setVerifier(byte[] verifier)
abstract boolean	verifyPassword(String password)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_PASSWORD

public static final String DEFAULT_PASSWORD

See Also:

• Constant Field Values

DEFAULT_POIFS_ENTRY

public static final String DEFAULT_POIFS_ENTRY

See Also:

• Constant Field Values

builder

protected final EncryptionInfoBuilder builder

Constructor Details

Decryptor

protected Decryptor(EncryptionInfoBuilder builder)

Method Details

getDataStream

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 - the node to read from

Returns:

decrypted stream

Throws:

IOException

GeneralSecurityException

verifyPassword

public abstract boolean verifyPassword(String password)
                                throws GeneralSecurityException

Throws:

GeneralSecurityException

getLength

public abstract long getLength()

Returns the length of the encrypted data that can be safely read with getDataStream(org.docx4j.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.docx4j.org.apache.poi.poifs.filesystem.DirectoryNode), an attempt to call getLength() prior to getDataStream() will result in IllegalStateException.

Returns:

length of the encrypted data

Throws:

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

getInstance

public static Decryptor getInstance(EncryptionInfo info)

getDataStream

public InputStream getDataStream(NPOIFSFileSystem fs)
                          throws IOException,
GeneralSecurityException

Throws:

IOException

GeneralSecurityException

getDataStream

public InputStream getDataStream(OPOIFSFileSystem fs)
                          throws IOException,
GeneralSecurityException

Throws:

IOException

GeneralSecurityException

getDataStream

public InputStream getDataStream(POIFSFileSystem fs)
                          throws IOException,
GeneralSecurityException

Throws:

IOException

GeneralSecurityException

getVerifier

public byte[] getVerifier()

getSecretKey

public SecretKey getSecretKey()

getIntegrityHmacKey

public byte[] getIntegrityHmacKey()

getIntegrityHmacValue

public byte[] getIntegrityHmacValue()

setSecretKey

protected void setSecretKey(SecretKey secretKey)

setVerifier

protected void setVerifier(byte[] verifier)

setIntegrityHmacKey

protected void setIntegrityHmacKey(byte[] integrityHmacKey)

setIntegrityHmacValue

protected void setIntegrityHmacValue(byte[] integrityHmacValue)

getBlockSizeInBytes

protected int getBlockSizeInBytes()

getKeySizeInBytes

protected int getKeySizeInBytes()