---
product: Chilkat
product_version: 11.7.0
language: wcpp
language_label: Unicode C++
class: Secrets
class_name: CkSecretsW
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/wcppCkSecretsWRef.html
---
# Chilkat Secrets — Unicode C++ — v11.7.0

> Chilkat 11.7.0 · language=wcpp · class=Secrets (CkSecretsW)
> 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/wcpp/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**

```cpp
// Local variable on the stack
CkSecretsW obj;

// Dynamically allocate/delete
CkSecretsW *pObj = new CkSecretsW();
// ...
delete pObj;
```

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 Unicode C++.

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` | `void get_DebugLogFilePath(CkString &str); const wchar_t *debugLogFilePath(void); void put_DebugLogFilePath(const wchar_t *str);` | 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` | `void get_LastErrorHtml(CkString &str); const wchar_t *lastErrorHtml(void);` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `void get_LastErrorText(CkString &str); const wchar_t *lastErrorText(void);` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `void get_LastErrorXml(CkString &str); const wchar_t *lastErrorXml(void);` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `bool get_LastMethodSuccess(void); void put_LastMethodSuccess(bool newVal);` | read/write | Indicates the success or failure of the most recent method call: `true` means success, `false` means failure. |
| `VerboseLogging` | `bool get_VerboseLogging(void); void put_VerboseLogging(bool newVal);` | read/write | If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `void get_Version(CkString &str); const wchar_t *version(void);` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `AutoSplit` | property, read/write | `bool get_AutoSplit(void); void put_AutoSplit(bool newVal);` |
| `Compression` | property, read/write | `bool get_Compression(void); void put_Compression(bool newVal);` |
| `Location` | property, read/write | `void get_Location(CkString &str); const wchar_t *location(void); void put_Location(const wchar_t *str);` |
| `UncommonOptions` | property, read/write | `void get_UncommonOptions(CkString &str); const wchar_t *uncommonOptions(void); void put_UncommonOptions(const wchar_t *str);` |
| `DeleteSecret` | method | `bool DeleteSecret(CkJsonObjectW &jsonId);` |
| `GetSecretBd` | method | `bool GetSecretBd(CkJsonObjectW &jsonId, CkBinDataW &bd);` |
| `GetSecretJson` | method | `bool GetSecretJson(CkJsonObjectW &jsonId, CkJsonObjectW &jsonOut);` |
| `GetSecretSb` | method | `bool GetSecretSb(CkJsonObjectW &jsonId, CkStringBuilderW &sb);` |
| `GetSecretStr` | method | `bool GetSecretStr(CkJsonObjectW &jsonId, CkString &outStr); const wchar_t *getSecretStr(CkJsonObjectW &jsonId);` |
| `ListSecrets` | method | `bool ListSecrets(CkJsonObjectW &json, CkJsonObjectW &jsonOut);` |
| `SecretSpecToJson` | method | `bool SecretSpecToJson(const wchar_t *secretSpec, CkJsonObjectW &json);` |
| `SetBootstrapSecret` | method | `bool SetBootstrapSecret(CkJsonObjectW &jsonId, CkSecretsW &secretContent);` |
| `UpdateSecretBd` | method | `bool UpdateSecretBd(CkJsonObjectW &jsonId, CkBinDataW &secret);` |
| `UpdateSecretJson` | method | `bool UpdateSecretJson(CkJsonObjectW &jsonId, CkJsonObjectW &secret);` |
| `UpdateSecretSb` | method | `bool UpdateSecretSb(CkJsonObjectW &jsonId, CkStringBuilderW &sb);` |
| `UpdateSecretStr` | method | `bool UpdateSecretStr(CkJsonObjectW &jsonId, const wchar_t *secret);` |

## Properties

### Secrets.AutoSplit

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

```cpp
bool get_AutoSplit(void);

void put_AutoSplit(bool newVal);
```

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 · wcpp · Secrets · Compression · property · read/write · since 10.1.0`

```cpp
bool get_Compression(void);

void put_Compression(bool newVal);
```

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 · wcpp · Secrets · Location · property · read/write · since 10.1.0`

```cpp
void get_Location(CkString &str);

const wchar_t *location(void);

void put_Location(const wchar_t *str);
```

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 · wcpp · Secrets · UncommonOptions · property · read/write · since 10.1.0`

```cpp
void get_UncommonOptions(CkString &str);

const wchar_t *uncommonOptions(void);

void put_UncommonOptions(const wchar_t *str);
```

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 · wcpp · Secrets · DeleteSecret · method · since 10.1.0`

```cpp
bool DeleteSecret(CkJsonObjectW &jsonId);
```

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 · wcpp · Secrets · GetSecretBd · method · since 10.1.0`

```cpp
bool GetSecretBd(CkJsonObjectW &jsonId, CkBinDataW &bd);
```

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 · wcpp · Secrets · GetSecretJson · method · since 10.1.0`

```cpp
bool GetSecretJson(CkJsonObjectW &jsonId, CkJsonObjectW &jsonOut);
```

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 · wcpp · Secrets · GetSecretSb · method · since 10.1.0`

```cpp
bool GetSecretSb(CkJsonObjectW &jsonId, CkStringBuilderW &sb);
```

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 · wcpp · Secrets · GetSecretStr · method · since 10.1.0`

```cpp
bool GetSecretStr(CkJsonObjectW &jsonId, CkString &outStr);

const wchar_t *getSecretStr(CkJsonObjectW &jsonId);
```

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

Returns true for success, false for failure.

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

### Secrets.ListSecrets

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

```cpp
bool ListSecrets(CkJsonObjectW &json, CkJsonObjectW &jsonOut);
```

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 · wcpp · Secrets · SecretSpecToJson · method · since 11.5.0`

```cpp
bool SecretSpecToJson(const wchar_t *secretSpec, CkJsonObjectW &json);
```

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 · wcpp · Secrets · SetBootstrapSecret · method · since 10.1.0`

```cpp
bool SetBootstrapSecret(CkJsonObjectW &jsonId, CkSecretsW &secretContent);
```

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 · wcpp · Secrets · UpdateSecretBd · method · since 10.1.0`

```cpp
bool UpdateSecretBd(CkJsonObjectW &jsonId, CkBinDataW &secret);
```

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 · wcpp · Secrets · UpdateSecretJson · method · since 10.1.0`

```cpp
bool UpdateSecretJson(CkJsonObjectW &jsonId, CkJsonObjectW &secret);
```

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 · wcpp · Secrets · UpdateSecretSb · method · since 10.1.0`

```cpp
bool UpdateSecretSb(CkJsonObjectW &jsonId, CkStringBuilderW &sb);
```

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 · wcpp · Secrets · UpdateSecretStr · method · since 10.1.0`

```cpp
bool UpdateSecretStr(CkJsonObjectW &jsonId, const wchar_t *secret);
```

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

To receive events, define your own class that inherits from CkBaseProgressW and override just the methods you want to handle. The base class provides an empty implementation of every method, so anything you don't override is simply ignored.

Then create an instance of your class and pass its address to the object's put_EventCallbackObject method. From that point on, the object calls your methods as the work proceeds. Be sure the callback object stays in scope for as long as it is in use.

**For example:**

```cpp
  CkSecretsW secrets;

  MySecretsProgressW callbackObj;

  secrets.put_EventCallbackObject(&callbackObj);
```

**MySecretsProgressW example:**

```cpp
#include "CkBaseProgressW.h"

class MySecretsProgressW : public CkBaseProgressW {

  public:
    MySecretsProgressW();
    virtual ~MySecretsProgressW();

    void AbortCheck(bool  *abort);
    void PercentDone(int pctDone, bool  *abort);
    void ProgressInfo(const wchar_t *name, const wchar_t *value);
    void TaskCompleted(CkTaskW &task);
};
```

### Secrets.AbortCheck (event)

`Chilkat 11.7.0 · wcpp · Secrets · AbortCheck · event`

```cpp
void AbortCheck(bool  *abort);
```

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 · wcpp · Secrets · PercentDone · event`

```cpp
void PercentDone(int pctDone, bool  *abort);
```

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 · wcpp · Secrets · ProgressInfo · event`

```cpp
void ProgressInfo(const wchar_t *name, const wchar_t *value);
```

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 · wcpp · Secrets · TaskCompleted · event`

```cpp
void TaskCompleted(CkTaskW &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.

```cpp
CkTaskW *DeleteSecretAsync(CkJsonObjectW &jsonId);
CkTaskW *GetSecretBdAsync(CkJsonObjectW &jsonId, CkBinDataW &bd);
CkTaskW *GetSecretJsonAsync(CkJsonObjectW &jsonId, CkJsonObjectW &jsonOut);
CkTaskW *GetSecretSbAsync(CkJsonObjectW &jsonId, CkStringBuilderW &sb);
CkTaskW *GetSecretStrAsync(CkJsonObjectW &jsonId);
CkTaskW *ListSecretsAsync(CkJsonObjectW &json, CkJsonObjectW &jsonOut);
CkTaskW *UpdateSecretBdAsync(CkJsonObjectW &jsonId, CkBinDataW &secret);
CkTaskW *UpdateSecretJsonAsync(CkJsonObjectW &jsonId, CkJsonObjectW &secret);
CkTaskW *UpdateSecretSbAsync(CkJsonObjectW &jsonId, CkStringBuilderW &sb);
CkTaskW *UpdateSecretStrAsync(CkJsonObjectW &jsonId, const wchar_t *secret);
```

## Related classes

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