org.apache.poi.poifs.crypt.agile

Class AgileDecryptor

java.lang.Object

org.apache.poi.poifs.crypt.Decryptor

org.apache.poi.poifs.crypt.agile.AgileDecryptor

All Implemented Interfaces:

Cloneable

public class AgileDecryptor
extends Decryptor
implements Cloneable

Decryptor implementation for Agile Encryption

Field Summary

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

DEFAULT_PASSWORD, DEFAULT_POIFS_ENTRY

Method Summary

Modifier and Type	Method and Description
AgileDecryptor	clone()
InputStream	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).
boolean	verifyPassword(KeyPair keyPair, X509Certificate x509) instead of a password, it's also possible to decrypt via certificate.
boolean	verifyPassword(String password) set decryption password

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

getDataStream, getDataStream, getEncryptionInfo, getInstance, getIntegrityHmacKey, getIntegrityHmacValue, getSecretKey, getVerifier, initCipherForBlock, setChunkSize, setEncryptionInfo

Methods inherited from class java.lang.Object

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

Method Detail

verifyPassword

public boolean verifyPassword(String password)
                       throws GeneralSecurityException

set decryption password

Specified by:

verifyPassword in class Decryptor

Throws:

GeneralSecurityException

verifyPassword

public boolean verifyPassword(KeyPair keyPair,
                              X509Certificate x509)
                       throws GeneralSecurityException

instead of a password, it's also possible to decrypt via certificate. Warning: this code is experimental and hasn't been validated

Parameters:

keyPair -

x509 -

Returns:

true, when the data can be successfully decrypted with the given private key

Throws:

GeneralSecurityException

See Also:

Agile encryption with certificates

getDataStream

public InputStream 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

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

clone

public AgileDecryptor clone()
                     throws CloneNotSupportedException

Overrides:

clone in class Decryptor

Throws:

CloneNotSupportedException