TrustedRoots VB.NET Reference Documentation

TrustedRoots

Current Version: 11.1.0

Used to set and manage the CA root certificates trusted by your application. This applies to PKCS7 (S/MIME) signature validation and SSL/TLS server certificates.

Object Creation

Dim obj As New Chilkat.TrustedRoots()

Properties

DebugLogFilePath
DebugLogFilePath As String

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

  • A timeout property set to 0, indicating an infinite timeout.
  • A hang occurring within an event callback in the application code.
  • An internal bug in the Chilkat code causing the hang.

More Information and Examples
top
LastErrorHtml
LastErrorHtml As String (ReadOnly)

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorText
LastErrorText As String (ReadOnly)

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorXml
LastErrorXml As String (ReadOnly)

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastMethodSuccess
LastMethodSuccess As Boolean

Indicates the success or failure of the most recent method call: True means success, False means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

top
NumCerts
NumCerts As Integer (ReadOnly)
Introduced in version 9.5.0.38

The number of certificates contained within this object.

This is the number of certificates explicitly added by the methods AddCert, AddJavaKeyStore, and LoadCaCertsPem.

top
RejectSelfSignedCerts
RejectSelfSignedCerts As Boolean
Introduced in version 9.5.0.80

Indicates whether all self-signed certificates are to be rejected in SSL/TLS connections. The default value of this property is False.

Note: This is for the case where the server certificate chain of authentication is 1 certificate long (i.e. the TLS server certificate itself is self-signed).

top
TrustSystemCaRoots
TrustSystemCaRoots As Boolean
Introduced in version 9.5.0.41

Indicates whether the operating system's CA root certificates are automatically trusted.

On a Windows operating system, this would be the registry-based CA certificate stores. On a Linux system, this could be /etc/ssl/certs/ca-certificates.crt, if it exists. The default value is True. Set this property equal to False to prevent Chilkat from automatically trusting system-provided root CA certificates.

More Information and Examples
top
VerboseLogging
VerboseLogging As Boolean

If set to True, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is False. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
Version As String (ReadOnly)

Version of the component/library, such as "10.1.0"

More Information and Examples
top

Methods

Activate
Function Activate() As Boolean
Introduced in version 9.5.0.38

Activates this collection of trusted roots as the set of CA and self-signed root certificates that are to be trusted Chilkat-wide for PKCS7 signature validation and SSL/TLS server certificate validation.

More Information and Examples
top
AddCert
Function AddCert(ByVal cert As Cert) As Boolean
Introduced in version 9.5.0.41

Adds a certificate to the collection of trusted roots.

top
AddJavaKeyStore
Function AddJavaKeyStore(ByVal keystore As JavaKeyStore) As Boolean
Introduced in version 9.5.0.44

Adds the trusted certificates from a Java key store to the collection of trusted roots.

Returns True for success, False for failure.

top
AddJavaKeyStoreAsync (1)
Function AddJavaKeyStoreAsync(ByVal keystore As JavaKeyStore) As Task
Introduced in version 9.5.0.44

Creates an asynchronous task to call the AddJavaKeyStore method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

top
CertAt
Function CertAt(ByVal index As Integer, ByVal cert As Cert) As Boolean
Introduced in version 11.0.0

Returns in cert the Nth cert contained within this object. The 1st certificate is at index 0.

Returns True for success, False for failure.

top
Deactivate
Function Deactivate() As Boolean
Introduced in version 9.5.0.40

Deactivates a previous set of activated trusted roots so that all roots / self-signed certificates are implicitly trusted.

Returns True for success, False for failure.

top
LoadCaCertsPem
Function LoadCaCertsPem(ByVal path As String) As Boolean
Introduced in version 9.5.0.38

Loads a CA bundle in PEM format. This is a file containing CA root certificates that are to be trusted. An example of one such file is the CA certs from mozilla.org exported to a cacert.pem file by the mk-ca-bundle tool located here: http://curl.haxx.se/docs/caextract.html.

Note: This can also be called to load the /etc/ssl/certs/ca-certificates.crt file on Linux systems.

More Information and Examples
top
LoadCaCertsPemAsync (1)
Function LoadCaCertsPemAsync(ByVal path As String) As Task
Introduced in version 9.5.0.38

Creates an asynchronous task to call the LoadCaCertsPem method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

top
LoadTaskCaller
Function LoadTaskCaller(ByVal task As Task) As Boolean
Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns True for success, False for failure.

top

Events

AbortCheck
Event OnAbortCheck

Enables a method call to be aborted by triggering the AbortCheck event at intervals defined by the HeartbeatMs property. If HeartbeatMs is set to its default value of 0, no events will occur. For instance, set HeartbeatMs to 200 to trigger 5 AbortCheck events per second.

More Information and Examples

Args are passed using Chilkat.AbortCheckEventArgs

Event callback implementation:

Dim WithEvents trustedroots As Chilkat.TrustedRoots

Private Sub trustedroots_OnAbortCheck(sender As Object, args As Chilkat.AbortCheckEventArgs) Handles trustedroots.OnAbortCheck

    ...

End Sub
top
PercentDone
Event OnPercentDone

This provides the percentage completion for any method involving network communications or time-consuming processing, assuming the progress can be measured as a percentage. This event is triggered only when it's possible and logical to express the operation's progress as a percentage. The pctDone argument will range from 1 to 100. For methods that finish quickly, the number of PercentDone callbacks may vary, but the final callback will have pctDone equal to 100. For longer operations, callbacks will not exceed one per percentage point (e.g., 1, 2, 3, ..., 98, 99, 100).

The PercentDone callback also acts as an AbortCheck event. For fast methods where PercentDone fires, an AbortCheck event may not trigger since the PercentDone callback already provides an opportunity to abort. For longer operations, where time between PercentDone callbacks is extended, AbortCheck callbacks enable more responsive operation termination.

To abort the operation, set the abort output argument to True. This will cause the method to terminate and return a failure status or corresponding failure value.

More Information and Examples

Args are passed using Chilkat.PercentDoneEventArgs

Event callback implementation:

Dim WithEvents trustedroots As Chilkat.TrustedRoots

Private Sub trustedroots_OnPercentDone(sender As Object, args As Chilkat.PercentDoneEventArgs) Handles trustedroots.OnPercentDone

    ...

End Sub
top
ProgressInfo
Event OnProgressInfo

This event callback provides tag name/value pairs that detail what occurs during a method call. To discover existing tag names, create code to handle the event, emit the pairs, and review them. Most tag names are self-explanatory.

More Information and Examples

Args are passed using Chilkat.ProgressInfoEventArgs

Event callback implementation:

Dim WithEvents trustedroots As Chilkat.TrustedRoots

Private Sub trustedroots_OnProgressInfo(sender As Object, args As Chilkat.ProgressInfoEventArgs) Handles trustedroots.OnProgressInfo

    ...

End Sub
top
TaskCompleted
Event OnTaskCompleted

Called from the background thread when an asynchronous task completes.

More Information and Examples

Args are passed using Chilkat.TaskCompletedEventArgs

Event callback implementation:

Dim WithEvents trustedroots As Chilkat.TrustedRoots

Private Sub trustedroots_OnTaskCompleted(sender As Object, args As Chilkat.TaskCompletedEventArgs) Handles trustedroots.OnTaskCompleted

    ...

End Sub
top

Deprecated

GetCert
Function GetCert(ByVal index As Integer) As Cert
Introduced in version 9.5.0.38
This method is deprecated and replaced by CertAt

This method is deprecated. Applications should instead call CertAt.

Returns the Nth cert contained within this object. The 1st certificate is at index 0.

Returns Nothing on failure

More Information and Examples
top