Apache POI - Common 5.3.0 · org.apache.poi.poifs.crypt.agile.PasswordKeyEncryptor

Field Summary

Modifier and Type	Field and Description
private Integer	blockSize An unsigned integer that specifies the number of bytes used to encrypt one block of data.
private CipherAlgorithm	cipherAlgorithm A CipherAlgorithm that specifies the cipher algorithm for a PasswordKeyEncryptor.
private ChainingMode	cipherChaining A CipherChaining that specifies the cipher chaining mode for a PasswordKeyEncryptor.
private byte[]	encryptedKeyValue A base64-encoded value that specifies the encrypted form of the intermediate key.
private byte[]	encryptedVerifierHashInput A base64-encoded value that specifies the encrypted verifier hash input for a PasswordKeyEncryptor used in password verification.
private byte[]	encryptedVerifierHashValue A base64-encoded value that specifies the encrypted verifier hash value for a PasswordKeyEncryptor used in password verification.
private HashAlgorithm	hashAlgorithm A HashAlgorithm that specifies the hashing algorithm for a PasswordKeyEncryptor.
private Integer	hashSize An unsigned integer that specifies the number of bytes used by a hash value.
private Integer	keyBits An unsigned integer that specifies the number of bits used by an encryption algorithm.
private Integer	saltSize An unsigned integer that specifies the number of bytes used by a salt.
private byte[]	saltValue A base64-encoded binary byte array that specifies the salt value for a PasswordKeyEncryptor.
private Integer	spinCount A SpinCount that specifies the spin count for a PasswordKeyEncryptor.

Access	Constructor and Description
public	PasswordKeyEncryptor()
public	PasswordKeyEncryptor(Element passwordKey)

Method Summary

Modifier and Type	Method and Description
public Integer	getBlockSize()
public CipherAlgorithm	getCipherAlgorithm()
public ChainingMode	getCipherChaining()
public byte[]	getEncryptedKeyValue()
public byte[]	getEncryptedVerifierHashInput()
public byte[]	getEncryptedVerifierHashValue()
public HashAlgorithm	getHashAlgorithm()
public Integer	getHashSize()
public Integer	getKeyBits()
public Integer	getSaltSize()
public byte[]	getSaltValue()
public Integer	getSpinCount()
public void	setBlockSize(Integer blockSize)
public void	setCipherAlgorithm(CipherAlgorithm cipherAlgorithm)
public void	setCipherChaining(ChainingMode cipherChaining)
public void	setEncryptedKeyValue(byte[] encryptedKeyValue)
public void	setEncryptedVerifierHashInput(byte[] encryptedVerifierHashInput)
public void	setEncryptedVerifierHashValue(byte[] encryptedVerifierHashValue)
public void	setHashAlgorithm(HashAlgorithm hashAlgorithm)
public void	setHashSize(Integer hashSize)
public void	setKeyBits(Integer keyBits)
public void	setSaltSize(Integer saltSize)
public void	setSaltValue(byte[] saltValue)
public void	setSpinCount(Integer spinCount)
pack-priv void	write(Element encryption)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

blockSize	back to summary
private Integer blockSize An unsigned integer that specifies the number of bytes used to encrypt one block of data. It MUST be at least 2, no greater than 4096, and a multiple of 2.

cipherAlgorithm	back to summary
private CipherAlgorithm cipherAlgorithm A CipherAlgorithm that specifies the cipher algorithm for a PasswordKeyEncryptor. The cipher algorithm specified MUST be the same as the cipher algorithm specified for the Encryption.keyData element.

cipherChaining	back to summary
private ChainingMode cipherChaining A CipherChaining that specifies the cipher chaining mode for a PasswordKeyEncryptor.

encryptedKeyValue	back to summary
private byte[] encryptedKeyValue A base64-encoded value that specifies the encrypted form of the intermediate key.

encryptedVerifierHashInput	back to summary
private byte[] encryptedVerifierHashInput A base64-encoded value that specifies the encrypted verifier hash input for a PasswordKeyEncryptor used in password verification.

encryptedVerifierHashValue	back to summary
private byte[] encryptedVerifierHashValue A base64-encoded value that specifies the encrypted verifier hash value for a PasswordKeyEncryptor used in password verification.

hashAlgorithm	back to summary
private HashAlgorithm hashAlgorithm A HashAlgorithm that specifies the hashing algorithm for a PasswordKeyEncryptor. The hashing algorithm specified MUST be the same as the hashing algorithm specified for the Encryption.keyData element.

hashSize	back to summary
private Integer hashSize An unsigned integer that specifies the number of bytes used by a hash value. It MUST be at least 1, no greater than 65,536, and the same number of bytes as the hash algorithm emits.

keyBits	back to summary
private Integer keyBits An unsigned integer that specifies the number of bits used by an encryption algorithm. It MUST be at least 8 and a multiple of 8.

saltSize	back to summary
private Integer saltSize An unsigned integer that specifies the number of bytes used by a salt. It MUST be at least 1 and no greater than 65,536.

saltValue	back to summary
private byte[] saltValue A base64-encoded binary byte array that specifies the salt value for a PasswordKeyEncryptor. The number of bytes required by the decoded form of this element MUST be saltSize.

spinCount	back to summary
private Integer spinCount A SpinCount that specifies the spin count for a PasswordKeyEncryptor.

Constructor Detail

PasswordKeyEncryptor	back to summary
public PasswordKeyEncryptor()

PasswordKeyEncryptor	back to summary
public PasswordKeyEncryptor(Element passwordKey)

Method Detail

getBlockSize	back to summary
public Integer getBlockSize()

getCipherAlgorithm	back to summary
public CipherAlgorithm getCipherAlgorithm()

getCipherChaining	back to summary
public ChainingMode getCipherChaining()

getEncryptedKeyValue	back to summary
public byte[] getEncryptedKeyValue()

getEncryptedVerifierHashInput	back to summary
public byte[] getEncryptedVerifierHashInput()

getEncryptedVerifierHashValue	back to summary
public byte[] getEncryptedVerifierHashValue()

getHashAlgorithm	back to summary
public HashAlgorithm getHashAlgorithm()

getHashSize	back to summary
public Integer getHashSize()

getKeyBits	back to summary
public Integer getKeyBits()

getSaltSize	back to summary
public Integer getSaltSize()

getSaltValue	back to summary
public byte[] getSaltValue()

getSpinCount	back to summary
public Integer getSpinCount()

setBlockSize	back to summary
public void setBlockSize(Integer blockSize)

setCipherAlgorithm	back to summary
public void setCipherAlgorithm(CipherAlgorithm cipherAlgorithm)

setCipherChaining	back to summary
public void setCipherChaining(ChainingMode cipherChaining)

setEncryptedKeyValue	back to summary
public void setEncryptedKeyValue(byte[] encryptedKeyValue)

setEncryptedVerifierHashInput	back to summary
public void setEncryptedVerifierHashInput(byte[] encryptedVerifierHashInput)

setEncryptedVerifierHashValue	back to summary
public void setEncryptedVerifierHashValue(byte[] encryptedVerifierHashValue)

setHashAlgorithm	back to summary
public void setHashAlgorithm(HashAlgorithm hashAlgorithm)

setHashSize	back to summary
public void setHashSize(Integer hashSize)

setKeyBits	back to summary
public void setKeyBits(Integer keyBits)

setSaltSize	back to summary
public void setSaltSize(Integer saltSize)

setSaltValue	back to summary
public void setSaltValue(byte[] saltValue)

setSpinCount	back to summary
public void setSpinCount(Integer spinCount)

write	back to summary
pack-priv void write(Element encryption)

public Class PasswordKeyEncryptor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail