TrustedRoots Classic ASP Reference Documentation
TrustedRoots
Current Version: 11.6.0
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
set trustedRoots = Server.CreateObject("Chilkat.TrustedRoots")
' ... use trustedRoots ...
set trustedRoots = NothingClassic ASP creates Chilkat objects with Server.CreateObject. The registered Chilkat ActiveX must match the bitness of the IIS application pool: a pool with Enable 32-Bit Applications set to True needs the 32-bit ActiveX, otherwise the 64-bit ActiveX. To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as Server.CreateObject("Chilkat.TrustedRoots.11") for Chilkat v11.*.*.
VBScript requires set when assigning an object, so the signatures on this page show set x = obj.Method(...) for methods that return a Chilkat object; test the result with Is Nothing, since a method that fails to return an object returns Nothing. A method with no return value is called as a statement without parentheses (obj.Method arg1, arg2). Boolean properties, arguments and return values are integers in the ActiveX: pass 1 or 0, and test success with = 1. Byte arrays are Variant arrays and can be sent with Response.BinaryWrite. Asynchronous (*Async) methods and event callbacks are not used from Classic ASP.
Properties
DebugLogFilePath
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.
LastBinaryResult
This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to 1. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.
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
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
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
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.
LastStringResult
In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.
LastStringResultLen
The length, in characters, of the string contained in the LastStringResult property.
topNumCerts
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
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
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
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
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
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
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 10
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 10
Returns 1 for success, 0 for 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 10
This method enumerates only certificates explicitly contained in this TrustedRoots object. Operating-system roots enabled through TrustSystemCaRoots are not included.
Returns 1 for success, 0 for failure.
topDeactivate
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 1 for success, 0 for failure.
topLoadCaCertsPem
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
Deprecated
GetCert
Returns the certificate at zero-based index in this object's explicitly added certificate collection.
This method is deprecated. New applications should call CertAt, which returns an explicit success/failure result and stores the certificate in a caller-supplied Cert object.
Valid indexes are from 0 through NumCerts - 1. Operating-system roots enabled by TrustSystemCaRoots are not part of this indexed collection.
Returns Nothing on failure