---
product: Chilkat
product_version: 11.7.0
language: phpext
language_label: PHP Extension
class: Secrets
class_name: CkSecrets
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/phpCkSecretsRef.html
---
# Chilkat Secrets — PHP Extension — v11.7.0

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

```php
$obj = new CkSecrets();
```

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 PHP Extension.

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` | `string debugLogFilePath(); void put_DebugLogFilePath(string strVal);` | 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` | `(read-only) string lastErrorHtml();` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `(read-only) string lastErrorText();` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `(read-only) string lastErrorXml();` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `bool get_LastMethodSuccess() void put_LastMethodSuccess(bool boolVal);` | read/write | Indicates the success or failure of the most recent method call: `true` means success, `false` means failure. |
| `Utf8` | `bool get_Utf8() void put_Utf8(bool boolVal);` | read/write | When set to `true`, all `string` arguments and return values are interpreted as UTF-8 strings. |
| `VerboseLogging` | `bool get_VerboseLogging() void put_VerboseLogging(bool boolVal);` | read/write | If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `(read-only) string version();` | 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 put_AutoSplit(bool boolVal);` |
| `Compression` | property, read/write | `bool get_Compression() void put_Compression(bool boolVal);` |
| `Location` | property, read/write | `string location(); void put_Location(string strVal);` |
| `UncommonOptions` | property, read/write | `string uncommonOptions(); void put_UncommonOptions(string strVal);` |
| `DeleteSecret` | method | `bool DeleteSecret(CkJsonObject $jsonId);` |
| `GetSecretBd` | method | `bool GetSecretBd(CkJsonObject $jsonId, CkBinData $bd);` |
| `GetSecretJson` | method | `bool GetSecretJson(CkJsonObject $jsonId, CkJsonObject $jsonOut);` |
| `GetSecretSb` | method | `bool GetSecretSb(CkJsonObject $jsonId, CkStringBuilder $sb);` |
| `GetSecretStr` | method | `bool GetSecretStr(CkJsonObject $jsonId, CkString outStr); string getSecretStr(CkJsonObject jsonId);` |
| `ListSecrets` | method | `bool ListSecrets(CkJsonObject $json, CkJsonObject $jsonOut);` |
| `SecretSpecToJson` | method | `bool SecretSpecToJson(string $secretSpec, CkJsonObject $json);` |
| `SetBootstrapSecret` | method | `bool SetBootstrapSecret(CkJsonObject $jsonId, CkSecrets $secretContent);` |
| `UpdateSecretBd` | method | `bool UpdateSecretBd(CkJsonObject $jsonId, CkBinData $secret);` |
| `UpdateSecretJson` | method | `bool UpdateSecretJson(CkJsonObject $jsonId, CkJsonObject $secret);` |
| `UpdateSecretSb` | method | `bool UpdateSecretSb(CkJsonObject $jsonId, CkStringBuilder $sb);` |
| `UpdateSecretStr` | method | `bool UpdateSecretStr(CkJsonObject $jsonId, string $secret);` |

## Properties

### Secrets.AutoSplit

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

```php
bool get_AutoSplit()

void put_AutoSplit(bool boolVal);
```

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

```php
bool get_Compression()

void put_Compression(bool boolVal);
```

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

```php
string location();

void put_Location(string strVal);
```

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

```php
string uncommonOptions();

void put_UncommonOptions(string strVal);
```

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

```php
bool DeleteSecret(CkJsonObject $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 · phpext · Secrets · GetSecretBd · method · since 10.1.0`

```php
bool GetSecretBd(CkJsonObject $jsonId, CkBinData $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 · phpext · Secrets · GetSecretJson · method · since 10.1.0`

```php
bool GetSecretJson(CkJsonObject $jsonId, CkJsonObject $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 · phpext · Secrets · GetSecretSb · method · since 10.1.0`

```php
bool GetSecretSb(CkJsonObject $jsonId, CkStringBuilder $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 · phpext · Secrets · GetSecretStr · method · since 10.1.0`

```php
bool GetSecretStr(CkJsonObject $jsonId, CkString outStr);

string getSecretStr(CkJsonObject 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 · phpext · Secrets · ListSecrets · method · since 10.1.0`

```php
bool ListSecrets(CkJsonObject $json, CkJsonObject $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 · phpext · Secrets · SecretSpecToJson · method · since 11.5.0`

```php
bool SecretSpecToJson(string $secretSpec, CkJsonObject $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 · phpext · Secrets · SetBootstrapSecret · method · since 10.1.0`

```php
bool SetBootstrapSecret(CkJsonObject $jsonId, CkSecrets $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 · phpext · Secrets · UpdateSecretBd · method · since 10.1.0`

```php
bool UpdateSecretBd(CkJsonObject $jsonId, CkBinData $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 · phpext · Secrets · UpdateSecretJson · method · since 10.1.0`

```php
bool UpdateSecretJson(CkJsonObject $jsonId, CkJsonObject $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 · phpext · Secrets · UpdateSecretSb · method · since 10.1.0`

```php
bool UpdateSecretSb(CkJsonObject $jsonId, CkStringBuilder $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 · phpext · Secrets · UpdateSecretStr · method · since 10.1.0`

```php
bool UpdateSecretStr(CkJsonObject $jsonId, string $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

This binding has no event callbacks. For progress, percent-done or cancellation use the `*Async` variant of a method and poll the returned `Task` (`PercentDone`, `Finished`, `Cancel`).

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

```php
CkTask DeleteSecretAsync(CkJsonObject $jsonId);
CkTask GetSecretBdAsync(CkJsonObject $jsonId, CkBinData $bd);
CkTask GetSecretJsonAsync(CkJsonObject $jsonId, CkJsonObject $jsonOut);
CkTask GetSecretSbAsync(CkJsonObject $jsonId, CkStringBuilder $sb);
CkTask GetSecretStrAsync(CkJsonObject $jsonId);
CkTask ListSecretsAsync(CkJsonObject $json, CkJsonObject $jsonOut);
CkTask UpdateSecretBdAsync(CkJsonObject $jsonId, CkBinData $secret);
CkTask UpdateSecretJsonAsync(CkJsonObject $jsonId, CkJsonObject $secret);
CkTask UpdateSecretSbAsync(CkJsonObject $jsonId, CkStringBuilder $sb);
CkTask UpdateSecretStrAsync(CkJsonObject $jsonId, string $secret);
```

## Related classes

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

