---
product: Chilkat
product_version: 11.7.0
language: xojo
language_label: Xojo
class: Secrets
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/xojoSecretsRef.html
---
# Chilkat Secrets — Xojo — v11.7.0

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

## Purpose

**Manage application secrets through one consistent API.**

`Chilkat.Secrets` provides a unified interface for storing, retrieving, listing, and deleting secrets across local, cloud-based, and in-memory secret stores. It supports string, binary, and JSON secrets, making it useful for passwords, API keys, OAuth credentials, tokens, unlock codes, certificates, and private configuration data.

**Local secure storage**

- Windows Credential Manager
- Apple Keychain

**Cloud secret managers**

- AWS Secrets Manager
- Azure Key Vault
- IBM Cloud Secrets Manager
- Oracle Cloud Secrets
- Doppler Secrets

**Temporary secrets**

Use in-memory secrets when values should exist only for the lifetime of the running process.

**Flexible content types**

Store and retrieve secrets as strings, binary data, or structured JSON.

**Note:** Cloud-based secret managers often require local bootstrap credentials. These can be stored securely in the Windows Credential Manager or Apple Keychain and then used to authenticate to the cloud secret manager.

Start with the [Conceptual Overview](https://www.chilkatsoft.com/chilkat_secrets_api.asp) and [Components of a Secret Name](https://www.chilkatsoft.com/components_of_a_secret_name.asp). For an extended overview, see the [Secrets Class Overview](https://www.chilkatsoft.com/secrets_class_overview.asp).

## Object creation, unlocking and error handling

**Object Creation**

```xojo
Dim secrets As New Chilkat.Secrets
```

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

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` | `DebugLogFilePath As String` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastErrorHtml` | `LastErrorHtml As String (read-only)` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `LastErrorText As String (read-only)` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `LastErrorXml As String (read-only)` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `LastMethodSuccess As Boolean` | read/write | Indicates the success or failure of the most recent method call: `True` means success, `False` means failure. |
| `VerboseLogging` | `VerboseLogging As Boolean` | read/write | If set to `True`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `Version As String (read-only)` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `AutoSplit` | property, read/write | `AutoSplit As Boolean` |
| `Compression` | property, read/write | `Compression As Boolean` |
| `Location` | property, read/write | `Location As String` |
| `UncommonOptions` | property, read/write | `UncommonOptions As String` |
| `DeleteSecret` | method | `Function DeleteSecret(jsonId As Chilkat.JsonObject) As Boolean` |
| `GetSecretBd` | method | `Function GetSecretBd(jsonId As Chilkat.JsonObject, bd As Chilkat.BinData) As Boolean` |
| `GetSecretJson` | method | `Function GetSecretJson(jsonId As Chilkat.JsonObject, jsonOut As Chilkat.JsonObject) As Boolean` |
| `GetSecretSb` | method | `Function GetSecretSb(jsonId As Chilkat.JsonObject, sb As Chilkat.StringBuilder) As Boolean` |
| `GetSecretStr` | method | `Function GetSecretStr(jsonId As Chilkat.JsonObject) As String` |
| `ListSecrets` | method | `Function ListSecrets(json As Chilkat.JsonObject, jsonOut As Chilkat.JsonObject) As Boolean` |
| `SecretSpecToJson` | method | `Function SecretSpecToJson(secretSpec As String, json As Chilkat.JsonObject) As Boolean` |
| `SetBootstrapSecret` | method | `Function SetBootstrapSecret(jsonId As Chilkat.JsonObject, secretContent As Chilkat.Secrets) As Boolean` |
| `UpdateSecretBd` | method | `Function UpdateSecretBd(jsonId As Chilkat.JsonObject, secret As Chilkat.BinData) As Boolean` |
| `UpdateSecretJson` | method | `Function UpdateSecretJson(jsonId As Chilkat.JsonObject, secret As Chilkat.JsonObject) As Boolean` |
| `UpdateSecretSb` | method | `Function UpdateSecretSb(jsonId As Chilkat.JsonObject, sb As Chilkat.StringBuilder) As Boolean` |
| `UpdateSecretStr` | method | `Function UpdateSecretStr(jsonId As Chilkat.JsonObject, secret As String) As Boolean` |

## Properties

### Secrets.AutoSplit

`Chilkat 11.7.0 · xojo · Secrets · AutoSplit · property · read/write · since 10.1.0`

```xojo
AutoSplit As Boolean
```

The AutoSplit property is specific to `local_manager` secrets on Windows. The Windows Credentials Manager supports a maximum of 2560 bytes per secret. If a secret exceeds this size, it will be automatically compressed and split when created or updated, and automatically recomposed when retrieved.

A secret can be split into a maximum of 10 parts.

The default value is `True`.

### Secrets.Compression

`Chilkat 11.7.0 · xojo · Secrets · Compression · property · read/write · since 10.1.0`

```xojo
Compression As Boolean
```

If set to `True`, then the contents of the secret will be stored compressed. The default value of this property is `False`.

### Secrets.Location

`Chilkat 11.7.0 · xojo · Secrets · Location · property · read/write · since 10.1.0`

```xojo
Location As String
```

The location of the secrets. Possible values are:

- `local_manager` - On Windows this is the Credentials Manager. On MacOS and iOS it is the Keychain. This is not yet an option on Linux or Android.
- `aws_secrets_manager` - AWS Secrets Manager
- `azure_key_vault` - Azure Key Vault
- `ibm_cloud` - IBM Cloud Secrets Manager
- `oracle_cloud` - Oracle Cloud Secrets
- `doppler` - Doppler Secrets
- `memory` - In-Memory Secrets

The default location is the `local_manager`. On Linux and Android, `local_manager` will behave the same as `memory`.

### Secrets.UncommonOptions

`Chilkat 11.7.0 · xojo · Secrets · UncommonOptions · property · read/write · since 10.1.0`

```xojo
UncommonOptions As String
```

This is a catch-all property to be used for uncommon needs. This property defaults to the empty string and should typically remain empty.

## Methods

### Secrets.DeleteSecret

`Chilkat 11.7.0 · xojo · Secrets · DeleteSecret · method · since 10.1.0`

```xojo
Function DeleteSecret(jsonId As Chilkat.JsonObject) As Boolean
```

Deletes a secret. Cloud secrets managers will typically disable the secret and schedule the secret for deletion after some number of days.

Returns True for success, False for failure.

Async variant: `DeleteSecretAsync` — same arguments, returns a `Task` (see Async variants below).

### Secrets.GetSecretBd

`Chilkat 11.7.0 · xojo · Secrets · GetSecretBd · method · since 10.1.0`

```xojo
Function GetSecretBd(jsonId As Chilkat.JsonObject, bd As Chilkat.BinData) As Boolean
```

Fetches a binary secret and returns the content in `bd`.

Returns True for success, False for failure.

Async variant: `GetSecretBdAsync` — same arguments, returns a `Task` (see Async variants below).

### Secrets.GetSecretJson

`Chilkat 11.7.0 · xojo · Secrets · GetSecretJson · method · since 10.1.0`

```xojo
Function GetSecretJson(jsonId As Chilkat.JsonObject, jsonOut As Chilkat.JsonObject) As Boolean
```

Fetches a JSON secret and returns the content in `jsonOut`.

Returns True for success, False for failure.

Async variant: `GetSecretJsonAsync` — same arguments, returns a `Task` (see Async variants below).

### Secrets.GetSecretSb

`Chilkat 11.7.0 · xojo · Secrets · GetSecretSb · method · since 10.1.0`

```xojo
Function GetSecretSb(jsonId As Chilkat.JsonObject, sb As Chilkat.StringBuilder) As Boolean
```

Fetches a string secret and returns the content in `sb`.

Returns True for success, False for failure.

Async variant: `GetSecretSbAsync` — same arguments, returns a `Task` (see Async variants below).

### Secrets.GetSecretStr

`Chilkat 11.7.0 · xojo · Secrets · GetSecretStr · method · since 10.1.0`

```xojo
Function GetSecretStr(jsonId As Chilkat.JsonObject) As String
```

Fetches a string secret and returns the content of the secret.

Returns `Nil` on failure

Async variant: `GetSecretStrAsync` — same arguments, returns a `Task` (see Async variants below).

### Secrets.ListSecrets

`Chilkat 11.7.0 · xojo · Secrets · ListSecrets · method · since 10.1.0`

```xojo
Function ListSecrets(json As Chilkat.JsonObject, jsonOut As Chilkat.JsonObject) As Boolean
```

Lists secrets matching the wildcarded or exact values passed in `json`. The results of the query are returned in `jsonOut`.

Returns True for success, False for failure.

Async variant: `ListSecretsAsync` — same arguments, returns a `Task` (see Async variants below).

### Secrets.SecretSpecToJson

`Chilkat 11.7.0 · xojo · Secrets · SecretSpecToJson · method · since 11.5.0`

```xojo
Function SecretSpecToJson(secretSpec As String, json As Chilkat.JsonObject) As Boolean
```

Converts a secret specification string (`secretSpec`) to JSON. A secret specification string is formatted as "!!part1\|part2\|part3\|part4" where parts 3 and 4 are optional. `json` is the output argument.

Returns True for success, False for failure.

### Secrets.SetBootstrapSecret

`Chilkat 11.7.0 · xojo · Secrets · SetBootstrapSecret · method · since 10.1.0`

```xojo
Function SetBootstrapSecret(jsonId As Chilkat.JsonObject, secretContent As Chilkat.Secrets) As Boolean
```

Accessing a cloud-based secrets manager requires authentication credentials, which cannot be stored in the manager itself. Instead, they must be securely stored locally.

One solution is to store the authentication credentials as a secret in the Windows Credentials Manager or Apple Keychain. These credentials serve as the `bootstrap secret` for authenticating with the cloud-based secrets manager.

`jsonId` contains the name of the bootstrap secret. `secretContent` contains the bootstrap's secret content.

Returns True for success, False for failure.

### Secrets.UpdateSecretBd

`Chilkat 11.7.0 · xojo · Secrets · UpdateSecretBd · method · since 10.1.0`

```xojo
Function UpdateSecretBd(jsonId As Chilkat.JsonObject, secret As Chilkat.BinData) As Boolean
```

Creates a binary secret if it does not yet exist, or updates an existing secret. The name of the secret is specified in `jsonId`, and the binary content of the secret in `secret`.

Returns True for success, False for failure.

Async variant: `UpdateSecretBdAsync` — same arguments, returns a `Task` (see Async variants below).

### Secrets.UpdateSecretJson

`Chilkat 11.7.0 · xojo · Secrets · UpdateSecretJson · method · since 10.1.0`

```xojo
Function UpdateSecretJson(jsonId As Chilkat.JsonObject, secret As Chilkat.JsonObject) As Boolean
```

Creates a JSON secret if it does not yet exist, or updates an existing secret. The name of the secret is specified in `jsonId`, and the JSON content of the secret in `secret`.

Returns True for success, False for failure.

Async variant: `UpdateSecretJsonAsync` — same arguments, returns a `Task` (see Async variants below).

### Secrets.UpdateSecretSb

`Chilkat 11.7.0 · xojo · Secrets · UpdateSecretSb · method · since 10.1.0`

```xojo
Function UpdateSecretSb(jsonId As Chilkat.JsonObject, sb As Chilkat.StringBuilder) As Boolean
```

Creates a string secret if it does not yet exist, or updates an existing secret. The name of the secret is specified in `jsonId`, and the string content of the secret in `sb`.

Returns True for success, False for failure.

Async variant: `UpdateSecretSbAsync` — same arguments, returns a `Task` (see Async variants below).

### Secrets.UpdateSecretStr

`Chilkat 11.7.0 · xojo · Secrets · UpdateSecretStr · method · since 10.1.0`

```xojo
Function UpdateSecretStr(jsonId As Chilkat.JsonObject, secret As String) As Boolean
```

Creates a string secret if it does not yet exist, or updates an existing secret. The name of the secret is specified in `jsonId`, and the string content of the secret in `secret`.

Note: Starting in Chilkat **v11.3.0**, if the `service` = `"Chilkat"` and the `username` = `"unlock_code"`, then the secret (which is the Chilkat unlock code) can be stored and retrieved without Chilkat being unlocked. This allows for the Chilkat unlock code itself to be persisted to a secrets manager.

Returns True for success, False for failure.

Async variant: `UpdateSecretStrAsync` — same arguments, returns a `Task` (see Async variants below).

## Events and callbacks

In Xojo, Chilkat events are handled by subclassing. Add a new class to your project that inherits from Chilkat.Secrets, then override the event methods you want to respond to. Any method you don't override keeps its default do-nothing behavior, so you only need to write the ones you actually care about.

From that point on, create and use an instance of your subclass wherever you would have used a Chilkat.Secrets. The events fire on your instance automatically as the object does its work.

**For example:**

```vb
class MySecrets
    Inherits Chilkat.Secrets

    Function AbortCheck() As Boolean
    Function PercentDone(pctDone As Int32) As Boolean
    Sub ProgressInfo(name As String, value As String)
    Sub TaskCompleted(task As Chilkat.Task)

End Class
```

### Secrets.AbortCheck (event)

`Chilkat 11.7.0 · xojo · Secrets · AbortCheck · event`

```xojo
Function AbortCheck() As Boolean
```

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.

### Secrets.PercentDone (event)

`Chilkat 11.7.0 · xojo · Secrets · PercentDone · event`

```xojo
Function PercentDone(pctDone As Int32) As Boolean
```

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.

### Secrets.ProgressInfo (event)

`Chilkat 11.7.0 · xojo · Secrets · ProgressInfo · event`

```xojo
Sub ProgressInfo(name As String, value As String)
```

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.

### Secrets.TaskCompleted (event)

`Chilkat 11.7.0 · xojo · Secrets · TaskCompleted · event`

```xojo
Sub TaskCompleted(task As Chilkat.Task)
```

Called from the background thread when an asynchronous task completes.

## Async variants

Each returns a `Task` instead of the result and takes the same arguments as the synchronous method; run the task, wait for `Finished`, then read the result from the task. No new Async methods are added from 11.7.0 on.

```xojo
Function DeleteSecretAsync(jsonId As Chilkat.JsonObject) As Chilkat.Task
Function GetSecretBdAsync(jsonId As Chilkat.JsonObject, bd As Chilkat.BinData) As Chilkat.Task
Function GetSecretJsonAsync(jsonId As Chilkat.JsonObject, jsonOut As Chilkat.JsonObject) As Chilkat.Task
Function GetSecretSbAsync(jsonId As Chilkat.JsonObject, sb As Chilkat.StringBuilder) As Chilkat.Task
Function GetSecretStrAsync(jsonId As Chilkat.JsonObject) As Chilkat.Task
Function ListSecretsAsync(json As Chilkat.JsonObject, jsonOut As Chilkat.JsonObject) As Chilkat.Task
Function UpdateSecretBdAsync(jsonId As Chilkat.JsonObject, secret As Chilkat.BinData) As Chilkat.Task
Function UpdateSecretJsonAsync(jsonId As Chilkat.JsonObject, secret As Chilkat.JsonObject) As Chilkat.Task
Function UpdateSecretSbAsync(jsonId As Chilkat.JsonObject, sb As Chilkat.StringBuilder) As Chilkat.Task
Function UpdateSecretStrAsync(jsonId As Chilkat.JsonObject, secret As String) As Chilkat.Task
```

## Related classes

[`BinData`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/xojo/classes/BinData.md), [`JsonObject`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/xojo/classes/JsonObject.md), [`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/xojo/classes/StringBuilder.md)

