Bouncy Castle Cryptography Library 1.80 · org.bouncycastle.openpgp.operator.PBESecretKeyEncryptor

Class responsible for encrypting secret key material or data packets using a passphrase.

RFC9580 recommends the following S2K specifiers + usages:

S2K Specifier	S2K Usage	Note
`S2K#ARGON_2`	`org.bouncycastle.bcpg.SecretKeyPacket#USAGE_AEAD`	RECOMMENDED; Argon2 MUST be used with AEAD
`S2K#SALTED_AND_ITERATED`	`org.bouncycastle.bcpg.SecretKeyPacket#USAGE_SHA1`	MAY be used if Argon2 is not available; Take care to use high octet count + strong passphrase
none	`org.bouncycastle.bcpg.SecretKeyPacket#USAGE_NONE`	Unprotected

Additionally, implementations MAY use the following combinations with caution:

S2K Specifier	S2K Usage	Note
`S2K#SALTED_AND_ITERATED`	`org.bouncycastle.bcpg.SecretKeyPacket#USAGE_AEAD`	Does not provide memory hardness
`S2K#SIMPLE`	`org.bouncycastle.bcpg.SecretKeyPacket#USAGE_SHA1`	Only for reading secret keys in backwards compatibility mode

Field Summary

Modifier and Type	Field and Description
protected int	aeadAlgorithm
protected int	encAlgorithm
protected char[]	passPhrase
protected SecureRandom	random
protected S2K	s2k
protected int	s2kCount
protected PGPDigestCalculator	s2kDigestCalculator

Constructor Summary

Access	Constructor and Description
protected	PBESecretKeyEncryptor(int encAlgorithm, int aeadAlgorithm, S2K.Argon2Params argon2Params, SecureRandom random, char[] passPhrase)
protected	PBESecretKeyEncryptor(int encAlgorithm, PGPDigestCalculator s2kDigestCalculator, SecureRandom random, char[] passPhrase)
protected	PBESecretKeyEncryptor(int encAlgorithm, PGPDigestCalculator s2kDigestCalculator, int s2kCount, SecureRandom random, char[] passPhrase)

Method Summary

Modifier and Type	Method and Description
public byte[]	Returns: an encryption of the passed in keyData. encryptKeyData(byte[] raw key data keyData, int offset into raw key data keyOff, int length of key data to use. keyLen) Key encryption method invoked for V4 keys and greater.
public abstract byte[]	encryptKeyData(byte[] key, byte[] keyData, int keyOff, int keyLen)
public byte[]	encryptKeyData(byte[] key, byte[] iv, byte[] keyData, int keyOff, int keyLen) Encrypt the passed in keyData using the key and the iv provided.
public int	getAeadAlgorithm()
public int	getAlgorithm()
public abstract byte[]	getCipherIV()
public int	getHashAlgorithm()
public byte[]	getKey()
public S2K	getS2K()

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

Field Detail

aeadAlgorithm	back to summary
protected int aeadAlgorithm

encAlgorithm	back to summary
protected int encAlgorithm

passPhrase	back to summary
protected char[] passPhrase

random	back to summary
protected SecureRandom random

s2k	back to summary
protected S2K s2k

s2kCount	back to summary
protected int s2kCount

s2kDigestCalculator	back to summary
protected PGPDigestCalculator s2kDigestCalculator

Constructor Detail

PBESecretKeyEncryptor	back to summary
protected PBESecretKeyEncryptor(int encAlgorithm, int aeadAlgorithm, S2K.Argon2Params argon2Params, SecureRandom random, char[] passPhrase)

PBESecretKeyEncryptor	back to summary
protected PBESecretKeyEncryptor(int encAlgorithm, PGPDigestCalculator s2kDigestCalculator, SecureRandom random, char[] passPhrase)

PBESecretKeyEncryptor	back to summary
protected PBESecretKeyEncryptor(int encAlgorithm, PGPDigestCalculator s2kDigestCalculator, int s2kCount, SecureRandom random, char[] passPhrase)

Method Detail

encryptKeyData	back to summary
public byte[] encryptKeyData(byte[] keyData, int keyOff, int keyLen) throws PGPException Key encryption method invoked for V4 keys and greater. Parameters keyData:byte[] raw key data keyOff:int offset into raw key data keyLen:int length of key data to use. Returns:byte[] an encryption of the passed in keyData. Exceptions PGPException: on error in the underlying encryption process.

encryptKeyData

back to summary

public byte[] encryptKeyData(byte[] keyData, int keyOff, int keyLen) throws PGPException

Key encryption method invoked for V4 keys and greater.

Parameters

keyData:byte[]: raw key data
keyOff:int: offset into raw key data
keyLen:int: length of key data to use.

Returns:byte[]

an encryption of the passed in keyData.

Exceptions

PGPException:: on error in the underlying encryption process.

encryptKeyData	back to summary
public abstract byte[] encryptKeyData(byte[] key, byte[] keyData, int keyOff, int keyLen) throws PGPException

encryptKeyData	back to summary
public byte[] encryptKeyData(byte[] key, byte[] iv, byte[] keyData, int keyOff, int keyLen) throws PGPException Encrypt the passed in keyData using the key and the iv provided. This method is only used for processing version 3 keys.

encryptKeyData

back to summary

public byte[] encryptKeyData(byte[] key, byte[] iv, byte[] keyData, int keyOff, int keyLen) throws PGPException

Encrypt the passed in keyData using the key and the iv provided.

This method is only used for processing version 3 keys.

getAeadAlgorithm	back to summary
public int getAeadAlgorithm()

getAlgorithm	back to summary
public int getAlgorithm()

getCipherIV	back to summary
public abstract byte[] getCipherIV()

getHashAlgorithm	back to summary
public int getHashAlgorithm()

getKey	back to summary
public byte[] getKey() throws PGPException