org.bouncycastle.openpgp.api

Class MessageEncryptionMechanism

java.lang.Object

org.bouncycastle.openpgp.api.MessageEncryptionMechanism

public class MessageEncryptionMechanism
extends java.lang.Object

Encryption mode (SEIPDv1 / SEIPDv2 / OED) and algorithms.

Method Summary

Modifier and Type	Method and Description
static MessageEncryptionMechanism	aead(int symmetricKeyAlgorithm, int aeadAlgorithm) The data will be AEAD-encrypted using the method described in RFC9580.
static MessageEncryptionMechanism	aead(PreferredAEADCiphersuites.Combination combination)
boolean	equals(java.lang.Object obj)
int	getAeadAlgorithm()
EncryptedDataPacketType	getMode()
int	getSymmetricKeyAlgorithm()
int	hashCode()
static MessageEncryptionMechanism	integrityProtected(int symmetricKeyAlgorithm) The data will be encrypted and integrity protected using a SEIPDv1 packet.
boolean	isEncrypted() Return true, if the message will be encrypted.
static MessageEncryptionMechanism	legacyEncryptedNonIntegrityProtected(int symmetricKeyAlgorithm) Deprecated.
static MessageEncryptionMechanism	librePgp(int symmetricKeyAlgorithm) The data will be OCB-encrypted as specified by the non-standard LibrePGP document.
java.lang.String	toString()
static MessageEncryptionMechanism	unencrypted() The data will not be encrypted.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getMode

public EncryptedDataPacketType getMode()

getSymmetricKeyAlgorithm

public int getSymmetricKeyAlgorithm()

getAeadAlgorithm

public int getAeadAlgorithm()

unencrypted

public static MessageEncryptionMechanism unencrypted()

The data will not be encrypted. Useful for sign-only operations.

Returns:

unencrypted encryption setup

legacyEncryptedNonIntegrityProtected

@Deprecated
public static MessageEncryptionMechanism legacyEncryptedNonIntegrityProtected(int symmetricKeyAlgorithm)

Deprecated.

integrityProtected

public static MessageEncryptionMechanism integrityProtected(int symmetricKeyAlgorithm)

The data will be encrypted and integrity protected using a SEIPDv1 packet.

Parameters:

symmetricKeyAlgorithm - symmetric cipher algorithm for message encryption

Returns:

sym. enc. integrity protected encryption setup

librePgp

public static MessageEncryptionMechanism librePgp(int symmetricKeyAlgorithm)

The data will be OCB-encrypted as specified by the non-standard LibrePGP document.

Parameters:

symmetricKeyAlgorithm - symmetric key algorithm which will be combined with OCB to form an OCB-encrypted data packet

Returns:

LibrePGP OCB encryption setup

aead

public static MessageEncryptionMechanism aead(int symmetricKeyAlgorithm,
                                              int aeadAlgorithm)

The data will be AEAD-encrypted using the method described in RFC9580.

Parameters:

symmetricKeyAlgorithm - symmetric cipher algorithm

aeadAlgorithm - AEAD algorithm

Returns:

AEAD encryption setup

aead

public static MessageEncryptionMechanism aead(PreferredAEADCiphersuites.Combination combination)

isEncrypted

public boolean isEncrypted()

Return true, if the message will be encrypted.

Returns:

is encrypted

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object