---
product: Chilkat
product_version: 11.7.0
language: sqlserver
language_label: SQL Server
class: TrustedRoots
license: free
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/sqlserver_TrustedRootsRef.html
---
# Chilkat TrustedRoots — SQL Server — v11.7.0

> Chilkat 11.7.0 · language=sqlserver · class=TrustedRoots
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/TrustedRoots.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/sqlserver/guide.md`.

## Purpose

**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**

Add root or CA certificates that should be trusted by Chilkat validation operations.

**PEM CA bundles**

Load one or more trusted CA certificates from PEM bundle files used by many TLS and certificate-validation workflows.

**Java keystore import**

Import trusted certificates from a `JavaKeyStore` when trust anchors are maintained in JKS-style storage.

**System CA root control**

Choose whether Chilkat should also trust the operating system's CA root certificates.

**Self-signed certificate policy**

Control whether self-signed server certificates are rejected or accepted during certificate validation.

**Activate Chilkat-wide trust**

Activate the configured trusted-root set so it is used by Chilkat classes that perform TLS or signature certificate validation.

**Common pattern:** Create a `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.

For an extended overview, see [TrustedRoots Class Overview](https://www.chilkatsoft.com/trustedroots_class_overview.asp).

## Object creation, unlocking and error handling

**Object Creation**

```sql
DECLARE @hr int
DECLARE @trustedRoots int
EXEC @hr = sp_OACreate 'Chilkat.TrustedRoots', @trustedRoots OUT
IF @hr <> 0
BEGIN
    PRINT 'Failed to create ActiveX component'
    RETURN
END

-- ... use @trustedRoots ...

EXEC @hr = sp_OADestroy @trustedRoots
```

T-SQL uses the Chilkat ActiveX through the OLE Automation stored procedures. They must be enabled once on the server (`EXEC sp_configure 'Ole Automation Procedures', 1; RECONFIGURE;`), and the Chilkat ActiveX registered must match the bitness of the SQL Server instance (64-bit for a 64-bit SQL Server). To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as `sp_OACreate 'Chilkat.TrustedRoots.11'` for Chilkat v11.\*.\*.

`sp_OACreate` returns an object token (an `int`) that is passed as the first argument of every `sp_OAMethod`, `sp_OAGetProperty` and `sp_OASetProperty` call, and released with `sp_OADestroy`. Objects returned by methods (such as an `HttpResponse` or `JsonObject`) are also tokens received through an `int` OUT parameter; they must likewise be destroyed, and the OUT parameter is `NULL` when the method fails to return an object. Objects passed as arguments are passed by their token. When an OLE Automation procedure itself fails (non-zero `@hr`), `sp_OAGetErrorInfo` describes the error.

Data types: strings are `nvarchar(4000)`; integers, booleans (1 or 0) and object tokens are `int`; dates are `datetime`. In the signatures on this page, `@success`, `@iResult`, `@sResult` and the like are the OUT variables receiving a method's return value, `@iValue` / `@sValue` receive or supply a property value, and the remaining `@` variables are the method's arguments in order.

A string returned through an OUT parameter is limited to 4000 characters. For longer values, retrieve the result as a result set into a table variable instead of an OUT parameter, for example `DECLARE @tmp TABLE (outputLine ntext)` followed by `INSERT INTO @tmp EXEC sp_OAGetProperty @trustedRoots, 'LastErrorText'`. See [string length limitations for strings returned by sp_OAMethod calls](https://www.chilkatsoft.com/sql_server_nvarchar_max_limitation.asp).

Methods that pass or return raw byte arrays are not shown on this page, because `varbinary(max)` values cannot be exchanged through `sp_OAMethod` (see [varbinary(max) limitation](https://www.chilkatsoft.com/sql_server_varbinary_max_limitation.asp)). Use the `BinData`-based alternatives (methods ending in *Bd*) or the base64 / hex string-encoded variants instead. Binary *properties* (such as `LastBinaryResult`) can be retrieved as a result set into a table variable, as shown in their signatures. Asynchronous (*\*Async*) methods and event callbacks are not available from SQL Server.

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in SQL Server.

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `EXEC sp_OAGetProperty @trustedRoots, 'DebugLogFilePath', @sValue OUT EXEC sp_OASetProperty @trustedRoots, 'DebugLogFilePath', @sValue` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastBinaryResult` | `INSERT INTO @tmp EXEC sp_OAGetProperty @trustedRoots, 'LastBinaryResult'` | read-only | This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. |
| `LastErrorHtml` | `EXEC sp_OAGetProperty @trustedRoots, 'LastErrorHtml', @sValue OUT` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `EXEC sp_OAGetProperty @trustedRoots, 'LastErrorText', @sValue OUT` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `EXEC sp_OAGetProperty @trustedRoots, 'LastErrorXml', @sValue OUT` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `EXEC sp_OAGetProperty @trustedRoots, 'LastMethodSuccess', @iValue OUT EXEC sp_OASetProperty @trustedRoots, 'LastMethodSuccess', @iValue` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `LastStringResult` | `EXEC sp_OAGetProperty @trustedRoots, 'LastStringResult', @sValue OUT` | read-only | In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. |
| `LastStringResultLen` | `EXEC sp_OAGetProperty @trustedRoots, 'LastStringResultLen', @iValue OUT` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `EXEC sp_OAGetProperty @trustedRoots, 'VerboseLogging', @iValue OUT EXEC sp_OASetProperty @trustedRoots, 'VerboseLogging', @iValue` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `EXEC sp_OAGetProperty @trustedRoots, 'Version', @sValue OUT` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `NumCerts` | property, read-only | `EXEC sp_OAGetProperty @trustedRoots, 'NumCerts', @iValue OUT` |
| `RejectSelfSignedCerts` | property, read/write | `EXEC sp_OAGetProperty @trustedRoots, 'RejectSelfSignedCerts', @iValue OUT EXEC sp_OASetProperty @trustedRoots, 'RejectSelfSignedCerts', @iValue` |
| `TrustSystemCaRoots` | property, read/write | `EXEC sp_OAGetProperty @trustedRoots, 'TrustSystemCaRoots', @iValue OUT EXEC sp_OASetProperty @trustedRoots, 'TrustSystemCaRoots', @iValue` |
| `Activate` | method | `EXEC sp_OAMethod @trustedRoots, 'Activate', @success OUT` |
| `AddCert` | method | `EXEC sp_OAMethod @trustedRoots, 'AddCert', @success OUT, @cert` |
| `AddJavaKeyStore` | method | `EXEC sp_OAMethod @trustedRoots, 'AddJavaKeyStore', @success OUT, @keystore` |
| `CertAt` | method | `EXEC sp_OAMethod @trustedRoots, 'CertAt', @success OUT, @index, @cert` |
| `Deactivate` | method | `EXEC sp_OAMethod @trustedRoots, 'Deactivate', @success OUT` |
| `LoadCaCertsPem` | method | `EXEC sp_OAMethod @trustedRoots, 'LoadCaCertsPem', @success OUT, @path` |

Deprecated members are listed at the end of this file with their replacements; do not use them in new code.

## Properties

### TrustedRoots.NumCerts

`Chilkat 11.7.0 · sqlserver · TrustedRoots · NumCerts · property · read-only · since 9.5.0.38`

```sql
EXEC sp_OAGetProperty @trustedRoots, 'NumCerts', @iValue OUT
```

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`.

**Scope of the count:** This property does not include operating-system CA roots made available by `TrustSystemCaRoots`. It reports only the certificates stored in this object.

### TrustedRoots.RejectSelfSignedCerts

`Chilkat 11.7.0 · sqlserver · TrustedRoots · RejectSelfSignedCerts · property · read/write · since 9.5.0.80`

```sql
EXEC sp_OAGetProperty @trustedRoots, 'RejectSelfSignedCerts', @iValue OUT
EXEC sp_OASetProperty @trustedRoots, 'RejectSelfSignedCerts', @iValue
```

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 |
| :--- | :--- |
| `0` | Do not reject a one-certificate TLS chain solely because the certificate is self-signed. |
| `1` | 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.

**Security guidance:** A self-signed certificate has no external issuer establishing trust. Accept it only when the certificate or its public-key fingerprint has been authenticated through a separate trusted channel.

### TrustedRoots.TrustSystemCaRoots

`Chilkat 11.7.0 · sqlserver · TrustedRoots · TrustSystemCaRoots · property · read/write · since 9.5.0.41`

```sql
EXEC sp_OAGetProperty @trustedRoots, 'TrustSystemCaRoots', @iValue OUT
EXEC sp_OASetProperty @trustedRoots, 'TrustSystemCaRoots', @iValue
```

Controls whether operating-system CA roots are included when this object's trust configuration is activated. The default value is `1`.

| Value | Behavior |
| :--- | :--- |
| `1` | Trust explicitly added certificates and the system-provided CA roots available to Chilkat. |
| `0` | 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`.

## Methods

### TrustedRoots.Activate

`Chilkat 11.7.0 · sqlserver · TrustedRoots · Activate · method · since 9.5.0.38`

```sql
EXEC sp_OAMethod @trustedRoots, 'Activate', @success OUT
```

Activates this object's trust configuration for Chilkat-wide certificate validation. The active configuration includes:

- Certificates explicitly added to this object by `AddCert`, `AddJavaKeyStore`, or `LoadCaCertsPem`.
- Operating-system CA roots when `TrustSystemCaRoots` is `1`.
- 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 `1` if the configuration was activated successfully; otherwise returns `0`.

**Trust-anchor note:** Activating a certificate as trusted supplies a starting point for certificate-path validation. It does not, by itself, prove that every certificate issued beneath that anchor is valid for every purpose; the applicable validation operation may also evaluate signatures, validity periods, identity, key usage, constraints, and other policy requirements.

Returns 1 for success, 0 for failure.

### TrustedRoots.AddCert

`Chilkat 11.7.0 · sqlserver · TrustedRoots · AddCert · method · since 9.5.0.41`

```sql
EXEC sp_OAMethod @trustedRoots, 'AddCert', @success OUT, @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 `1` if the certificate was added successfully; otherwise returns `0`.

**Security-sensitive operation:** Calling this method is an explicit trust decision. It does not first determine whether the certificate is self-signed, belongs to a public CA, is currently valid, or is appropriate for the intended application. Add only certificates obtained and verified through a trustworthy process.

Returns 1 for success, 0 for failure.

### TrustedRoots.AddJavaKeyStore

`Chilkat 11.7.0 · sqlserver · TrustedRoots · AddJavaKeyStore · method · since 9.5.0.44`

```sql
EXEC sp_OAMethod @trustedRoots, 'AddJavaKeyStore', @success OUT, @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 `1` if the trusted certificates were added successfully; otherwise returns `0`.

**Java keystore terminology:** A trusted-certificate entry represents a certificate that the keystore owner has chosen to trust. Importing it preserves that trust decision; it does not independently validate the certificate or build a certification path for it.

Returns 1 for success, 0 for failure.

### TrustedRoots.CertAt

`Chilkat 11.7.0 · sqlserver · TrustedRoots · CertAt · method · since 11.0.0`

```sql
EXEC sp_OAMethod @trustedRoots, 'CertAt', @success OUT, @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 `1` if the certificate was retrieved successfully; otherwise returns `0`, such as when the index is outside the valid range.

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.

### TrustedRoots.Deactivate

`Chilkat 11.7.0 · sqlserver · TrustedRoots · Deactivate · method · since 9.5.0.40`

```sql
EXEC sp_OAMethod @trustedRoots, 'Deactivate', @success OUT
```

Deactivates the previously activated Chilkat-wide trusted-root configuration. After deactivation, roots and single-certificate self-signed certificates are implicitly trusted.

Returns `1` if the active configuration was deactivated successfully; otherwise returns `0`.

**Security warning:** This is a permissive mode. It does not merely restore a conventional “trust the operating-system CA store” policy. Use `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.

### TrustedRoots.LoadCaCertsPem

`Chilkat 11.7.0 · sqlserver · TrustedRoots · LoadCaCertsPem · method · since 9.5.0.38`

```sql
EXEC sp_OAMethod @trustedRoots, 'LoadCaCertsPem', @success OUT, @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 `1` if the bundle was loaded successfully; otherwise returns `0`.

**Trust implication:** Certificates loaded by this method are treated as trusted anchors after activation. The file is not merely a source of intermediate certificates. Review and protect the bundle as security-sensitive configuration.

Returns 1 for success, 0 for failure.

## Events and callbacks

This binding has no event callbacks.

## Deprecated members — do not use in new code

| Member | Kind | Deprecated in | Use instead |
|---|---|---|---|
| `GetCert` | method | before 11.6.1 | `CertAt` |

## Related classes

[`Cert`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/sqlserver/classes/Cert.md), [`JavaKeyStore`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/sqlserver/classes/JavaKeyStore.md)

