Package org.apache.poi.poifs.crypt.binaryrc4

Class BinaryRC4Decryptor

java.lang.Object

org.apache.poi.poifs.crypt.Decryptor

org.apache.poi.poifs.crypt.binaryrc4.BinaryRC4Decryptor

All Implemented Interfaces:

GenericRecord

public class BinaryRC4Decryptor
extends Decryptor

Field Summary

Fields inherited from class org.apache.poi.poifs.crypt.Decryptor

DEFAULT_PASSWORD, DEFAULT_POIFS_ENTRY, encryptionInfo

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BinaryRC4Decryptor()
protected	BinaryRC4Decryptor(BinaryRC4Decryptor other)

Method Summary

Modifier and Type	Method	Description
BinaryRC4Decryptor	copy()
protected static SecretKey	generateSecretKey(String password, EncryptionVerifier ver)
InputStream	getDataStream(InputStream stream, int size, int initialPos)	Wraps a stream for decryption
ChunkedCipherInputStream	getDataStream(DirectoryNode dir)	Return a stream with decrypted data.
long	getLength()	Returns the length of the encrypted data that can be safely read with Decryptor.getDataStream(org.apache.poi.poifs.filesystem.DirectoryNode).
Cipher	initCipherForBlock(Cipher cipher, int block)	Initializes a cipher object for a given block index for encryption
protected static Cipher	initCipherForBlock(Cipher cipher, int block, EncryptionInfo encryptionInfo, SecretKey skey, int encryptMode)
void	setChunkSize(int chunkSize)	Sets the chunk size of the data stream.
boolean	verifyPassword(String password)

Methods inherited from class org.apache.poi.poifs.crypt.Decryptor

getBlockSizeInBytes, getDataStream, getEncryptionInfo, getGenericProperties, getInstance, getIntegrityHmacKey, getIntegrityHmacValue, getKeySizeInBytes, getSecretKey, getVerifier, setEncryptionInfo, setIntegrityHmacKey, setIntegrityHmacValue, setSecretKey, setVerifier

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord

getGenericChildren, getGenericRecordType

Constructor Detail

BinaryRC4Decryptor

protected BinaryRC4Decryptor()

BinaryRC4Decryptor

protected BinaryRC4Decryptor(BinaryRC4Decryptor other)

Method Detail

verifyPassword

public boolean verifyPassword(String password)

Specified by:

verifyPassword in class Decryptor

initCipherForBlock

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

Description copied from class: Decryptor

Initializes a cipher object for a given block index for encryption

Overrides:

initCipherForBlock in class Decryptor

Parameters:

cipher - may be null, otherwise the given instance is reset to the new block index

block - the block index, e.g. the persist/slide id (hslf)

Returns:

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

Throws:

GeneralSecurityException - if the cipher can't be initialized

initCipherForBlock

protected static Cipher initCipherForBlock(Cipher cipher,
                                           int block,
                                           EncryptionInfo encryptionInfo,
                                           SecretKey skey,
                                           int encryptMode)
                                    throws GeneralSecurityException

Throws:

GeneralSecurityException

generateSecretKey

protected static SecretKey generateSecretKey(String password,
                                             EncryptionVerifier ver)

getDataStream

public ChunkedCipherInputStream getDataStream(DirectoryNode dir)
                                       throws IOException,
                                              GeneralSecurityException

Description copied from class: Decryptor

Return a stream with decrypted data.

Use Decryptor.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

Specified by:

getDataStream in class Decryptor

Parameters:

dir - the node to read from

Returns:

decrypted stream

Throws:

IOException

GeneralSecurityException

getDataStream

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

Description copied from class: Decryptor

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.

Overrides:

getDataStream in class Decryptor

Parameters:

stream - the stream to be wrapped

initialPos - initial/current byte position within the stream

Returns:

decrypted stream

Throws:

IOException

GeneralSecurityException

getLength

public long getLength()

Description copied from class: Decryptor

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

Specified by:

getLength in class Decryptor

Returns:

length of the encrypted data

setChunkSize

public void setChunkSize(int chunkSize)

Description copied from class: Decryptor

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

Overrides:

setChunkSize in class Decryptor

Parameters:

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

copy

public BinaryRC4Decryptor copy()

Specified by:

copy in class Decryptor