Reference

OpcSecurityPolicy Members

Type

OpcSecurityPolicy

Namespace

Opc.UaFx

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Also in

Opc.UaFx.Client

Constructors

OpcSecurityPolicy

3 overloads

Overload	Description
OpcSecurityPolicy(OpcSecurityMode)	Initializes a new instance of the OpcSecurityPolicy class using the mode specified to determine the according Uri and Algorithm of the configuration to represent.
OpcSecurityPolicy(OpcSecurityMode, OpcSecurityAlgorithm)	Initializes a new instance of the OpcSecurityPolicy class using the mode and algorithm specified to determine the according Uri of the configuration to represent.
OpcSecurityPolicy(OpcSecurityMode, Uri)	Initializes a new instance of the OpcSecurityPolicy class using the mode and uri specified.

OpcSecurityPolicy(OpcSecurityMode)

Initializes a new instance of the OpcSecurityPolicy class using the mode specified to determine the according Uri and Algorithm of the configuration to represent.

public OpcSecurityPolicy(OpcSecurityMode mode)

Public Sub New(mode As OpcSecurityMode)

Parameters

Name	Type	Description
mode	OpcSecurityMode	One of the OpcSecurityMode members to define the mechanisms to secure the message exchange.

OpcSecurityPolicy(OpcSecurityMode, OpcSecurityAlgorithm)

Initializes a new instance of the OpcSecurityPolicy class using the mode and algorithm specified to determine the according Uri of the configuration to represent.

public OpcSecurityPolicy(OpcSecurityMode mode, OpcSecurityAlgorithm algorithm)

Public Sub New(mode As OpcSecurityMode, algorithm As OpcSecurityAlgorithm)

Parameters

Name	Type	Description
mode	OpcSecurityMode	One of the OpcSecurityMode members to define the mechanisms to secure the message exchange.
algorithm	OpcSecurityAlgorithm	One of the OpcSecurityAlgorithm members to define the algorithm to use for signing and message encryption (depending on the mode specified). Using the algorithm Auto results into None for the mode None and into Basic256Sha256 for the modes Sign and SignAndEncrypt. The Algorithm is set to None in case of the algorithm Custom is used.

OpcSecurityPolicy(OpcSecurityMode, Uri)

Initializes a new instance of the OpcSecurityPolicy class using the mode and uri specified.

public OpcSecurityPolicy(OpcSecurityMode mode, Uri uri)

Public Sub New(mode As OpcSecurityMode, uri As Uri)

Parameters

Name	Type	Description
mode	OpcSecurityMode	One of the OpcSecurityMode members to define the mechanisms to secure the message exchange.
uri	Uri	The absolute URI of the security policy configuration to use which identifies the Algorithm to use for signing and message encryption (depending on the mode specified).

Exceptions

Exception	Condition
ArgumentNullException	The uri is a null reference (Nothing in Visual Basic).

Fields

BaseUri

static

Provides the base URI used by all security policies to refer to the according OpcSecurityAlgorithm they use.

public static readonly Uri BaseUri

Public Shared ReadOnly BaseUri As Uri

Field value

Uri

Properties

Algorithm

Gets the OpcSecurityAlgorithm used to encrypt messages using the current OpcSecurityPolicy configuration.

public OpcSecurityAlgorithm Algorithm { get; }

Public ReadOnly Property Algorithm As OpcSecurityAlgorithm

Property value

OpcSecurityAlgorithm

One of the members defined by the OpcSecurityAlgorithm enumeration or Custom in case there Uri does not refer to a known algorithm.

Level

Gets an ordinal value to order and classify the current OpcSecurityPolicy accordingly to others and their security configuration.

public int Level { get; }

Public ReadOnly Property Level As Integer

Property value

Int32

A positive int to identify the most secure policy. The policy with the highest Level is also the most secure.

Mode

Gets the mechanism used to secure the message exchange using the current OpcSecurityPolicy configuration.

public OpcSecurityMode Mode { get; }

Public ReadOnly Property Mode As OpcSecurityMode

Property value

OpcSecurityMode

One of the members defined by the OpcSecurityMode enumeration. The value Invalid in case of an invalid OpcSecurityPolicy configuration.

Uri

Gets the URI which expresses the Algorithm used for message encryption using the current OpcSecurityPolicy configuration.

public Uri Uri { get; }

Public ReadOnly Property Uri As Uri

Property value

Uri

An instance of the Uri class which identifies the Algorithm used for message encryption.