AzureKeys Class

Properties   Methods   Events   Config Settings   Errors  

The AzureKeys class makes it easy to interact with keys in Azure Key Vaults.

Syntax

AzureKeys

Remarks

The AzureKeys class provides an easy-to-use interface for the key-related functionality of the Azure Key Vault service. Azure Key Vault allows you to works with a few different kinds of resources, one of which is asymmetric key pairs. This class helps you to create, manage, and use said key pairs (or just "keys", for short) for cryptographic operations. To work with "secrets" instead, refer to the AzureSecrets 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* properties to set the appropriate fields for the chosen OAuthClientProfile and OAuthGrantType.

The component has the following defaults:

Additionaly, 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 properties. 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 OAuthAccessToken property will be populated. Additionally, if a refresh token was provided the OAuthRefreshToken property 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 OAuthAccessToken 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 OAuthAccessToken. 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 OAuthGrantType property. 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 OAuthGrantType property 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 OAuthGrantType the class expects a OAuthClientId, OAuthClientSecret, OAuthServerAuthURL, and OAuthServerTokenURL 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 OAuthAuthorizationCode property, 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 OAuthRefreshToken property 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: AzureKeys azurekeys = new AzureKeys(); azurekeys.OAuth.ClientProfile = OAuthClientProfiles.cocpApplication; azurekeys.OAuth.GrantType = OAuthGrantTypes.cogtAuthorizationCode; azurekeys.OAuth.ClientId = CLIENT_ID; azurekeys.OAuth.ClientSecret = SECRET_ID; azurekeys.OAuth.AuthorizationScope = "offline_access https://vault.azure.net/user_impersonation"; azurekeys.OAuth.ServerAuthURL = "https://login.microsoftonline.com/" + TENANT_ID + "/oauth2/v2.0/authorize"; azurekeys.OAuth.ServerTokenURL = "https://login.microsoftonline.com/" + TENANT_ID + "/oauth2/v2.0/token"; azurekeys.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 OAuthGrantType the class expects a OAuthClientId, OAuthClientSecret, and OAuthServerAuthURL 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 OAuthGrantType the class requires OAuthPasswordGrantUsername, OAuthClientSecret, and OAuthServerTokenURL to be set. The OAuthClientSecret should be set to the password of the account instead of a typical secret. In some cases, the OAuthClientId 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; azurekeys.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

Keys can be created using the CreateKey method. A key's name and type (i.e., whether it is RSA or EC, and its size or curve, respectively) must be set at the time of creation, and cannot be changed later. A list of cryptographic operations that the key is valid for must also be set, but can be changed at any time using the UpdateKey. If a key with the specified name already exists, a new version of it is created; this makes it easy to "rotate" a key.

When a key will no longer be used, it can be deleted using the DeleteKey method. However, the key 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 key may be recovered using RecoverKey, or permanently deleted using PurgeKey (assuming the currently-authenticated user has the permissions to do so). azurekeys.CreateKey("mykey", "RSA_2048", "encrypt,decrypt,sign,verify,wrapKey,unwrapKey"); // ... Some time later, when the key is no longer needed ... azurekeys.DeleteKey("mykey"); // At this point, the key is only soft-deleted. It could be recovered... azurekeys.RecoverKey("mykey"); // ...or permanently deleted. azurekeys.PurgeKey("mykey");

To list keys, use the ListKeys method. This method is also used to list soft-deleted keys if the GetDeleted configuration setting has been enabled first. To list a key's versions, use the ListVersions method. (You cannot list a deleted key's versions.) In all cases, the IncludeKeyDetails property can optionally be enabled to have the class attempt to retrieve the full information for each key (Azure leaves out certain fields by default when listing). // If there are many keys to list, there may be multiple pages of results. This will // cause all pages of results to be accumulated into the Keys collection property. do { azurekeys.ListKeys(); } while (!string.IsNullOrEmpty(azurekeys.KeyMarker)); // A similar thing applies to key versions as well. do { azurekeys.ListVersions("mykey"); } while (!string.IsNullOrEmpty(azurekeys.VersionMarker));

Depending on a key's "key ops" list, it can be used to perform different cryptographic operations. Keys with the encrypt and decrypt ops can be used in Encrypt and Decrypt operations. Keys with the sign and verify ops can be used in Sign and Verify. Finally, keys with the wrapKey and unwrapKey ops can be used in WrapKey and UnwrapKey operations (which are just like encryption and decryption, but which are intended to be used for wrapping a symmetric key, and which require different permissions to call successfully).

To perform a cryptographic operation, use InputData, InputFile, or SetInputStream to supply the input data that should be processed. All operations will output the result data to OutputData, OutputFile, or SetOutputStream (except Verify; refer to its documentation for more information). azurekeys.CreateKey("mykey", "RSA_2048", "encrypt,decrypt"); azurekeys.InputData = "Test123"; azurekeys.OutputFile = "C:/temp/enc.dat"; azurekeys.Encrypt("mykey", "RSA-OAEP-256"); azurekeys.InputFile = "C:/temp/enc.dat"; azurekeys.OutputFile = ""; // So that the data will be output to the OutputData property. azurekeys.Decrypt("mykey", "RSA-OAEP-256");

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

• Retrieval of a single key's information (including public key) with GetKeyInfo.
• Enabling and disabling keys with SetKeyEnabled.
• Tagging support using AddTag and the Tag* properties.
• Secure key backup and restoration using BackupKey and RestoreKey.
• 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 (AzureKeys 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_azurekeys_getauthorization(void* lpObj);
int cloudkeys_azurekeys_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

FirewallAutoDetect Property (AzureKeys Class)

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect);

Unicode (Windows)
BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);

int cloudkeys_azurekeys_getfirewallautodetect(void* lpObj);
int cloudkeys_azurekeys_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

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

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (AzureKeys Class)

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallType();
int SetFirewallType(int iFirewallType);

Unicode (Windows)
INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);

FW_NONE(0), 
FW_TUNNEL(1), 
FW_SOCKS4(2), 
FW_SOCKS5(3), 
FW_SOCKS4A(10)

int cloudkeys_azurekeys_getfirewalltype(void* lpObj);
int cloudkeys_azurekeys_setfirewalltype(void* lpObj, int iFirewallType);

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

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (AzureKeys Class)

This property contains the name or IP address of firewall (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost);

Unicode (Windows)
LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);

char* cloudkeys_azurekeys_getfirewallhost(void* lpObj);
int cloudkeys_azurekeys_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

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

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (AzureKeys Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword);

Unicode (Windows)
LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);

char* cloudkeys_azurekeys_getfirewallpassword(void* lpObj);
int cloudkeys_azurekeys_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

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

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (AzureKeys Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Unicode (Windows)
INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);

int cloudkeys_azurekeys_getfirewallport(void* lpObj);
int cloudkeys_azurekeys_setfirewallport(void* lpObj, int iFirewallPort);

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

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (AzureKeys Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser);

Unicode (Windows)
LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);

char* cloudkeys_azurekeys_getfirewalluser(void* lpObj);
int cloudkeys_azurekeys_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

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

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

Idle Property (AzureKeys Class)

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int cloudkeys_azurekeys_getidle(void* lpObj);

bool GetIdle();

Default Value

TRUE

Remarks

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

This property is read-only.

Data Type

Boolean

IncludeKeyDetails Property (AzureKeys Class)

Whether to attempt to retrieve fill details when listing keys.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIncludeKeyDetails();
int SetIncludeKeyDetails(int bIncludeKeyDetails);

Unicode (Windows)
BOOL GetIncludeKeyDetails();
INT SetIncludeKeyDetails(BOOL bIncludeKeyDetails);

int cloudkeys_azurekeys_getincludekeydetails(void* lpObj);
int cloudkeys_azurekeys_setincludekeydetails(void* lpObj, int bIncludeKeyDetails);

bool GetIncludeKeyDetails();
int SetIncludeKeyDetails(bool bIncludeKeyDetails);

Default Value

FALSE

Remarks

This property specifies whether the class should make additional requests when ListKeys or ListVersions is called in order to retrieve full information for each key. By default, Azure will omit certain fields when one of those methods is called (refer to each one's documentation for more information).

If this property is enabled, then after the initial listing is returned, the class will call GetKeyInfo internally for each key returned. For all keys for which this call is successful, the additional information will be used to populate the Key* properties. Any keys for which the GetKeyInfo call fails will not have the additional properties populated.

This property is not available at design time.

Data Type

Boolean

InputData Property (AzureKeys Class)

The data to process.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetInputData(char* &lpInputData, int &lenInputData);
int SetInputData(const char* lpInputData, int lenInputData);

Unicode (Windows)
INT GetInputData(LPSTR &lpInputData, INT &lenInputData);
INT SetInputData(LPCSTR lpInputData, INT lenInputData);

int cloudkeys_azurekeys_getinputdata(void* lpObj, char** lpInputData, int* lenInputData);
int cloudkeys_azurekeys_setinputdata(void* lpObj, const char* lpInputData, int lenInputData);

QByteArray GetInputData();
int SetInputData(QByteArray qbaInputData);

Default Value

""

Remarks

This property specifies the data that should be processed in a cryptographic operation.

Input Sources & Output Destinations

The class automatically determines the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

1. An input stream supplied via the SetInputStream method
2. The InputFile property
3. The InputData property

The first valid input source found is used. The order in which the output properties are considered is as follows:

1. An output stream supplied via the SetOutputStream method
2. The OutputFile property
3. The OutputData property

This property is not available at design time.

Data Type

Binary String

InputFile Property (AzureKeys Class)

The file whose data should be processed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInputFile();
wchar_t* GetInputFile_W(); // Windows only
int SetInputFile(const char* lpszInputFile);
int SetInputFile(const wchar_t* lpszInputFile); // Windows only

Unicode (Windows)
LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);

char* cloudkeys_azurekeys_getinputfile(void* lpObj);
wchar_t* cloudkeys_azurekeys_getinputfile_W(void* lpObj); // Windows only
int cloudkeys_azurekeys_setinputfile(void* lpObj, const char* lpszInputFile);
int cloudkeys_azurekeys_setinputfile(void* lpObj, const wchar_t* lpszInputFile); // Windows only

QString GetInputFile();
int SetInputFile(QString qsInputFile);

Default Value

""

Remarks

This property specifies the file whose data should be processed in a cryptographic operation. It accepts both absolute and relative file paths.

Setting this property to a non-empty value will discard any stream set using the SetInputStream method. Similarly, passing a non-null value to the aforementioned method will clear this property.

Input Sources & Output Destinations

The class automatically determines the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

1. An input stream supplied via the SetInputStream method
2. The InputFile property
3. The InputData property

The first valid input source found is used. The order in which the output properties are considered is as follows:

1. An output stream supplied via the SetOutputStream method
2. The OutputFile property
3. The OutputData property

Data Type

String

KeyMarker Property (AzureKeys Class)

A marker indicating what page of keys to return next.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyMarker();
int SetKeyMarker(const char* lpszKeyMarker);

Unicode (Windows)
LPWSTR GetKeyMarker();
INT SetKeyMarker(LPCWSTR lpszKeyMarker);

char* cloudkeys_azurekeys_getkeymarker(void* lpObj);
int cloudkeys_azurekeys_setkeymarker(void* lpObj, const char* lpszKeyMarker);

QString GetKeyMarker();
int SetKeyMarker(QString qsKeyMarker);

Default Value

""

Remarks

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

Refer to ListKeys for more information.

This property is not available at design time.

Data Type

String

KeyCount Property (AzureKeys Class)

The number of records in the Key arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyCount();

Unicode (Windows)
INT GetKeyCount();

int cloudkeys_azurekeys_getkeycount(void* lpObj);

int GetKeyCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• KeyCreationDate
• KeyDeletionDate
• KeyEnabled
• KeyExpiryDate
• KeyName
• KeyNotBeforeDate
• KeyOps
• KeyPublicKey
• KeyPurgeDate
• KeyRecoverableDays
• KeyRecoveryLevel
• KeyType
• KeyUpdateDate
• KeyVersionId

The array indices start at 0 and end at KeyCount - 1.

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

Data Type

Integer

KeyCreationDate Property (AzureKeys Class)

The creation date of the key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetKeyCreationDate(int iKeyIndex);

Unicode (Windows)
LONG64 GetKeyCreationDate(INT iKeyIndex);

int64 cloudkeys_azurekeys_getkeycreationdate(void* lpObj, int keyindex);

qint64 GetKeyCreationDate(int iKeyIndex);

Default Value

-1

Remarks

The creation date of the key.

This property reflects the creation date of the key, in seconds since the Unix epoch.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

Long64

KeyDeletionDate Property (AzureKeys Class)

The deletion date of the key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetKeyDeletionDate(int iKeyIndex);

Unicode (Windows)
LONG64 GetKeyDeletionDate(INT iKeyIndex);

int64 cloudkeys_azurekeys_getkeydeletiondate(void* lpObj, int keyindex);

qint64 GetKeyDeletionDate(int iKeyIndex);

Default Value

-1

Remarks

The deletion date of the key.

This property reflects the deletion date of the key, in seconds since the Unix epoch, or -1 if the key has not been deleted.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

Long64

KeyEnabled Property (AzureKeys Class)

Whether the key is enabled.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyEnabled(int iKeyIndex);

Unicode (Windows)
BOOL GetKeyEnabled(INT iKeyIndex);

int cloudkeys_azurekeys_getkeyenabled(void* lpObj, int keyindex);

bool GetKeyEnabled(int iKeyIndex);

Default Value

FALSE

Remarks

Whether the key is enabled.

This property reflects whether the key is currently enabled.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

Boolean

KeyExpiryDate Property (AzureKeys Class)

The expiration date of the key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetKeyExpiryDate(int iKeyIndex);

Unicode (Windows)
LONG64 GetKeyExpiryDate(INT iKeyIndex);

int64 cloudkeys_azurekeys_getkeyexpirydate(void* lpObj, int keyindex);

qint64 GetKeyExpiryDate(int iKeyIndex);

Default Value

-1

Remarks

The expiration date of the key.

This property reflects the expiration date of the key, in seconds since the Unix epoch, or -1 if the key does not expire.

A key can only be used for the Decrypt, Verify, and UnwrapKey operations after its expiry date.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

Long64

KeyOps Property (AzureKeys Class)

The operation that the key may be used for.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyOps(int iKeyIndex);

Unicode (Windows)
LPWSTR GetKeyOps(INT iKeyIndex);

char* cloudkeys_azurekeys_getkeyops(void* lpObj, int keyindex);

QString GetKeyOps(int iKeyIndex);

Default Value

""

Remarks

The operation that the key may be used for.

This property reflects a comma-separated list of operations that they key may be used for. Possible values are:

• encrypt
• decrypt
• sign
• verify
• wrapKey
• unwrapKey

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

String

KeyType Property (AzureKeys Class)

The key's type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyType(int iKeyIndex);

Unicode (Windows)
LPWSTR GetKeyType(INT iKeyIndex);

char* cloudkeys_azurekeys_getkeytype(void* lpObj, int keyindex);

QString GetKeyType(int iKeyIndex);

Default Value

""

Remarks

The key's type.

This property reflects the key's type. Each key type has two variants, a software-based one and an HSM-based one. Possible values for this property are shown in the first two columns of the following table:

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

String

KeyName Property (AzureKeys Class)

The name of the key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyName(int iKeyIndex);

Unicode (Windows)
LPWSTR GetKeyName(INT iKeyIndex);

char* cloudkeys_azurekeys_getkeyname(void* lpObj, int keyindex);

QString GetKeyName(int iKeyIndex);

Default Value

""

Remarks

The name of the key.

This property reflects the name of the key.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

String

KeyNotBeforeDate Property (AzureKeys Class)

The 'not before' date of the key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetKeyNotBeforeDate(int iKeyIndex);

Unicode (Windows)
LONG64 GetKeyNotBeforeDate(INT iKeyIndex);

int64 cloudkeys_azurekeys_getkeynotbeforedate(void* lpObj, int keyindex);

qint64 GetKeyNotBeforeDate(int iKeyIndex);

Default Value

-1

Remarks

The 'not before' date of the key.

This property reflects the "not before" date of the key, in seconds since the Unix epoch, or -1 if the key doesn't have an explicit "not before" date.

A key can only be used for the Decrypt, Verify, and UnwrapKey operations prior to its "not before" date.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

Long64

KeyPublicKey Property (AzureKeys Class)

The key's public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyPublicKey(int iKeyIndex);

Unicode (Windows)
LPWSTR GetKeyPublicKey(INT iKeyIndex);

char* cloudkeys_azurekeys_getkeypublickey(void* lpObj, int keyindex);

QString GetKeyPublicKey(int iKeyIndex);

Default Value

""

Remarks

The key's public key.

This property reflects the public key of the key, in PEM format.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

String

KeyPurgeDate Property (AzureKeys Class)

The purge date of the key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetKeyPurgeDate(int iKeyIndex);

Unicode (Windows)
LONG64 GetKeyPurgeDate(INT iKeyIndex);

int64 cloudkeys_azurekeys_getkeypurgedate(void* lpObj, int keyindex);

qint64 GetKeyPurgeDate(int iKeyIndex);

Default Value

-1

Remarks

The purge date of the key.

This property reflects the purge (i.e., permanent deletion) date of the key, in seconds since the Unix epoch, or -1 if the key has not been deleted.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

Long64

KeyRecoverableDays Property (AzureKeys Class)

The number of days the key will be recoverable if it gets deleted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyRecoverableDays(int iKeyIndex);

Unicode (Windows)
INT GetKeyRecoverableDays(INT iKeyIndex);

int cloudkeys_azurekeys_getkeyrecoverabledays(void* lpObj, int keyindex);

int GetKeyRecoverableDays(int iKeyIndex);

Default Value

0

Remarks

The number of days the key will be recoverable if it gets deleted.

This property reflects the number of days that the key will be recoverable for if it gets deleted.

Note that this property's value is based on the retention policy of the currently-selected Vault; it will not change after the key has actually been deleted.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

Integer

KeyRecoveryLevel Property (AzureKeys Class)

The key's ability to be recovered and/or purged if it gets deleted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyRecoveryLevel(int iKeyIndex);

Unicode (Windows)
LPWSTR GetKeyRecoveryLevel(INT iKeyIndex);

char* cloudkeys_azurekeys_getkeyrecoverylevel(void* lpObj, int keyindex);

QString GetKeyRecoveryLevel(int iKeyIndex);

Default Value

""

Remarks

The key's ability to be recovered and/or purged if it gets deleted.

This property reflects the key's ability to be recovered and/or purged (i.e., permanently deleted) if it gets deleted. Possible values are as follows; please refer to this part of the Azure Key Vault documentation for more information about each one:

• CustomizedRecoverable
• CustomizedRecoverable+ProtectedSubscription
• CustomizedRecoverable+Purgeable
• Purgeable
• Recoverable
• Recoverable+ProtectedSubscription
• Recoverable+Purgeable

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

String

KeyUpdateDate Property (AzureKeys Class)

The update date of the key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetKeyUpdateDate(int iKeyIndex);

Unicode (Windows)
LONG64 GetKeyUpdateDate(INT iKeyIndex);

int64 cloudkeys_azurekeys_getkeyupdatedate(void* lpObj, int keyindex);

qint64 GetKeyUpdateDate(int iKeyIndex);

Default Value

-1

Remarks

The update date of the key.

This property reflects the update date of the key, in seconds since the Unix epoch.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

Long64

KeyVersionId Property (AzureKeys Class)

The version Id of the key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyVersionId(int iKeyIndex);

Unicode (Windows)
LPWSTR GetKeyVersionId(INT iKeyIndex);

char* cloudkeys_azurekeys_getkeyversionid(void* lpObj, int keyindex);

QString GetKeyVersionId(int iKeyIndex);

Default Value

""

Remarks

The version Id of the key.

This property reflects the version Id of the key.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

String

LocalHost Property (AzureKeys 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_azurekeys_getlocalhost(void* lpObj);
int cloudkeys_azurekeys_setlocalhost(void* lpObj, const char* lpszLocalHost);

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

Default Value

""

Remarks

The LocalHost 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

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 multi-homed 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

OAuthAccessToken Property (AzureKeys Class)

The access token returned by the authorization server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOAuthAccessToken();
int SetOAuthAccessToken(const char* lpszOAuthAccessToken);

Unicode (Windows)
LPWSTR GetOAuthAccessToken();
INT SetOAuthAccessToken(LPCWSTR lpszOAuthAccessToken);

char* cloudkeys_azurekeys_getoauthaccesstoken(void* lpObj);
int cloudkeys_azurekeys_setoauthaccesstoken(void* lpObj, const char* lpszOAuthAccessToken);

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

Default Value

""

Remarks

The access token returned by the authorization server. This is set when the class makes a request to the token server.

This property is not available at design time.

Data Type

String

OAuthAuthorizationCode Property (AzureKeys Class)

The authorization code that is exchanged for an access token.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOAuthAuthorizationCode();
int SetOAuthAuthorizationCode(const char* lpszOAuthAuthorizationCode);

Unicode (Windows)
LPWSTR GetOAuthAuthorizationCode();
INT SetOAuthAuthorizationCode(LPCWSTR lpszOAuthAuthorizationCode);

char* cloudkeys_azurekeys_getoauthauthorizationcode(void* lpObj);
int cloudkeys_azurekeys_setoauthauthorizationcode(void* lpObj, const char* lpszOAuthAuthorizationCode);

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

Default Value

""

Remarks

The authorization code that is exchanged for an access token. This is required to be set when the OAuthClientProfile property is set to the Web profile. Otherwise, this field is for information purposes only.

This property is not available at design time.

Data Type

String

OAuthAuthorizationScope Property (AzureKeys Class)

The scope request or response parameter used during authorization.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOAuthAuthorizationScope();
int SetOAuthAuthorizationScope(const char* lpszOAuthAuthorizationScope);

Unicode (Windows)
LPWSTR GetOAuthAuthorizationScope();
INT SetOAuthAuthorizationScope(LPCWSTR lpszOAuthAuthorizationScope);

char* cloudkeys_azurekeys_getoauthauthorizationscope(void* lpObj);
int cloudkeys_azurekeys_setoauthauthorizationscope(void* lpObj, const char* lpszOAuthAuthorizationScope);

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

Default Value

""

Remarks

The scope request or response parameter used during authorization.

This property is not available at design time.

Data Type

String

OAuthClientId Property (AzureKeys Class)

The id of the client assigned when registering the application.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOAuthClientId();
int SetOAuthClientId(const char* lpszOAuthClientId);

Unicode (Windows)
LPWSTR GetOAuthClientId();
INT SetOAuthClientId(LPCWSTR lpszOAuthClientId);

char* cloudkeys_azurekeys_getoauthclientid(void* lpObj);
int cloudkeys_azurekeys_setoauthclientid(void* lpObj, const char* lpszOAuthClientId);

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

Default Value

""

Remarks

The id of the client assigned when registering the application.

This property is not available at design time.

Data Type

String

OAuthClientProfile Property (AzureKeys Class)

The type of client that is requesting authorization.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOAuthClientProfile();
int SetOAuthClientProfile(int iOAuthClientProfile);

Unicode (Windows)
INT GetOAuthClientProfile();
INT SetOAuthClientProfile(INT iOAuthClientProfile);

COCP_APPLICATION(0), 
COCP_WEB(1)

int cloudkeys_azurekeys_getoauthclientprofile(void* lpObj);
int cloudkeys_azurekeys_setoauthclientprofile(void* lpObj, int iOAuthClientProfile);

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

Default Value

0

Remarks

The type of client that is requesting authorization. See the introduction section for more information. Possible values are:

This property is not available at design time.

Data Type

Integer

OAuthClientSecret Property (AzureKeys Class)

The secret value for the client assigned when registering the application.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOAuthClientSecret();
int SetOAuthClientSecret(const char* lpszOAuthClientSecret);

Unicode (Windows)
LPWSTR GetOAuthClientSecret();
INT SetOAuthClientSecret(LPCWSTR lpszOAuthClientSecret);

char* cloudkeys_azurekeys_getoauthclientsecret(void* lpObj);
int cloudkeys_azurekeys_setoauthclientsecret(void* lpObj, const char* lpszOAuthClientSecret);

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

Default Value

""

Remarks

The secret value for the client assigned when registering the application.

This property is not available at design time.

Data Type

String

OAuthGrantType Property (AzureKeys Class)

The OAuth grant type used to acquire an OAuth access token.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOAuthGrantType();
int SetOAuthGrantType(int iOAuthGrantType);

Unicode (Windows)
INT GetOAuthGrantType();
INT SetOAuthGrantType(INT iOAuthGrantType);

COGT_AUTHORIZATION_CODE(0), 
COGT_IMPLICIT(1), 
COGT_PASSWORD(2), 
COGT_CLIENT_CREDENTIALS(3)

int cloudkeys_azurekeys_getoauthgranttype(void* lpObj);
int cloudkeys_azurekeys_setoauthgranttype(void* lpObj, int iOAuthGrantType);

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

Default Value

0

Remarks

The OAuth grant type used to acquire an OAuth access token. See the introduction section for more information. Possible values are:

This property is not available at design time.

Data Type

Integer

OAuthRefreshToken Property (AzureKeys Class)

Specifies the refresh token received from or sent to the authorization server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOAuthRefreshToken();
int SetOAuthRefreshToken(const char* lpszOAuthRefreshToken);

Unicode (Windows)
LPWSTR GetOAuthRefreshToken();
INT SetOAuthRefreshToken(LPCWSTR lpszOAuthRefreshToken);

char* cloudkeys_azurekeys_getoauthrefreshtoken(void* lpObj);
int cloudkeys_azurekeys_setoauthrefreshtoken(void* lpObj, const char* lpszOAuthRefreshToken);

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

Default Value

""

Remarks

Specifies the refresh token received from or sent to the authorization server. This property is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the OAuthGrantType property is set to a grant that can use refresh tokens.

This property is not available at design time.

Data Type

String

OAuthReturnURL Property (AzureKeys Class)

The URL where the user (browser) returns after authenticating.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOAuthReturnURL();
int SetOAuthReturnURL(const char* lpszOAuthReturnURL);

Unicode (Windows)
LPWSTR GetOAuthReturnURL();
INT SetOAuthReturnURL(LPCWSTR lpszOAuthReturnURL);

char* cloudkeys_azurekeys_getoauthreturnurl(void* lpObj);
int cloudkeys_azurekeys_setoauthreturnurl(void* lpObj, const char* lpszOAuthReturnURL);

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

Default Value

""

Remarks

The URL where the user (browser) returns after authenticating. This property is mapped to the redirect_uri parameter when making a request to the authorization server. Typically, this is automatically set by the class when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this property should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing.

This property is not available at design time.

Data Type

String

OAuthServerAuthURL Property (AzureKeys Class)

The URL of the authorization server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOAuthServerAuthURL();
int SetOAuthServerAuthURL(const char* lpszOAuthServerAuthURL);

Unicode (Windows)
LPWSTR GetOAuthServerAuthURL();
INT SetOAuthServerAuthURL(LPCWSTR lpszOAuthServerAuthURL);

char* cloudkeys_azurekeys_getoauthserverauthurl(void* lpObj);
int cloudkeys_azurekeys_setoauthserverauthurl(void* lpObj, const char* lpszOAuthServerAuthURL);

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

Default Value

""

Remarks

The URL of the authorization server.

This property is not available at design time.

Data Type

String

OAuthServerTokenURL Property (AzureKeys Class)

The URL of the token server used to obtain the access token.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOAuthServerTokenURL();
int SetOAuthServerTokenURL(const char* lpszOAuthServerTokenURL);

Unicode (Windows)
LPWSTR GetOAuthServerTokenURL();
INT SetOAuthServerTokenURL(LPCWSTR lpszOAuthServerTokenURL);

char* cloudkeys_azurekeys_getoauthservertokenurl(void* lpObj);
int cloudkeys_azurekeys_setoauthservertokenurl(void* lpObj, const char* lpszOAuthServerTokenURL);

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

Default Value

""

Remarks

The URL of the token server used to obtain the access token.

This property is not available at design time.

Data Type

String

OAuthWebAuthURL Property (AzureKeys Class)

The URL to which the user should be re-directed for authorization.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOAuthWebAuthURL();

Unicode (Windows)
LPWSTR GetOAuthWebAuthURL();

char* cloudkeys_azurekeys_getoauthwebauthurl(void* lpObj);

QString GetOAuthWebAuthURL();

Default Value

""

Remarks

The URL to which the user should be re-directed for authorization. This field is used to get the URL that the user should be redirected to when using the Web client profile. See introduction section for more information.

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

Data Type

String

OtherHeaders Property (AzureKeys Class)

This property includes 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_azurekeys_getotherheaders(void* lpObj);
int cloudkeys_azurekeys_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

OutputData Property (AzureKeys Class)

The output data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOutputData(char* &lpOutputData, int &lenOutputData);
int SetOutputData(const char* lpOutputData, int lenOutputData);

Unicode (Windows)
INT GetOutputData(LPSTR &lpOutputData, INT &lenOutputData);
INT SetOutputData(LPCSTR lpOutputData, INT lenOutputData);

int cloudkeys_azurekeys_getoutputdata(void* lpObj, char** lpOutputData, int* lenOutputData);
int cloudkeys_azurekeys_setoutputdata(void* lpObj, const char* lpOutputData, int lenOutputData);

QByteArray GetOutputData();
int SetOutputData(QByteArray qbaOutputData);

Default Value

""

Remarks

This property is populated with the data that was output from a successful cryptographic operation.

Note: For the Verify operation, this property functions as a secondary input property instead (along with InputData); refer to the Verify method for more information.

Input Sources & Output Destinations

The class automatically determines the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

1. An input stream supplied via the SetInputStream method
2. The InputFile property
3. The InputData property

The first valid input source found is used. The order in which the output properties are considered is as follows:

1. An output stream supplied via the SetOutputStream method
2. The OutputFile property
3. The OutputData property

This property is not available at design time.

Data Type

Binary String

OutputFile Property (AzureKeys Class)

The file to which output data should be written.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOutputFile();
wchar_t* GetOutputFile_W(); // Windows only
int SetOutputFile(const char* lpszOutputFile);
int SetOutputFile(const wchar_t* lpszOutputFile); // Windows only

Unicode (Windows)
LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);

char* cloudkeys_azurekeys_getoutputfile(void* lpObj);
wchar_t* cloudkeys_azurekeys_getoutputfile_W(void* lpObj); // Windows only
int cloudkeys_azurekeys_setoutputfile(void* lpObj, const char* lpszOutputFile);
int cloudkeys_azurekeys_setoutputfile(void* lpObj, const wchar_t* lpszOutputFile); // Windows only

QString GetOutputFile();
int SetOutputFile(QString qsOutputFile);

Default Value

""

Remarks

This property specifies the file to which data output from a successful cryptographic operation should be written.

Setting this property to a non-empty value will discard any stream set using the SetOutputStream method. Similarly, passing a non-null value to the aforementioned method will clear this property.

Note: For the Verify operation, the specified file functions as a secondary input file instead (along with InputFile); refer to the Verify method for more information.

Input Sources & Output Destinations

The class automatically determines the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

1. An input stream supplied via the SetInputStream method
2. The InputFile property
3. The InputData property

The first valid input source found is used. The order in which the output properties are considered is as follows:

1. An output stream supplied via the SetOutputStream method
2. The OutputFile property
3. The OutputData property

Data Type

String

Overwrite Property (AzureKeys Class)

Whether the output 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_azurekeys_getoverwrite(void* lpObj);
int cloudkeys_azurekeys_setoverwrite(void* lpObj, int bOverwrite);

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

Default Value

FALSE

Remarks

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

Data Type

Boolean

ParsedHeaderCount Property (AzureKeys Class)

The number of records in the ParsedHeader arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetParsedHeaderCount();

Unicode (Windows)
INT GetParsedHeaderCount();

int cloudkeys_azurekeys_getparsedheadercount(void* lpObj);

int GetParsedHeaderCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParsedHeaderField
• ParsedHeaderValue

The array indices start at 0 and end at ParsedHeaderCount - 1.

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

Data Type

Integer

ParsedHeaderField Property (AzureKeys Class)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetParsedHeaderField(int iParsedHeaderIndex);

Unicode (Windows)
LPWSTR GetParsedHeaderField(INT iParsedHeaderIndex);

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

QString GetParsedHeaderField(int iParsedHeaderIndex);

Default Value

""

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

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

Data Type

String

ParsedHeaderValue Property (AzureKeys Class)

This property contains the header contents.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetParsedHeaderValue(int iParsedHeaderIndex);

Unicode (Windows)
LPWSTR GetParsedHeaderValue(INT iParsedHeaderIndex);

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

QString GetParsedHeaderValue(int iParsedHeaderIndex);

Default Value

""

Remarks

This property contains the Header contents.

The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

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

Data Type

String

ProxyAuthScheme Property (AzureKeys Class)

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Unicode (Windows)
INT GetProxyAuthScheme();
INT SetProxyAuthScheme(INT iProxyAuthScheme);

AUTH_BASIC(0), 
AUTH_DIGEST(1), 
AUTH_PROPRIETARY(2), 
AUTH_NONE(3), 
AUTH_NTLM(4), 
AUTH_NEGOTIATE(5)

int cloudkeys_azurekeys_getproxyauthscheme(void* lpObj);
int cloudkeys_azurekeys_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

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

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (AzureKeys Class)

This property tells the class whether or not to automatically detect and use proxy system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAutoDetect();
int SetProxyAutoDetect(int bProxyAutoDetect);

Unicode (Windows)
BOOL GetProxyAutoDetect();
INT SetProxyAutoDetect(BOOL bProxyAutoDetect);

int cloudkeys_azurekeys_getproxyautodetect(void* lpObj);
int cloudkeys_azurekeys_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

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

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (AzureKeys Class)

This property contains a password if authentication is to be used for the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword);

Unicode (Windows)
LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);

char* cloudkeys_azurekeys_getproxypassword(void* lpObj);
int cloudkeys_azurekeys_setproxypassword(void* lpObj, const char* lpszProxyPassword);

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

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (AzureKeys Class)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyPort();
int SetProxyPort(int iProxyPort);

Unicode (Windows)
INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);

int cloudkeys_azurekeys_getproxyport(void* lpObj);
int cloudkeys_azurekeys_setproxyport(void* lpObj, int iProxyPort);

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

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (AzureKeys Class)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyServer();
int SetProxyServer(const char* lpszProxyServer);

Unicode (Windows)
LPWSTR GetProxyServer();
INT SetProxyServer(LPCWSTR lpszProxyServer);

char* cloudkeys_azurekeys_getproxyserver(void* lpObj);
int cloudkeys_azurekeys_setproxyserver(void* lpObj, const char* lpszProxyServer);

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

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (AzureKeys Class)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxySSL();
int SetProxySSL(int iProxySSL);

Unicode (Windows)
INT GetProxySSL();
INT SetProxySSL(INT iProxySSL);

PS_AUTOMATIC(0), 
PS_ALWAYS(1), 
PS_NEVER(2), 
PS_TUNNEL(3)

int cloudkeys_azurekeys_getproxyssl(void* lpObj);
int cloudkeys_azurekeys_setproxyssl(void* lpObj, int iProxySSL);

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

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (AzureKeys Class)

This property contains a user name, if authentication is to be used for the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyUser();
int SetProxyUser(const char* lpszProxyUser);

Unicode (Windows)
LPWSTR GetProxyUser();
INT SetProxyUser(LPCWSTR lpszProxyUser);

char* cloudkeys_azurekeys_getproxyuser(void* lpObj);
int cloudkeys_azurekeys_setproxyuser(void* lpObj, const char* lpszProxyUser);

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

Default Value

""

Remarks

This property contains a user name, if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

QueryParamCount Property (AzureKeys Class)

The number of records in the QueryParam arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetQueryParamCount();
int SetQueryParamCount(int iQueryParamCount);

Unicode (Windows)
INT GetQueryParamCount();
INT SetQueryParamCount(INT iQueryParamCount);

int cloudkeys_azurekeys_getqueryparamcount(void* lpObj);
int cloudkeys_azurekeys_setqueryparamcount(void* lpObj, int iQueryParamCount);

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• QueryParamName
• QueryParamValue

The array indices start at 0 and end at QueryParamCount - 1.

This property is not available at design time.

Data Type

Integer

QueryParamName Property (AzureKeys Class)

The name of the query parameter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQueryParamName(int iQueryParamIndex);
int SetQueryParamName(int iQueryParamIndex, const char* lpszQueryParamName);

Unicode (Windows)
LPWSTR GetQueryParamName(INT iQueryParamIndex);
INT SetQueryParamName(INT iQueryParamIndex, LPCWSTR lpszQueryParamName);

char* cloudkeys_azurekeys_getqueryparamname(void* lpObj, int queryparamindex);
int cloudkeys_azurekeys_setqueryparamname(void* lpObj, int queryparamindex, const char* lpszQueryParamName);

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

Default Value

""

Remarks

The name of the query parameter.

This property specifies the name of the query parameter.

The QueryParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.

This property is not available at design time.

Data Type

String

QueryParamValue Property (AzureKeys Class)

The value of the query parameter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQueryParamValue(int iQueryParamIndex);
int SetQueryParamValue(int iQueryParamIndex, const char* lpszQueryParamValue);

Unicode (Windows)
LPWSTR GetQueryParamValue(INT iQueryParamIndex);
INT SetQueryParamValue(INT iQueryParamIndex, LPCWSTR lpszQueryParamValue);

char* cloudkeys_azurekeys_getqueryparamvalue(void* lpObj, int queryparamindex);
int cloudkeys_azurekeys_setqueryparamvalue(void* lpObj, int queryparamindex, const char* lpszQueryParamValue);

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

Default Value

""

Remarks

The value of the query parameter.

This property specifies the value of the query parameter. The class will automatically URL-encode this value when sending the request.

The QueryParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.

This property is not available at design time.

Data Type

String

SSLAcceptServerCertEncoded Property (AzureKeys Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

int cloudkeys_azurekeys_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int cloudkeys_azurekeys_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

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

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (AzureKeys Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int cloudkeys_azurekeys_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int cloudkeys_azurekeys_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

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

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (AzureKeys Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int cloudkeys_azurekeys_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int cloudkeys_azurekeys_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

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

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (AzureKeys Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* cloudkeys_azurekeys_getsslcertstorepassword(void* lpObj);
int cloudkeys_azurekeys_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

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

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (AzureKeys Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int cloudkeys_azurekeys_getsslcertstoretype(void* lpObj);
int cloudkeys_azurekeys_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

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

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (AzureKeys Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* cloudkeys_azurekeys_getsslcertsubject(void* lpObj);
int cloudkeys_azurekeys_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

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

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

If a field value contains a comma it must be quoted.

Data Type

String

SSLProvider Property (AzureKeys Class)

This specifies the 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_azurekeys_getsslprovider(void* lpObj);
int cloudkeys_azurekeys_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:

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

SSLServerCertEncoded Property (AzureKeys Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);

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

QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

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

Data Type

Binary String

TagCount Property (AzureKeys Class)

The number of records in the Tag arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTagCount();
int SetTagCount(int iTagCount);

Unicode (Windows)
INT GetTagCount();
INT SetTagCount(INT iTagCount);

int cloudkeys_azurekeys_gettagcount(void* lpObj);
int cloudkeys_azurekeys_settagcount(void* lpObj, int iTagCount);

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• TagName
• TagValue

The array indices start at 0 and end at TagCount - 1.

This property is not available at design time.

Data Type

Integer

TagName Property (AzureKeys Class)

The name of the tag.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTagName(int iTagIndex);
int SetTagName(int iTagIndex, const char* lpszTagName);

Unicode (Windows)
LPWSTR GetTagName(INT iTagIndex);
INT SetTagName(INT iTagIndex, LPCWSTR lpszTagName);

char* cloudkeys_azurekeys_gettagname(void* lpObj, int tagindex);
int cloudkeys_azurekeys_settagname(void* lpObj, int tagindex, const char* lpszTagName);

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

Default Value

""

Remarks

The name of the tag.

This property specifies the name of the tag.

The TagIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TagCount property.

This property is not available at design time.

Data Type

String

TagValue Property (AzureKeys Class)

The value of the tag.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTagValue(int iTagIndex);
int SetTagValue(int iTagIndex, const char* lpszTagValue);

Unicode (Windows)
LPWSTR GetTagValue(INT iTagIndex);
INT SetTagValue(INT iTagIndex, LPCWSTR lpszTagValue);

char* cloudkeys_azurekeys_gettagvalue(void* lpObj, int tagindex);
int cloudkeys_azurekeys_settagvalue(void* lpObj, int tagindex, const char* lpszTagValue);

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

Default Value

""

Remarks

The value of the tag.

This property specifies the value of the tag.

The TagIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TagCount property.

This property is not available at design time.

Data Type

String

Timeout Property (AzureKeys Class)

A 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_azurekeys_gettimeout(void* lpObj);
int cloudkeys_azurekeys_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.

Please note that by default, all timeouts are inactivity timeouts, i.e. 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 (AzureKeys 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_azurekeys_getvault(void* lpObj);
int cloudkeys_azurekeys_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 (AzureKeys Class)

A marker indicating what page of key 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_azurekeys_getversionmarker(void* lpObj);
int cloudkeys_azurekeys_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 key 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 (AzureKeys 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_azurekeys_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 QueryaParam* 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 (AzureKeys 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_azurekeys_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 Tag* 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 (AzureKeys 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_azurekeys_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 OAuthClientProfile property and the OAuthGrantType property. This method is not to be used in conjunction with the Authorization property. It should instead be used when setting the OAuth* properties.

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.)

BackupKey Method (AzureKeys Class)

Backs up a key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int BackupKey(const char* lpszKeyName);

Unicode (Windows)
INT BackupKey(LPCWSTR lpszKeyName);

int cloudkeys_azurekeys_backupkey(void* lpObj, const char* lpszKeyName);

int BackupKey(const QString& qsKeyName);

Remarks

This method backs up the key specified by KeyName, returning it in a protected form via the output stream specified via the SetOutputStream method, the specified OutputFile, or the OutputData property.

Note that the protected key cannot be used outside of Azure Key Vault, it must be restored to another vault using the RestoreKey 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 (AzureKeys 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_azurekeys_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.

CreateKey Method (AzureKeys Class)

Creates a new key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* CreateKey(const char* lpszKeyName, const char* lpszKeyType, const char* lpszKeyOps);

Unicode (Windows)
LPWSTR CreateKey(LPCWSTR lpszKeyName, LPCWSTR lpszKeyType, LPCWSTR lpszKeyOps);

char* cloudkeys_azurekeys_createkey(void* lpObj, const char* lpszKeyName, const char* lpszKeyType, const char* lpszKeyOps);

QString CreateKey(const QString& qsKeyName, const QString& qsKeyType, const QString& qsKeyOps);

Remarks

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

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

The KeyType parameter specifies the type of key that should be created. Each key type has two variants, a software-based one and an HSM-based one. Possible values are shown in the first two columns of the following table:

The KeyOps parameter specifies which operations the key will be valid for use with. Possible values are as follows; at least one pair of operations must be specified:

• encrypt
• decrypt
• sign
• verify
• wrapKey
• unwrapKey

If there are any items in the Tag* properties, they will be applied to the newly-created key. Keys may have up to 15 tags.

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

• CreateKeyEnabled
• ExpiryDate
• NotBeforeDate

Note: If there is already a soft-deleted key with the specified KeyName in the currently-selected Vault, then a new key cannot be created with the same name. To resolve such a situation, the soft-deleted key would need to be recovered (using RecoverKey) or permanently deleted (using PurgeKey) 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.

Decrypt Method (AzureKeys Class)

Decrypts data using a key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Decrypt(const char* lpszKeyName, const char* lpszAlgorithm);

Unicode (Windows)
INT Decrypt(LPCWSTR lpszKeyName, LPCWSTR lpszAlgorithm);

int cloudkeys_azurekeys_decrypt(void* lpObj, const char* lpszKeyName, const char* lpszAlgorithm);

int Decrypt(const QString& qsKeyName, const QString& qsAlgorithm);

Remarks

This method decrypts data using the key specified by KeyName and the given Algorithm. The VersionId configuration setting can be used to target a specific key version.

The data to decrypt is taken from the input stream supplied via the SetInputStream method, the specified InputFile, or the InputData property. The decrypted data is output to the output stream supplied via the SetOutputStream method, the specified OutputFile, or the OutputData property.

The key specified by KeyName must be an RSA key; EC keys cannot be used for encryption/decryption.

The Algorithm parameter specifies which algorithm to use to decrypt the data; it must match the algorithm used to encrypt the data previously. Possible values are:

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.)

DeleteKey Method (AzureKeys Class)

Deletes a key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteKey(const char* lpszKeyName);

Unicode (Windows)
INT DeleteKey(LPCWSTR lpszKeyName);

int cloudkeys_azurekeys_deletekey(void* lpObj, const char* lpszKeyName);

int DeleteKey(const QString& qsKeyName);

Remarks

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

Note that the key is only soft-deleted; it can be recovered during the retention period using the RecoverKey method, or permanently deleted using the PurgeKey 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 (AzureKeys Class)

Processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int cloudkeys_azurekeys_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.)

Encrypt Method (AzureKeys Class)

Encrypts data using a key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Encrypt(const char* lpszKeyName, const char* lpszAlgorithm);

Unicode (Windows)
INT Encrypt(LPCWSTR lpszKeyName, LPCWSTR lpszAlgorithm);

int cloudkeys_azurekeys_encrypt(void* lpObj, const char* lpszKeyName, const char* lpszAlgorithm);

int Encrypt(const QString& qsKeyName, const QString& qsAlgorithm);

Remarks

This method encrypts data using the key specified by KeyName and the given Algorithm. The VersionId configuration setting can be used to target a specific key version.

The data to encrypt is taken from the input stream supplied via the SetInputStream method, the specified InputFile, or the InputData property. The encrypted data is output to the output stream supplied via the SetOutputStream method, the specified OutputFile, or the OutputData property.

The key specified by KeyName must be an RSA key; EC keys cannot be used for encryption/decryption.

The Algorithm parameter specifies which algorithm to use to encrypt the data. The type of key and the selected algorithm together dictate the maximum size of the input data. Refer to the following table for possible values and maximum data sizes:

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.)

GetKeyInfo Method (AzureKeys Class)

Gets a key's information and public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyInfo(const char* lpszKeyName);

Unicode (Windows)
INT GetKeyInfo(LPCWSTR lpszKeyName);

int cloudkeys_azurekeys_getkeyinfo(void* lpObj, const char* lpszKeyName);

int GetKeyInfo(const QString& qsKeyName);

Remarks

This method gets the information, including the public key, for the key specified by KeyName. The VersionId configuration setting can be used to target a specific key version. Alternatively, the GetDeleted configuration setting can be enabled to get a soft-deleted key's information (but only for the last version).

When the information is returned, the class clears the Key* properties and repopulates them with a single item that contains the key's information, and repopulates the Tag* properties with the key's tags. The KeyList event is 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.)

ListKeys Method (AzureKeys Class)

Lists keys in the currently-selected vault.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListKeys();

Unicode (Windows)
INT ListKeys();

int cloudkeys_azurekeys_listkeys(void* lpObj);

int ListKeys();

Remarks

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

Calling this method will fire the KeyList event once for each key, and will also populate the Key* properties. However, note that by default the following properties will not be populated, since the server does not return full information for keys when listing them. The IncludeKeyDetails property can be enabled to have the class attempt to retrieve full information for each key; refer to its documentation for more information.

• KeyOps
• KeyType
• KeyPublicKey
• KeyVersionId

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

The MaxKeys 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 (AzureKeys Class)

Lists versions of a key.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT ListVersions(LPCWSTR lpszKeyName);

int cloudkeys_azurekeys_listversions(void* lpObj, const char* lpszKeyName);

int ListVersions(const QString& qsKeyName);

Remarks

This method lists the versions of the key specified by KeyName.

Calling this method will fire the KeyList event once for each key version, and will also populate the Key* properties. However, note that by default the following properties will not be populated, since the server does not return full information for key versions when listing them. The IncludeKeyDetails property can be enabled to have the class attempt to retrieve full information for each key version; refer to its documentation for more information.

• KeyOps
• KeyType
• KeyPublicKey

If there are still more key 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 Key* properties.

The MaxKeys 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.)

PurgeKey Method (AzureKeys Class)

Permanently deletes a soft-deleted key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int PurgeKey(const char* lpszKeyName);

Unicode (Windows)
INT PurgeKey(LPCWSTR lpszKeyName);

int cloudkeys_azurekeys_purgekey(void* lpObj, const char* lpszKeyName);

int PurgeKey(const QString& qsKeyName);

Remarks

This method permanently deletes the soft-deleted key specified by KeyName.

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.)

RecoverKey Method (AzureKeys Class)

Recovers a soft-deleted key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RecoverKey(const char* lpszKeyName);

Unicode (Windows)
INT RecoverKey(LPCWSTR lpszKeyName);

int cloudkeys_azurekeys_recoverkey(void* lpObj, const char* lpszKeyName);

int RecoverKey(const QString& qsKeyName);

Remarks

This method recovers the soft-deleted key specified by KeyName.

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 (AzureKeys Class)

Resets the class to its initial state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int cloudkeys_azurekeys_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.)

RestoreKey Method (AzureKeys Class)

Restores a previously backed-up key to the vault.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* RestoreKey();

Unicode (Windows)
LPWSTR RestoreKey();

char* cloudkeys_azurekeys_restorekey(void* lpObj);

QString RestoreKey();

Remarks

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

The protected key data to restore is taken from the input stream supplied via the SetInputStream method, the specified InputFile, or the InputData property.

Note: There are certain restrictions on which vaults a key can be restored to. In particular, a key 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.

SendCustomRequest Method (AzureKeys Class)

Sends a custom request to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendCustomRequest(const char* lpszHttpMethod, const char* lpszPath);

Unicode (Windows)
INT SendCustomRequest(LPCWSTR lpszHttpMethod, LPCWSTR lpszPath);

int cloudkeys_azurekeys_sendcustomrequest(void* lpObj, const char* lpszHttpMethod, const char* lpszPath);

int SendCustomRequest(const QString& qsHttpMethod, const QString& qsPath);

Remarks

This method can be used to send arbitrary requests to the server.

Valid values for HttpMethod are:

• GET (default if empty)
• HEAD
• POST
• PUT
• PATCH
• DELETE

Path is optional, and if non-empty must be specified without a leading forward slash (/).

When this method is called, the class does the following:

1. Builds a request URL, including query parameters, based on the following:
   • The base URL https://{Vault}.vault.azure.net/keys, where {Vault} is Vault.
   • The specified Path, if any.
   • An api-version query parameter whose value is APIVersion.
   • All query parameters from QueryParam*.
2. Adds an Authorization header with the value specified by Authorization.
3. Adds any request headers from OtherHeaders.
4. Adds any request body supplied via the stream specified using SetInputStream, the specified InputFile, or InputData.
5. Sends the request to the server.
6. Stores the response headers in the ParsedHeader* properties; and the response body in the stream specified using SetOutputStream, the specified OutputFile, or OutputData.

If the response body is JSON data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.

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.)

SetInputStream Method (AzureKeys Class)

Sets the stream whose data should be processed.

Syntax

• C++
• C
• Qt

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

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

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

int SetInputStream(CloudKeysStream* sInputStream);

Remarks

This method sets the stream whose data should be processed in a cryptographic operation.

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

Input Sources & Output Destinations

The class automatically determines the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

1. An input stream supplied via the SetInputStream method
2. The InputFile property
3. The InputData property

The first valid input source found is used. The order in which the output properties are considered is as follows:

1. An output stream supplied via the SetOutputStream method
2. The OutputFile property
3. The OutputData property

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.)

SetKeyEnabled Method (AzureKeys Class)

Enables or disables a key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetKeyEnabled(const char* lpszKeyName, int bEnabled);

Unicode (Windows)
INT SetKeyEnabled(LPCWSTR lpszKeyName, BOOL bEnabled);

int cloudkeys_azurekeys_setkeyenabled(void* lpObj, const char* lpszKeyName, int bEnabled);

int SetKeyEnabled(const QString& qsKeyName, bool bEnabled);

Remarks

This method enables or disables the key specified by KeyName.

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 (AzureKeys Class)

Sets the stream to which output data should be written.

Syntax

• C++
• C
• Qt

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

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

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

int SetOutputStream(CloudKeysStream* sOutputStream);

Remarks

This method sets the stream to which data output from a successful cryptographic operation should be written.

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

Input Sources & Output Destinations

The class automatically determines the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

1. An input stream supplied via the SetInputStream method
2. The InputFile property
3. The InputData property

The first valid input source found is used. The order in which the output properties are considered is as follows:

1. An output stream supplied via the SetOutputStream method
2. The OutputFile property
3. The OutputData property

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.)

Sign Method (AzureKeys Class)

Signs a message using a key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Sign(const char* lpszKeyName, const char* lpszAlgorithm, int bIsDigest);

Unicode (Windows)
INT Sign(LPCWSTR lpszKeyName, LPCWSTR lpszAlgorithm, BOOL bIsDigest);

int cloudkeys_azurekeys_sign(void* lpObj, const char* lpszKeyName, const char* lpszAlgorithm, int bIsDigest);

int Sign(const QString& qsKeyName, const QString& qsAlgorithm, bool bIsDigest);

Remarks

This method signs a message using the key specified by KeyName and the given Algorithm. The VersionId configuration setting can be used to target a specific key version.

The message data to sign is taken from the input stream supplied via the SetInputStream method, the specified InputFile, or the InputData property. The signature data is output to the output stream supplied via the SetOutputStream method, the specified OutputFile, or the OutputData property.

The Algorithm parameter specifies which algorithm to use to sign the data. Possible values are:

• ES256: ECDSA using P-256 and SHA-256.
• ES256K: ECDSA using P-256K and SHA-256.
• ES384: ECDSA using P-384 and SHA-384.
• ES512: ECDSA using P-521 and SHA-512.
• PS256: RSASSA-PSS using SHA-256 and MGF1 with SHA-256.
• PS384: RSASSA-PSS using SHA-384 and MGF1 with SHA-384.
• PS512: RSASSA-PSS using SHA-512 and MGF1 with SHA-512.
• RS256: RSASSA-PKCS1-v1_5 using SHA-256.
• RS384: RSASSA-PKCS1-v1_5 using SHA-384.
• RS512: RSASSA-PKCS1-v1_5 using SHA-512.

The IsDigest parameter specifies whether the message data is the original message (false) or a message digest (true). When supplying a message digest, keep in mind that the same digest will need to be provided in order to Verify the signature later.

If IsDigest is false, the class will automatically compute an appropriate message digest before the request is made. In such cases, the computed digest is made available via the MessageDigest configuration setting.

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.)

UnwrapKey Method (AzureKeys Class)

Unwraps a symmetric key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UnwrapKey(const char* lpszKeyName, const char* lpszAlgorithm);

Unicode (Windows)
INT UnwrapKey(LPCWSTR lpszKeyName, LPCWSTR lpszAlgorithm);

int cloudkeys_azurekeys_unwrapkey(void* lpObj, const char* lpszKeyName, const char* lpszAlgorithm);

int UnwrapKey(const QString& qsKeyName, const QString& qsAlgorithm);

Remarks

This method unwraps (i.e., decrypts) a symmetric key using the key specified by KeyName and the given Algorithm.

This method functions exactly the same way as the Decrypt method, except that it requires the keys/unwrapKey permission instead of the keys/decrypt permission. Refer to the Decrypt method's 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.)

UpdateKey Method (AzureKeys Class)

Updates a key's information.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdateKey(const char* lpszKeyName, const char* lpszKeyOps, int bUpdateTags);

Unicode (Windows)
INT UpdateKey(LPCWSTR lpszKeyName, LPCWSTR lpszKeyOps, BOOL bUpdateTags);

int cloudkeys_azurekeys_updatekey(void* lpObj, const char* lpszKeyName, const char* lpszKeyOps, int bUpdateTags);

int UpdateKey(const QString& qsKeyName, const QString& qsKeyOps, bool bUpdateTags);

Remarks

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

The KeyOps parameter, if non-empty, must be a comma-separated list of operations that the key is valid for. If empty, the key's current operations list remains unchanged. Possible values are as follows; operations should be specified in pairs:

• encrypt
• decrypt
• sign
• verify
• wrapKey
• unwrapKey

The UpdateTags parameter determines whether the class replaces the key's current tags with the items in the Tag* properties (which may be empty). Keys 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.)

Verify Method (AzureKeys Class)

Verifies a digital signature using a key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Verify(const char* lpszKeyName, const char* lpszAlgorithm, int bIsDigest);

Unicode (Windows)
INT Verify(LPCWSTR lpszKeyName, LPCWSTR lpszAlgorithm, BOOL bIsDigest);

int cloudkeys_azurekeys_verify(void* lpObj, const char* lpszKeyName, const char* lpszAlgorithm, int bIsDigest);

bool Verify(const QString& qsKeyName, const QString& qsAlgorithm, bool bIsDigest);

Remarks

This method verifies a digital signature using the key specified by KeyName and the given Algorithm. The VersionId configuration setting can be used to target a specific key version. If the signature is successfully verified, this method returns true, otherwise it returns false.

The message data is taken from the input stream supplied via the SetInputStream method, the specified InputFile, or the InputData property. The digital signature data is taken from the specified OutputFile or the OutputData property.

The Algorithm parameter specifies which algorithm was used to sign the data. Possible values are:

• ES256: ECDSA using P-256 and SHA-256.
• ES256K: ECDSA using P-256K and SHA-256.
• ES384: ECDSA using P-384 and SHA-384.
• ES512: ECDSA using P-521 and SHA-512.
• PS256: RSASSA-PSS using SHA-256 and MGF1 with SHA-256.
• PS384: RSASSA-PSS using SHA-384 and MGF1 with SHA-384.
• PS512: RSASSA-PSS using SHA-512 and MGF1 with SHA-512.
• RS256: RSASSA-PKCS1-v1_5 using SHA-256.
• RS384: RSASSA-PKCS1-v1_5 using SHA-384.
• RS512: RSASSA-PKCS1-v1_5 using SHA-512.

The IsDigest parameter specifies whether the message data is the original message (false) or a message digest (true). When a message digest is supplied, keep in mind that it must be the exact same digest that was used at signing time, regardless of whether it has been recomputed.

If IsDigest is false, the class will automatically compute an appropriate message digest before the request is made. In such cases, the computed digest is made available via the MessageDigest configuration setting.

Error Handling (C++)

This method returns a Boolean 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.

WrapKey Method (AzureKeys Class)

Wraps a symmetric key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int WrapKey(const char* lpszKeyName, const char* lpszAlgorithm);

Unicode (Windows)
INT WrapKey(LPCWSTR lpszKeyName, LPCWSTR lpszAlgorithm);

int cloudkeys_azurekeys_wrapkey(void* lpObj, const char* lpszKeyName, const char* lpszAlgorithm);

int WrapKey(const QString& qsKeyName, const QString& qsAlgorithm);

Remarks

This method wraps (i.e., encrypts) a symmetric key using the key specified by KeyName and the given Algorithm. The VersionId configuration setting can be used to target a specific key version.

This method functions exactly the same way as the Encrypt method, except that it requires the keys/wrapKey permission instead of the keys/encrypt permission. Refer to the Encrypt method's 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 (AzureKeys Class)

This event fires when a document finishes transferring.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AZUREKEYS_ENDTRANSFER 1

virtual INT CLOUDKEYS_CALL FireEndTransfer(INT &iDirection);

class AzureKeysEndTransferEventParams {
public:
  int Direction();

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

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

// Or, subclass AzureKeys and override this emitter function.
virtual int FireEndTransfer(AzureKeysEndTransferEventParams *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 (AzureKeys Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AZUREKEYS_ERROR 2

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

class AzureKeysErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

Remarks

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

ErrorCode contains an error code and Description 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 (AzureKeys Class)

This event is fired every time a header line comes in.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AZUREKEYS_HEADER 3

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

class AzureKeysHeaderEventParams {
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(AzureKeysHeaderEventParams *e);

// Or, subclass AzureKeys and override this emitter function.
virtual int FireHeader(AzureKeysHeaderEventParams *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).

KeyList Event (AzureKeys Class)

Fires once for each key when listing keys.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireKeyList(AzureKeysKeyListEventParams *e);

typedef struct {
  const char *Name;
  const char *VersionId;
  const char *KeyType;
  const char *KeyOps;
  int Enabled;
  int64 CreationDate;
  int64 UpdateDate;
  int64 DeletionDate;
  int64 PurgeDate;
  const char *PublicKey;
  int reserved;
} AzureKeysKeyListEventParams;


Unicode (Windows)
virtual INT FireKeyList(AzureKeysKeyListEventParams *e);

typedef struct {
  LPCWSTR Name;
  LPCWSTR VersionId;
  LPCWSTR KeyType;
  LPCWSTR KeyOps;
  BOOL Enabled;
  LONG64 CreationDate;
  LONG64 UpdateDate;
  LONG64 DeletionDate;
  LONG64 PurgeDate;
  LPCWSTR PublicKey;
  INT reserved;
} AzureKeysKeyListEventParams;

#define EID_AZUREKEYS_KEYLIST 4

virtual INT CLOUDKEYS_CALL FireKeyList(LPSTR &lpszName, LPSTR &lpszVersionId, LPSTR &lpszKeyType, LPSTR &lpszKeyOps, BOOL &bEnabled, LONG64 &lCreationDate, LONG64 &lUpdateDate, LONG64 &lDeletionDate, LONG64 &lPurgeDate, LPSTR &lpszPublicKey);

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

  const QString &VersionId();

  const QString &KeyType();

  const QString &KeyOps();

  bool Enabled();

  qint64 CreationDate();

  qint64 UpdateDate();

  qint64 DeletionDate();

  qint64 PurgeDate();

  const QString &PublicKey();

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

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

// Or, subclass AzureKeys and override this emitter function.
virtual int FireKeyList(AzureKeysKeyListEventParams *e) {...}

Remarks

This event fires once for each key (or key version) returned when ListKeys, ListVersions, or GetKeyInfo is called. However, note that the KeyOps, KeyType, PublicKey, and (for ListKeys) VersionId parameters are not populated when one of the listing methods is called unless the IncludeKeyDetails property is enabled; refer to its documentation for more information.

Name reflects the name of the key.

VersionId reflects the Id of the key version.

KeyType reflects the key's type. Each key type has two variants, a software-based one and an HSM-based one. Possible values are shown in the first two columns of the following table:

KeyOps reflects a comma-separated list of operations that the key may be used for. Possible values are:

• encrypt
• decrypt
• sign
• verify
• wrapKey
• unwrapKey

Enabled reflects whether the key is currently enabled.

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

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

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

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

PublicKey reflects the key's public key, in PEM format.

Log Event (AzureKeys Class)

This event fires once for each log message.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AZUREKEYS_LOG 5

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

class AzureKeysLogEventParams {
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(AzureKeysLogEventParams *e);

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

Remarks

This event fires 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"

SSLServerAuthentication Event (AzureKeys Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AZUREKEYS_SSLSERVERAUTHENTICATION 6

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

class AzureKeysSSLServerAuthenticationEventParams {
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(AzureKeysSSLServerAuthenticationEventParams *e);

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

Remarks

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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 (AzureKeys Class)

Shows the progress of the secure connection.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AZUREKEYS_SSLSTATUS 7

virtual INT CLOUDKEYS_CALL FireSSLStatus(LPSTR &lpszMessage);

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

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

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

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

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

StartTransfer Event (AzureKeys Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AZUREKEYS_STARTTRANSFER 8

virtual INT CLOUDKEYS_CALL FireStartTransfer(INT &iDirection);

class AzureKeysStartTransferEventParams {
public:
  int Direction();

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

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

// Or, subclass AzureKeys and override this emitter function.
virtual int FireStartTransfer(AzureKeysStartTransferEventParams *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 (AzureKeys Class)

Fires once for each tag returned when a key's information is retrieved.

Syntax

• C++
• C
• Qt

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

typedef struct {
  const char *KeyName;
  const char *VersionId;
  const char *Name;
  const char *Value;
  int reserved;
} AzureKeysTagListEventParams;


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

typedef struct {
  LPCWSTR KeyName;
  LPCWSTR VersionId;
  LPCWSTR Name;
  LPCWSTR Value;
  INT reserved;
} AzureKeysTagListEventParams;

#define EID_AZUREKEYS_TAGLIST 9

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

class AzureKeysTagListEventParams {
public:
  const QString &KeyName();

  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(AzureKeysTagListEventParams *e);

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

Remarks

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

KeyName reflects the name of the key.

VersionId reflects the Id of the key version.

Name reflects the name of the tag.

Value reflects the value of the tag.

Transfer Event (AzureKeys Class)

This event is fired while a document transfers (delivers document).

Syntax

• C++
• C
• Qt

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

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


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

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