Secrets DataFlex 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

// (Dataflex programs use the 32-bit Chilkat ActiveX)
Handle hoSecrets
Get Create(RefClass(cComChilkatSecrets)) to hoSecrets

Properties

AutoSplit
Function ComAutoSplit Returns Boolean
Procedure Set ComAutoSplit Boolean value
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 True.

top
Compression
Function ComCompression Returns Boolean
Procedure Set ComCompression Boolean value
Introduced in version 10.1.0

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

top
DebugLogFilePath
Function ComDebugLogFilePath Returns String
Procedure Set ComDebugLogFilePath String value

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
LastBinaryResult
Function ComLastBinaryResult Returns Variant

This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to True. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.

top
LastErrorHtml
Function ComLastErrorHtml Returns String

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
Function ComLastErrorText Returns String

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
Function ComLastErrorXml Returns String

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
Function ComLastMethodSuccess Returns Boolean
Procedure Set ComLastMethodSuccess Boolean value

Indicates the success or failure of the most recent method call: True means success, False 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
LastStringResult
Function ComLastStringResult Returns String

In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.

top
LastStringResultLen
Function ComLastStringResultLen Returns Integer

The length, in characters, of the string contained in the LastStringResult property.

top
Location
Function ComLocation Returns String
Procedure Set ComLocation String value
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
Function ComUncommonOptions Returns String
Procedure Set ComUncommonOptions String value
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
Function ComVerboseLogging Returns Boolean
Procedure Set ComVerboseLogging Boolean value

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

top
Version
Function ComVersion Returns String

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

More Information and Examples
top

Methods

DeleteSecret
Function ComDeleteSecret cComChilkatJsonObject jsonId Returns 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 True for success, False for failure.

top
DeleteSecretAsync (1)
Function ComDeleteSecretAsync cComChilkatJsonObject jsonId Returns cComChilkatTask
Introduced in version 10.1.0

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

Returns null on failure

top
GetSecretBd
Function ComGetSecretBd cComChilkatJsonObject jsonId cComChilkatBinData bd Returns Boolean
Introduced in version 10.1.0

Fetches a binary secret and returns the content in bd.

Returns True for success, False for failure.

top
GetSecretBdAsync (1)
Function ComGetSecretBdAsync cComChilkatJsonObject jsonId cComChilkatBinData bd Returns cComChilkatTask
Introduced in version 10.1.0

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

Returns null on failure

top
GetSecretJson
Function ComGetSecretJson cComChilkatJsonObject jsonId cComChilkatJsonObject jsonOut Returns Boolean
Introduced in version 10.1.0

Fetches a JSON secret and returns the content in jsonOut.

Returns True for success, False for failure.

top
GetSecretJsonAsync (1)
Function ComGetSecretJsonAsync cComChilkatJsonObject jsonId cComChilkatJsonObject jsonOut Returns cComChilkatTask
Introduced in version 10.1.0

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

Returns null on failure

top
GetSecretSb
Function ComGetSecretSb cComChilkatJsonObject jsonId cComChilkatStringBuilder sb Returns Boolean
Introduced in version 10.1.0

Fetches a string secret and returns the content in sb.

Returns True for success, False for failure.

top
GetSecretSbAsync (1)
Function ComGetSecretSbAsync cComChilkatJsonObject jsonId cComChilkatStringBuilder sb Returns cComChilkatTask
Introduced in version 10.1.0

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

Returns null on failure

top
GetSecretStr
Function ComGetSecretStr cComChilkatJsonObject jsonId Returns String
Introduced in version 10.1.0

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

Returns null on failure

top
GetSecretStrAsync (1)
Function ComGetSecretStrAsync cComChilkatJsonObject jsonId Returns cComChilkatTask
Introduced in version 10.1.0

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

Returns null on failure

top
ListSecrets
Function ComListSecrets cComChilkatJsonObject json cComChilkatJsonObject jsonOut Returns 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 True for success, False for failure.

top
ListSecretsAsync (1)
Function ComListSecretsAsync cComChilkatJsonObject json cComChilkatJsonObject jsonOut Returns cComChilkatTask
Introduced in version 10.1.0

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

Returns null on failure

top
SetBootstrapSecret
Function ComSetBootstrapSecret cComChilkatJsonObject jsonId cComChilkatSecrets secretContent Returns 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 True for success, False for failure.

top
UpdateSecretBd
Function ComUpdateSecretBd cComChilkatJsonObject jsonId cComChilkatBinData secret Returns 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 True for success, False for failure.

top
UpdateSecretBdAsync (1)
Function ComUpdateSecretBdAsync cComChilkatJsonObject jsonId cComChilkatBinData secret Returns cComChilkatTask
Introduced in version 10.1.0

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

Returns null on failure

top
UpdateSecretJson
Function ComUpdateSecretJson cComChilkatJsonObject jsonId cComChilkatJsonObject secret Returns 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 True for success, False for failure.

top
UpdateSecretJsonAsync (1)
Function ComUpdateSecretJsonAsync cComChilkatJsonObject jsonId cComChilkatJsonObject secret Returns cComChilkatTask
Introduced in version 10.1.0

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

Returns null on failure

top
UpdateSecretSb
Function ComUpdateSecretSb cComChilkatJsonObject jsonId cComChilkatStringBuilder sb Returns 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 True for success, False for failure.

top
UpdateSecretSbAsync (1)
Function ComUpdateSecretSbAsync cComChilkatJsonObject jsonId cComChilkatStringBuilder sb Returns cComChilkatTask
Introduced in version 10.1.0

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

Returns null on failure

top
UpdateSecretStr
Function ComUpdateSecretStr cComChilkatJsonObject jsonId String secret Returns 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 True for success, False for failure.

top
UpdateSecretStrAsync (1)
Function ComUpdateSecretStrAsync cComChilkatJsonObject jsonId String secret Returns cComChilkatTask
Introduced in version 10.1.0

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

Returns null on failure

top