Module org.eclipse.milo.opcua.stack.core

Package org.eclipse.milo.opcua.stack.core.security

Enum Class SecurityAlgorithm

java.lang.Object

java.lang.Enum<SecurityAlgorithm>

org.eclipse.milo.opcua.stack.core.security.SecurityAlgorithm

All Implemented Interfaces:

Serializable, Comparable<SecurityAlgorithm>, Constable

public enum SecurityAlgorithm
extends Enum<SecurityAlgorithm>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Aes128	Symmetric Encryption; transformation to be used with Cipher.getInstance(String).
Aes256	Symmetric Encryption; transformation to be used with Cipher.getInstance(String).
HmacSha1	Symmetric Signature; transformation to be used with Mac.getInstance(String).
HmacSha256	Symmetric Signature; transformation to be used with Mac.getInstance(String).
KwRsa15	Asymmetric Key Wrap
KwRsaOaep	Asymmetric Key Wrap
None
PSha1	Key Derivation
PSha256	Key Derivation
Rsa15	Asymmetric Encryption; transformation to be used with Cipher.getInstance(String).
RsaOaepSha1	Asymmetric Encryption; transformation to be used with Cipher.getInstance(String).
RsaOaepSha256	Asymmetric Encryption; transformation to be used with Cipher.getInstance(String).
RsaSha1	Asymmetric Signature; transformation to be used with Signature.getInstance(String).
RsaSha256	Asymmetric Signature; transformation to be used with Signature.getInstance(String).
RsaSha256Pss	Asymmetric Signature; transformation to be used with Signature.getInstance(String).
Sha1	Cryptographic Hash; transformation to be used with MessageDigest.getInstance(String).
Sha256	Cryptographic Hash; transformation to be used with MessageDigest.getInstance(String).

Method Summary

Modifier and Type	Method	Description
static SecurityAlgorithm	fromUri(String securityAlgorithmUri)
String	getTransformation()
String	getUri()
static SecurityAlgorithm	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SecurityAlgorithm[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

None

public static final SecurityAlgorithm None

HmacSha1

public static final SecurityAlgorithm HmacSha1

Symmetric Signature; transformation to be used with Mac.getInstance(String).

HmacSha256

public static final SecurityAlgorithm HmacSha256

Symmetric Signature; transformation to be used with Mac.getInstance(String).

Aes128

public static final SecurityAlgorithm Aes128

Symmetric Encryption; transformation to be used with Cipher.getInstance(String).

Aes256

public static final SecurityAlgorithm Aes256

Symmetric Encryption; transformation to be used with Cipher.getInstance(String).

RsaSha1

public static final SecurityAlgorithm RsaSha1

Asymmetric Signature; transformation to be used with Signature.getInstance(String).

RsaSha256

public static final SecurityAlgorithm RsaSha256

Asymmetric Signature; transformation to be used with Signature.getInstance(String).

RsaSha256Pss

public static final SecurityAlgorithm RsaSha256Pss

Asymmetric Signature; transformation to be used with Signature.getInstance(String).

Requires Bouncy Castle installed as a Security Provider.

Rsa15

public static final SecurityAlgorithm Rsa15

Asymmetric Encryption; transformation to be used with Cipher.getInstance(String).

RsaOaepSha1

public static final SecurityAlgorithm RsaOaepSha1

Asymmetric Encryption; transformation to be used with Cipher.getInstance(String).

RsaOaepSha256

public static final SecurityAlgorithm RsaOaepSha256

Asymmetric Encryption; transformation to be used with Cipher.getInstance(String).

Important note: the transformation used is "RSA/ECB/OAEPWithSHA256AndMGF1Padding" as opposed to "RSA/ECB/OAEPWithSHA-256AndMGF1Padding".

While similar, the former is provided by Bouncy Castle whereas the latter is provided by SunJCE.

This is important because the BC version uses SHA256 in the padding while the SunJCE version uses Sha1.

KwRsa15

public static final SecurityAlgorithm KwRsa15

Asymmetric Key Wrap

KwRsaOaep

public static final SecurityAlgorithm KwRsaOaep

Asymmetric Key Wrap

PSha1

public static final SecurityAlgorithm PSha1

Key Derivation

PSha256

public static final SecurityAlgorithm PSha256

Key Derivation

Sha1

public static final SecurityAlgorithm Sha1

Cryptographic Hash; transformation to be used with MessageDigest.getInstance(String).

Sha256

public static final SecurityAlgorithm Sha256

Cryptographic Hash; transformation to be used with MessageDigest.getInstance(String).

Method Details

values

public static SecurityAlgorithm[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static SecurityAlgorithm valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getUri

public String getUri()

Returns:

The URI identifying this security algorithm.

getTransformation

public String getTransformation()

Returns:

The transformation string to use with the appropriate provider SPI.

fromUri

public static SecurityAlgorithm fromUri(String securityAlgorithmUri)
                                 throws UaException

Throws:

UaException