Docs
DEEN

Reference

OpcClientSecurity Members

Defines the different security configurations supported by the OpcClient.

Reference

OpcClientSecurity Members ​

Type
OpcClientSecurity
Namespace
Opc.UaFx.Client
Assembly
Opc.UaFx.Advanced.dll
Package
Opc.UaFx.Advanced v2.59.0
Also in
Opc.UaFx.Client

Inherits members from OpcSecurity.

Properties ​

AuthenticationLevel ​

since v2.25

Gets or sets the level of DCOM authentication to use when connecting to an OPC Classic server and creating DCOM objects.

csharp
public OpcClassicAuthenticationLevel? AuthenticationLevel { get; set; }
vbnet
Public Property AuthenticationLevel As OpcClassicAuthenticationLevel?

Property value

Nullable<OpcClassicAuthenticationLevel>

One of the members defined by the OpcClassicAuthenticationLevel enumeration or a null reference (Nothing in Visual Basic). If a null reference (Nothing in Visual Basic) is used no application wide DCOM security is initialized; otherwise the DCOM security is initialized with the value specified. Any subsequent creation of DCOM objects will additionally use the authentication level specified. If no authentication level is specified the PacketIntegrity is used for DCOM object creation.

AuthenticationService ​

since v2.32

Gets or sets the DCOM authentication service to use to identify the security package to use when connecting to an OPC Classic server and creating DCOM objects.

csharp
public OpcClassicAuthenticationService? AuthenticationService { get; set; }
vbnet
Public Property AuthenticationService As OpcClassicAuthenticationService?

Property value

Nullable<OpcClassicAuthenticationService>

One of the members defined by the OpcClassicAuthenticationService enumeration or a null reference (Nothing in Visual Basic). If a null reference (Nothing in Visual Basic) is used no application wide DCOM security is initialized; otherwise the DCOM security is initialized with the value specified. Any subsequent creation of DCOM objects will additionally use the authentication service specified. If no authentication service is specified the WinNt is used for DCOM object creation.

AuthorizationService ​

since v2.32

Gets or sets the DCOM authorization service to use to define what the server authorizes when connecting to an OPC Classic server and creating DCOM objects.

csharp
public OpcClassicAuthorizationService? AuthorizationService { get; set; }
vbnet
Public Property AuthorizationService As OpcClassicAuthorizationService?

Property value

Nullable<OpcClassicAuthorizationService>

One of the members defined by the OpcClassicAuthorizationService enumeration or a null reference (Nothing in Visual Basic). If a null reference (Nothing in Visual Basic) is used no application wide DCOM security is initialized; otherwise the DCOM security is initialized with the value specified. Any subsequent creation of DCOM objects will additionally use the authorization serivce specified. If no authorization service is specified the None is used for DCOm object creation.

AutoUpgradeEndpointPolicy ​

since v2.11

Gets or sets a value indicating whether the client have to select an endpoint which uses at least the policy configured by the EndpointPolicy and in case there such an endpoint is missing the endpoint with the next best policy is to be used instead.

csharp
public bool AutoUpgradeEndpointPolicy { get; set; }
vbnet
Public Property AutoUpgradeEndpointPolicy As Boolean

Property value

Boolean

The value true if the client shall automatically upgrade the EndpointPolicy configured to the next best policy in case non of the offered endpoints supports exactly the policy expected; otherwise the value false.

EndpointPolicy ​

Gets or sets the policy configuration of the endpoint of the server to connect to.

csharp
public OpcSecurityPolicy EndpointPolicy { get; set; }
vbnet
Public Property EndpointPolicy As OpcSecurityPolicy

Property value

OpcSecurityPolicy

An instance of the OpcSecurityPolicy class which defines the different policy characteristics an endpoint have to use to that the client will connect. Only in case there is an explicit OpcSecurityPolicy instance defined the client will only connect to such an endpoint. In case there this property is set to a null reference (Nothing in Visual Basic) the automatic endpoint selection will be used. This means that the endpoint will be selected using the properties UseOnlySecureEndpoints and UseHighLevelEndpoint. In case there this property is set to a concrete endpoint policy configuration the client will select the first endpoint which exactly matches the endpoint policy configuration defined by this property. The default value of this property is a null reference (Nothing in Visual Basic).

ImpersonationLevel ​

since v2.25

Gets or sets the level of DCOM impersonation to use when connecting to an OPC Classic server and creating DCOM objects.

csharp
public OpcClassicImpersonationLevel? ImpersonationLevel { get; set; }
vbnet
Public Property ImpersonationLevel As OpcClassicImpersonationLevel?

Property value

Nullable<OpcClassicImpersonationLevel>

One of the members defined by the OpcClassicImpersonationLevel enumeration or a null reference (Nothing in Visual Basic). If a null reference (Nothing in Visual Basic) is used no application wide DCOM security is initialized; otherwise the DCOM security is initialized with the value specified. Any subsequent creation of DCOM objects will additionally use the impersonation level specified. If no impersonation level is specified the Impersonate is used for DCOM object creation.

ProxyCapabilities ​

since v2.32

Gets or sets the DCOM proxy capabilities to use when connecting to an OPC Classic server and creating DCOM objects.

csharp
public OpcClassicProxyCapabilities? ProxyCapabilities { get; set; }
vbnet
Public Property ProxyCapabilities As OpcClassicProxyCapabilities?

Property value

Nullable<OpcClassicProxyCapabilities>

One or more members defined by the OpcClassicProxyCapabilities enumeration or a null reference (Nothing in Visual Basic). If a null reference (Nothing in Visual Basic) is used no application wide DCOM security is initialized; otherwise the DCOM security is initialized with the value specified. Any subsequent creation of DCOM objects will additionally use the proxy capabilities specified. If no proxy capabilities are specified the None is used for DCOM object creation.

UseHighLevelEndpoint ​

Gets or sets a value indicating whether the client have to select an endpoint which uses the highest policy level available (Level).

csharp
public bool UseHighLevelEndpoint { get; set; }
vbnet
Public Property UseHighLevelEndpoint As Boolean

Property value

Boolean

The value true if the client have to automatically select the endpoint its Policy defines the highest policy level (see Level) of all endpoints provided; otherwise the value false (the default value is false).

Remarks

The value of this property will only take affect in case there is not an explicit endpoint policy defined by EndpointPolicy. Only in case there the EndpointPolicy property defines no explicit endpoint policy - the property value is a null reference (Nothing in Visual Basic) - then the value of this property is respected.

In case there the value of this property is set to true (= OPC UA default behavior), the policy level of the servers endpoints decides about the endpoint selection. This means that the client will select the endpoint with the highest policy level.

UseOnlySecureEndpoints ​

Gets or sets a value indicating whether the client have to select an endpoint which uses a different OpcSecurityMode than None.

csharp
public bool UseOnlySecureEndpoints { get; set; }
vbnet
Public Property UseOnlySecureEndpoints As Boolean

Property value

Boolean

The value true if the client have to respect endpoints which using no security (= security mode is equals None); otherwise the value false (the default value is false).

Remarks

The value of this property will only take affect in case there is not an explicit endpoint policy defined by EndpointPolicy. Only in case there the EndpointPolicy property defines no explicit endpoint policy - the property value is a null reference (Nothing in Visual Basic) - then the value of this property is respected.

In case there the value of this property is set to true, there is no guarantee that the client will select an endpoint with no security. This property just indicates whether endpoints (independent from their policy level) with no security have to be also taken into consideration.

UserIdentity ​

Gets or sets the identity to use to authenticate the client sessions against the server.

csharp
public OpcUserIdentity UserIdentity { get; set; }
vbnet
Public Property UserIdentity As OpcUserIdentity

Property value

OpcUserIdentity

An instance of one of the OpcUserIdentity derivatives defining the credentials to use to authenticate the client sessions against the server or a null reference (Nothing in Visual Basic) in case there an anonymous identity is to be used by the server to authenticate the client sessions.

Remarks

Only in case there the server supports an user token policy for anonymous user access (the 'Opc.UaFx.Server.OpcAnonymousAcl' is to be enabled) this property can be left with a null reference (Nothing in Visual Basic); otherwise there is a concrete instance of one of the OpcUserIdentity derivatives required.

The following derivatives can be used to define an user identity:

  1. OpcClientIdentity Defines an identity using an user name and a password as the credentials to use to authenticate against the server. This will only work in case there the server supports an username user token policy for user name for user name and password authentication (the 'Opc.UaFx.Server.OpcUserNameAcl' is to be enabled).
  2. OpcCertificateIdentity Defines an identity using certificate data as the credentials to use to authenticate against the server. This will only work in case there the server supports an certificate user token policy for certificate based authentication. (the 'Opc.UaFx.Server.OpcCertificateAcl' is to be enabled).

VerifyServersCertificateDomains ​

Gets or sets a value indicating whether the client have to verify the domain names referenced in the servers certificate.

csharp
public bool VerifyServersCertificateDomains { get; set; }
vbnet
Public Property VerifyServersCertificateDomains As Boolean

Property value

Boolean

The value true if the servers certificate domain names have to be verified on their existence; otherwise the value false (the default value is false).

Remarks

In case there this option is set to true, the client will investigate the domain names of the servers certificate. In case there is one of the domain names unknown and can't be resolved the client will refuse to establish a connection to the server.