---
product: Chilkat
product_version: 11.7.0
language: objc
language_label: Objective-C
class: Secrets
class_name: CkoSecrets
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/objcCkoSecretsRef.html
---
# Chilkat Secrets — Objective-C — v11.7.0

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

```objectivec
CkoSecrets *obj = [[CkoSecrets alloc] init];
```

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 Objective-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` | `@property (nonatomic, copy) NSString *DebugLogFilePath;` | 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` | `@property (nonatomic, readonly, copy) NSString *LastErrorHtml;` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `@property (nonatomic, readonly, copy) NSString *LastErrorText;` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `@property (nonatomic, readonly, copy) NSString *LastErrorXml;` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `@property (nonatomic) BOOL LastMethodSuccess;` | read/write | Indicates the success or failure of the most recent method call: `YES` means success, `NO` means failure. |
| `VerboseLogging` | `@property (nonatomic) BOOL VerboseLogging;` | read/write | If set to `YES`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `@property (nonatomic, readonly, copy) NSString *Version;` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `AutoSplit` | property, read/write | `@property (nonatomic) BOOL AutoSplit;` |
| `Compression` | property, read/write | `@property (nonatomic) BOOL Compression;` |
| `Location` | property, read/write | `@property (nonatomic, copy) NSString *Location;` |
| `UncommonOptions` | property, read/write | `@property (nonatomic, copy) NSString *UncommonOptions;` |
| `DeleteSecret` | method | `- (BOOL)DeleteSecret:(CkoJsonObject *)jsonId;` |
| `GetSecretBd` | method | `- (BOOL)GetSecretBd:(CkoJsonObject *)jsonId     bd:(CkoBinData *)bd;` |
| `GetSecretJson` | method | `- (BOOL)GetSecretJson:(CkoJsonObject *)jsonId     jsonOut:(CkoJsonObject *)jsonOut;` |
| `GetSecretSb` | method | `- (BOOL)GetSecretSb:(CkoJsonObject *)jsonId     sb:(CkoStringBuilder *)sb;` |
| `GetSecretStr` | method | `- (NSString *)GetSecretStr:(CkoJsonObject *)jsonId;` |
| `ListSecrets` | method | `- (BOOL)ListSecrets:(CkoJsonObject *)json     jsonOut:(CkoJsonObject *)jsonOut;` |
| `SecretSpecToJson` | method | `- (BOOL)SecretSpecToJson:(NSString *)secretSpec     json:(CkoJsonObject *)json;` |
| `SetBootstrapSecret` | method | `- (BOOL)SetBootstrapSecret:(CkoJsonObject *)jsonId     secretContent:(CkoSecrets *)secretContent;` |
| `UpdateSecretBd` | method | `- (BOOL)UpdateSecretBd:(CkoJsonObject *)jsonId     secret:(CkoBinData *)secret;` |
| `UpdateSecretJson` | method | `- (BOOL)UpdateSecretJson:(CkoJsonObject *)jsonId     secret:(CkoJsonObject *)secret;` |
| `UpdateSecretSb` | method | `- (BOOL)UpdateSecretSb:(CkoJsonObject *)jsonId     sb:(CkoStringBuilder *)sb;` |
| `UpdateSecretStr` | method | `- (BOOL)UpdateSecretStr:(CkoJsonObject *)jsonId     secret:(NSString *)secret;` |

## Properties

### Secrets.AutoSplit

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

```objectivec
@property (nonatomic) BOOL AutoSplit;
```

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

### Secrets.Compression

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

```objectivec
@property (nonatomic) BOOL Compression;
```

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

### Secrets.Location

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

```objectivec
@property (nonatomic, copy) NSString *Location;
```

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

```objectivec
@property (nonatomic, copy) NSString *UncommonOptions;
```

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

```objectivec
- (BOOL)DeleteSecret:(CkoJsonObject *)jsonId;
```

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

Returns YES for success, NO for failure.

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

### Secrets.GetSecretBd

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

```objectivec
- (BOOL)GetSecretBd:(CkoJsonObject *)jsonId 
    bd:(CkoBinData *)bd;
```

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

Returns YES for success, NO for failure.

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

### Secrets.GetSecretJson

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

```objectivec
- (BOOL)GetSecretJson:(CkoJsonObject *)jsonId 
    jsonOut:(CkoJsonObject *)jsonOut;
```

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

Returns YES for success, NO for failure.

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

### Secrets.GetSecretSb

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

```objectivec
- (BOOL)GetSecretSb:(CkoJsonObject *)jsonId 
    sb:(CkoStringBuilder *)sb;
```

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

Returns YES for success, NO for failure.

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

### Secrets.GetSecretStr

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

```objectivec
- (NSString *)GetSecretStr:(CkoJsonObject *)jsonId;
```

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 · objc · Secrets · ListSecrets · method · since 10.1.0`

```objectivec
- (BOOL)ListSecrets:(CkoJsonObject *)json 
    jsonOut:(CkoJsonObject *)jsonOut;
```

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

Returns YES for success, NO for failure.

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

### Secrets.SecretSpecToJson

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

```objectivec
- (BOOL)SecretSpecToJson:(NSString *)secretSpec 
    json:(CkoJsonObject *)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 YES for success, NO for failure.

### Secrets.SetBootstrapSecret

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

```objectivec
- (BOOL)SetBootstrapSecret:(CkoJsonObject *)jsonId 
    secretContent:(CkoSecrets *)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 YES for success, NO for failure.

### Secrets.UpdateSecretBd

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

```objectivec
- (BOOL)UpdateSecretBd:(CkoJsonObject *)jsonId 
    secret:(CkoBinData *)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 YES for success, NO for failure.

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

### Secrets.UpdateSecretJson

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

```objectivec
- (BOOL)UpdateSecretJson:(CkoJsonObject *)jsonId 
    secret:(CkoJsonObject *)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 YES for success, NO for failure.

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

### Secrets.UpdateSecretSb

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

```objectivec
- (BOOL)UpdateSecretSb:(CkoJsonObject *)jsonId 
    sb:(CkoStringBuilder *)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 YES for success, NO for failure.

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

### Secrets.UpdateSecretStr

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

```objectivec
- (BOOL)UpdateSecretStr:(CkoJsonObject *)jsonId 
    secret:(NSString *)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 YES for success, NO 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 CkoBaseProgress 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 it to the object's setEventCallbackObject: method. From that point on, the object calls your methods as the work proceeds.

**For example:**

```objectivec
  CkoSecrets *secrets = [[CkoSecrets alloc] init];

  MySecretsProgress *callbackObj = [[MySecretsProgress alloc] init];

  [secrets setEventCallbackObject:callbackObj];
```

**MySecretsProgress interface example:**

```objectivec
#import "CkoBaseProgress.h"

@interface MySecretsProgress : CkoBaseProgress {

}

    - (id)init;
    - (void)dealloc;
    - (void)dispose;

    - (void)AbortCheck:(BOOL *)abort;
    - (void)PercentDone:(NSNumber *)pctDone 
        abort:(BOOL *)abort;
    - (void)ProgressInfo:(NSString *)name 
        value:(NSString *)value;
    - (void)TaskCompleted:(CkoTask *)task;
@end
```

### Secrets.AbortCheck (event)

`Chilkat 11.7.0 · objc · Secrets · AbortCheck · event`

```objectivec
- (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 · objc · Secrets · PercentDone · event`

```objectivec
- (void)PercentDone:(NSNumber *)pctDone 
    abort:(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 `YES`. This will cause the method to terminate and return a failure status or corresponding failure value.

### Secrets.ProgressInfo (event)

`Chilkat 11.7.0 · objc · Secrets · ProgressInfo · event`

```objectivec
- (void)ProgressInfo:(NSString *)name 
    value:(NSString *)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 · objc · Secrets · TaskCompleted · event`

```objectivec
- (void)TaskCompleted:(CkoTask *)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.

```objectivec
- (CkoTask *)DeleteSecretAsync:(CkoJsonObject *)jsonId;
- (CkoTask *)GetSecretBdAsync:(CkoJsonObject *)jsonId 
    bd:(CkoBinData *)bd;
- (CkoTask *)GetSecretJsonAsync:(CkoJsonObject *)jsonId 
    jsonOut:(CkoJsonObject *)jsonOut;
- (CkoTask *)GetSecretSbAsync:(CkoJsonObject *)jsonId 
    sb:(CkoStringBuilder *)sb;
- (CkoTask *)GetSecretStrAsync:(CkoJsonObject *)jsonId;
- (CkoTask *)ListSecretsAsync:(CkoJsonObject *)json 
    jsonOut:(CkoJsonObject *)jsonOut;
- (CkoTask *)UpdateSecretBdAsync:(CkoJsonObject *)jsonId 
    secret:(CkoBinData *)secret;
- (CkoTask *)UpdateSecretJsonAsync:(CkoJsonObject *)jsonId 
    secret:(CkoJsonObject *)secret;
- (CkoTask *)UpdateSecretSbAsync:(CkoJsonObject *)jsonId 
    sb:(CkoStringBuilder *)sb;
- (CkoTask *)UpdateSecretStrAsync:(CkoJsonObject *)jsonId 
    secret:(NSString *)secret;
```

## Related classes

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

