Secrets C++ Reference Documentation
CkSecrets
Current Version: 11.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
// Local variable on the stack CkSecrets obj; // Dynamically allocate/delete CkSecrets *pObj = new CkSecrets(); // ... delete pObj;
Properties
AutoSplit
void put_AutoSplit(bool newVal);
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.
Compression
void put_Compression(bool newVal);
If set to true, then the contents of the secret will be stored compressed. The default value of this property is false.
DebugLogFilePath
const char *debugLogFilePath(void);
void put_DebugLogFilePath(const char *ansiOrUtf8Str);
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
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
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
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
void put_LastMethodSuccess(bool newVal);
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.
Location
const char *location(void);
void put_Location(const char *ansiOrUtf8Str);
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 Managerazure_key_vault- Azure Key Vaultibm_cloud- IBM Cloud Secrets Manageroracle_cloud- Oracle Cloud Secretsdoppler- Doppler Secretsmemory- In-Memory Secrets
The default location is the local_manager. On Linux and Android, local_manager will behave the same as memory.
UncommonOptions
const char *uncommonOptions(void);
void put_UncommonOptions(const char *ansiOrUtf8Str);
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
void put_Utf8(bool newVal);
When set to true, all const char * arguments and return values are interpreted as UTF-8 strings. When set to false, they are interpreted as ANSI strings.
In Chilkat v11.0.0 and later, the default value is true. Before v11.0.0, it was false.
VerboseLogging
void put_VerboseLogging(bool newVal);
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.
Version
Methods
DeleteSecret
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.
DeleteSecretAsync (1)
Creates an asynchronous task to call the DeleteSecret method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.
Returns NULL on failure
GetSecretBd
Fetches a binary secret and returns the content in bd.
Returns true for success, false for failure.
GetSecretBdAsync (1)
Creates an asynchronous task to call the GetSecretBd method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.
Returns NULL on failure
GetSecretJson
Fetches a JSON secret and returns the content in jsonOut.
Returns true for success, false for failure.
GetSecretJsonAsync (1)
Creates an asynchronous task to call the GetSecretJson method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.
Returns NULL on failure
GetSecretSb
Fetches a string secret and returns the content in sb.
Returns true for success, false for failure.
GetSecretSbAsync (1)
Creates an asynchronous task to call the GetSecretSb method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.
Returns NULL on failure
GetSecretStr
const char *getSecretStr(CkJsonObject &jsonId);
Fetches a string secret and returns the content of the secret.
Returns true for success, false for failure.
GetSecretStrAsync (1)
Creates an asynchronous task to call the GetSecretStr method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.
Returns NULL on failure
ListSecrets
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.
ListSecretsAsync (1)
Creates an asynchronous task to call the ListSecrets method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.
Returns NULL on failure
SetBootstrapSecret
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.
UpdateSecretBd
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.
UpdateSecretBdAsync (1)
Creates an asynchronous task to call the UpdateSecretBd method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.
Returns NULL on failure
UpdateSecretJson
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.
UpdateSecretJsonAsync (1)
Creates an asynchronous task to call the UpdateSecretJson method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.
Returns NULL on failure
UpdateSecretSb
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.
UpdateSecretSbAsync (1)
Creates an asynchronous task to call the UpdateSecretSb method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.
Returns NULL on failure
UpdateSecretStr
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.
UpdateSecretStrAsync (1)
Creates an asynchronous task to call the UpdateSecretStr method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.
Returns NULL on failure
Events
To implement an event callback, your application would define and implement a class that inherits from CkBaseProgress. Your application can implement methods to override some or all of the default/empty method implementations of the CkBaseProgress base class.
For example:
CkSecrets secrets; MySecretsProgress callbackObj; secrets.put_EventCallbackObject(&callbackObj);
MySecretsProgress example:
#include "CkBaseProgress.h"
class MySecretsProgress : public CkBaseProgress {
public:
MySecretsProgress();
virtual ~MySecretsProgress();
void AbortCheck(bool *abort);
void PercentDone(int pctDone, bool *abort);
void ProgressInfo(const char *name, const char *value);
void TaskCompleted(CkTask &task);
};AbortCheck
Enables a method call to be aborted by triggering the AbortCheck event at intervals defined by the HeartbeatMs property. If HeartbeatMs is set to its default value of 0, no events will occur. For instance, set HeartbeatMs to 200 to trigger 5 AbortCheck events per second.
PercentDone
This provides the percentage completion for any method involving network communications or time-consuming processing, assuming the progress can be measured as a percentage. This event is triggered only when it's possible and logical to express the operation's progress as a percentage. The pctDone argument will range from 1 to 100. For methods that finish quickly, the number of PercentDone callbacks may vary, but the final callback will have pctDone equal to 100. For longer operations, callbacks will not exceed one per percentage point (e.g., 1, 2, 3, ..., 98, 99, 100).
The PercentDone callback also acts as an AbortCheck event. For fast methods where PercentDone fires, an AbortCheck event may not trigger since the PercentDone callback already provides an opportunity to abort. For longer operations, where time between PercentDone callbacks is extended, AbortCheck callbacks enable more responsive operation termination.
To abort the operation, set the abort output argument to true. This will cause the method to terminate and return a failure status or corresponding failure value.
ProgressInfo
This event callback provides tag name/value pairs that detail what occurs during a method call. To discover existing tag names, create code to handle the event, emit the pairs, and review them. Most tag names are self-explanatory.
TaskCompleted
Called from the background thread when an asynchronous task completes.