OPC Studio User's Guide and Reference
CreateCsr Method



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.Application Namespace > AbstractEasyUAClientServerApplication Class : CreateCsr Method
The sub-id of the certificate. Normally an empty string.

The value of this parameter cannot be null (Nothing in Visual Basic).

The certificate type Id, or null (Nothing in Visual Basic) for certificate pack.

Because the OpcLabs.EasyOpc.UA.AddressSpace.UANodeId has an implicit conversion from System.String, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a string (representing the expanded text of the nodeId) in place of this parameter, and the corresponding OPC UA node Id will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the UANodeId Constructor(String) constructor instead.

The value of this parameter cannot be null (Nothing in Visual Basic).

Name of file containing the private key.

The value of this parameter cannot be null (Nothing in Visual Basic).

Password to the private key in the file.

The value of this parameter cannot be null (Nothing in Visual Basic).

Password to the current certificate's private key.

The value of this parameter cannot be null (Nothing in Visual Basic).

Domain names to be included within the CSR.

The value of this parameter cannot be null (Nothing in Visual Basic).

Infrastructure. Create a certificate signing request (CSR).
Syntax
'Declaration
 
<JetBrains.Annotations.NotNullAttribute()>
Protected MustOverride Function CreateCsr( _
   ByVal certificateSubId As String, _
   ByVal certificateTypeId As UANodeId, _
   ByVal privateKeyFileName As String, _
   ByVal filePrivateKeyPassword As String, _
   ByVal oldPrivateKeyPassword As String, _
   ByVal domainNames As IEnumerable(Of String) _
) As Byte()
'Usage
 
Dim instance As AbstractEasyUAClientServerApplication
Dim certificateSubId As String
Dim certificateTypeId As UANodeId
Dim privateKeyFileName As String
Dim filePrivateKeyPassword As String
Dim oldPrivateKeyPassword As String
Dim domainNames As IEnumerable(Of String)
Dim value() As Byte
 
value = instance.CreateCsr(certificateSubId, certificateTypeId, privateKeyFileName, filePrivateKeyPassword, oldPrivateKeyPassword, domainNames)

Parameters

certificateSubId
The sub-id of the certificate. Normally an empty string.

The value of this parameter cannot be null (Nothing in Visual Basic).

certificateTypeId
The certificate type Id, or null (Nothing in Visual Basic) for certificate pack.

Because the OpcLabs.EasyOpc.UA.AddressSpace.UANodeId has an implicit conversion from System.String, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a string (representing the expanded text of the nodeId) in place of this parameter, and the corresponding OPC UA node Id will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the UANodeId Constructor(String) constructor instead.

The value of this parameter cannot be null (Nothing in Visual Basic).

privateKeyFileName
Name of file containing the private key.

The value of this parameter cannot be null (Nothing in Visual Basic).

filePrivateKeyPassword
Password to the private key in the file.

The value of this parameter cannot be null (Nothing in Visual Basic).

oldPrivateKeyPassword
Password to the current certificate's private key.

The value of this parameter cannot be null (Nothing in Visual Basic).

domainNames
Domain names to be included within the CSR.

The value of this parameter cannot be null (Nothing in Visual Basic).

Return Value

An array of bytes representing the CSR.

This method never returns null (Nothing in Visual Basic).

Exceptions
ExceptionDescription

The OPC UA operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause.

This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

Remarks

This method may only be called when SupportsCreatingCsr is true.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

See Also