AzureSecrets Class

Properties   Methods   Events   Config Settings   Errors  

The AzureSecrets class makes it easy to interact with secrets in Azure Key Vaults.

Syntax

AzureSecrets

Remarks

The AzureSecrets class provides an easy-to-use interface for the secret-related functionality of the Azure Key Vault service. Azure Key Vault allows you to work with a few different kinds of resources, one of which is secrets (e.g., passwords, symmetric keys, etc.). This class helps you to create and manage said secrets. To work with asymmetric key pairs instead, refer to the AzureKeys class.

To begin, register for an Azure account and create one or more Key Vaults via the Azure Portal. Set the Vault property to the name of the vault you wish to work with.

This class requires authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth property to set the appropriate fields for the chosen ClientProfile and GrantType.

The component has the following defaults:

Additionally, depending on how the application is registered (Ex. Single-tenant, Multi-tenant) and what OAuthGrantType is selected (Ex. Authorization Code, Password), it may be required to use the tenant ID rather than "common" in the OAuthServerAuthURL, and OAuthServerTokenURL fields. See below for examples of the modified URLs:

Application Profile

This profile encompasses the most basic grant types that OAuth supports. When this profile is set, all the requests and response handling is done by the class. Depending on the grant type, this may involve launching a browser so a user can login to authenticate with a authorization server. It may also involve starting an embedded web server to receive a response from a redirect.

To start the authentication and authorization process, the Authorize method should be called. If the authorization and authentication was successful, then the AccessToken field will be populated. Additionally, if a refresh token was provided the RefreshToken field will be populated as well. These values of the fields are for informational purposes. The class will also cache these tokens along with when the AccessToken will be expired. When a method that makes requests to the service provider is called or the Authorize method is called the class will automatically check to see if the access token is expired. If it is, it will then automatically try to get a new AccessToken. If the Authorize method was not used and user interaction would be required, the class will throw an error which can be caught. When user interaction is needed depends on what grant type is set in the GrantType field. To force the component to only check the access token when the Authorize method is called, the OAuthAutomaticRefresh configuration setting can be set to false.

A brief description of the supported values for the GrantType field are below. For more information, see the service documentation.

Authorization Code

When using the Authorization Code grant type, the class will use an authorization code to get an access token. For this GrantType the class expects a ClientId, ClientSecret, ServerAuthURL, and ServerTokenURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the class will parse the authorization code, setting the AuthorizationCode field, from the redirect. Immediately, the class will make a request to the token server to exchange the authorization code for an access token. The token server will return an access token and possibly a refresh token. If the RefreshToken field is set, or a refresh token is cached, then the class will not launch the browser and use the refresh token in its request to the token server instead of an authorization code.

Example: AzureSecrets azuresecrets = new AzureSecrets(); azuresecrets.OAuth.ClientProfile = CloudOAuthClientProfiles.cocpApplication; azuresecrets.OAuth.GrantType = OAuthSettingsGrantTypes.cogtAuthorizationCode; azuresecrets.OAuth.ClientId = CLIENT_ID; azuresecrets.OAuth.ClientSecret = SECRET_ID; azuresecrets.OAuth.AuthorizationScope = "offline_access https://vault.azure.net/user_impersonation"; azuresecrets.OAuth.ServerAuthURL = "https://login.microsoftonline.com/" + TENANT_ID + "/oauth2/v2.0/authorize"; azuresecrets.OAuth.ServerTokenURL = "https://login.microsoftonline.com/" + TENANT_ID + "/oauth2/v2.0/token"; azuresecrets.Authorize(); Implicit

Note: This grant type is considered insecure and should only be used when necessary.

When using the Implicit grant type, the class will request the authorization server to get an access token. For this GrantType the class expects a ClientId, ClientSecret, and ServerAuthURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the class will parse the access token from the redirect.

A disadvantage of the grant type is that can not use a refresh token to silently get a new access token. Most service providers offer a way to silently get a new access token. See the service documentation for specifics. This means the class will not be able to automatically get a fresh token once it expires.

Password

Note: This grant type is considered insecure and should only be used when necessary.

When using the Resource Owner Password Credentials grant type, the class will authenticate as the resource owner. This allows for the class to avoid user interaction. This grant type often has specific limitations put on it by the service provider. See the service documentation for more details.

For this GrantType the class requires OAuthPasswordGrantUsername, ClientSecret, and ServerTokenURL to be set. The ClientSecret should be set to the password of the account instead of a typical secret. In some cases, the ClientId also needs to be set. When the Authorize method is called, the component will make a request to the token server for an access token using the username and password. The token server will return an access token if the authentication was successful. When this access token is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one.

Web Profile

External OAuth Support

Bearer ACCESS_TOKEN_VALUE

Assign this value to the Authorization property before attempting any operations. Setting the Authorization property will cause the class to ignore the values set in the OAuth property.

For Example: Oauth oauth = new Oauth(); oauth.ClientId = "CLIENT_ID"; oauth.ClientSecret = "CLIENT_SECRET"; oauth.ServerAuthURL = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize"; oauth.ServerTokenURL = "https://login.microsoftonline.com/common/oauth2/v2.0/token"; oauth.AuthorizationScope = "offline_access https://vault.azure.net/user_impersonation"; oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode; azuresecrets.Authorization = oauth.GetAuthorization(); Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.

Using the Class

Secrets can be created using the CreateSecret method. A secret's name must be set at the time of creation, and cannot be changed later. The secret's value and, optionally, content type must also be set, but can be changed at any time. To change a secret's value, create a new version of it using the CreateSecret method (which will always create a new version if a secret with the specified name already exists); to change a secret's content-type, use the UpdateSecret method.

To retrieve a secret and its information, use the GetSecret method.

When a secret will no long be used, it can be deleted using the DeleteSecret method. However, the secret will only be soft-deleted; by default, Azure will permanently delete it after the waiting period configured for the vault. During this waiting period, the soft-deleted secret may be recovered using RecoverSecret, or permanently deleted using PurgeSecret (assuming the currently-authenticated user has the permissions to do so). // Create a secret. azuresecrets.SecretData = "Test123"; azuresecrets.CreateSecret("mysecret", "text/plain"); // Download the secret value to a local file. azuresecrets.LocalFile = "C:\temp\secret.txt"; azuresecrets.GetSecret("mysecret"); // Create a new version of the secret. azuresecrets.SecretData = "Cats456"; azuresecrets.CreateSecret("mysecret", "text/plain"); // ... Some time later, when the secret is no longer needed ... azuresecrets.DeleteSecret("mysecret"); // At this point, the secret is only soft-deleted. It could be recovered... azuresecrets.RecoverSecret("mysecret"); // ...or permanently deleted. azuresecrets.PurgeSecret("mysecret");

To list secrets, use the ListSecrets method. This method is also used to list soft-deleted secrets if the GetDeleted configuration setting has been enabled first. To list a secret's versions, use the ListVersions method. (You cannot list a deleted secret's versions.) // If there are many secrets to list, there may be multiple pages of results. This will // cause all pages of results to be accumulated into the Secrets collection property. do { azuresecrets.ListSecrets(); } while (!string.IsNullOrEmpty(azuresecrets.SecretMarker)); // A similar thing applies to secret versions as well. do { azuresecrets.ListVersions("mysecret"); } while (!string.IsNullOrEmpty(azuresecrets.VersionMarker));

The class also supports a variety of other functionality, including:

• Enabling and disabling secrets with SetSecretEnabled.
• Tagging support using AddTag and the Tags properties.
• Secure secret backup and restoration using BackupSecret and RestoreSecret.
• And more!

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

Authorization Property (AzureSecrets Class)

OAuth 2.0 Authorization Token.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthorization();
int SetAuthorization(const char* lpszAuthorization);

Unicode (Windows)
LPWSTR GetAuthorization();
INT SetAuthorization(LPCWSTR lpszAuthorization);

char* cloudkeys_azuresecrets_getauthorization(void* lpObj);
int cloudkeys_azuresecrets_setauthorization(void* lpObj, const char* lpszAuthorization);

QString GetAuthorization();
int SetAuthorization(QString qsAuthorization);

Default Value

""

Remarks

This class supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth class or a separate process. Once complete you should have an authorization string which looks like:

Bearer ACCESS_TOKEN

Data Type

String

EncodeData Property (AzureSecrets Class)

Whether to automatically base64-encode and -decode secret data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncodeData();
int SetEncodeData(int bEncodeData);

Unicode (Windows)
BOOL GetEncodeData();
INT SetEncodeData(BOOL bEncodeData);

int cloudkeys_azuresecrets_getencodedata(void* lpObj);
int cloudkeys_azuresecrets_setencodedata(void* lpObj, int bEncodeData);

bool GetEncodeData();
int SetEncodeData(bool bEncodeData);

Default Value

FALSE

Remarks

This property specifies whether the class should automatically base64-encode secret data when it is uploaded by CreateSecret, and base64-decode it when it is downloaded with GetSecret.

Secrets are stored on the server as strings, and are transported via a JSON string property, so binary values must be encoded in some way; this property is provided as a convenience.

This property is not available at design time.

Data Type

Boolean

Firewall Property (AzureSecrets Class)

A set of properties related to firewall access.

Syntax

• C++
• C
• Qt

CloudKeysFirewall* GetFirewall();
int SetFirewall(CloudKeysFirewall* val);

int cloudkeys_azuresecrets_getfirewallautodetect(void* lpObj);
int cloudkeys_azuresecrets_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int cloudkeys_azuresecrets_getfirewalltype(void* lpObj);
int cloudkeys_azuresecrets_setfirewalltype(void* lpObj, int iFirewallType);

char* cloudkeys_azuresecrets_getfirewallhost(void* lpObj);
int cloudkeys_azuresecrets_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* cloudkeys_azuresecrets_getfirewallpassword(void* lpObj);
int cloudkeys_azuresecrets_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int cloudkeys_azuresecrets_getfirewallport(void* lpObj);
int cloudkeys_azuresecrets_setfirewallport(void* lpObj, int iFirewallPort);

char* cloudkeys_azuresecrets_getfirewalluser(void* lpObj);
int cloudkeys_azuresecrets_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.

Data Type

CloudKeysFirewall

Idle Property (AzureSecrets Class)

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int cloudkeys_azuresecrets_getidle(void* lpObj);

bool GetIdle();

Default Value

TRUE

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

LocalFile Property (AzureSecrets Class)

The local file to write data to, or whose data should be sent.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalFile();
wchar_t* GetLocalFile_W(); // Windows only
int SetLocalFile(const char* lpszLocalFile);
int SetLocalFile(const wchar_t* lpszLocalFile); // Windows only

Unicode (Windows)
LPWSTR GetLocalFile();
INT SetLocalFile(LPCWSTR lpszLocalFile);

char* cloudkeys_azuresecrets_getlocalfile(void* lpObj);
wchar_t* cloudkeys_azuresecrets_getlocalfile_W(void* lpObj); // Windows only
int cloudkeys_azuresecrets_setlocalfile(void* lpObj, const char* lpszLocalFile);
int cloudkeys_azuresecrets_setlocalfile(void* lpObj, const wchar_t* lpszLocalFile); // Windows only

QString GetLocalFile();
int SetLocalFile(QString qsLocalFile);

Default Value

""

Remarks

This property specifies the location of a local file on disk. This is used as the source file when calling CreateSecret, and as the destination file when calling GetSecret.

Note: Setting this property to a non-empty value will discard and streams set using SetInputStream and SetOutputStream. Similarly, passing a non-null value to either of those methods will clear this property.

Data Type

String

LocalHost Property (AzureSecrets Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* cloudkeys_azuresecrets_getlocalhost(void* lpObj);
int cloudkeys_azuresecrets_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

OAuth Property (AzureSecrets Class)

This property holds the OAuth Settings.

Syntax

• C++
• C
• Qt

CloudKeysOAuthSettings* GetOAuth();

char* cloudkeys_azuresecrets_getoauthaccesstoken(void* lpObj);
int cloudkeys_azuresecrets_setoauthaccesstoken(void* lpObj, const char* lpszOAuthAccessToken);

char* cloudkeys_azuresecrets_getoauthauthorizationcode(void* lpObj);
int cloudkeys_azuresecrets_setoauthauthorizationcode(void* lpObj, const char* lpszOAuthAuthorizationCode);

char* cloudkeys_azuresecrets_getoauthauthorizationscope(void* lpObj);
int cloudkeys_azuresecrets_setoauthauthorizationscope(void* lpObj, const char* lpszOAuthAuthorizationScope);

char* cloudkeys_azuresecrets_getoauthclientid(void* lpObj);
int cloudkeys_azuresecrets_setoauthclientid(void* lpObj, const char* lpszOAuthClientId);

int cloudkeys_azuresecrets_getoauthclientprofile(void* lpObj);
int cloudkeys_azuresecrets_setoauthclientprofile(void* lpObj, int iOAuthClientProfile);

char* cloudkeys_azuresecrets_getoauthclientsecret(void* lpObj);
int cloudkeys_azuresecrets_setoauthclientsecret(void* lpObj, const char* lpszOAuthClientSecret);

int cloudkeys_azuresecrets_getoauthgranttype(void* lpObj);
int cloudkeys_azuresecrets_setoauthgranttype(void* lpObj, int iOAuthGrantType);

char* cloudkeys_azuresecrets_getoauthrefreshtoken(void* lpObj);
int cloudkeys_azuresecrets_setoauthrefreshtoken(void* lpObj, const char* lpszOAuthRefreshToken);

int cloudkeys_azuresecrets_getoauthrequestrefreshtoken(void* lpObj);
int cloudkeys_azuresecrets_setoauthrequestrefreshtoken(void* lpObj, int bOAuthRequestRefreshToken);

char* cloudkeys_azuresecrets_getoauthreturnurl(void* lpObj);
int cloudkeys_azuresecrets_setoauthreturnurl(void* lpObj, const char* lpszOAuthReturnURL);

char* cloudkeys_azuresecrets_getoauthserverauthurl(void* lpObj);
int cloudkeys_azuresecrets_setoauthserverauthurl(void* lpObj, const char* lpszOAuthServerAuthURL);

char* cloudkeys_azuresecrets_getoauthservertokenurl(void* lpObj);
int cloudkeys_azuresecrets_setoauthservertokenurl(void* lpObj, const char* lpszOAuthServerTokenURL);

char* cloudkeys_azuresecrets_getoauthwebauthurl(void* lpObj);

QString GetOAuthAccessToken();
int SetOAuthAccessToken(QString qsOAuthAccessToken);

QString GetOAuthAuthorizationCode();
int SetOAuthAuthorizationCode(QString qsOAuthAuthorizationCode);

QString GetOAuthAuthorizationScope();
int SetOAuthAuthorizationScope(QString qsOAuthAuthorizationScope);

QString GetOAuthClientId();
int SetOAuthClientId(QString qsOAuthClientId);

int GetOAuthClientProfile();
int SetOAuthClientProfile(int iOAuthClientProfile);

QString GetOAuthClientSecret();
int SetOAuthClientSecret(QString qsOAuthClientSecret);

int GetOAuthGrantType();
int SetOAuthGrantType(int iOAuthGrantType);

QString GetOAuthRefreshToken();
int SetOAuthRefreshToken(QString qsOAuthRefreshToken);

bool GetOAuthRequestRefreshToken();
int SetOAuthRequestRefreshToken(bool bOAuthRequestRefreshToken);

QString GetOAuthReturnURL();
int SetOAuthReturnURL(QString qsOAuthReturnURL);

QString GetOAuthServerAuthURL();
int SetOAuthServerAuthURL(QString qsOAuthServerAuthURL);

QString GetOAuthServerTokenURL();
int SetOAuthServerTokenURL(QString qsOAuthServerTokenURL);

QString GetOAuthWebAuthURL();

Remarks

This property is used to define the necessary fields to authenticate with the service provider. See the introduction for more information.

This property is read-only and not available at design time.

Data Type

CloudKeysOAuthSettings

OtherHeaders Property (AzureSecrets Class)

Other headers as determined by the user (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOtherHeaders();
int SetOtherHeaders(const char* lpszOtherHeaders);

Unicode (Windows)
LPWSTR GetOtherHeaders();
INT SetOtherHeaders(LPCWSTR lpszOtherHeaders);

char* cloudkeys_azuresecrets_getotherheaders(void* lpObj);
int cloudkeys_azuresecrets_setotherheaders(void* lpObj, const char* lpszOtherHeaders);

QString GetOtherHeaders();
int SetOtherHeaders(QString qsOtherHeaders);

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the class beyond what is provided.

This property is not available at design time.

Data Type

String

Overwrite Property (AzureSecrets Class)

Whether the local file should be overwritten if necessary.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOverwrite();
int SetOverwrite(int bOverwrite);

Unicode (Windows)
BOOL GetOverwrite();
INT SetOverwrite(BOOL bOverwrite);

int cloudkeys_azuresecrets_getoverwrite(void* lpObj);
int cloudkeys_azuresecrets_setoverwrite(void* lpObj, int bOverwrite);

bool GetOverwrite();
int SetOverwrite(bool bOverwrite);

Default Value

FALSE

Remarks

This property controls whether the specified LocalFile should be overwritten if it already exists.

This property is not available at design time.

Data Type

Boolean

ParsedHeaders Property (AzureSecrets Class)

This property includes a collection of headers returned from the last request.

Syntax

• C++
• C
• Qt

CloudKeysList<CloudKeysHeader>* GetParsedHeaders();

int cloudkeys_azuresecrets_getparsedheadercount(void* lpObj);

char* cloudkeys_azuresecrets_getparsedheaderfield(void* lpObj, int parsedheaderindex);

char* cloudkeys_azuresecrets_getparsedheadervalue(void* lpObj, int parsedheaderindex);

int GetParsedHeaderCount();

QString GetParsedHeaderField(int iParsedHeaderIndex);

QString GetParsedHeaderValue(int iParsedHeaderIndex);

Remarks

This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each Header in this collection contains information describing that header.

MaxHeaders can be used to control the maximum number of headers saved.

This property is read-only and not available at design time.

Data Type

CloudKeysHeader

Proxy Property (AzureSecrets Class)

A set of properties related to proxy access.

Syntax

• C++
• C
• Qt

CloudKeysProxy* GetProxy();
int SetProxy(CloudKeysProxy* val);

int cloudkeys_azuresecrets_getproxyauthscheme(void* lpObj);
int cloudkeys_azuresecrets_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int cloudkeys_azuresecrets_getproxyautodetect(void* lpObj);
int cloudkeys_azuresecrets_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

char* cloudkeys_azuresecrets_getproxypassword(void* lpObj);
int cloudkeys_azuresecrets_setproxypassword(void* lpObj, const char* lpszProxyPassword);

int cloudkeys_azuresecrets_getproxyport(void* lpObj);
int cloudkeys_azuresecrets_setproxyport(void* lpObj, int iProxyPort);

char* cloudkeys_azuresecrets_getproxyserver(void* lpObj);
int cloudkeys_azuresecrets_setproxyserver(void* lpObj, const char* lpszProxyServer);

int cloudkeys_azuresecrets_getproxyssl(void* lpObj);
int cloudkeys_azuresecrets_setproxyssl(void* lpObj, int iProxySSL);

char* cloudkeys_azuresecrets_getproxyuser(void* lpObj);
int cloudkeys_azuresecrets_setproxyuser(void* lpObj, const char* lpszProxyUser);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Remarks

This property contains fields describing the proxy through which the class will attempt to connect.

Data Type

CloudKeysProxy

QueryParams Property (AzureSecrets Class)

Additional query parameters to be included in the request.

Syntax

• C++
• C
• Qt

CloudKeysList<CloudKeysQueryParam>* GetQueryParams();
int SetQueryParams(CloudKeysList<CloudKeysQueryParam>* val);

int cloudkeys_azuresecrets_getqueryparamcount(void* lpObj);
int cloudkeys_azuresecrets_setqueryparamcount(void* lpObj, int iQueryParamCount);

char* cloudkeys_azuresecrets_getqueryparamname(void* lpObj, int queryparamindex);
int cloudkeys_azuresecrets_setqueryparamname(void* lpObj, int queryparamindex, const char* lpszQueryParamName);

char* cloudkeys_azuresecrets_getqueryparamvalue(void* lpObj, int queryparamindex);
int cloudkeys_azuresecrets_setqueryparamvalue(void* lpObj, int queryparamindex, const char* lpszQueryParamValue);

int GetQueryParamCount();
int SetQueryParamCount(int iQueryParamCount);

QString GetQueryParamName(int iQueryParamIndex);
int SetQueryParamName(int iQueryParamIndex, QString qsQueryParamName);

QString GetQueryParamValue(int iQueryParamIndex);
int SetQueryParamValue(int iQueryParamIndex, QString qsQueryParamValue);

Remarks

This is a collection of query parameters that will be added to the request. Parameters can be added via the AddQueryParam method.

Data Type

CloudKeysQueryParam

SecretData Property (AzureSecrets Class)

The secret data that was retrieved, or that should be sent.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSecretData(char* &lpSecretData, int &lenSecretData);
int SetSecretData(const char* lpSecretData, int lenSecretData);

Unicode (Windows)
INT GetSecretData(LPSTR &lpSecretData, INT &lenSecretData);
INT SetSecretData(LPCSTR lpSecretData, INT lenSecretData);

int cloudkeys_azuresecrets_getsecretdata(void* lpObj, char** lpSecretData, int* lenSecretData);
int cloudkeys_azuresecrets_setsecretdata(void* lpObj, const char* lpSecretData, int lenSecretData);

QByteArray GetSecretData();
int SetSecretData(QByteArray qbaSecretData);

Default Value

""

Remarks

This property is populated with secret data after calling GetSecret if SetOutputStream and LocalFile are not set.

This property can also be set before calling CreateSecret; its data will be sent if SetInputStream and LocalFile are not set.

This property is not available at design time.

Data Type

Binary String

SecretMarker Property (AzureSecrets Class)

A marker indicating what page of secrets to return next.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSecretMarker();
int SetSecretMarker(const char* lpszSecretMarker);

Unicode (Windows)
LPWSTR GetSecretMarker();
INT SetSecretMarker(LPCWSTR lpszSecretMarker);

char* cloudkeys_azuresecrets_getsecretmarker(void* lpObj);
int cloudkeys_azuresecrets_setsecretmarker(void* lpObj, const char* lpszSecretMarker);

QString GetSecretMarker();
int SetSecretMarker(QString qsSecretMarker);

Default Value

""

Remarks

This property will be populated when ListSecrets is called if the results are paged and there are more pages. To list all secrets, continue to call ListSecrets until this property returns empty string.

Refer to ListSecrets for more information.

This property is not available at design time.

Data Type

String

Secrets Property (AzureSecrets Class)

A collection of secrets.

Syntax

• C++
• C
• Qt

CloudKeysList<CloudKeysAzureSecret>* GetSecrets();

int cloudkeys_azuresecrets_getsecretcount(void* lpObj);

char* cloudkeys_azuresecrets_getsecretcontenttype(void* lpObj, int secretindex);

int64 cloudkeys_azuresecrets_getsecretcreationdate(void* lpObj, int secretindex);

int64 cloudkeys_azuresecrets_getsecretdeletiondate(void* lpObj, int secretindex);

int cloudkeys_azuresecrets_getsecretenabled(void* lpObj, int secretindex);

int64 cloudkeys_azuresecrets_getsecretexpirydate(void* lpObj, int secretindex);

char* cloudkeys_azuresecrets_getsecretname(void* lpObj, int secretindex);

int64 cloudkeys_azuresecrets_getsecretnotbeforedate(void* lpObj, int secretindex);

int64 cloudkeys_azuresecrets_getsecretpurgedate(void* lpObj, int secretindex);

int cloudkeys_azuresecrets_getsecretrecoverabledays(void* lpObj, int secretindex);

char* cloudkeys_azuresecrets_getsecretrecoverylevel(void* lpObj, int secretindex);

int64 cloudkeys_azuresecrets_getsecretupdatedate(void* lpObj, int secretindex);

char* cloudkeys_azuresecrets_getsecretversionid(void* lpObj, int secretindex);

int GetSecretCount();

QString GetSecretContentType(int iSecretIndex);

qint64 GetSecretCreationDate(int iSecretIndex);

qint64 GetSecretDeletionDate(int iSecretIndex);

bool GetSecretEnabled(int iSecretIndex);

qint64 GetSecretExpiryDate(int iSecretIndex);

QString GetSecretName(int iSecretIndex);

qint64 GetSecretNotBeforeDate(int iSecretIndex);

qint64 GetSecretPurgeDate(int iSecretIndex);

int GetSecretRecoverableDays(int iSecretIndex);

QString GetSecretRecoveryLevel(int iSecretIndex);

qint64 GetSecretUpdateDate(int iSecretIndex);

QString GetSecretVersionId(int iSecretIndex);

Remarks

This collection holds a list of AzureSecret items.

Calling ListSecrets, ListVersions, or GetSecret will populate this collection.

This property is read-only and not available at design time.

Data Type

CloudKeysAzureSecret

SSLAcceptServerCert Property (AzureSecrets Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C++
• C
• Qt

CloudKeysCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(CloudKeysCertificate* val);

char* cloudkeys_azuresecrets_getsslacceptservercerteffectivedate(void* lpObj);

char* cloudkeys_azuresecrets_getsslacceptservercertexpirationdate(void* lpObj);

char* cloudkeys_azuresecrets_getsslacceptservercertextendedkeyusage(void* lpObj);

char* cloudkeys_azuresecrets_getsslacceptservercertfingerprint(void* lpObj);

char* cloudkeys_azuresecrets_getsslacceptservercertfingerprintsha1(void* lpObj);

char* cloudkeys_azuresecrets_getsslacceptservercertfingerprintsha256(void* lpObj);

char* cloudkeys_azuresecrets_getsslacceptservercertissuer(void* lpObj);

char* cloudkeys_azuresecrets_getsslacceptservercertprivatekey(void* lpObj);

int cloudkeys_azuresecrets_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* cloudkeys_azuresecrets_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* cloudkeys_azuresecrets_getsslacceptservercertpublickey(void* lpObj);

char* cloudkeys_azuresecrets_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int cloudkeys_azuresecrets_getsslacceptservercertpublickeylength(void* lpObj);

char* cloudkeys_azuresecrets_getsslacceptservercertserialnumber(void* lpObj);

char* cloudkeys_azuresecrets_getsslacceptservercertsignaturealgorithm(void* lpObj);

int cloudkeys_azuresecrets_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int cloudkeys_azuresecrets_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* cloudkeys_azuresecrets_getsslacceptservercertstorepassword(void* lpObj);
int cloudkeys_azuresecrets_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int cloudkeys_azuresecrets_getsslacceptservercertstoretype(void* lpObj);
int cloudkeys_azuresecrets_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* cloudkeys_azuresecrets_getsslacceptservercertsubjectaltnames(void* lpObj);

char* cloudkeys_azuresecrets_getsslacceptservercertthumbprintmd5(void* lpObj);

char* cloudkeys_azuresecrets_getsslacceptservercertthumbprintsha1(void* lpObj);

char* cloudkeys_azuresecrets_getsslacceptservercertthumbprintsha256(void* lpObj);

char* cloudkeys_azuresecrets_getsslacceptservercertusage(void* lpObj);

int cloudkeys_azuresecrets_getsslacceptservercertusageflags(void* lpObj);

char* cloudkeys_azuresecrets_getsslacceptservercertversion(void* lpObj);

char* cloudkeys_azuresecrets_getsslacceptservercertsubject(void* lpObj);
int cloudkeys_azuresecrets_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int cloudkeys_azuresecrets_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int cloudkeys_azuresecrets_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore);

QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword);

int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType);

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Data Type

CloudKeysCertificate

SSLCert Property (AzureSecrets Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C++
• C
• Qt

CloudKeysCertificate* GetSSLCert();
int SetSSLCert(CloudKeysCertificate* val);

char* cloudkeys_azuresecrets_getsslcerteffectivedate(void* lpObj);

char* cloudkeys_azuresecrets_getsslcertexpirationdate(void* lpObj);

char* cloudkeys_azuresecrets_getsslcertextendedkeyusage(void* lpObj);

char* cloudkeys_azuresecrets_getsslcertfingerprint(void* lpObj);

char* cloudkeys_azuresecrets_getsslcertfingerprintsha1(void* lpObj);

char* cloudkeys_azuresecrets_getsslcertfingerprintsha256(void* lpObj);

char* cloudkeys_azuresecrets_getsslcertissuer(void* lpObj);

char* cloudkeys_azuresecrets_getsslcertprivatekey(void* lpObj);

int cloudkeys_azuresecrets_getsslcertprivatekeyavailable(void* lpObj);

char* cloudkeys_azuresecrets_getsslcertprivatekeycontainer(void* lpObj);

char* cloudkeys_azuresecrets_getsslcertpublickey(void* lpObj);

char* cloudkeys_azuresecrets_getsslcertpublickeyalgorithm(void* lpObj);

int cloudkeys_azuresecrets_getsslcertpublickeylength(void* lpObj);

char* cloudkeys_azuresecrets_getsslcertserialnumber(void* lpObj);

char* cloudkeys_azuresecrets_getsslcertsignaturealgorithm(void* lpObj);

int cloudkeys_azuresecrets_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int cloudkeys_azuresecrets_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* cloudkeys_azuresecrets_getsslcertstorepassword(void* lpObj);
int cloudkeys_azuresecrets_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int cloudkeys_azuresecrets_getsslcertstoretype(void* lpObj);
int cloudkeys_azuresecrets_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* cloudkeys_azuresecrets_getsslcertsubjectaltnames(void* lpObj);

char* cloudkeys_azuresecrets_getsslcertthumbprintmd5(void* lpObj);

char* cloudkeys_azuresecrets_getsslcertthumbprintsha1(void* lpObj);

char* cloudkeys_azuresecrets_getsslcertthumbprintsha256(void* lpObj);

char* cloudkeys_azuresecrets_getsslcertusage(void* lpObj);

int cloudkeys_azuresecrets_getsslcertusageflags(void* lpObj);

char* cloudkeys_azuresecrets_getsslcertversion(void* lpObj);

char* cloudkeys_azuresecrets_getsslcertsubject(void* lpObj);
int cloudkeys_azuresecrets_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int cloudkeys_azuresecrets_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int cloudkeys_azuresecrets_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Data Type

CloudKeysCertificate

SSLProvider Property (AzureSecrets Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int cloudkeys_azuresecrets_getsslprovider(void* lpObj);
int cloudkeys_azuresecrets_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCert Property (AzureSecrets Class)

The server certificate for the last established connection.

Syntax

• C++
• C
• Qt

CloudKeysCertificate* GetSSLServerCert();

char* cloudkeys_azuresecrets_getsslservercerteffectivedate(void* lpObj);

char* cloudkeys_azuresecrets_getsslservercertexpirationdate(void* lpObj);

char* cloudkeys_azuresecrets_getsslservercertextendedkeyusage(void* lpObj);

char* cloudkeys_azuresecrets_getsslservercertfingerprint(void* lpObj);

char* cloudkeys_azuresecrets_getsslservercertfingerprintsha1(void* lpObj);

char* cloudkeys_azuresecrets_getsslservercertfingerprintsha256(void* lpObj);

char* cloudkeys_azuresecrets_getsslservercertissuer(void* lpObj);

char* cloudkeys_azuresecrets_getsslservercertprivatekey(void* lpObj);

int cloudkeys_azuresecrets_getsslservercertprivatekeyavailable(void* lpObj);

char* cloudkeys_azuresecrets_getsslservercertprivatekeycontainer(void* lpObj);

char* cloudkeys_azuresecrets_getsslservercertpublickey(void* lpObj);

char* cloudkeys_azuresecrets_getsslservercertpublickeyalgorithm(void* lpObj);

int cloudkeys_azuresecrets_getsslservercertpublickeylength(void* lpObj);

char* cloudkeys_azuresecrets_getsslservercertserialnumber(void* lpObj);

char* cloudkeys_azuresecrets_getsslservercertsignaturealgorithm(void* lpObj);

int cloudkeys_azuresecrets_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);

char* cloudkeys_azuresecrets_getsslservercertstorepassword(void* lpObj);

int cloudkeys_azuresecrets_getsslservercertstoretype(void* lpObj);

char* cloudkeys_azuresecrets_getsslservercertsubjectaltnames(void* lpObj);

char* cloudkeys_azuresecrets_getsslservercertthumbprintmd5(void* lpObj);

char* cloudkeys_azuresecrets_getsslservercertthumbprintsha1(void* lpObj);

char* cloudkeys_azuresecrets_getsslservercertthumbprintsha256(void* lpObj);

char* cloudkeys_azuresecrets_getsslservercertusage(void* lpObj);

int cloudkeys_azuresecrets_getsslservercertusageflags(void* lpObj);

char* cloudkeys_azuresecrets_getsslservercertversion(void* lpObj);

char* cloudkeys_azuresecrets_getsslservercertsubject(void* lpObj);

int cloudkeys_azuresecrets_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

CloudKeysCertificate

Tags Property (AzureSecrets Class)

A collection of tags.

Syntax

• C++
• C
• Qt

CloudKeysList<CloudKeysAzureTag>* GetTags();
int SetTags(CloudKeysList<CloudKeysAzureTag>* val);

int cloudkeys_azuresecrets_gettagcount(void* lpObj);
int cloudkeys_azuresecrets_settagcount(void* lpObj, int iTagCount);

char* cloudkeys_azuresecrets_gettagname(void* lpObj, int tagindex);
int cloudkeys_azuresecrets_settagname(void* lpObj, int tagindex, const char* lpszTagName);

char* cloudkeys_azuresecrets_gettagvalue(void* lpObj, int tagindex);
int cloudkeys_azuresecrets_settagvalue(void* lpObj, int tagindex, const char* lpszTagValue);

int GetTagCount();
int SetTagCount(int iTagCount);

QString GetTagName(int iTagIndex);
int SetTagName(int iTagIndex, QString qsTagName);

QString GetTagValue(int iTagIndex);
int SetTagValue(int iTagIndex, QString qsTagValue);

Remarks

This collection holds a list of AzureTag items.

Calling AddTag or GetSecret will populate this collection. The items in this collection are used by the CreateSecret and UpdateSecret methods.

This property is not available at design time.

Data Type

CloudKeysAzureTag

Timeout Property (AzureSecrets Class)

The timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int cloudkeys_azuresecrets_gettimeout(void* lpObj);
int cloudkeys_azuresecrets_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

Vault Property (AzureSecrets Class)

Selects a vault for the class to interact with.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetVault();
int SetVault(const char* lpszVault);

Unicode (Windows)
LPWSTR GetVault();
INT SetVault(LPCWSTR lpszVault);

char* cloudkeys_azuresecrets_getvault(void* lpObj);
int cloudkeys_azuresecrets_setvault(void* lpObj, const char* lpszVault);

QString GetVault();
int SetVault(QString qsVault);

Default Value

""

Remarks

This property specifies the Azure Key Vault vault, by name, that the class should interact with.

Data Type

String

VersionMarker Property (AzureSecrets Class)

A marker indicating what page of secret versions to return next.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetVersionMarker();
int SetVersionMarker(const char* lpszVersionMarker);

Unicode (Windows)
LPWSTR GetVersionMarker();
INT SetVersionMarker(LPCWSTR lpszVersionMarker);

char* cloudkeys_azuresecrets_getversionmarker(void* lpObj);
int cloudkeys_azuresecrets_setversionmarker(void* lpObj, const char* lpszVersionMarker);

QString GetVersionMarker();
int SetVersionMarker(QString qsVersionMarker);

Default Value

""

Remarks

This property will be populated when ListVersions is called if the results are paged and there are more pages. To list all secret versions, continue to call ListVersions until this property returns empty string.

Refer to ListVersions for more information.

This property is not available at design time.

Data Type

String

AddQueryParam Method (AzureSecrets Class)

Adds a query parameter to the QueryParams properties.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddQueryParam(const char* lpszName, const char* lpszValue);

Unicode (Windows)
INT AddQueryParam(LPCWSTR lpszName, LPCWSTR lpszValue);

int cloudkeys_azuresecrets_addqueryparam(void* lpObj, const char* lpszName, const char* lpszValue);

int AddQueryParam(const QString& qsName, const QString& qsValue);

Remarks

This method is used to add a query parameter to the QueryParams properties. Name specifies the name of the parameter, and Value specifies the value of the parameter.

All specified Values will be URL encoded by the class automatically. Consult the service documentation for details on the available parameters.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

AddTag Method (AzureSecrets Class)

Adds an item to the Tags properties.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddTag(const char* lpszName, const char* lpszValue);

Unicode (Windows)
INT AddTag(LPCWSTR lpszName, LPCWSTR lpszValue);

int cloudkeys_azuresecrets_addtag(void* lpObj, const char* lpszName, const char* lpszValue);

int AddTag(const QString& qsName, const QString& qsValue);

Remarks

This method adds an item to the Tags properties. Name specifies the name of the item, and Value specifies the value of the item.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Authorize Method (AzureSecrets Class)

Get the authorization string required to access the protected resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Authorize();

Unicode (Windows)
INT Authorize();

int cloudkeys_azuresecrets_authorize(void* lpObj);

int Authorize();

Remarks

This method is used to get an access token that is required to access the protected resource. The method will act differently based on what is set in the ClientProfile field and the GrantType field. This method is not to be used in conjunction with the Authorization property. It should instead be used when setting the OAuth property.

For more information, see the introduction section.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

BackupSecret Method (AzureSecrets Class)

Backs up a secret.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int BackupSecret(const char* lpszSecretName);

Unicode (Windows)
INT BackupSecret(LPCWSTR lpszSecretName);

int cloudkeys_azuresecrets_backupsecret(void* lpObj, const char* lpszSecretName);

int BackupSecret(const QString& qsSecretName);

Remarks

This method backs up the secret specified by SecretName, returning it in a protected form via the output stream specified via the SetOutputStream method, the specified LocalFile, or the SecretData property.

Note that the protected secret cannot be used outside of Azure Key Vault, it must be restored to another vault using the RestoreSecret method in order to be used.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (AzureSecrets Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* cloudkeys_azuresecrets_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CreateSecret Method (AzureSecrets Class)

Creates a new secret.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* CreateSecret(const char* lpszSecretName, const char* lpszContentType);

Unicode (Windows)
LPWSTR CreateSecret(LPCWSTR lpszSecretName, LPCWSTR lpszContentType);

char* cloudkeys_azuresecrets_createsecret(void* lpObj, const char* lpszSecretName, const char* lpszContentType);

QString CreateSecret(const QString& qsSecretName, const QString& qsContentType);

Remarks

This method creates a new secret with the given SecretName. If a secret with the specified SecretName already exists, a new version of it is created. The version Id of the newly-created secret is returned.

The secret value is taken from the input stream supplied via the SetInputStream method, the specified LocalFile, or the SecretData property. If the EncodeData property is enabled, the value will be base64-encoded before it is sent.

The value passed for SecretName must consist solely of alphanumeric characters and hyphens (-).

The ContentType parameter is optional, and can be set to any string value.

If there are any items in the Tags properties, they will be applied to the newly-created secret. Secrets may have up to 15 tags.

The following configuration settings can also be used to send additional values when creating the secret, refer to their documentation for more information:

• CreateSecretEnabled
• ExpiryDate
• NotBeforeDate

Note: If there is already a soft-deleted secret with the specified SecretName in the currently-selected Vault, then a new secret cannot be created with the same name. To resolve such a situation, the soft-deleted secret would need to be recovered (using RecoverSecret) or permanently deleted (using PurgeSecret) first.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DeleteSecret Method (AzureSecrets Class)

Deletes a secret.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteSecret(const char* lpszSecretName);

Unicode (Windows)
INT DeleteSecret(LPCWSTR lpszSecretName);

int cloudkeys_azuresecrets_deletesecret(void* lpObj, const char* lpszSecretName);

int DeleteSecret(const QString& qsSecretName);

Remarks

This method deletes the secret specified by SecretName. If there are multiple versions of the secret, all of them are deleted.

Note that the secret is only soft-deleted; it can be recovered during the retention period using the RecoverSecret method, or permanently deleted using the PurgeSecret method. The length of the retention period depends on the configuration of the currently-selected Vault, refer to the Azure Key Vault documentation for more information.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DoEvents Method (AzureSecrets Class)

This method processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int cloudkeys_azuresecrets_doevents(void* lpObj);

int DoEvents();

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetSecret Method (AzureSecrets Class)

Gets a secret's value and information.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSecret(const char* lpszSecretName);

Unicode (Windows)
INT GetSecret(LPCWSTR lpszSecretName);

int cloudkeys_azuresecrets_getsecret(void* lpObj, const char* lpszSecretName);

int GetSecret(const QString& qsSecretName);

Remarks

This method gets the value and information for the secret specified by SecretName. The VersionId configuration setting can be used to target a specific secret version. The secret's value is returned via the output stream supplied via the SetOutputStream method, the specified LocalFile, or the SecretData property.

Alternatively, the GetDeleted configuration setting can be enabled to get a soft-deleted secret's information (but not its value).

When the information is returned, the class clears the Secrets properties and repopulates it properties with the secret's tags. The SecretList and TagList events are also fired.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListSecrets Method (AzureSecrets Class)

Lists the secrets in the currently-selected vault.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListSecrets();

Unicode (Windows)
INT ListSecrets();

int cloudkeys_azuresecrets_listsecrets(void* lpObj);

int ListSecrets();

Remarks

This method lists the secrets in the currently-selected Vault. If the GetDeleted configuration setting is enabled, it lists the soft-deleted secrets in the vault instead.

Calling this method will fire the SecretList event once for each secret, and will also populate the Secrets properties.

If there are still more secrets available to list when this method returns, the SecretMarker property will be populated. Continue to call this method until SecretMarker is empty to accumulate all pages of results in the Secrets properties.

The MaxSecrets configuration setting can be used to control the maximum number of results to return at once.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListVersions Method (AzureSecrets Class)

Lists versions of a secret.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListVersions(const char* lpszSecretName);

Unicode (Windows)
INT ListVersions(LPCWSTR lpszSecretName);

int cloudkeys_azuresecrets_listversions(void* lpObj, const char* lpszSecretName);

int ListVersions(const QString& qsSecretName);

Remarks

This method lists the versions of the secret specified by SecretName.

Calling this method will fire the SecretList event once for each secret version, and will also populate the Secrets properties.

If there are still more secret versions available to list when this method returns, the VersionMarker property will be populated. Continue to call this method until VersionMarker is empty to accumulate all pages of results in the Secrets properties.

The MaxSecrets configuration setting can be used to control the maximum number of results to return at once.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

PurgeSecret Method (AzureSecrets Class)

Permanently deletes a soft-deleted secret.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int PurgeSecret(const char* lpszSecretName);

Unicode (Windows)
INT PurgeSecret(LPCWSTR lpszSecretName);

int cloudkeys_azuresecrets_purgesecret(void* lpObj, const char* lpszSecretName);

int PurgeSecret(const QString& qsSecretName);

Remarks

This method permanently deletes the soft-deleted secret specified by SecretName.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

RecoverSecret Method (AzureSecrets Class)

Recovers a soft-deleted secret.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RecoverSecret(const char* lpszSecretName);

Unicode (Windows)
INT RecoverSecret(LPCWSTR lpszSecretName);

int cloudkeys_azuresecrets_recoversecret(void* lpObj, const char* lpszSecretName);

int RecoverSecret(const QString& qsSecretName);

Remarks

This method recovers the soft-deleted secret specified by SecretName.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (AzureSecrets Class)

Resets the class to its initial state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int cloudkeys_azuresecrets_reset(void* lpObj);

int Reset();

Remarks

This method resets the class to its initial state.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

RestoreSecret Method (AzureSecrets Class)

Restores a previously backed-up secret to the vault.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* RestoreSecret();

Unicode (Windows)
LPWSTR RestoreSecret();

char* cloudkeys_azuresecrets_restoresecret(void* lpObj);

QString RestoreSecret();

Remarks

This method restores a secret previously backed up using BackupSecret to the currently-selected Vault. The secret is restored in its entirety, with all of its versions intact. However, note that the restore will fail if the secret's name is already in use. The name of the restored secret is returned.

The protected secret data to restore is taken from the input stream supplied via the SetInputStream method, the specified LocalFile, or the SecretData property.

Note: There are certain restrictions on which vaults a secret can be restored to. In particular, a secret must be restored to a vault owned by the same Azure subscription that owned its original vault, and must be restored to a vault in the same geolocation as its original vault. Refer to the Azure Key Vault documentation for more information.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

SetInputStream Method (AzureSecrets Class)

Sets the stream whose data should be sent.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetInputStream(CloudKeysStream* sInputStream);

Unicode (Windows)
INT SetInputStream(CloudKeysStream* sInputStream);

int cloudkeys_azuresecrets_setinputstream(void* lpObj, CloudKeysStream* sInputStream);

int SetInputStream(CloudKeysStream* sInputStream);

Remarks

This method sets the stream whose data should be sent when CreateSecret is called.

Note: Passing a non-null value for InputStream will cause the LocalFile property to be cleared. Similarly, setting LocalFile to a non-empty value will discard any stream set using this method.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetOutputStream Method (AzureSecrets Class)

Sets the stream to which received data should be written.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetOutputStream(CloudKeysStream* sOutputStream);

Unicode (Windows)
INT SetOutputStream(CloudKeysStream* sOutputStream);

int cloudkeys_azuresecrets_setoutputstream(void* lpObj, CloudKeysStream* sOutputStream);

int SetOutputStream(CloudKeysStream* sOutputStream);

Remarks

This method sets the stream to which data should be written when GetSecret is called.

Note: Passing a non-null value for OutputStream will cause the LocalFile property to be cleared. Similarly, setting LocalFile to a non-empty value will discard any stream set using this method.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetSecretEnabled Method (AzureSecrets Class)

Enables or disables a secret.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetSecretEnabled(const char* lpszSecretName, int bEnabled);

Unicode (Windows)
INT SetSecretEnabled(LPCWSTR lpszSecretName, BOOL bEnabled);

int cloudkeys_azuresecrets_setsecretenabled(void* lpObj, const char* lpszSecretName, int bEnabled);

int SetSecretEnabled(const QString& qsSecretName, bool bEnabled);

Remarks

This method enables or disables the secret specified by SecretName.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

UpdateSecret Method (AzureSecrets Class)

Updates a secret's information.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdateSecret(const char* lpszSecretName, const char* lpszContentType, int bUpdateTags);

Unicode (Windows)
INT UpdateSecret(LPCWSTR lpszSecretName, LPCWSTR lpszContentType, BOOL bUpdateTags);

int cloudkeys_azuresecrets_updatesecret(void* lpObj, const char* lpszSecretName, const char* lpszContentType, int bUpdateTags);

int UpdateSecret(const QString& qsSecretName, const QString& qsContentType, bool bUpdateTags);

Remarks

This method updates the information for the secret specified by SecretName. The VersionId configuration setting can be used to target a specific secret version.

The ContentType parameter, if non-empty, can be any string value. If empty, the secret's current content type is left unchanged. (To explicitly clear the secret's content type, pass %CLEAR%).

The UpdateTags parameter determines whether the class replaces the secret's current tags with the items in the Tags properties (which may be empty). Secrets may have up to 15 tags.

The ExpiryDate and NotBeforeDate configuration settings may also be used to send additional values, refer to their documentation for more information.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

EndTransfer Event (AzureSecrets Class)

This event fires when a document finishes transferring.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEndTransfer(AzureSecretsEndTransferEventParams *e);

typedef struct {
  int Direction;
  int reserved;
} AzureSecretsEndTransferEventParams;


Unicode (Windows)
virtual INT FireEndTransfer(AzureSecretsEndTransferEventParams *e);

typedef struct {
  INT Direction;
  INT reserved;
} AzureSecretsEndTransferEventParams;

#define EID_AZURESECRETS_ENDTRANSFER 1

virtual INT CLOUDKEYS_CALL FireEndTransfer(INT &iDirection);

class AzureSecretsEndTransferEventParams {
public:
  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void EndTransfer(AzureSecretsEndTransferEventParams *e);

// Or, subclass AzureSecrets and override this emitter function.
virtual int FireEndTransfer(AzureSecretsEndTransferEventParams *e) {...}

Remarks

The EndTransfer event is fired when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (AzureSecrets Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(AzureSecretsErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} AzureSecretsErrorEventParams;


Unicode (Windows)
virtual INT FireError(AzureSecretsErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} AzureSecretsErrorEventParams;

#define EID_AZURESECRETS_ERROR 2

virtual INT CLOUDKEYS_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class AzureSecretsErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(AzureSecretsErrorEventParams *e);

// Or, subclass AzureSecrets and override this emitter function.
virtual int FireError(AzureSecretsErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Header Event (AzureSecrets Class)

Fired every time a header line comes in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireHeader(AzureSecretsHeaderEventParams *e);

typedef struct {
  const char *Field;
  const char *Value;
  int reserved;
} AzureSecretsHeaderEventParams;


Unicode (Windows)
virtual INT FireHeader(AzureSecretsHeaderEventParams *e);

typedef struct {
  LPCWSTR Field;
  LPCWSTR Value;
  INT reserved;
} AzureSecretsHeaderEventParams;

#define EID_AZURESECRETS_HEADER 3

virtual INT CLOUDKEYS_CALL FireHeader(LPSTR &lpszField, LPSTR &lpszValue);

class AzureSecretsHeaderEventParams {
public:
  const QString &Field();

  const QString &Value();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Header(AzureSecretsHeaderEventParams *e);

// Or, subclass AzureSecrets and override this emitter function.
virtual int FireHeader(AzureSecretsHeaderEventParams *e) {...}

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

Log Event (AzureSecrets Class)

Fired once for each log message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireLog(AzureSecretsLogEventParams *e);

typedef struct {
  int LogLevel;
  const char *Message;
  const char *LogType;
  int reserved;
} AzureSecretsLogEventParams;


Unicode (Windows)
virtual INT FireLog(AzureSecretsLogEventParams *e);

typedef struct {
  INT LogLevel;
  LPCWSTR Message;
  LPCWSTR LogType;
  INT reserved;
} AzureSecretsLogEventParams;

#define EID_AZURESECRETS_LOG 4

virtual INT CLOUDKEYS_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);

class AzureSecretsLogEventParams {
public:
  int LogLevel();

  const QString &Message();

  const QString &LogType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Log(AzureSecretsLogEventParams *e);

// Or, subclass AzureSecrets and override this emitter function.
virtual int FireLog(AzureSecretsLogEventParams *e) {...}

Remarks

This event is fired once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

SecretList Event (AzureSecrets Class)

Fires once for each secret when listing secrets.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSecretList(AzureSecretsSecretListEventParams *e);

typedef struct {
  const char *Name;
  const char *VersionId;
  const char *ContentType;
  int Enabled;
  int64 CreationDate;
  int64 UpdateDate;
  int64 DeletionDate;
  int64 PurgeDate;
  int reserved;
} AzureSecretsSecretListEventParams;


Unicode (Windows)
virtual INT FireSecretList(AzureSecretsSecretListEventParams *e);

typedef struct {
  LPCWSTR Name;
  LPCWSTR VersionId;
  LPCWSTR ContentType;
  BOOL Enabled;
  LONG64 CreationDate;
  LONG64 UpdateDate;
  LONG64 DeletionDate;
  LONG64 PurgeDate;
  INT reserved;
} AzureSecretsSecretListEventParams;

#define EID_AZURESECRETS_SECRETLIST 5

virtual INT CLOUDKEYS_CALL FireSecretList(LPSTR &lpszName, LPSTR &lpszVersionId, LPSTR &lpszContentType, BOOL &bEnabled, LONG64 &lCreationDate, LONG64 &lUpdateDate, LONG64 &lDeletionDate, LONG64 &lPurgeDate);

class AzureSecretsSecretListEventParams {
public:
  const QString &Name();

  const QString &VersionId();

  const QString &ContentType();

  bool Enabled();

  qint64 CreationDate();

  qint64 UpdateDate();

  qint64 DeletionDate();

  qint64 PurgeDate();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SecretList(AzureSecretsSecretListEventParams *e);

// Or, subclass AzureSecrets and override this emitter function.
virtual int FireSecretList(AzureSecretsSecretListEventParams *e) {...}

Remarks

This event fires once for each secret (or secret version) returned when ListSecrets, ListVersions, or GetSecret is called.

Name reflects the name of the secret.

VersionId reflects the Id of the secret version.

ContentType reflects the secret's content type.

Enabled reflects whether the secret is currently enabled.

CreationDate reflects the secret's creation date, in seconds since the Unix epoch.

UpdateDate reflects the secret's update date, in seconds since the Unix epoch.

DeletionDate reflects the secret's deletion date, in seconds since the Unix epoch, or -1 if the secret has not been deleted.

PurgeDate reflects the secret's purge (i.e., permanent deletion) date, in seconds since the Unix epoch, or -1 if the secret has not been deleted.

SSLServerAuthentication Event (AzureSecrets Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(AzureSecretsSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} AzureSecretsSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(AzureSecretsSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} AzureSecretsSSLServerAuthenticationEventParams;

#define EID_AZURESECRETS_SSLSERVERAUTHENTICATION 6

virtual INT CLOUDKEYS_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class AzureSecretsSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(AzureSecretsSSLServerAuthenticationEventParams *e);

// Or, subclass AzureSecrets and override this emitter function.
virtual int FireSSLServerAuthentication(AzureSecretsSSLServerAuthenticationEventParams *e) {...}

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (AzureSecrets Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(AzureSecretsSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} AzureSecretsSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(AzureSecretsSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} AzureSecretsSSLStatusEventParams;

#define EID_AZURESECRETS_SSLSTATUS 7

virtual INT CLOUDKEYS_CALL FireSSLStatus(LPSTR &lpszMessage);

class AzureSecretsSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(AzureSecretsSSLStatusEventParams *e);

// Or, subclass AzureSecrets and override this emitter function.
virtual int FireSSLStatus(AzureSecretsSSLStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (AzureSecrets Class)

This event fires when a document starts transferring (after the headers).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStartTransfer(AzureSecretsStartTransferEventParams *e);

typedef struct {
  int Direction;
  int reserved;
} AzureSecretsStartTransferEventParams;


Unicode (Windows)
virtual INT FireStartTransfer(AzureSecretsStartTransferEventParams *e);

typedef struct {
  INT Direction;
  INT reserved;
} AzureSecretsStartTransferEventParams;

#define EID_AZURESECRETS_STARTTRANSFER 8

virtual INT CLOUDKEYS_CALL FireStartTransfer(INT &iDirection);

class AzureSecretsStartTransferEventParams {
public:
  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void StartTransfer(AzureSecretsStartTransferEventParams *e);

// Or, subclass AzureSecrets and override this emitter function.
virtual int FireStartTransfer(AzureSecretsStartTransferEventParams *e) {...}

Remarks

The StartTransfer event is fired when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

TagList Event (AzureSecrets Class)

Fires once for each tag returned when a secret is retrieved.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTagList(AzureSecretsTagListEventParams *e);

typedef struct {
  const char *SecretName;
  const char *VersionId;
  const char *Name;
  const char *Value;
  int reserved;
} AzureSecretsTagListEventParams;


Unicode (Windows)
virtual INT FireTagList(AzureSecretsTagListEventParams *e);

typedef struct {
  LPCWSTR SecretName;
  LPCWSTR VersionId;
  LPCWSTR Name;
  LPCWSTR Value;
  INT reserved;
} AzureSecretsTagListEventParams;

#define EID_AZURESECRETS_TAGLIST 9

virtual INT CLOUDKEYS_CALL FireTagList(LPSTR &lpszSecretName, LPSTR &lpszVersionId, LPSTR &lpszName, LPSTR &lpszValue);

class AzureSecretsTagListEventParams {
public:
  const QString &SecretName();

  const QString &VersionId();

  const QString &Name();

  const QString &Value();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void TagList(AzureSecretsTagListEventParams *e);

// Or, subclass AzureSecrets and override this emitter function.
virtual int FireTagList(AzureSecretsTagListEventParams *e) {...}

Remarks

This event fires once for each tag returned when GetSecret is called.

SecretName reflects the name of the secret.

VersionId reflects the Id of the secret version.

Name reflects the name of the tag.

Value reflects the value of the tag.

Transfer Event (AzureSecrets Class)

Fired while a document transfers (delivers document).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTransfer(AzureSecretsTransferEventParams *e);

typedef struct {
  int Direction;
  int64 BytesTransferred;
  int PercentDone;
  const char *Text;
  int lenText;
  int reserved;
} AzureSecretsTransferEventParams;


Unicode (Windows)
virtual INT FireTransfer(AzureSecretsTransferEventParams *e);

typedef struct {
  INT Direction;
  LONG64 BytesTransferred;
  INT PercentDone;
  LPCSTR Text;
  INT lenText;
  INT reserved;
} AzureSecretsTransferEventParams;

#define EID_AZURESECRETS_TRANSFER 10

virtual INT CLOUDKEYS_CALL FireTransfer(INT &iDirection, LONG64 &lBytesTransferred, INT &iPercentDone, LPSTR &lpText, INT &lenText);

class AzureSecretsTransferEventParams {
public:
  int Direction();

  qint64 BytesTransferred();

  int PercentDone();

  const QByteArray &Text();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Transfer(AzureSecretsTransferEventParams *e);

// Or, subclass AzureSecrets and override this emitter function.
virtual int FireTransfer(AzureSecretsTransferEventParams *e) {...}

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

AzureSecret Type

An Azure Key Vault secret.

Syntax

CloudKeysAzureSecret (declared in cloudkeys.h)

Remarks

This type represents an Azure Key Vault secret.

Fields

AzureTag Type

An Azure Key Vault tag.

Syntax

CloudKeysAzureTag (declared in cloudkeys.h)

Remarks

This type represents an Azure Key Vault tag.

Fields

Constructors

AzureTag()

AzureTag(const char* lpszName, const char* lpszValue)

Certificate Type

This is the digital certificate being used.

Syntax

CloudKeysCertificate (declared in cloudkeys.h)

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

Certificate()

Certificate(const char* lpEncoded, int lenEncoded)

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

Firewall Type

The firewall the component will connect through.

Syntax

CloudKeysFirewall (declared in cloudkeys.h)

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

Fields

Constructors

Firewall()

Header Type

This is an HTTP header as it is received from the server.

Syntax

CloudKeysHeader (declared in cloudkeys.h)

Remarks

When a header is received through a Header event, it is parsed into a Header type. This type contains a Field, and its corresponding Value.

Fields

Constructors

Header()

Header(const char* lpszField, const char* lpszValue)

OAuthSettings Type

The settings to use to authenticate with the service provider.

Syntax

CloudKeysOAuthSettings (declared in cloudkeys.h)

Remarks

Used to set give the class the necessary information needed to complete OAuth authentication.

Fields

Constructors

OAuthSettings()

Proxy Type

The proxy the component will connect to.

Syntax

CloudKeysProxy (declared in cloudkeys.h)

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

Fields

Constructors

Proxy()

Proxy(const char* lpszServer, int iPort)

Proxy(const char* lpszServer, int iPort, const char* lpszUser, const char* lpszPassword)

QueryParam Type

A query parameter to send in the request.

Syntax

CloudKeysQueryParam (declared in cloudkeys.h)

Remarks

This type represents a query parameter to send in the request.

Fields

Constructors

QueryParam()

QueryParam(const char* lpszName, const char* lpszValue)

CloudKeysList Type

Syntax

CloudKeysList<T> (declared in cloudkeys.h)

Remarks

CloudKeysList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the AzureSecrets class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

T* Set(int index, T* value) {}

CloudKeysStream Type

Syntax

CloudKeysStream (declared in cloudkeys.h)

Remarks

The AzureSecrets class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the CloudKeysStream interface and pass the AzureSecrets class an instance of that concrete class.

When implementing the CloudKeysStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

bool CanRead() { return true; }

bool CanSeek() { return true; }

bool CanWrite() { return true; }

int64 GetLength() = 0;

void Close() {}

int Flush() { return 0; }

int Read(void* buffer, int count) = 0;

int64 Seek(int64 offset, int seekOrigin) = 0;

int Write(const void* buffer, int count) = 0;

Config Settings (AzureSecrets Class)

AzureSecrets Config Settings

<firstlevel>
  <one>value</one>
  <two>
    <item>first</item>
    <item>second</item>
  </two>
  <three>value three</three>
</firstlevel>

{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}

OAuth Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----