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

java.lang.Object
  extended by org.apache.poi.poifs.crypt.Decryptor
      extended by org.apache.poi.poifs.crypt.agile.AgileDecryptor

public class AgileDecryptor
extends Decryptor

Decryptor implementation for Agile Encryption


Field Summary
protected static byte[] kCryptoKeyBlock
           
protected static byte[] kHashedVerifierBlock
           
protected static byte[] kIntegrityKeyBlock
           
protected static byte[] kIntegrityValueBlock
           
protected static byte[] kVerifierInputBlock
           
 
Fields inherited from class org.apache.poi.poifs.crypt.Decryptor
DEFAULT_PASSWORD, info
 
Constructor Summary
protected AgileDecryptor(AgileEncryptionInfoBuilder builder)
           
 
Method Summary
protected  int getBlockSizeInBytes()
           
 java.io.InputStream getDataStream(DirectoryNode dir)
          Return a stream with decrypted data.
protected  int getKeySizeInBytes()
           
 long getLength()
          Returns the length of the encytpted data that can be safely read with Decryptor.getDataStream(org.apache.poi.poifs.filesystem.DirectoryNode).
protected static int getNextBlockSize(int inputLen, int blockSize)
           
protected static byte[] hashInput(AgileEncryptionInfoBuilder builder, byte[] pwHash, byte[] blockKey, byte[] inputKey, int cipherMode)
           
 boolean verifyPassword(java.security.KeyPair keyPair, java.security.cert.X509Certificate x509)
          instead of a password, it's also possible to decrypt via certificate.
 boolean verifyPassword(java.lang.String password)
          set decryption password
 
Methods inherited from class org.apache.poi.poifs.crypt.Decryptor
getDataStream, getDataStream, getInstance, getIntegrityHmacKey, getIntegrityHmacValue, getSecretKey, getVerifier, setIntegrityHmacKey, setIntegrityHmacValue, setSecretKey, setVerifier
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

kVerifierInputBlock

protected static final byte[] kVerifierInputBlock

kHashedVerifierBlock

protected static final byte[] kHashedVerifierBlock

kCryptoKeyBlock

protected static final byte[] kCryptoKeyBlock

kIntegrityKeyBlock

protected static final byte[] kIntegrityKeyBlock

kIntegrityValueBlock

protected static final byte[] kIntegrityValueBlock
Constructor Detail

AgileDecryptor

protected AgileDecryptor(AgileEncryptionInfoBuilder builder)
Method Detail

verifyPassword

public boolean verifyPassword(java.lang.String password)
                       throws java.security.GeneralSecurityException
set decryption password

Specified by:
verifyPassword in class Decryptor
Throws:
java.security.GeneralSecurityException

verifyPassword

public boolean verifyPassword(java.security.KeyPair keyPair,
                              java.security.cert.X509Certificate x509)
                       throws java.security.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:
java.security.GeneralSecurityException
See Also:
Agile encryption with certificates

getNextBlockSize

protected static int getNextBlockSize(int inputLen,
                                      int blockSize)

hashInput

protected static byte[] hashInput(AgileEncryptionInfoBuilder builder,
                                  byte[] pwHash,
                                  byte[] blockKey,
                                  byte[] inputKey,
                                  int cipherMode)

getDataStream

public java.io.InputStream getDataStream(DirectoryNode dir)
                                  throws java.io.IOException,
                                         java.security.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:
java.io.IOException
java.security.GeneralSecurityException

getLength

public long getLength()
Description copied from class: Decryptor
Returns the length of the encytpted 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

getBlockSizeInBytes

protected int getBlockSizeInBytes()

getKeySizeInBytes

protected int getKeySizeInBytes()


Copyright 2014 The Apache Software Foundation or its licensors, as applicable.