Secrets Tcl 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
set mySecrets [new CkSecrets]
Properties
AutoSplit
set boolVal [CkSecrets_get_AutoSplit $mySecrets]
CkSecrets_put_AutoSplit $mySecrets $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 1.
Compression
set boolVal [CkSecrets_get_Compression $mySecrets]
CkSecrets_put_Compression $mySecrets $boolVal
If set to 1, then the contents of the secret will be stored compressed. The default value of this property is 0.
topDebugLogFilePath
# ckStr is a CkString
CkSecrets_get_DebugLogFilePath $mySecrets $ckStr
set strVal [CkSecrets_get_debugLogFilePath $mySecrets]
CkSecrets_put_DebugLogFilePath $mySecrets $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.
LastErrorHtml
# ckStr is a CkString
CkSecrets_get_LastErrorHtml $mySecrets $ckStr
set strVal [CkSecrets_get_lastErrorHtml $mySecrets]
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.
topLastErrorText
# ckStr is a CkString
CkSecrets_get_LastErrorText $mySecrets $ckStr
set strVal [CkSecrets_get_lastErrorText $mySecrets]
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.
LastErrorXml
# ckStr is a CkString
CkSecrets_get_LastErrorXml $mySecrets $ckStr
set strVal [CkSecrets_get_lastErrorXml $mySecrets]
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.
topLastMethodSuccess
set boolVal [CkSecrets_get_LastMethodSuccess $mySecrets]
CkSecrets_put_LastMethodSuccess $mySecrets $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.
topLocation
# ckStr is a CkString
CkSecrets_get_Location $mySecrets $ckStr
set strVal [CkSecrets_get_location $mySecrets]
CkSecrets_put_Location $mySecrets $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".
topUncommonOptions
# ckStr is a CkString
CkSecrets_get_UncommonOptions $mySecrets $ckStr
set strVal [CkSecrets_get_uncommonOptions $mySecrets]
CkSecrets_put_UncommonOptions $mySecrets $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.
topUtf8
set boolVal [CkSecrets_get_Utf8 $mySecrets]
CkSecrets_put_Utf8 $mySecrets $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.
topVerboseLogging
set boolVal [CkSecrets_get_VerboseLogging $mySecrets]
CkSecrets_put_VerboseLogging $mySecrets $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.
topVersion
# ckStr is a CkString
CkSecrets_get_Version $mySecrets $ckStr
set strVal [CkSecrets_get_version $mySecrets]
Methods
DeleteSecret
set status [CkSecrets_DeleteSecret $jsonId]
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.
DeleteSecretAsync (1)
# jsonId is a CkJsonObject
set ret_task [CkSecrets_DeleteSecretAsync $jsonId]
Creates an asynchronous task to call the DeleteSecret method with the arguments provided.
Returns NULL on failure
topGetSecretBd
# bd is a CkBinData
set status [CkSecrets_GetSecretBd $jsonId $bd]
Fetches a binary secret and returns the content in bd.
Returns 1 for success, 0 for failure.
GetSecretBdAsync (1)
# jsonId is a CkJsonObject
# bd is a CkBinData
set ret_task [CkSecrets_GetSecretBdAsync $jsonId $bd]
Creates an asynchronous task to call the GetSecretBd method with the arguments provided.
Returns NULL on failure
topGetSecretJson
# jsonOut is a CkJsonObject
set status [CkSecrets_GetSecretJson $jsonId $jsonOut]
Fetches a JSON secret and returns the content in jsonOut.
Returns 1 for success, 0 for failure.
GetSecretJsonAsync (1)
# jsonId is a CkJsonObject
# jsonOut is a CkJsonObject
set ret_task [CkSecrets_GetSecretJsonAsync $jsonId $jsonOut]
Creates an asynchronous task to call the GetSecretJson method with the arguments provided.
Returns NULL on failure
topGetSecretSb
# sb is a CkStringBuilder
set status [CkSecrets_GetSecretSb $jsonId $sb]
Fetches a string secret and returns the content in sb.
Returns 1 for success, 0 for failure.
GetSecretSbAsync (1)
# jsonId is a CkJsonObject
# sb is a CkStringBuilder
set ret_task [CkSecrets_GetSecretSbAsync $jsonId $sb]
Creates an asynchronous task to call the GetSecretSb method with the arguments provided.
Returns NULL on failure
topGetSecretStr
# outStr is a CkString (output)
set status [CkSecrets_GetSecretStr $jsonId $outStr]
set retStr [CkSecrets_getSecretStr $mySecrets $jsonId]
Fetches a string secret and returns the content of the secret.
Returns 1 for success, 0 for failure.
GetSecretStrAsync (1)
# jsonId is a CkJsonObject
set ret_task [CkSecrets_GetSecretStrAsync $jsonId]
Creates an asynchronous task to call the GetSecretStr method with the arguments provided.
Returns NULL on failure
topListSecrets
# jsonOut is a CkJsonObject
set status [CkSecrets_ListSecrets $json $jsonOut]
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.
ListSecretsAsync (1)
# json is a CkJsonObject
# jsonOut is a CkJsonObject
set ret_task [CkSecrets_ListSecretsAsync $json $jsonOut]
Creates an asynchronous task to call the ListSecrets method with the arguments provided.
Returns NULL on failure
topSetBootstrapSecret
# secretContent is a CkSecrets
set status [CkSecrets_SetBootstrapSecret $jsonId $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 1 for success, 0 for failure.
UpdateSecretBd
# secret is a CkBinData
set status [CkSecrets_UpdateSecretBd $jsonId $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 1 for success, 0 for failure.
UpdateSecretBdAsync (1)
# jsonId is a CkJsonObject
# secret is a CkBinData
set ret_task [CkSecrets_UpdateSecretBdAsync $jsonId $secret]
Creates an asynchronous task to call the UpdateSecretBd method with the arguments provided.
Returns NULL on failure
topUpdateSecretJson
# secret is a CkJsonObject
set status [CkSecrets_UpdateSecretJson $jsonId $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 1 for success, 0 for failure.
UpdateSecretJsonAsync (1)
# jsonId is a CkJsonObject
# secret is a CkJsonObject
set ret_task [CkSecrets_UpdateSecretJsonAsync $jsonId $secret]
Creates an asynchronous task to call the UpdateSecretJson method with the arguments provided.
Returns NULL on failure
topUpdateSecretSb
# sb is a CkStringBuilder
set status [CkSecrets_UpdateSecretSb $jsonId $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 1 for success, 0 for failure.
UpdateSecretSbAsync (1)
# jsonId is a CkJsonObject
# sb is a CkStringBuilder
set ret_task [CkSecrets_UpdateSecretSbAsync $jsonId $sb]
Creates an asynchronous task to call the UpdateSecretSb method with the arguments provided.
Returns NULL on failure
topUpdateSecretStr
# secret is a string
set status [CkSecrets_UpdateSecretStr $jsonId $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.
Returns 1 for success, 0 for failure.
UpdateSecretStrAsync (1)
# jsonId is a CkJsonObject
# secret is a string
set ret_task [CkSecrets_UpdateSecretStrAsync $jsonId $secret]
Creates an asynchronous task to call the UpdateSecretStr method with the arguments provided.
Returns NULL on failure
top