Modifier and Type	Class and Description
private class	BinaryRC4Decryptor.BinaryRC4CipherInputStream

Modifier and Type	Field and Description
private int	chunkSize
private long	length

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

Method Summary

Modifier and Type	Method and Description
public BinaryRC4Decryptor	copy() Implements abstract org.apache.poi.poifs.crypt.Decryptor.copy.
protected static SecretKey	generateSecretKey(String password, EncryptionVerifier ver)
public ChunkedCipherInputStream	getDataStream(DirectoryNode the node to read from dir) Implements abstract org.apache.poi.poifs.crypt.Decryptor.getDataStream. Return a stream with decrypted data.
public InputStream	getDataStream(InputStream the stream to be wrapped stream, int size, int initial/current byte position within the stream initialPos) Overrides org.apache.poi.poifs.crypt.Decryptor.getDataStream. 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 long	getLength() Implements abstract org.apache.poi.poifs.crypt.Decryptor.getLength. Returns the length of the encrypted data that can be safely read with `getDataStream(org.apache.poi.poifs.filesystem.DirectoryNode)`.
public 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) Overrides org.apache.poi.poifs.crypt.Decryptor.initCipherForBlock. 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)
public void	setChunkSize(int the chunk size, i.e. the block size with the same encryption key chunkSize) Overrides org.apache.poi.poifs.crypt.Decryptor.setChunkSize. Sets the chunk size of the data stream.
public boolean	verifyPassword(String password) Implements abstract org.apache.poi.poifs.crypt.Decryptor.verifyPassword.

Inherited from org.apache.poi.poifs.crypt.Decryptor:: getBlockSizeInBytes getDataStream getEncryptionInfo getGenericProperties getInstance getIntegrityHmacKey getIntegrityHmacValue getKeySizeInBytes getSecretKey getVerifier setEncryptionInfo setIntegrityHmacKey setIntegrityHmacValue setSecretKey setVerifier

Field Detail

chunkSize	back to summary
private int chunkSize

length	back to summary
private long length

Constructor Detail

BinaryRC4Decryptor	back to summary
protected BinaryRC4Decryptor()

BinaryRC4Decryptor	back to summary
protected BinaryRC4Decryptor(BinaryRC4Decryptor other)

Method Detail

copy	back to summary
public BinaryRC4Decryptor copy() Implements abstract org.apache.poi.poifs.crypt.Decryptor.copy. Annotations @Override

copy

back to summary

public BinaryRC4Decryptor copy()

Implements abstract org.apache.poi.poifs.crypt.Decryptor.copy.

Annotations

@Override

generateSecretKey	back to summary
protected static SecretKey generateSecretKey(String password, EncryptionVerifier ver)

getDataStream back to summary

getDataStream	back to summary
public ChunkedCipherInputStream getDataStream(DirectoryNode dir) throws IOException, GeneralSecurityException Implements abstract org.apache.poi.poifs.crypt.Decryptor.getDataStream. Doc from org.apache.poi.poifs.crypt.Decryptor.getDataStream. 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:ChunkedCipherInputStream decrypted stream Annotations @Override @SuppressWarnings:java:S2095, resource

public ChunkedCipherInputStream getDataStream(DirectoryNode dir) throws IOException, GeneralSecurityException

Implements abstract org.apache.poi.poifs.crypt.Decryptor.getDataStream.

Doc from org.apache.poi.poifs.crypt.Decryptor.getDataStream.

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:ChunkedCipherInputStream

decrypted stream

Annotations

@Override
@SuppressWarnings:java:S2095, resource

getDataStream	back to summary
public InputStream getDataStream(InputStream stream, int size, int initialPos) throws IOException, GeneralSecurityException Overrides org.apache.poi.poifs.crypt.Decryptor.getDataStream. Doc from org.apache.poi.poifs.crypt.Decryptor.getDataStream. 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 Annotations @Override

getDataStream

back to summary

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

Overrides org.apache.poi.poifs.crypt.Decryptor.getDataStream.

Doc from org.apache.poi.poifs.crypt.Decryptor.getDataStream.

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

Annotations

@Override

getLength back to summary

getLength	back to summary
public long getLength() Implements abstract org.apache.poi.poifs.crypt.Decryptor.getLength. Doc from org.apache.poi.poifs.crypt.Decryptor.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 Annotations @Override

public long getLength()

Implements abstract org.apache.poi.poifs.crypt.Decryptor.getLength.

Doc from org.apache.poi.poifs.crypt.Decryptor.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

Annotations

@Override

initCipherForBlock	back to summary
public Cipher initCipherForBlock(Cipher cipher, int block) throws GeneralSecurityException Overrides org.apache.poi.poifs.crypt.Decryptor.initCipherForBlock. Doc from org.apache.poi.poifs.crypt.Decryptor.initCipherForBlock. 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 Annotations @Override Exceptions GeneralSecurityException: if the cipher can't be initialized

initCipherForBlock

back to summary

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

Overrides org.apache.poi.poifs.crypt.Decryptor.initCipherForBlock.

Doc from org.apache.poi.poifs.crypt.Decryptor.initCipherForBlock.

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

Annotations

@Override

Exceptions

GeneralSecurityException:: if the cipher can't be initialized

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

setChunkSize	back to summary
public void setChunkSize(int chunkSize) Overrides org.apache.poi.poifs.crypt.Decryptor.setChunkSize. Doc from org.apache.poi.poifs.crypt.Decryptor.setChunkSize. 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 Annotations @Override

setChunkSize

back to summary

public void setChunkSize(int chunkSize)

Overrides org.apache.poi.poifs.crypt.Decryptor.setChunkSize.

Doc from org.apache.poi.poifs.crypt.Decryptor.setChunkSize.

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

Annotations

@Override

verifyPassword	back to summary
public boolean verifyPassword(String password) Implements abstract org.apache.poi.poifs.crypt.Decryptor.verifyPassword. Annotations @Override

verifyPassword

back to summary

public boolean verifyPassword(String password)

Implements abstract org.apache.poi.poifs.crypt.Decryptor.verifyPassword.

Annotations

@Override

org.apache.poi.poifs.crypt.binaryrc4 back to summary

private Class BinaryRC4Decryptor.BinaryRC4CipherInputStream

Class Inheritance

extends ChunkedCipherInputStream

java.lang.Object
java.io.InputStream
java.io.FilterInputStream
org.apache.poi.util.LittleEndianInputStream
org.apache.poi.poifs.crypt.ChunkedCipherInputStream
org.apache.poi.poifs.crypt.binaryrc4.BinaryRC4Decryptor.BinaryRC4CipherInputStream

Constructor Summary

Access	Constructor and Description
public	BinaryRC4CipherInputStream(DocumentInputStream stream, long size)
public	BinaryRC4CipherInputStream(InputStream stream, int size, int initialPos)

Method Summary

Modifier and Type	Method and Description
protected Cipher	initCipherForBlock(Cipher existing, int block) Implements abstract org.apache.poi.poifs.crypt.ChunkedCipherInputStream.initCipherForBlock.

Inherited from org.apache.poi.poifs.crypt.ChunkedCipherInputStream:: available getChunk getChunkMask getPlain getPos initCipherForBlock invokeCipher mark markSupported read read readPlain reset setNextRecordSize skip

Constructor Detail

BinaryRC4CipherInputStream	back to summary
public BinaryRC4CipherInputStream(DocumentInputStream stream, long size) throws GeneralSecurityException

BinaryRC4CipherInputStream	back to summary
public BinaryRC4CipherInputStream(InputStream stream, int size, int initialPos) throws GeneralSecurityException

Method Detail

initCipherForBlock	back to summary
protected Cipher initCipherForBlock(Cipher existing, int block) throws GeneralSecurityException Implements abstract org.apache.poi.poifs.crypt.ChunkedCipherInputStream.initCipherForBlock. Annotations @Override

initCipherForBlock

back to summary

protected Cipher initCipherForBlock(Cipher existing, int block) throws GeneralSecurityException

Implements abstract org.apache.poi.poifs.crypt.ChunkedCipherInputStream.initCipherForBlock.

Annotations

@Override

public Class BinaryRC4Decryptor

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class BinaryRC4Decryptor.BinaryRC4CipherInputStream

Constructor Summary

Method Summary

Constructor Detail

Method Detail