CkSecrets Perl Reference Documentation

CkSecrets

Current Version: 10.1.0

Requires Chilkat Bundle License

Provides a unified API for managing secrets stored in the following locations:

Windows Credentials Manager
Apple Keychain
AWS Secrets Manager
Azure Key Vault
IBM Cloud Secrets Manager
Oracle Cloud Secrets
Doppler Secrets
In-Memory Secrets

Object Creation

$obj = chilkat::CkSecrets->new();

Properties

AutoSplit

# $boolVal is a boolean
$boolVal = $secrets->get_AutoSplit();
$secrets->put_AutoSplit($boolVal);

Introduced in version 10.1.0

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

More Information and Examples

Windows Credentials Manager - AutoSplit Larger Secrets

Compression

# $boolVal is a boolean
$boolVal = $secrets->get_Compression();
$secrets->put_Compression($boolVal);

Introduced in version 10.1.0

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

DebugLogFilePath

# $strVal is a string
# $ckStr is a CkString
$secrets->get_DebugLogFilePath($ckStr);
$strVal = $secrets->debugLogFilePath();
$secrets->put_DebugLogFilePath($strVal);

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

More Information and Examples

Example showing how to use DebugLogFilePath.

LastErrorHtml

# $strVal is a string
# $ckStr is a CkString
$secrets->get_LastErrorHtml($ckStr);
$strVal = $secrets->lastErrorHtml();

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastErrorText

# $strVal is a string
# $ckStr is a CkString
$secrets->get_LastErrorText($ckStr);
$strVal = $secrets->lastErrorText();

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

# $strVal is a string
# $ckStr is a CkString
$secrets->get_LastErrorXml($ckStr);
$strVal = $secrets->lastErrorXml();

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastMethodSuccess

# $boolVal is a boolean
$boolVal = $secrets->get_LastMethodSuccess();
$secrets->put_LastMethodSuccess($boolVal);

Indicates the success or failure of the most recent method call: 1 means success, 0 means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

Location

# $strVal is a string
# $ckStr is a CkString
$secrets->get_Location($ckStr);
$strVal = $secrets->location();
$secrets->put_Location($strVal);

Introduced in version 10.1.0

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

UncommonOptions

# $strVal is a string
# $ckStr is a CkString
$secrets->get_UncommonOptions($ckStr);
$strVal = $secrets->uncommonOptions();
$secrets->put_UncommonOptions($strVal);

Introduced in version 10.1.0

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

Utf8

# $boolVal is a boolean
$boolVal = $secrets->get_Utf8();
$secrets->put_Utf8($boolVal);

When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.

VerboseLogging

# $boolVal is a boolean
$boolVal = $secrets->get_VerboseLogging();
$secrets->put_VerboseLogging($boolVal);

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version

# $strVal is a string
# $ckStr is a CkString
$secrets->get_Version($ckStr);
$strVal = $secrets->version();

Version of the component/library, such as "10.1.0"

More Information and Examples

How to get the Chilkat version at runtime.

Methods

DeleteSecret

# $jsonId is a CkJsonObject
$status = $secrets->DeleteSecret($jsonId);

Introduced in version 10.1.0

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

Returns 1 for success, 0 for failure.

More Information and Examples

Windows Credentials Manager / Apple Keychain - Delete a Secret AWS Secrets Manager - Delete a Secret Azure Key Vault - Delete a Secret Oracle Cloud Secrets - Delete a Secret IBM Cloud Secrets - Delete a Secret Doppler Secrets - Delete a Secret

DeleteSecretAsync ⁽¹⁾

# returns a CkTask
# $jsonId is a CkJsonObject
$ret_task = $secrets->DeleteSecretAsync($jsonId);

Introduced in version 10.1.0

Creates an asynchronous task to call the DeleteSecret method with the arguments provided.

Returns null on failure

GetSecretBd

# $jsonId is a CkJsonObject
# $bd is a CkBinData
$status = $secrets->GetSecretBd($jsonId, $bd);

Introduced in version 10.1.0

Fetches a binary secret and returns the content in bd.

Returns 1 for success, 0 for failure.

More Information and Examples

Windows Credentials Manager / Apple Keychain - Get a Binary Secret AWS Secrets Manager - Get a Binary Secret Azure Key Vault - Get a Binary Secret Oracle Cloud Secrets - Get a Binary Secret IBM Cloud Secrets - Get a Binary Secret Doppler Secrets - Get a Binary Secret

GetSecretBdAsync ⁽¹⁾

# returns a CkTask
# $jsonId is a CkJsonObject
# $bd is a CkBinData
$ret_task = $secrets->GetSecretBdAsync($jsonId, $bd);

Introduced in version 10.1.0

Creates an asynchronous task to call the GetSecretBd method with the arguments provided.

Returns null on failure

GetSecretJson

# $jsonId is a CkJsonObject
# $jsonOut is a CkJsonObject
$status = $secrets->GetSecretJson($jsonId, $jsonOut);

Introduced in version 10.1.0

Fetches a JSON secret and returns the content in jsonOut.

Returns 1 for success, 0 for failure.

More Information and Examples

Windows Credentials Manager / Apple Keychain - Get a JSON Secret AWS Secrets Manager - Get a JSON Secret Azure Key Vault - Get a JSON Secret Oracle Cloud Secrets - Get a JSON Secret IBM Cloud Secrets - Get a JSON Secret Doppler Secrets - Get a JSON Secret

GetSecretJsonAsync ⁽¹⁾

# returns a CkTask
# $jsonId is a CkJsonObject
# $jsonOut is a CkJsonObject
$ret_task = $secrets->GetSecretJsonAsync($jsonId, $jsonOut);

Introduced in version 10.1.0

Creates an asynchronous task to call the GetSecretJson method with the arguments provided.

Returns null on failure

GetSecretSb

# $jsonId is a CkJsonObject
# $sb is a CkStringBuilder
$status = $secrets->GetSecretSb($jsonId, $sb);

Introduced in version 10.1.0

Fetches a string secret and returns the content in sb.

Returns 1 for success, 0 for failure.

More Information and Examples

Windows Credentials Manager / Apple Keychain - Get a String Secret to a StringBuilder

GetSecretSbAsync ⁽¹⁾

# returns a CkTask
# $jsonId is a CkJsonObject
# $sb is a CkStringBuilder
$ret_task = $secrets->GetSecretSbAsync($jsonId, $sb);

Introduced in version 10.1.0

Creates an asynchronous task to call the GetSecretSb method with the arguments provided.

Returns null on failure

GetSecretStr

# $jsonId is a CkJsonObject
# $outStr is a CkString (output)
$status = $secrets->GetSecretStr($jsonId, $outStr);
$retStr = $secrets->getSecretStr($jsonId);

Introduced in version 10.1.0

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

Returns 1 for success, 0 for failure.

More Information and Examples

Windows Credentials Manager / Apple Keychain - Get a String Secret AWS Secrets Manager - Get a String Secret Azure Key Vault - Get a String Secret Oracle Cloud Secrets - Get a String Secret IBM Cloud Secrets - Get a String Secret Doppler Secrets - Get a String Secret

GetSecretStrAsync ⁽¹⁾

# returns a CkTask
# $jsonId is a CkJsonObject
$ret_task = $secrets->GetSecretStrAsync($jsonId);

Introduced in version 10.1.0

Creates an asynchronous task to call the GetSecretStr method with the arguments provided.

Returns null on failure

ListSecrets

# $json is a CkJsonObject
# $jsonOut is a CkJsonObject
$status = $secrets->ListSecrets($json, $jsonOut);

Introduced in version 10.1.0

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

Returns 1 for success, 0 for failure.

More Information and Examples

Windows Credentials Manager / Apple Keychain - List All Secrets Windows Credentials Manager / Apple Keychain - List Matching Secrets AWS Secrets Manager - List Matching Secrets Azure Key Vault - List Matching Secrets Oracle Cloud Secrets - List Matching Secrets IBM Cloud Secrets - List Matching Secrets Doppler Secrets - List Matching Secrets

ListSecretsAsync ⁽¹⁾

# returns a CkTask
# $json is a CkJsonObject
# $jsonOut is a CkJsonObject
$ret_task = $secrets->ListSecretsAsync($json, $jsonOut);

Introduced in version 10.1.0

Creates an asynchronous task to call the ListSecrets method with the arguments provided.

Returns null on failure

SetBootstrapSecret

# $jsonId is a CkJsonObject
# $secretContent is a CkSecrets
$status = $secrets->SetBootstrapSecret($jsonId, $secretContent);

Introduced in version 10.1.0

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 1 for success, 0 for failure.

More Information and Examples

AWS Setup Bootstrap Secret in Local Manager AWS Setup Bootstrap Secret in Memory Azure Key Vault - Setup Bootstrap Secret in Local Manager Azure Key Vault - Setup Bootstrap Secret in Memory Oracle Cloud Secrets - Setup Bootstrap Secret in Local Manager Oracle Cloud Secrets - Setup Bootstrap Secret in Memory IBM Cloud Secrets - Setup Bootstrap Secret in Local Manager IBM Cloud Secrets - Setup Bootstrap Secret in Memory Doppler Secrets - Setup Bootstrap Secret in Local Manager Doppler Secrets - Setup Bootstrap Secret in Memory

UpdateSecretBd

# $jsonId is a CkJsonObject
# $secret is a CkBinData
$status = $secrets->UpdateSecretBd($jsonId, $secret);

Introduced in version 10.1.0

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 1 for success, 0 for failure.

More Information and Examples

Windows Credentials Manager / Apple Keychain - Create or Update a Binary Secret AWS Secrets Manager - Create or Update a Binary Secret Azure Key Vault - Create or Update a Binary Secret Oracle Cloud Secrets - Create or Update a Binary Secret IBM Cloud Secrets - Create or Update a Binary Secret Doppler Secrets - Create or Update a Binary Secret

UpdateSecretBdAsync ⁽¹⁾

# returns a CkTask
# $jsonId is a CkJsonObject
# $secret is a CkBinData
$ret_task = $secrets->UpdateSecretBdAsync($jsonId, $secret);

Introduced in version 10.1.0

Creates an asynchronous task to call the UpdateSecretBd method with the arguments provided.

Returns null on failure

UpdateSecretJson

# $jsonId is a CkJsonObject
# $secret is a CkJsonObject
$status = $secrets->UpdateSecretJson($jsonId, $secret);

Introduced in version 10.1.0

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 1 for success, 0 for failure.

More Information and Examples

Windows Credentials Manager / Apple Keychain - Create or Update a JSON Secret Windows Credentials Manager - AutoSplit Larger Secrets Azure Key Vault - Create or Update a JSON Secret Oracle Cloud Secrets - Create or Update a JSON Secret IBM Cloud Secrets - Create or Update a JSON Secret Doppler Secrets - Create or Update a JSON Secret

UpdateSecretJsonAsync ⁽¹⁾

# returns a CkTask
# $jsonId is a CkJsonObject
# $secret is a CkJsonObject
$ret_task = $secrets->UpdateSecretJsonAsync($jsonId, $secret);

Introduced in version 10.1.0

Creates an asynchronous task to call the UpdateSecretJson method with the arguments provided.

Returns null on failure

UpdateSecretSb

# $jsonId is a CkJsonObject
# $sb is a CkStringBuilder
$status = $secrets->UpdateSecretSb($jsonId, $sb);

Introduced in version 10.1.0

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 1 for success, 0 for failure.

More Information and Examples

Create or Update a Secret from the Content of a StringBuilder

UpdateSecretSbAsync ⁽¹⁾

# returns a CkTask
# $jsonId is a CkJsonObject
# $sb is a CkStringBuilder
$ret_task = $secrets->UpdateSecretSbAsync($jsonId, $sb);

Introduced in version 10.1.0

Creates an asynchronous task to call the UpdateSecretSb method with the arguments provided.

Returns null on failure

UpdateSecretStr

# $jsonId is a CkJsonObject
# $secret is a string
$status = $secrets->UpdateSecretStr($jsonId, $secret);

Introduced in version 10.1.0

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.

Returns 1 for success, 0 for failure.

More Information and Examples

Windows Credentials Manager / Apple Keychain - Create or Update a Secret Azure Key Vault - Create or Update a Secret Oracle Cloud Secrets - Create or Update a Secret IBM Cloud Secrets - Create or Update a Secret Doppler Secrets - Create or Update a Secret

UpdateSecretStrAsync ⁽¹⁾

# returns a CkTask
# $jsonId is a CkJsonObject
# $secret is a string
$ret_task = $secrets->UpdateSecretStrAsync($jsonId, $secret);

Introduced in version 10.1.0

Creates an asynchronous task to call the UpdateSecretStr method with the arguments provided.

Returns null on failure