TrustedRoots Chilkat2 Perl Reference Documentation
Chilkat2::TrustedRoots
Current Version: 11.7.0
Markdown version of this page for AI tools (v 11.7.0) · all AI docs
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
use Chilkat2;
my $trustedRoots = Chilkat2::TrustedRoots->new;
# or set properties (and RaiseError) at creation:
# my $trustedRoots = Chilkat2::TrustedRoots->new(VerboseLogging => 1, RaiseError => 1);Creates the object. The optional pairs set writable properties (and RaiseError) in order, as if set one by one; an unknown or read-only name croaks. use Chilkat2; loads every class; the Chilkat2/TrustedRoots.pm file holds only this class's documentation (perldoc Chilkat2::TrustedRoots).
Perl frees the object when its last reference goes (undef $trustedRoots, or the variable going out of scope); there is nothing to close. Objects returned by methods are independent and freed the same way. The class may be subclassed (use parent -norequire, 'Chilkat2::TrustedRoots';): an object is a blessed hash reference whose hash is free for the subclass's own fields.
When false (the default), a method that fails returns false (or undef), and the reason is in LastErrorText. When true, it dies with a Chilkat2::Error instead, as DBI does with its RaiseError. Objects returned by a method inherit the value of the object that returned them.
Errors
A Chilkat2::Error stringifies to the failed call's full LastErrorText, and has the methods text, class ('Chilkat2::TrustedRoots'), method (the method name) and object. Methods that look something up and find nothing return undef without dying (each such method says so), methods that answer a question (HasMember, IsUnlocked, ...) return a plain boolean, and property reads and writes never fail for Chilkat reasons.
Misuse always croaks, with your file and line, whatever RaiseError is: a wrong number of arguments, a reference or undef where a string or number is expected, an object of the wrong class, an out-of-range integer, a string containing a NUL character, a wide character in a byte string, or a write to a read-only property.
Strings are Perl character strings in both directions (length, regexes and :encoding layers see characters); binary data (BinData) is a byte string. Unlocking: call Chilkat2::Global->new->UnlockBundle('...') once at startup.
Properties
DebugLogFilePath
my $strVal = $trustedRoots->DebugLogFilePath;
$trustedRoots->DebugLogFilePath($strVal);
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
my $strVal = $trustedRoots->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
my $strVal = $trustedRoots->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
my $strVal = $trustedRoots->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
my $boolVal = $trustedRoots->LastMethodSuccess;
$trustedRoots->LastMethodSuccess($boolVal);
Indicates the success or failure of the most recent method call: 1 means success, 0 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
my $intVal = $trustedRoots->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
my $boolVal = $trustedRoots->RejectSelfSignedCerts;
$trustedRoots->RejectSelfSignedCerts($boolVal);
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 0
| 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
my $boolVal = $trustedRoots->TrustSystemCaRoots;
$trustedRoots->TrustSystemCaRoots($boolVal);
Controls whether operating-system CA roots are included when this object's trust configuration is activated. The default value is 1
| 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
my $boolVal = $trustedRoots->VerboseLogging;
$trustedRoots->VerboseLogging($boolVal);
If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
my $strVal = $trustedRoots->Version;
Methods
Activate
my $success = $trustedRoots->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
TrustSystemCaRootsis1 - 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 10
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
AddCert
# $success is true or false
my $success = $trustedRoots->AddCert($cert);
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 10
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
AddJavaKeyStore
# $success is true or false
my $success = $trustedRoots->AddJavaKeyStore($keystore);
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 10
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
CertAt
# $cert is a Chilkat2::Cert
# $success is true or false
my $success = $trustedRoots->CertAt($index, $cert);
Copies the certificate at zero-based $index into the caller-supplied Cert object in $cert.
Valid indexes are from 0 through NumCerts - 1. Returns 10
This method enumerates only certificates explicitly contained in this TrustedRoots object. Operating-system roots enabled through TrustSystemCaRoots are not included.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
Deactivate
my $success = $trustedRoots->Deactivate();
Deactivates the previously activated Chilkat-wide trusted-root configuration. After deactivation, roots and single-certificate self-signed certificates are implicitly trusted.
Returns 10
Deactivate only when implicitly trusting arbitrary roots and self-signed certificates is intentional and acceptable for the application.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
LoadCaCertsPem
# $success is true or false
my $success = $trustedRoots->LoadCaCertsPem($path);
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 10
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
Events
All Chilkat methods are synchronous: the call returns when the work is done. During a long-running call, Chilkat2::TrustedRoots reports progress to handlers installed with on, which takes Event => CODE pairs (closures, so a handler can use the variables around it):
$trustedRoots->on(
PercentDone => sub { my ($pctDone) = @_; print "$pctDone%\n"; return 0 }, # a true return aborts
ProgressInfo => sub { my ($name, $value) = @_; print "$name: $value\n" },
);Installs the handlers given, replacing those installed before for the same events; undef instead of a CODE reference removes one, and $trustedRoots->on() with no arguments returns the installed handlers as a list of pairs. The event names are checked: a misspelled one croaks, and nothing is installed.
The AbortCheck handler is called periodically during long operations; PercentDone is called when an operation's completion percentage is known; ProgressInfo delivers named progress values. A true return from the AbortCheck or PercentDone handler aborts the running method, which then fails in the usual way (false or undef, or a Chilkat2::Error under RaiseError).
Handlers run during the method call, on the thread that called it. Inside a handler, other objects may be used, but calling a method of the same object (or its on) croaks. A die in a handler aborts the running method and is re-thrown from the method call; the object remains usable. A handler that uses $trustedRoots itself makes a reference cycle: weaken the captured copy (Scalar::Util) or remove the handler when done.
AbortCheck
$trustedRoots->on(AbortCheck => sub { ... });
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
my $deadline = time() + 30; # give up after 30 seconds
$trustedRoots->on(AbortCheck => sub { return time() > $deadline });PercentDone
$trustedRoots->on(PercentDone => sub { ... });
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 1. This will cause the method to terminate and return a failure status or corresponding failure value.
Example
$trustedRoots->on(PercentDone => sub {
my ($pctDone) = @_; # 0 to 100
print "Percent done: $pctDone\n";
return 0; # return a true value to abort the method in progress
});ProgressInfo
$trustedRoots->on(ProgressInfo => sub { ... });
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->on(ProgressInfo => sub {
my ($name, $value) = @_;
print "$name: $value\n";
});