StartSigningRequest Method (IEasyUACertificateManagement)

Initiates a request to create a certificate which uses the private key which the caller currently has. The new certificate is returned in the FinishRequest response.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<NotNullAttribute()>
Function StartSigningRequest( _
   ByVal gdsEndpointDescriptor As UAEndpointDescriptor, _
   ByVal applicationId As UANodeId, _
   ByVal certificateGroupId As UANodeId, _
   ByVal certificateTypeId As UANodeId, _
   ByVal certificateRequest() As Byte _
) As UANodeId

'Usage
 
Dim instance As IEasyUACertificateManagement
Dim gdsEndpointDescriptor As UAEndpointDescriptor
Dim applicationId As UANodeId
Dim certificateGroupId As UANodeId
Dim certificateTypeId As UANodeId
Dim certificateRequest() As Byte
Dim value As UANodeId
 
value = instance.StartSigningRequest(gdsEndpointDescriptor, applicationId, certificateGroupId, certificateTypeId, certificateRequest)

[NotNull()]
UANodeId StartSigningRequest( 
   UAEndpointDescriptor gdsEndpointDescriptor,
   UANodeId applicationId,
   UANodeId certificateGroupId,
   UANodeId certificateTypeId,
   byte[] certificateRequest
)

[NotNull()]
UANodeId^ StartSigningRequest( 
   UAEndpointDescriptor^ gdsEndpointDescriptor,
   UANodeId^ applicationId,
   UANodeId^ certificateGroupId,
   UANodeId^ certificateTypeId,
   array<byte>^ certificateRequest
)

Parameters

gdsEndpointDescriptor: Endpoint descriptor. Identifies the OPC-UA server. The server must be a Global Directory Server (GDS).
applicationId: The identifier assigned to the Application record by the CertificateManager.
certificateGroupId: The NodeId of the Certificate Group which provides the context for the new request.
If OpcLabs.EasyOpc.UA.AddressSpace.UANodeId.Null the CertificateManager shall choose the DefaultApplicationGroup.
certificateTypeId: The NodeId of the CertificateType for the new Certificate.
If OpcLabs.EasyOpc.UA.AddressSpace.UANodeId.Null the CertificateManager shall generate a Certificate based on the value of the certificateGroupId argument.
certificateRequest: A CertificateRequest used to prove possession of the Private Key.
It is a PKCS #10 encoded blob in DER format.
This blob shall include the subjectAltName extension that is in the Certificate.

Return Value

The NodeId that represents the request. This value is passed to FinishRequest.

Exceptions

Exception Description

Exception	Description
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.
OpcLabs.EasyOpc.UA.OperationModel.UAException	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.

System.ArgumentNullException

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

OpcLabs.EasyOpc.UA.OperationModel.UAException

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

If you want to obtain new certificate for the current client application, it is recommended that you use the higher-level OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.BeginObtainNewCertificate method instead.

Requirements

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

Reference

IEasyUACertificateManagement Interface
IEasyUACertificateManagement Members

Send Documentation Feedback. Resources: Knowledge Base. Technical support: Online Forums, FAQ.