SecurityPolicy (prosys-opc-ua-sdk-client-server-pubsub 5.6.2-227 API)

java.lang.Object
- java.lang.Enum<SecurityPolicy>
- - com.prosysopc.ua.stack.transport.security.SecurityPolicy

All Implemented Interfaces:

Serializable, Comparable<SecurityPolicy>
```
public enum SecurityPolicy
extends Enum<SecurityPolicy>
```
Security Policy determines which algorithms to use during asymmetric and symmetric encryption.

See Also:

for instantiating cryptographics objects

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AES128_SHA256_RSAOAEP`
`AES256_SHA256_RSAPSS`
`BASIC128RSA15` Deprecated. This SecurityPolicy is Deprecated in the OPC UA Specification. Using this SecurityPolicy in applications is not recommended and it should be disabled by default in applications that allow choosing which SecurityPolicies to use.
`BASIC256` Deprecated. This SecurityPolicy is Deprecated in the OPC UA Specification. Using this SecurityPolicy in applications is not recommended and it should be disabled by default in applications that allow choosing which SecurityPolicies to use.
`BASIC256SHA256`
`NONE`

Field Summary

Fields
Modifier and Type	Field and Description
`static Set<SecurityPolicy>`	`ALL_SECURE_101` Deprecated. since the set contains deprecated policies.
`static Set<SecurityPolicy>`	`ALL_SECURE_102` Deprecated. since the set contains deprecated policies.
`static Set<SecurityPolicy>`	`ALL_SECURE_103` Deprecated. since the set contains deprecated policies.
`static Set<SecurityPolicy>`	`ALL_SECURE_104` Policies defined in OPC UA 1.04.
`static Set<SecurityPolicy>`	`ALL_SECURE_105` Policies defined in OPC UA 1.05.
`static SecurityPolicy[]`	`EMPTY_ARRAY`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static SecurityPolicy[]`	`getAllSecurityPolicies()` Deprecated. use `values()` instead, if needed, but note that it too includes deprecated policies.
`SecurityAlgorithm`	`getAsymmetricEncryptionAlgorithm()` Getter for the field `asymmetricEncryptionAlgorithm`.
`SecurityAlgorithm`	`getAsymmetricKeyWrapAlgorithm()` Getter for the field `asymmetricKeyWrapAlgorithm`.
`SecurityAlgorithm`	`getAsymmetricSignatureAlgorithm()` Getter for the field `asymmetricSignatureAlgorithm`.
`String`	`getDisplayName()` Returns a nicer human-readable name for this `SecurityPolicy`.
`byte[]`	`getEncodedPolicyUri()` Getter for the field `encodedPolicyUri`.
`int`	`getEncryptionBlockSize()` Getter for the field `encryptionBlockSize`.
`int`	`getEncryptionKeySize()` Getter for the field `encryptionKeySize`.
`SecurityAlgorithm`	`getKeyDerivationAlgorithm()` Getter for the field `keyDerivationAlgorithm`.
`int`	`getMaxAsymmetricKeyLength()` Getter for the field `maxAsymmetricKeyLength`.
`int`	`getMinAsymmetricKeyLength()` Getter for the field `minAsymmetricKeyLength`.
`String`	`getPolicyUri()` Getter for the field `policyUri`.
`int`	`getSecureChannelNonceLength()`
`static SecurityPolicy`	`getSecurityPolicy(String securityPolicyUri)` Get security policy by policy uri.
`int`	`getSignatureKeySize()` Getter for the field `signatureKeySize`.
`SecurityAlgorithm`	`getSymmetricEncryptionAlgorithm()` Getter for the field `symmetricEncryptionAlgorithm`.
`SecurityAlgorithm`	`getSymmetricSignatureAlgorithm()` Getter for the field `symmetricSignatureAlgorithm`.
`int`	`getSymmetricSignatureSize()` Getter for the field `symmetricSignatureSize`.
`boolean`	`isUsableWith(Cert cert)` Checks if a certificate is useable for this security policy.
`String`	`toString()`
`static SecurityPolicy`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static SecurityPolicy[]`	`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, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - NONE
```
public static final SecurityPolicy NONE
```
  - BASIC128RSA15
```
@Deprecated
public static final SecurityPolicy BASIC128RSA15
```
    Deprecated. This SecurityPolicy is Deprecated in the OPC UA Specification. Using this SecurityPolicy in applications is not recommended and it should be disabled by default in applications that allow choosing which SecurityPolicies to use.
    
    Deprecated.
  - BASIC256
```
@Deprecated
public static final SecurityPolicy BASIC256
```
    Deprecated. This SecurityPolicy is Deprecated in the OPC UA Specification. Using this SecurityPolicy in applications is not recommended and it should be disabled by default in applications that allow choosing which SecurityPolicies to use.
    
    Deprecated.
  - BASIC256SHA256
```
public static final SecurityPolicy BASIC256SHA256
```
  - AES128_SHA256_RSAOAEP
```
public static final SecurityPolicy AES128_SHA256_RSAOAEP
```
  - AES256_SHA256_RSAPSS
```
public static final SecurityPolicy AES256_SHA256_RSAPSS
```
- Field Detail
  - ALL_SECURE_101
```
@Deprecated
public static final Set<SecurityPolicy> ALL_SECURE_101
```
    Deprecated. since the set contains deprecated policies.
    
    Policies defined in OPC UA 1.01. Includes BASIC128RSA15 and BASIC256. This set in unmodifiable.
  - ALL_SECURE_102
```
@Deprecated
public static final Set<SecurityPolicy> ALL_SECURE_102
```
    Deprecated. since the set contains deprecated policies.
    
    Policies defined in OPC UA 1.02. Includes BASIC128RSA15, BASIC256 and BASIC256SHA256. This set in unmodifiable.
  - ALL_SECURE_103
```
@Deprecated
public static final Set<SecurityPolicy> ALL_SECURE_103
```
    Deprecated. since the set contains deprecated policies.
    
    Policies defined in OPC UA 1.03. Includes BASIC128RSA15, BASIC256 and BASIC256SHA256. This set in unmodifiable. Note that this set contains same policies as in ALL_SECURE_102.
  - ALL_SECURE_104
```
public static final Set<SecurityPolicy> ALL_SECURE_104
```
    Policies defined in OPC UA 1.04. Includes BASIC256SHA256, AES128_SHA256_RSAOAEP and AES256_SHA256_RSAPSS. This set in unmodifiable.
  - ALL_SECURE_105
```
public static final Set<SecurityPolicy> ALL_SECURE_105
```
    Policies defined in OPC UA 1.05. Includes BASIC256SHA256, AES128_SHA256_RSAOAEP and AES256_SHA256_RSAPSS i.e. same as ALL_SECURE_104. This set in unmodifiable.
  - EMPTY_ARRAY
```
public static final SecurityPolicy[] EMPTY_ARRAY
```
- Method Detail
  - values
```
public static SecurityPolicy[] 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 (SecurityPolicy c : SecurityPolicy.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SecurityPolicy valueOf(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:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getAllSecurityPolicies
```
@Deprecated
public static SecurityPolicy[] getAllSecurityPolicies()
```
    Deprecated. use values() instead, if needed, but note that it too includes deprecated policies.
    
    Get all security policies.
    
    Returns:
    
    security policies
  - getSecurityPolicy
```
public static SecurityPolicy getSecurityPolicy(String securityPolicyUri)
                                        throws ServiceResultException
```
    Get security policy by policy uri.
    
    Parameters:
    
    securityPolicyUri - security policy uri
    
    Returns:
    
    security policy
    
    Throws:
    
    ServiceResultException - Bad_SecurityPolicyRejected if policy is unknown
  - getAsymmetricEncryptionAlgorithm
```
public SecurityAlgorithm getAsymmetricEncryptionAlgorithm()
```
    Getter for the field asymmetricEncryptionAlgorithm.
    
    Returns:
    
    a SecurityAlgorithm object.
  - getAsymmetricKeyWrapAlgorithm
```
public SecurityAlgorithm getAsymmetricKeyWrapAlgorithm()
```
    Getter for the field asymmetricKeyWrapAlgorithm.
    
    Returns:
    
    a SecurityAlgorithm object.
  - getAsymmetricSignatureAlgorithm
```
public SecurityAlgorithm getAsymmetricSignatureAlgorithm()
```
    Getter for the field asymmetricSignatureAlgorithm.
    
    Returns:
    
    a SecurityAlgorithm object.
  - getDisplayName
```
public String getDisplayName()
```
    Returns a nicer human-readable name for this SecurityPolicy. Effectively this is the part of the getPolicyUri() after the '#' character.
  - getEncodedPolicyUri
```
public byte[] getEncodedPolicyUri()
```
    Getter for the field encodedPolicyUri.
    
    Returns:
    
    an array of byte.
  - getEncryptionBlockSize
```
public int getEncryptionBlockSize()
```
    Getter for the field encryptionBlockSize.
    
    Returns:
    
    the encryptionBlockSize
  - getEncryptionKeySize
```
public int getEncryptionKeySize()
```
    Getter for the field encryptionKeySize.
    
    Returns:
    
    the encryptionKeySize
  - getKeyDerivationAlgorithm
```
public SecurityAlgorithm getKeyDerivationAlgorithm()
```
    Getter for the field keyDerivationAlgorithm.
    
    Returns:
    
    a SecurityAlgorithm object.
  - getMaxAsymmetricKeyLength
```
public int getMaxAsymmetricKeyLength()
```
    Getter for the field maxAsymmetricKeyLength.
    
    Returns:
    
    the maxAsymmetricKeyLength
  - getMinAsymmetricKeyLength
```
public int getMinAsymmetricKeyLength()
```
    Getter for the field minAsymmetricKeyLength.
    
    Returns:
    
    the minAsymmetricKeyLength
  - getPolicyUri
```
public String getPolicyUri()
```
    Getter for the field policyUri.
    
    Returns:
    
    a String object.
  - getSecureChannelNonceLength
```
public int getSecureChannelNonceLength()
```
  - getSignatureKeySize
```
public int getSignatureKeySize()
```
    Getter for the field signatureKeySize.
    
    Returns:
    
    the signatureKeySize
  - getSymmetricEncryptionAlgorithm
```
public SecurityAlgorithm getSymmetricEncryptionAlgorithm()
```
    Getter for the field symmetricEncryptionAlgorithm.
    
    Returns:
    
    a SecurityAlgorithm object.
  - getSymmetricSignatureAlgorithm
```
public SecurityAlgorithm getSymmetricSignatureAlgorithm()
```
    Getter for the field symmetricSignatureAlgorithm.
    
    Returns:
    
    a SecurityAlgorithm object.
  - getSymmetricSignatureSize
```
public int getSymmetricSignatureSize()
```
    Getter for the field symmetricSignatureSize.
    
    Returns:
    
    the hmacHashSize
  - isUsableWith
```
public boolean isUsableWith(Cert cert)
```
    Checks if a certificate is useable for this security policy.
    
    Parameters:
    
    cert - a Cert object.
    
    Returns:
    
    true if certificate is usable
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<SecurityPolicy>

Enum SecurityPolicy

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NONE

BASIC128RSA15

BASIC256

BASIC256SHA256

AES128_SHA256_RSAOAEP

AES256_SHA256_RSAPSS

Field Detail

ALL_SECURE_101

ALL_SECURE_102

ALL_SECURE_103

ALL_SECURE_104

ALL_SECURE_105

EMPTY_ARRAY

Method Detail

values

valueOf

getAllSecurityPolicies

getSecurityPolicy

getAsymmetricEncryptionAlgorithm

getAsymmetricKeyWrapAlgorithm

getAsymmetricSignatureAlgorithm

getDisplayName

getEncodedPolicyUri

getEncryptionBlockSize

getEncryptionKeySize

getKeyDerivationAlgorithm

getMaxAsymmetricKeyLength

getMinAsymmetricKeyLength

getPolicyUri

getSecureChannelNonceLength

getSignatureKeySize

getSymmetricEncryptionAlgorithm

getSymmetricSignatureAlgorithm

getSymmetricSignatureSize

isUsableWith

toString