 |
.NET Based OPC UA Client/Server SDK
2.6.1.422
|
|
.NET Based OPC UA Client/Server SDK
2.6.1.422
|
The interface for methods implemented on the TrustListModel object. More...
Inherits UnifiedAutomation.UaServer.IFileMethods.
Inherited by UnifiedAutomation.UaServer.TrustListModel.
Public Member Functions | |
| StatusCode | AddCertificate (RequestContext context, TrustListModel model, byte[] Certificate, bool IsTrustedCertificate) |
| Allows a Client to add a single certificate to the trust list. More... | |
| StatusCode | CloseAndUpdate (RequestContext context, TrustListModel model, uint FileHandle, out bool ApplyChangesRequired) |
| Closes the file and applies the changes to the trust list. More... | |
| StatusCode | OpenWithMasks (RequestContext context, TrustListModel model, uint Masks, out uint FileHandle) |
| Allows a Client to read only the portion of the trust list. More... | |
| StatusCode | RemoveCertificate (RequestContext context, TrustListModel model, string Thumbprint, bool IsTrustedCertificate) |
| Allows a Client to remove a single certificate from the trust list. More... | |
 Public Member Functions inherited from UnifiedAutomation.UaServer.IFileMethods | |
| StatusCode | Close (RequestContext context, FileModel model, uint FileHandle) |
| Closes a file represented by a UnifiedAutomation.UaServer.FileModel. More... | |
| StatusCode | GetPosition (RequestContext context, FileModel model, uint FileHandle, out ulong Position) |
| Provides the current position of the FileHandle. More... | |
| StatusCode | Open (RequestContext context, FileModel model, byte Mode, out uint FileHandle) |
| Opens a file represented by an object of UnifiedAutomation.UaServer.FileModel. More... | |
| StatusCode | Read (RequestContext context, FileModel model, uint FileHandle, int Length, out byte[] Data) |
| Reads a part of the file starting from the current file position. More... | |
| StatusCode | SetPosition (RequestContext context, FileModel model, uint FileHandle, ulong Position) |
| Sets the current position of the FileHandle. More... | |
| StatusCode | Write (RequestContext context, FileModel model, uint FileHandle, byte[] Data) |
| Writes a part of the file starting from the current file position. More... | |
The interface for methods implemented on the TrustListModel object.
| StatusCode UnifiedAutomation.UaServer.ITrustListMethods.AddCertificate | ( | RequestContext | context, |
| TrustListModel | model, | ||
| byte[] | Certificate, | ||
| bool | IsTrustedCertificate | ||
| ) |
Allows a Client to add a single certificate to the trust list.
The Server shall verify that the certificate is valid according to the mandatory rules defined in Part 4 of the OPC UA Specification. If an invalid certificate is found, the Server shall return an error and shall not update the trust list.
This method cannot be called if the file object is open.
Method Result Codes
| Result Code | Description |
|---|---|
| Bad_UserAccessDenied | The current user does not have the rights required. |
| Bad_CertificateInvalid | The certificate to add is invalid. |
| Bad_InvalidState | The object is opened. |
| context | |
| model | |
| Certificate | The DER encoded certificate to add. |
| IsTrustedCertificate | If TRUE, the certificate is added to the trusted certificate s list. If FALSE, the certificate is added to the Issuer certificate s list. |
Implemented in UnifiedAutomation.UaServer.TrustListModel.
| StatusCode UnifiedAutomation.UaServer.ITrustListMethods.CloseAndUpdate | ( | RequestContext | context, |
| TrustListModel | model, | ||
| uint | FileHandle, | ||
| out bool | ApplyChangesRequired | ||
| ) |
Closes the file and applies the changes to the trust list.
This method can only be called if the file was opened for writing. If the Close method is called, any cached data is discarded and the trust list is not changed.
The Server shall verify that every certificate in the new trust list is valid according to the mandatory rules defined in Part 4 of the OPC UA Specification. If an invalid certificate is found, the Server shall return an error and shall not update the trust list. If only part of the trust list is being updated, the Server creates a temporary trust list that includes the existing trust list plus any updates and validates the temporary trust list.
If the file cannot be processed, this method still closes the file and discards the data before returning an error. This method is required if the Server supports updates to the trust list.
The structure uploaded includes a mask that specifies which fields are updated. If a bit is not set, the associated field is not changed.
Method Result Codes
| Result Code | Description |
|---|---|
| Bad_UserAccessDenied | The current user does not have the rights required. |
| Bad_CertificateInvalid | The Server could not validate all certificate s in the trust list. The DiagnosticInfo shall specify which certificate (s) are invalid and the specific error. |
| context | |
| model | |
| FileHandle | The handle of the previously opened file. |
| ApplyChangesRequired | A flag indicating whether the UnifiedAutomation.UaServer.IServerConfigurationMethods.ApplyChanges method must be called before the new trust list will be used by the Server. |
Implemented in UnifiedAutomation.UaServer.TrustListModel.
| StatusCode UnifiedAutomation.UaServer.ITrustListMethods.OpenWithMasks | ( | RequestContext | context, |
| TrustListModel | model, | ||
| uint | Masks, | ||
| out uint | FileHandle | ||
| ) |
Allows a Client to read only the portion of the trust list.
This method can only be used to read the trust list.
Method Result Codes
| Result Code | Description |
|---|---|
| Bad_UserAccessDenied | The current user does not have the rights required. |
| context | |
| model | |
| Masks | The parts of the trust list that are to be included in the file to read. |
| FileHandle | The handle of the newly opened file. |
Implemented in UnifiedAutomation.UaServer.TrustListModel.
| StatusCode UnifiedAutomation.UaServer.ITrustListMethods.RemoveCertificate | ( | RequestContext | context, |
| TrustListModel | model, | ||
| string | Thumbprint, | ||
| bool | IsTrustedCertificate | ||
| ) |
Allows a Client to remove a single certificate from the trust list.
This method returns Bad_InvalidArgument if the thumbprint does not match a certificate in the trust list.
This method cannot be called if the file object is open.
Method Result Codes
| Result Code | Description |
|---|---|
| Bad_UserAccessDenied | The current user does not have the rights required. |
| Bad_InvalidArgument | The certificate to remove was not found. |
| Bad_InvalidState | The object is opened. |
| context | |
| model | |
| Thumbprint | The SHA1 hash of the certificate to remove. |
| IsTrustedCertificate | If TRUE, the certificate is removed from the trusted certificate s list. If FALSE, the certificate is removed from the Issuer certificate s list. |
Implemented in UnifiedAutomation.UaServer.TrustListModel.