TrustedRoots Dart Reference Documentation
CkTrustedRoots
Current Version: 11.6.1
Chilkat.TrustedRoots
Add root or CA certificates that should be trusted by Chilkat validation
operations.
Load one or more trusted CA certificates from PEM bundle files used by
many TLS and certificate-validation workflows.
Import trusted certificates from a
Choose whether Chilkat should also trust the operating system's CA root
certificates.
Control whether self-signed server certificates are rejected or accepted
during certificate validation.
Activate the configured trusted-root set so it is used by Chilkat classes
that perform TLS or signature certificate validation.
For an extended overview, see
TrustedRoots Class Overview.
Configure the trusted root certificates used by Chilkat certificate validation.
Chilkat.TrustedRoots manages a collection of trusted CA and
self-signed root certificates used Chilkat-wide for PKCS7/CMS signature
validation and SSL/TLS server certificate validation. It can add individual
certificates, import trusted certificates from a Java keystore, load PEM CA
bundles, activate or deactivate the trusted-root set, and control whether
system CA roots and self-signed server certificates are trusted.
Custom trusted roots
PEM CA bundles
Java keystore import
JavaKeyStore when trust
anchors are maintained in JKS-style storage.
System CA root control
Self-signed certificate policy
Activate Chilkat-wide trust
TrustedRoots object, add trusted certificates or load a
PEM CA bundle, configure whether system roots and self-signed certificates
should be trusted, then call Activate. Treat trusted roots as
Chilkat-wide validation configuration, not as private state for a single
object.
Object Creation
// pubspec.yaml:
// dependencies:
// chilkat: ^11.6.1
import 'package:chilkat/chilkat.dart';
// Once per process, before any other Chilkat call:
Chilkat.unlockBundle('Anything for 30-day trial'); // shorthand for CkGlobal().unlockBundle(..)
final trustedRoots = CkTrustedRoots();
// ... the native object is released when `trustedRoots` is garbage collected, or now with trustedRoots.dispose().Creates the underlying native Chilkat object. Use a CkTrustedRoots only from the isolate that created it: Chilkat objects cannot be sent between isolates. Every call is synchronous; in a Flutter app, run long operations (network, large files) inside Isolate.run, creating the Chilkat objects inside the isolate.
Releases the native object immediately instead of waiting for garbage collection (useful for a large CkBinData or an open socket). Calling it more than once is harmless; any other use of the object afterwards throws a StateError. isDisposed tells whether it has been called.
Errors
A method that can fail throws a ChilkatException: a method whose only outcome is success or failure returns void and throws on failure; a method producing a String or an object returns it and throws where Chilkat would have returned null. The exception carries the object's LastErrorText at the time of the failure (lastErrorText), the class and method names (className, methodName) and a one-line message. Properties never throw, and methods that answer a question (has..., is..., ...) return a plain bool.
try {
trustedRoots.someMethod(...);
} on ChilkatException catch (e) {
print(e); // CkTrustedRoots.someMethod failed: <reason>
print(e.lastErrorText); // the full Chilkat log of the failed call
}Properties
DebugLogFilePath
String get debugLogFilePath
set debugLogFilePath(String value)
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.
LastErrorHtml
String get lastErrorHtml
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.
topLastErrorText
String get lastErrorText
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.
LastErrorXml
String get lastErrorXml
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.
topLastMethodSuccess
bool get lastMethodSuccess
set lastMethodSuccess(bool value)
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. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
NumCerts
int get numCerts
The number of certificates explicitly contained in this object. The count includes certificates added by AddCert, AddJavaKeyStore, and LoadCaCertsPem.
Use indexes from 0 through NumCerts - 1 with CertAt.
TrustSystemCaRoots. It reports only the certificates stored in this object.
RejectSelfSignedCerts
bool get rejectSelfSignedCerts
set rejectSelfSignedCerts(bool value)
Controls the special case in which an SSL/TLS server presents a certificate chain containing exactly one certificate and that certificate is self-signed. The default value is false
| Value | Behavior |
|---|---|
| Do not reject a one-certificate TLS chain solely because the certificate is self-signed. |
| Reject TLS server chains consisting of one self-signed certificate. |
This property applies to the TLS server-certificate case described above. It does not reject a self-signed CA certificate merely because that certificate appears as the trust anchor above a longer chain.
TrustSystemCaRoots
bool get trustSystemCaRoots
set trustSystemCaRoots(bool value)
Controls whether operating-system CA roots are included when this object's trust configuration is activated. The default value is true
| Value | Behavior |
|---|---|
| Trust explicitly added certificates and the system-provided CA roots available to Chilkat. |
| Do not automatically trust system-provided CA roots; use the explicitly configured collection and the selected self-signed-certificate policy. |
On Windows, system roots come from registry-based certificate stores. On Linux, Chilkat may use a system CA bundle such as /etc/ssl/certs/ca-certificates.crt when available.
System roots are not added to this object's explicit collection and therefore are not included in NumCerts or returned by CertAt.
VerboseLogging
bool get verboseLogging
set verboseLogging(bool value)
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.
Version
String get version
Methods
Activate
Activates this object's trust configuration for Chilkat-wide certificate validation. The active configuration includes:
- Certificates explicitly added to this object by
AddCert,AddJavaKeyStore, orLoadCaCertsPem. - Operating-system CA roots when
TrustSystemCaRootsistrue - The self-signed TLS certificate policy selected by
RejectSelfSignedCerts.
After activation, Chilkat classes that validate PKCS7/CMS signatures or SSL/TLS server certificate chains use this trust configuration. Returns truefalse
Returns normally on success; throws a ChilkatException on failure.
AddCert
Adds the certificate in cert to this object's explicit trusted-certificate collection. The certificate is subsequently treated as a trust anchor when this configuration is activated.
Returns truefalse
Returns normally on success; throws a ChilkatException on failure.
AddJavaKeyStore
Adds the certificates designated as trusted entries in the keystore JavaKeyStore to this object's explicit trusted-certificate collection.
Private keys and secret keys are not imported. Returns truefalse
Returns normally on success; throws a ChilkatException on failure.
CertAt
Copies the certificate at zero-based index into the caller-supplied Cert object in cert.
Valid indexes are from 0 through NumCerts - 1. Returns truefalse
This method enumerates only certificates explicitly contained in this TrustedRoots object. Operating-system roots enabled through TrustSystemCaRoots are not included.
Returns normally on success; throws a ChilkatException on failure.
Deactivate
Deactivates the previously activated Chilkat-wide trusted-root configuration. After deactivation, roots and single-certificate self-signed certificates are implicitly trusted.
Returns truefalse
Deactivate only when implicitly trusting arbitrary roots and self-signed certificates is intentional and acceptable for the application.
Returns normally on success; throws a ChilkatException on failure.
LoadCaCertsPem
Loads one or more PEM-encoded certificates from the file at path and adds them to this object's explicit trusted-certificate collection. A CA bundle normally contains consecutive -----BEGIN CERTIFICATE----- / -----END CERTIFICATE----- blocks.
This method can load a curated application bundle, a Mozilla-derived CA bundle, or a platform bundle such as /etc/ssl/certs/ca-certificates.crt when that file exists. Returns truefalse
Returns normally on success; throws a ChilkatException on failure.
Events
All Chilkat methods are synchronous: the call returns when the work is done. During a call, CkTrustedRoots raises three events so your application can show progress and offer a way out. Each event is a nullable callback property on the object; assign a function to receive it, or null to stop receiving it:
final trustedRoots = CkTrustedRoots();
trustedRoots.onPercentDone = (pct) {
print('$pct%');
return false; // return true to abort the method in progress
};
trustedRoots.onProgressInfo = (name, value) => print('$name: $value');
trustedRoots.heartbeatMs = 250; // raise onAbortCheck 4 times per second during Chilkat calls
trustedRoots.onAbortCheck = () => _userPressedCancel;AbortCheck fires at regular intervals controlled by the HeartbeatMs property (0, the default, disables it); PercentDone fires when an operation's completion percentage is known; ProgressInfo delivers named progress values. Returning true from onAbortCheck or onPercentDone aborts the running method, which then throws a ChilkatException.
Events fire on the thread that called the method, before that method returns. An exception thrown inside a callback aborts the running method and is rethrown from it once the native library has returned. In a Flutter app the callbacks run inside the worker isolate that owns the object; forward progress to the UI through a SendPort, and let onAbortCheck read a flag the UI sets the same way.
AbortCheck
bool Function()? 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.
Example:
trustedRoots.heartbeatMs = 250; // call onAbortCheck 4 times per second
var cancelRequested = false;
trustedRoots.onAbortCheck = () => cancelRequested;
// ... set cancelRequested = true (e.g. from a message received on a ReceivePort) to abort the method in progressPercentDone
bool Function(int pctDone)? 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.
Example:
trustedRoots.onPercentDone = (pct) {
// pct ranges from 1 to 100.
print('Percent done: $pct');
return false; // return true to abort the method in progress
};ProgressInfo
void Function(String name, String value)? 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.
Note: Some Chilkat methods don't fire any ProgressInfo events.
Example:
trustedRoots.onProgressInfo = (name, value) => print('$name: $value');