Secrets Lianja Reference Documentation

Secrets

Current Version: 10.1.0

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

loObject = createobject("CkSecrets")

Properties

AutoSplit
AutoSplit As Boolean
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 .T..

top
Compression
Compression As Boolean
Introduced in version 10.1.0

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

top
DebugLogFilePath
DebugLogFilePath As Character

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
top
LastErrorHtml
LastErrorHtml As Character (read-only)

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.

top
LastErrorText
LastErrorText As Character (read-only)

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.

top
LastErrorXml
LastErrorXml As Character (read-only)

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.

top
LastMethodSuccess
LastMethodSuccess As Boolean

Indicates the success or failure of the most recent method call: .T. means success, .F. 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.

top
Location
Location As Character
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".

top
UncommonOptions
UncommonOptions As Character
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.

top
VerboseLogging
VerboseLogging As Boolean

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

top
Version
Version As Character (read-only)

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

More Information and Examples
top

Methods

DeleteSecret
DeleteSecret(jsonId As CkJsonObject) As Boolean
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 .T. for success, .F. for failure.

top
DeleteSecretAsync (1)
DeleteSecretAsync(jsonId As CkJsonObject) As CkTask
Introduced in version 10.1.0

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

Returns .F. on failure

top
GetSecretBd
GetSecretBd(jsonId As CkJsonObject, bd As CkBinData) As Boolean
Introduced in version 10.1.0

Fetches a binary secret and returns the content in bd.

Returns .T. for success, .F. for failure.

top
GetSecretBdAsync (1)
GetSecretBdAsync(jsonId As CkJsonObject, bd As CkBinData) As CkTask
Introduced in version 10.1.0

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

Returns .F. on failure

top
GetSecretJson
GetSecretJson(jsonId As CkJsonObject, jsonOut As CkJsonObject) As Boolean
Introduced in version 10.1.0

Fetches a JSON secret and returns the content in jsonOut.

Returns .T. for success, .F. for failure.

top
GetSecretJsonAsync (1)
GetSecretJsonAsync(jsonId As CkJsonObject, jsonOut As CkJsonObject) As CkTask
Introduced in version 10.1.0

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

Returns .F. on failure

top
GetSecretSb
GetSecretSb(jsonId As CkJsonObject, sb As CkStringBuilder) As Boolean
Introduced in version 10.1.0

Fetches a string secret and returns the content in sb.

Returns .T. for success, .F. for failure.

top
GetSecretSbAsync (1)
GetSecretSbAsync(jsonId As CkJsonObject, sb As CkStringBuilder) As CkTask
Introduced in version 10.1.0

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

Returns .F. on failure

top
GetSecretStr
GetSecretStr(jsonId As CkJsonObject) As Character
Introduced in version 10.1.0

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

Returns .F. on failure

top
GetSecretStrAsync (1)
GetSecretStrAsync(jsonId As CkJsonObject) As CkTask
Introduced in version 10.1.0

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

Returns .F. on failure

top
ListSecrets
ListSecrets(json As CkJsonObject, jsonOut As CkJsonObject) As Boolean
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 .T. for success, .F. for failure.

top
ListSecretsAsync (1)
ListSecretsAsync(json As CkJsonObject, jsonOut As CkJsonObject) As CkTask
Introduced in version 10.1.0

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

Returns .F. on failure

top
SetBootstrapSecret
SetBootstrapSecret(jsonId As CkJsonObject, secretContent As CkSecrets) As Boolean
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 .T. for success, .F. for failure.

top
UpdateSecretBd
UpdateSecretBd(jsonId As CkJsonObject, secret As CkBinData) As Boolean
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 .T. for success, .F. for failure.

top
UpdateSecretBdAsync (1)
UpdateSecretBdAsync(jsonId As CkJsonObject, secret As CkBinData) As CkTask
Introduced in version 10.1.0

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

Returns .F. on failure

top
UpdateSecretJson
UpdateSecretJson(jsonId As CkJsonObject, secret As CkJsonObject) As Boolean
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 .T. for success, .F. for failure.

top
UpdateSecretJsonAsync (1)
UpdateSecretJsonAsync(jsonId As CkJsonObject, secret As CkJsonObject) As CkTask
Introduced in version 10.1.0

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

Returns .F. on failure

top
UpdateSecretSb
UpdateSecretSb(jsonId As CkJsonObject, sb As CkStringBuilder) As Boolean
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 .T. for success, .F. for failure.

top
UpdateSecretSbAsync (1)
UpdateSecretSbAsync(jsonId As CkJsonObject, sb As CkStringBuilder) As CkTask
Introduced in version 10.1.0

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

Returns .F. on failure

top
UpdateSecretStr
UpdateSecretStr(jsonId As CkJsonObject, secret As Character) As Boolean
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 .T. for success, .F. for failure.

top
UpdateSecretStrAsync (1)
UpdateSecretStrAsync(jsonId As CkJsonObject, secret As Character) As CkTask
Introduced in version 10.1.0

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

Returns .F. on failure

top