org.bouncycastle.crypto

Enum CryptoServicePurpose

java.lang.Object

java.lang.Enum<CryptoServicePurpose>

org.bouncycastle.crypto.CryptoServicePurpose

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CryptoServicePurpose>

public enum CryptoServicePurpose
extends java.lang.Enum<CryptoServicePurpose>

Enum Constant Summary

Enum Constants

Enum Constant and Description
AGREEMENT
ANY
AUTHENTICATION
DECRYPTION
ENCRYPTION
INTERNAL A primitive built inside another algorithm's engine as a fixed part of that algorithm - the SHAKE an ML-DSA or ML-KEM engine expands its matrix with, the tree hash of a stateful hash-based signature.
KEYGEN
PRF
SIGNING
VERIFICATION
VERIFYING

Method Summary

Modifier and Type	Method and Description
static CryptoServicePurpose	forCode(int code) Return the purpose with the given code.
int	getCode() The stable numeric code for this purpose.
static CryptoServicePurpose	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CryptoServicePurpose[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AGREEMENT

public static final CryptoServicePurpose AGREEMENT

ENCRYPTION

public static final CryptoServicePurpose ENCRYPTION

DECRYPTION

public static final CryptoServicePurpose DECRYPTION

KEYGEN

public static final CryptoServicePurpose KEYGEN

SIGNING

public static final CryptoServicePurpose SIGNING

VERIFYING

public static final CryptoServicePurpose VERIFYING

AUTHENTICATION

public static final CryptoServicePurpose AUTHENTICATION

VERIFICATION

public static final CryptoServicePurpose VERIFICATION

PRF

public static final CryptoServicePurpose PRF

ANY

public static final CryptoServicePurpose ANY

INTERNAL

public static final CryptoServicePurpose INTERNAL

A primitive built inside another algorithm's engine as a fixed part of that algorithm - the SHAKE an ML-DSA or ML-KEM engine expands its matrix with, the tree hash of a stateful hash-based signature. It is not a service in its own right and is not checked against the constraints: the enclosing algorithm reports for it, with the strength of its parameter set.

Method Detail

values

public static CryptoServicePurpose[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CryptoServicePurpose c : CryptoServicePurpose.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CryptoServicePurpose valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getCode

public int getCode()

The stable numeric code for this purpose. It is written as the trailing byte of a digest's encoded state, so - unlike Enum.ordinal() - it must not shift if the constants are ever reordered; each constant carries its own code for that reason.

forCode

public static CryptoServicePurpose forCode(int code)

Return the purpose with the given code.

Throws:

java.lang.IllegalArgumentException - if no purpose has that code.