Top Description Fields Constructors Methods
org.apache.poi.poifs.crypt.agile

public Class AgileEncryptionVerifier

extends EncryptionVerifier
Class Inheritance
Imports
org.apache.poi.EncryptedDocumentException, org.apache.poi.poifs.crypt.ChainingMode, .CipherAlgorithm, .EncryptionVerifier, .HashAlgorithm
Used when checking if a key is valid for a document

Field Summary

Modifier and TypeField and Description
private int
blockSize

private int
keyBits

Constructor Summary

AccessConstructor and Description
public
AgileEncryptionVerifier(String descriptor)

protected
AgileEncryptionVerifier(EncryptionDocument ed)

public
AgileEncryptionVerifier(CipherAlgorithm cipherAlgorithm, HashAlgorithm hashAlgorithm, int keyBits, int blockSize, ChainingMode chainingMode)

public
AgileEncryptionVerifier(AgileEncryptionVerifier other)

Method Summary

Modifier and TypeMethod and Description
public AgileEncryptionVerifier
copy()

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

Implements org.apache.poi.common.Duplicatable.copy.

public int

Returns:

the blockSize (in bytes) of the verifier,
getBlockSize()

The blockSize (in bytes) of the verifier data.

public int

Returns:

the keysize (in bits) of the verifier.
getKeySize()

The keysize (in bits) of the verifier data.

public void
setBlockSize(int
the blockSize (in bytes)
blockSize)

Sets the blockSize (in bytes) of the verifier

public final void
setCipherAlgorithm(CipherAlgorithm cipherAlgorithm)

Overrides org.apache.poi.poifs.crypt.EncryptionVerifier.setCipherAlgorithm.

public void
setEncryptedKey(byte[] encryptedKey)

Overrides org.apache.poi.poifs.crypt.EncryptionVerifier.setEncryptedKey.

public void
setEncryptedVerifier(byte[] encryptedVerifier)

Overrides org.apache.poi.poifs.crypt.EncryptionVerifier.setEncryptedVerifier.

public void
setEncryptedVerifierHash(byte[] encryptedVerifierHash)

Overrides org.apache.poi.poifs.crypt.EncryptionVerifier.setEncryptedVerifierHash.

public void
setKeySize(int
the keysize (in bits)
keyBits)

Sets the keysize (in bits) of the verifier

public void
setSalt(byte[] salt)

Overrides org.apache.poi.poifs.crypt.EncryptionVerifier.setSalt.

Inherited from org.apache.poi.poifs.crypt.EncryptionVerifier:
getChainingModegetCipherAlgorithmgetEncryptedKeygetEncryptedVerifiergetEncryptedVerifierHashgetGenericPropertiesgetHashAlgorithmgetSaltgetSpinCountsetChainingModesetHashAlgorithmsetSpinCount

Field Detail

blockSizeback to summary
private int blockSize
keyBitsback to summary
private int keyBits

Constructor Detail

AgileEncryptionVerifierback to summary
public AgileEncryptionVerifier(String descriptor)
Annotations
@SuppressWarnings:unused
AgileEncryptionVerifierback to summary
protected AgileEncryptionVerifier(EncryptionDocument ed)
AgileEncryptionVerifierback to summary
public AgileEncryptionVerifier(CipherAlgorithm cipherAlgorithm, HashAlgorithm hashAlgorithm, int keyBits, int blockSize, ChainingMode chainingMode)
AgileEncryptionVerifierback to summary
public AgileEncryptionVerifier(AgileEncryptionVerifier other)

Method Detail

copyback to summary
public AgileEncryptionVerifier copy()

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

Implements org.apache.poi.common.Duplicatable.copy.

Returns:AgileEncryptionVerifier

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations
@Override
getBlockSizeback to summary
public int getBlockSize()

The blockSize (in bytes) of the verifier data. This usually equals the blocksize of the header.

Returns:int

the blockSize (in bytes) of the verifier,

getKeySizeback to summary
public int getKeySize()

The keysize (in bits) of the verifier data. This usually equals the keysize of the header, but only on a few exceptions, like files generated by Office for Mac, can be different.

Returns:int

the keysize (in bits) of the verifier.

setBlockSizeback to summary
public void setBlockSize(int blockSize)

Sets the blockSize (in bytes) of the verifier

Parameters
blockSize:int

the blockSize (in bytes)

setCipherAlgorithmback to summary
public final void setCipherAlgorithm(CipherAlgorithm cipherAlgorithm)

Overrides org.apache.poi.poifs.crypt.EncryptionVerifier.setCipherAlgorithm.

Annotations
@Override
setEncryptedKeyback to summary
public void setEncryptedKey(byte[] encryptedKey)

Overrides org.apache.poi.poifs.crypt.EncryptionVerifier.setEncryptedKey.

Annotations
@Override
setEncryptedVerifierback to summary
public void setEncryptedVerifier(byte[] encryptedVerifier)

Overrides org.apache.poi.poifs.crypt.EncryptionVerifier.setEncryptedVerifier.

Annotations
@Override
setEncryptedVerifierHashback to summary
public void setEncryptedVerifierHash(byte[] encryptedVerifierHash)

Overrides org.apache.poi.poifs.crypt.EncryptionVerifier.setEncryptedVerifierHash.

Annotations
@Override
setKeySizeback to summary
public void setKeySize(int keyBits)

Sets the keysize (in bits) of the verifier

Parameters
keyBits:int

the keysize (in bits)

setSaltback to summary
public void setSalt(byte[] salt)

Overrides org.apache.poi.poifs.crypt.EncryptionVerifier.setSalt.

Annotations
@Override