AzureKeys Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

CloudKeys_AzureKeys

Procedural Interface

 cloudkeys_azurekeys_open();
 cloudkeys_azurekeys_close($res);
 cloudkeys_azurekeys_register_callback($res, $id, $function);
 cloudkeys_azurekeys_get_last_error($res);
 cloudkeys_azurekeys_get_last_error_code($res);
 cloudkeys_azurekeys_set($res, $id, $index, $value);
 cloudkeys_azurekeys_get($res, $id, $index);
 cloudkeys_azurekeys_do_addqueryparam($res, $name, $value);
 cloudkeys_azurekeys_do_addtag($res, $name, $value);
 cloudkeys_azurekeys_do_authorize($res);
 cloudkeys_azurekeys_do_backupkey($res, $keyname);
 cloudkeys_azurekeys_do_config($res, $configurationstring);
 cloudkeys_azurekeys_do_createkey($res, $keyname, $keytype, $keyops);
 cloudkeys_azurekeys_do_decrypt($res, $keyname, $algorithm);
 cloudkeys_azurekeys_do_deletekey($res, $keyname);
 cloudkeys_azurekeys_do_doevents($res);
 cloudkeys_azurekeys_do_encrypt($res, $keyname, $algorithm);
 cloudkeys_azurekeys_do_getkeyinfo($res, $keyname);
 cloudkeys_azurekeys_do_listkeys($res);
 cloudkeys_azurekeys_do_listversions($res, $keyname);
 cloudkeys_azurekeys_do_purgekey($res, $keyname);
 cloudkeys_azurekeys_do_recoverkey($res, $keyname);
 cloudkeys_azurekeys_do_reset($res);
 cloudkeys_azurekeys_do_restorekey($res);
 cloudkeys_azurekeys_do_sendcustomrequest($res, $httpmethod, $path);
 cloudkeys_azurekeys_do_setkeyenabled($res, $keyname, $enabled);
 cloudkeys_azurekeys_do_sign($res, $keyname, $algorithm, $isdigest);
 cloudkeys_azurekeys_do_unwrapkey($res, $keyname, $algorithm);
 cloudkeys_azurekeys_do_updatekey($res, $keyname, $keyops, $updatetags);
 cloudkeys_azurekeys_do_verify($res, $keyname, $algorithm, $isdigest);
 cloudkeys_azurekeys_do_wrapkey($res, $keyname, $algorithm);

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 property 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 = CloudOAuthClientProfiles.cocpApplication; azurekeys.OAuth.GrantType = OAuthSettingsGrantTypes.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 or InputFile to supply the input data that should be processed. All operations will output the result data to OutputData or OutputFile (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 Tags 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 (CloudKeys_AzureKeys Class)

OAuth 2.0 Authorization Token.

Object Oriented Interface

public function getAuthorization();
public function setAuthorization($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 1 );
cloudkeys_azurekeys_set($res, 1, $value );

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

Whether to automatically detect and use firewall system settings, if available.

Object Oriented Interface

public function getFirewallAutoDetect();
public function setFirewallAutoDetect($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 2 );
cloudkeys_azurekeys_set($res, 2, $value );

Default Value

false

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (CloudKeys_AzureKeys Class)

The type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();
public function setFirewallType($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 3 );
cloudkeys_azurekeys_set($res, 3, $value );

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (CloudKeys_AzureKeys Class)

The name or IP address of the firewall (optional).

Object Oriented Interface

public function getFirewallHost();
public function setFirewallHost($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 4 );
cloudkeys_azurekeys_set($res, 4, $value );

Default Value

''

Remarks

The name or IP address of the 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 (CloudKeys_AzureKeys Class)

A password if authentication is to be used when connecting through the firewall.

Object Oriented Interface

public function getFirewallPassword();
public function setFirewallPassword($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 5 );
cloudkeys_azurekeys_set($res, 5, $value );

Default Value

''

Remarks

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

The Transmission Control Protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();
public function setFirewallPort($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 6 );
cloudkeys_azurekeys_set($res, 6, $value );

Default Value

0

Remarks

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

A username if authentication is to be used when connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();
public function setFirewallUser($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 7 );
cloudkeys_azurekeys_set($res, 7, $value );

Default Value

''

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property 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 (CloudKeys_AzureKeys Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

cloudkeys_azurekeys_get($res, 8 );

Default Value

true

Remarks

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

This property is read-only.

Data Type

Boolean

IncludeKeyDetails Property (CloudKeys_AzureKeys Class)

Whether to attempt to retrieve fill details when listing keys.

Object Oriented Interface

public function getIncludeKeyDetails();
public function setIncludeKeyDetails($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 9 );
cloudkeys_azurekeys_set($res, 9, $value );

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 Keys 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 (CloudKeys_AzureKeys Class)

The data to process.

Object Oriented Interface

public function getInputData();
public function setInputData($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 10 );
cloudkeys_azurekeys_set($res, 10, $value );

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. The InputFile property
2. The InputData property

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

1. The OutputFile property
2. The OutputData property

This property is not available at design time.

Data Type

Binary String

InputFile Property (CloudKeys_AzureKeys Class)

The file whose data should be processed.

Object Oriented Interface

public function getInputFile();
public function setInputFile($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 11 );
cloudkeys_azurekeys_set($res, 11, $value );

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.

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. The InputFile property
2. The InputData property

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

1. The OutputFile property
2. The OutputData property

Data Type

String

KeyMarker Property (CloudKeys_AzureKeys Class)

A marker indicating what page of keys to return next.

Object Oriented Interface

public function getKeyMarker();
public function setKeyMarker($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 12 );
cloudkeys_azurekeys_set($res, 12, $value );

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

The number of records in the Key arrays.

Object Oriented Interface

public function getKeyCount();

Procedural Interface

cloudkeys_azurekeys_get($res, 13 );

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

The creation date of the key.

Object Oriented Interface

public function getKeyCreationDate($keyindex);

Procedural Interface

cloudkeys_azurekeys_get($res, 14 , $keyindex);

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

The deletion date of the key.

Object Oriented Interface

public function getKeyDeletionDate($keyindex);

Procedural Interface

cloudkeys_azurekeys_get($res, 15 , $keyindex);

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

Whether the key is enabled.

Object Oriented Interface

public function getKeyEnabled($keyindex);

Procedural Interface

cloudkeys_azurekeys_get($res, 16 , $keyindex);

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

The expiration date of the key.

Object Oriented Interface

public function getKeyExpiryDate($keyindex);

Procedural Interface

cloudkeys_azurekeys_get($res, 17 , $keyindex);

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

The operation that the key may be used for.

Object Oriented Interface

public function getKeyOps($keyindex);

Procedural Interface

cloudkeys_azurekeys_get($res, 18 , $keyindex);

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

The key's type.

Object Oriented Interface

public function getKeyType($keyindex);

Procedural Interface

cloudkeys_azurekeys_get($res, 19 , $keyindex);

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

The name of the key.

Object Oriented Interface

public function getKeyName($keyindex);

Procedural Interface

cloudkeys_azurekeys_get($res, 20 , $keyindex);

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

The 'not before' date of the key.

Object Oriented Interface

public function getKeyNotBeforeDate($keyindex);

Procedural Interface

cloudkeys_azurekeys_get($res, 21 , $keyindex);

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

The key's public key.

Object Oriented Interface

public function getKeyPublicKey($keyindex);

Procedural Interface

cloudkeys_azurekeys_get($res, 22 , $keyindex);

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

The purge date of the key.

Object Oriented Interface

public function getKeyPurgeDate($keyindex);

Procedural Interface

cloudkeys_azurekeys_get($res, 23 , $keyindex);

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

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

Object Oriented Interface

public function getKeyRecoverableDays($keyindex);

Procedural Interface

cloudkeys_azurekeys_get($res, 24 , $keyindex);

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

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

Object Oriented Interface

public function getKeyRecoveryLevel($keyindex);

Procedural Interface

cloudkeys_azurekeys_get($res, 25 , $keyindex);

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

The update date of the key.

Object Oriented Interface

public function getKeyUpdateDate($keyindex);

Procedural Interface

cloudkeys_azurekeys_get($res, 26 , $keyindex);

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

The version Id of the key.

Object Oriented Interface

public function getKeyVersionId($keyindex);

Procedural Interface

cloudkeys_azurekeys_get($res, 27 , $keyindex);

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

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

Object Oriented Interface

public function getLocalHost();
public function setLocalHost($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 28 );
cloudkeys_azurekeys_set($res, 28, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

OAuthAccessToken Property (CloudKeys_AzureKeys Class)

The access token returned by the authorization server.

Object Oriented Interface

public function getOAuthAccessToken();
public function setOAuthAccessToken($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 29 );
cloudkeys_azurekeys_set($res, 29, $value );

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

The authorization code that is exchanged for an access token.

Object Oriented Interface

public function getOAuthAuthorizationCode();
public function setOAuthAuthorizationCode($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 30 );
cloudkeys_azurekeys_set($res, 30, $value );

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

The scope request or response parameter used during authorization.

Object Oriented Interface

public function getOAuthAuthorizationScope();
public function setOAuthAuthorizationScope($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 31 );
cloudkeys_azurekeys_set($res, 31, $value );

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

The id of the client assigned when registering the application.

Object Oriented Interface

public function getOAuthClientId();
public function setOAuthClientId($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 32 );
cloudkeys_azurekeys_set($res, 32, $value );

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

The type of client that is requesting authorization.

Object Oriented Interface

public function getOAuthClientProfile();
public function setOAuthClientProfile($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 33 );
cloudkeys_azurekeys_set($res, 33, $value );

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

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

Object Oriented Interface

public function getOAuthClientSecret();
public function setOAuthClientSecret($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 34 );
cloudkeys_azurekeys_set($res, 34, $value );

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

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

Object Oriented Interface

public function getOAuthGrantType();
public function setOAuthGrantType($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 35 );
cloudkeys_azurekeys_set($res, 35, $value );

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

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

Object Oriented Interface

public function getOAuthRefreshToken();
public function setOAuthRefreshToken($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 36 );
cloudkeys_azurekeys_set($res, 36, $value );

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

OAuthRequestRefreshToken Property (CloudKeys_AzureKeys Class)

Specifies whether the class will request a refresh token during authorization.

Object Oriented Interface

public function getOAuthRequestRefreshToken();
public function setOAuthRequestRefreshToken($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 37 );
cloudkeys_azurekeys_set($res, 37, $value );

Default Value

true

Remarks

Specifies whether the class will request a refresh token during authorization. By default, this value is True.

When True, the class will automatically add the necessary scopes or parameters to obtain a refresh token. When False, this property will have no effect. If the necessary scopes or parameters are specified manually, a refresh token can still be obtained.

Note: This property is only applicable when the OAuthGrantType property is set to cogtAuthorizationCode.

This property is not available at design time.

Data Type

Boolean

OAuthReturnURL Property (CloudKeys_AzureKeys Class)

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

Object Oriented Interface

public function getOAuthReturnURL();
public function setOAuthReturnURL($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 38 );
cloudkeys_azurekeys_set($res, 38, $value );

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

The URL of the authorization server.

Object Oriented Interface

public function getOAuthServerAuthURL();
public function setOAuthServerAuthURL($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 39 );
cloudkeys_azurekeys_set($res, 39, $value );

Default Value

''

Remarks

The URL of the authorization server.

This property is not available at design time.

Data Type

String

OAuthServerTokenURL Property (CloudKeys_AzureKeys Class)

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

Object Oriented Interface

public function getOAuthServerTokenURL();
public function setOAuthServerTokenURL($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 40 );
cloudkeys_azurekeys_set($res, 40, $value );

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

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

Object Oriented Interface

public function getOAuthWebAuthURL();

Procedural Interface

cloudkeys_azurekeys_get($res, 41 );

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

Other headers as determined by the user (optional).

Object Oriented Interface

public function getOtherHeaders();
public function setOtherHeaders($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 42 );
cloudkeys_azurekeys_set($res, 42, $value );

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

The output data.

Object Oriented Interface

public function getOutputData();
public function setOutputData($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 43 );
cloudkeys_azurekeys_set($res, 43, $value );

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. The InputFile property
2. The InputData property

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

1. The OutputFile property
2. The OutputData property

This property is not available at design time.

Data Type

Binary String

OutputFile Property (CloudKeys_AzureKeys Class)

The file to which output data should be written.

Object Oriented Interface

public function getOutputFile();
public function setOutputFile($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 44 );
cloudkeys_azurekeys_set($res, 44, $value );

Default Value

''

Remarks

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

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. The InputFile property
2. The InputData property

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

1. The OutputFile property
2. The OutputData property

Data Type

String

Overwrite Property (CloudKeys_AzureKeys Class)

Whether the output file should be overwritten if necessary.

Object Oriented Interface

public function getOverwrite();
public function setOverwrite($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 45 );
cloudkeys_azurekeys_set($res, 45, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ParsedHeaderCount Property (CloudKeys_AzureKeys Class)

The number of records in the ParsedHeader arrays.

Object Oriented Interface

public function getParsedHeaderCount();

Procedural Interface

cloudkeys_azurekeys_get($res, 46 );

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

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

Object Oriented Interface

public function getParsedHeaderField($parsedheaderindex);

Procedural Interface

cloudkeys_azurekeys_get($res, 47 , $parsedheaderindex);

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

This property contains the header contents.

Object Oriented Interface

public function getParsedHeaderValue($parsedheaderindex);

Procedural Interface

cloudkeys_azurekeys_get($res, 48 , $parsedheaderindex);

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

The type of authorization to perform when connecting to the proxy.

Object Oriented Interface

public function getProxyAuthScheme();
public function setProxyAuthScheme($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 49 );
cloudkeys_azurekeys_set($res, 49, $value );

Default Value

0

Remarks

The 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 class 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 (CloudKeys_AzureKeys Class)

Whether to automatically detect and use proxy system settings, if available.

Object Oriented Interface

public function getProxyAutoDetect();
public function setProxyAutoDetect($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 50 );
cloudkeys_azurekeys_set($res, 50, $value );

Default Value

false

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (CloudKeys_AzureKeys Class)

A password if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyPassword();
public function setProxyPassword($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 51 );
cloudkeys_azurekeys_set($res, 51, $value );

Default Value

''

Remarks

A password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties 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 (CloudKeys_AzureKeys Class)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Object Oriented Interface

public function getProxyPort();
public function setProxyPort($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 52 );
cloudkeys_azurekeys_set($res, 52, $value );

Default Value

80

Remarks

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

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

Object Oriented Interface

public function getProxyServer();
public function setProxyServer($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 53 );
cloudkeys_azurekeys_set($res, 53, $value );

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

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Object Oriented Interface

public function getProxySSL();
public function setProxySSL($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 54 );
cloudkeys_azurekeys_set($res, 54, $value );

Default Value

0

Remarks

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

A username if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyUser();
public function setProxyUser($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 55 );
cloudkeys_azurekeys_set($res, 55, $value );

Default Value

''

Remarks

A username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties 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 (CloudKeys_AzureKeys Class)

The number of records in the QueryParam arrays.

Object Oriented Interface

public function getQueryParamCount();
public function setQueryParamCount($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 56 );
cloudkeys_azurekeys_set($res, 56, $value );

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

The name of the query parameter.

Object Oriented Interface

public function getQueryParamName($queryparamindex);
public function setQueryParamName($queryparamindex, $value);

Procedural Interface

cloudkeys_azurekeys_get($res, 57 , $queryparamindex);
cloudkeys_azurekeys_set($res, 57, $value , $queryparamindex);

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

The value of the query parameter.

Object Oriented Interface

public function getQueryParamValue($queryparamindex);
public function setQueryParamValue($queryparamindex, $value);

Procedural Interface

cloudkeys_azurekeys_get($res, 58 , $queryparamindex);
cloudkeys_azurekeys_set($res, 58, $value , $queryparamindex);

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

SSLAcceptServerCertEffectiveDate Property (CloudKeys_AzureKeys Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

cloudkeys_azurekeys_get($res, 59 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (CloudKeys_AzureKeys Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

cloudkeys_azurekeys_get($res, 60 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (CloudKeys_AzureKeys Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

cloudkeys_azurekeys_get($res, 61 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (CloudKeys_AzureKeys Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

cloudkeys_azurekeys_get($res, 62 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (CloudKeys_AzureKeys Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

cloudkeys_azurekeys_get($res, 63 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (CloudKeys_AzureKeys Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

cloudkeys_azurekeys_get($res, 64 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (CloudKeys_AzureKeys Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

cloudkeys_azurekeys_get($res, 65 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (CloudKeys_AzureKeys Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

cloudkeys_azurekeys_get($res, 66 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (CloudKeys_AzureKeys Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

cloudkeys_azurekeys_get($res, 67 );

Default Value

false

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (CloudKeys_AzureKeys Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

cloudkeys_azurekeys_get($res, 68 );

Default Value

''

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (CloudKeys_AzureKeys Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

cloudkeys_azurekeys_get($res, 69 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (CloudKeys_AzureKeys Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

cloudkeys_azurekeys_get($res, 70 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (CloudKeys_AzureKeys Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

cloudkeys_azurekeys_get($res, 71 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (CloudKeys_AzureKeys Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

cloudkeys_azurekeys_get($res, 72 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (CloudKeys_AzureKeys Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

cloudkeys_azurekeys_get($res, 73 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (CloudKeys_AzureKeys Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 74 );
cloudkeys_azurekeys_set($res, 74, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (CloudKeys_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.

Object Oriented Interface

public function getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 75 );
cloudkeys_azurekeys_set($res, 75, $value );

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

SSLAcceptServerCertStoreType Property (CloudKeys_AzureKeys Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 76 );
cloudkeys_azurekeys_set($res, 76, $value );

Default Value

0

Remarks

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

SSLAcceptServerCertSubjectAltNames Property (CloudKeys_AzureKeys Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

cloudkeys_azurekeys_get($res, 77 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (CloudKeys_AzureKeys Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

cloudkeys_azurekeys_get($res, 78 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (CloudKeys_AzureKeys Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

cloudkeys_azurekeys_get($res, 79 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (CloudKeys_AzureKeys Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

cloudkeys_azurekeys_get($res, 80 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (CloudKeys_AzureKeys Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

cloudkeys_azurekeys_get($res, 81 );

Default Value

''

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (CloudKeys_AzureKeys Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

cloudkeys_azurekeys_get($res, 82 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (CloudKeys_AzureKeys Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

cloudkeys_azurekeys_get($res, 83 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (CloudKeys_AzureKeys Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 84 );
cloudkeys_azurekeys_set($res, 84, $value );

Default Value

''

Remarks

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 as follows:

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

Data Type

String

SSLAcceptServerCertEncoded Property (CloudKeys_AzureKeys Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 85 );
cloudkeys_azurekeys_set($res, 85, $value );

Default Value

''

Remarks

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

SSLCertEffectiveDate Property (CloudKeys_AzureKeys Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

cloudkeys_azurekeys_get($res, 86 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (CloudKeys_AzureKeys Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

cloudkeys_azurekeys_get($res, 87 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (CloudKeys_AzureKeys Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

cloudkeys_azurekeys_get($res, 88 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (CloudKeys_AzureKeys Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

cloudkeys_azurekeys_get($res, 89 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (CloudKeys_AzureKeys Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

cloudkeys_azurekeys_get($res, 90 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (CloudKeys_AzureKeys Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

cloudkeys_azurekeys_get($res, 91 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (CloudKeys_AzureKeys Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

cloudkeys_azurekeys_get($res, 92 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (CloudKeys_AzureKeys Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

cloudkeys_azurekeys_get($res, 93 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (CloudKeys_AzureKeys Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

cloudkeys_azurekeys_get($res, 94 );

Default Value

false

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (CloudKeys_AzureKeys Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

cloudkeys_azurekeys_get($res, 95 );

Default Value

''

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (CloudKeys_AzureKeys Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

cloudkeys_azurekeys_get($res, 96 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (CloudKeys_AzureKeys Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

cloudkeys_azurekeys_get($res, 97 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (CloudKeys_AzureKeys Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

cloudkeys_azurekeys_get($res, 98 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (CloudKeys_AzureKeys Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

cloudkeys_azurekeys_get($res, 99 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (CloudKeys_AzureKeys Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

cloudkeys_azurekeys_get($res, 100 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (CloudKeys_AzureKeys Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 101 );
cloudkeys_azurekeys_set($res, 101, $value );

Default Value

'MY'

Remarks

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 designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (CloudKeys_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.

Object Oriented Interface

public function getSSLCertStorePassword();
public function setSSLCertStorePassword($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 102 );
cloudkeys_azurekeys_set($res, 102, $value );

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

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 103 );
cloudkeys_azurekeys_set($res, 103, $value );

Default Value

0

Remarks

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

SSLCertSubjectAltNames Property (CloudKeys_AzureKeys Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

cloudkeys_azurekeys_get($res, 104 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (CloudKeys_AzureKeys Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

cloudkeys_azurekeys_get($res, 105 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (CloudKeys_AzureKeys Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

cloudkeys_azurekeys_get($res, 106 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (CloudKeys_AzureKeys Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

cloudkeys_azurekeys_get($res, 107 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (CloudKeys_AzureKeys Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

cloudkeys_azurekeys_get($res, 108 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (CloudKeys_AzureKeys Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

cloudkeys_azurekeys_get($res, 109 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (CloudKeys_AzureKeys Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

cloudkeys_azurekeys_get($res, 110 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (CloudKeys_AzureKeys Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 111 );
cloudkeys_azurekeys_set($res, 111, $value );

Default Value

''

Remarks

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 as follows:

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

Data Type

String

SSLCertEncoded Property (CloudKeys_AzureKeys Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 112 );
cloudkeys_azurekeys_set($res, 112, $value );

Default Value

''

Remarks

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

SSLProvider Property (CloudKeys_AzureKeys Class)

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

Object Oriented Interface

public function getSSLProvider();
public function setSSLProvider($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 113 );
cloudkeys_azurekeys_set($res, 113, $value );

Default Value

0

Remarks

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

Possible values are as follows:

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

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

Data Type

Integer

SSLServerCertEffectiveDate Property (CloudKeys_AzureKeys Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

cloudkeys_azurekeys_get($res, 114 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (CloudKeys_AzureKeys Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

cloudkeys_azurekeys_get($res, 115 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (CloudKeys_AzureKeys Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

cloudkeys_azurekeys_get($res, 116 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (CloudKeys_AzureKeys Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

cloudkeys_azurekeys_get($res, 117 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (CloudKeys_AzureKeys Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

cloudkeys_azurekeys_get($res, 118 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (CloudKeys_AzureKeys Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

cloudkeys_azurekeys_get($res, 119 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (CloudKeys_AzureKeys Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

cloudkeys_azurekeys_get($res, 120 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (CloudKeys_AzureKeys Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

cloudkeys_azurekeys_get($res, 121 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (CloudKeys_AzureKeys Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

cloudkeys_azurekeys_get($res, 122 );

Default Value

false

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (CloudKeys_AzureKeys Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

cloudkeys_azurekeys_get($res, 123 );

Default Value

''

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (CloudKeys_AzureKeys Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

cloudkeys_azurekeys_get($res, 124 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (CloudKeys_AzureKeys Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

cloudkeys_azurekeys_get($res, 125 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (CloudKeys_AzureKeys Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

cloudkeys_azurekeys_get($res, 126 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (CloudKeys_AzureKeys Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

cloudkeys_azurekeys_get($res, 127 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (CloudKeys_AzureKeys Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

cloudkeys_azurekeys_get($res, 128 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertStore Property (CloudKeys_AzureKeys Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

cloudkeys_azurekeys_get($res, 129 );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (CloudKeys_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.

Object Oriented Interface

public function getSSLServerCertStorePassword();

Procedural Interface

cloudkeys_azurekeys_get($res, 130 );

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.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (CloudKeys_AzureKeys Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

cloudkeys_azurekeys_get($res, 131 );

Default Value

0

Remarks

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:

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (CloudKeys_AzureKeys Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

cloudkeys_azurekeys_get($res, 132 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (CloudKeys_AzureKeys Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

cloudkeys_azurekeys_get($res, 133 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (CloudKeys_AzureKeys Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

cloudkeys_azurekeys_get($res, 134 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (CloudKeys_AzureKeys Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

cloudkeys_azurekeys_get($res, 135 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (CloudKeys_AzureKeys Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

cloudkeys_azurekeys_get($res, 136 );

Default Value

''

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (CloudKeys_AzureKeys Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

cloudkeys_azurekeys_get($res, 137 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (CloudKeys_AzureKeys Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

cloudkeys_azurekeys_get($res, 138 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (CloudKeys_AzureKeys Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

cloudkeys_azurekeys_get($res, 139 );

Default Value

''

Remarks

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 as follows:

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

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (CloudKeys_AzureKeys Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

cloudkeys_azurekeys_get($res, 140 );

Default Value

''

Remarks

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

The number of records in the Tag arrays.

Object Oriented Interface

public function getTagCount();
public function setTagCount($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 141 );
cloudkeys_azurekeys_set($res, 141, $value );

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

The name of the tag.

Object Oriented Interface

public function getTagName($tagindex);
public function setTagName($tagindex, $value);

Procedural Interface

cloudkeys_azurekeys_get($res, 142 , $tagindex);
cloudkeys_azurekeys_set($res, 142, $value , $tagindex);

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

The value of the tag.

Object Oriented Interface

public function getTagValue($tagindex);
public function setTagValue($tagindex, $value);

Procedural Interface

cloudkeys_azurekeys_get($res, 143 , $tagindex);
cloudkeys_azurekeys_set($res, 143, $value , $tagindex);

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

The timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 144 );
cloudkeys_azurekeys_set($res, 144, $value );

Default Value

60

Remarks

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

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

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

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

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

The default value for the Timeout property is 60 seconds.

Data Type

Integer

Vault Property (CloudKeys_AzureKeys Class)

Selects a vault for the class to interact with.

Object Oriented Interface

public function getVault();
public function setVault($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 145 );
cloudkeys_azurekeys_set($res, 145, $value );

Default Value

''

Remarks

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

Data Type

String

VersionMarker Property (CloudKeys_AzureKeys Class)

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

Object Oriented Interface

public function getVersionMarker();
public function setVersionMarker($value);

Procedural Interface

cloudkeys_azurekeys_get($res, 146 );
cloudkeys_azurekeys_set($res, 146, $value );

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

Adds a query parameter to the QueryParams properties.

Object Oriented Interface

public function doAddQueryParam($name, $value);

Procedural Interface

cloudkeys_azurekeys_do_addqueryparam($res, $name, $value);

Remarks

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

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

AddTag Method (CloudKeys_AzureKeys Class)

Adds an item to the Tags properties.

Object Oriented Interface

public function doAddTag($name, $value);

Procedural Interface

cloudkeys_azurekeys_do_addtag($res, $name, $value);

Remarks

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

Authorize Method (CloudKeys_AzureKeys Class)

Get the authorization string required to access the protected resource.

Object Oriented Interface

public function doAuthorize();

Procedural Interface

cloudkeys_azurekeys_do_authorize($res);

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

For more information, see the introduction section.

BackupKey Method (CloudKeys_AzureKeys Class)

Backs up a key.

Object Oriented Interface

public function doBackupKey($keyname);

Procedural Interface

cloudkeys_azurekeys_do_backupkey($res, $keyname);

Remarks

This method backs up the key specified by KeyName, returning it in a protected form via the 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.

Config Method (CloudKeys_AzureKeys Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

cloudkeys_azurekeys_do_config($res, $configurationstring);

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.

CreateKey Method (CloudKeys_AzureKeys Class)

Creates a new key.

Object Oriented Interface

public function doCreateKey($keyname, $keytype, $keyops);

Procedural Interface

cloudkeys_azurekeys_do_createkey($res, $keyname, $keytype, $keyops);

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

Decrypt Method (CloudKeys_AzureKeys Class)

Decrypts data using a key.

Object Oriented Interface

public function doDecrypt($keyname, $algorithm);

Procedural Interface

cloudkeys_azurekeys_do_decrypt($res, $keyname, $algorithm);

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 the specified InputFile or the InputData property. The decrypted data is output to the 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:

DeleteKey Method (CloudKeys_AzureKeys Class)

Deletes a key.

Object Oriented Interface

public function doDeleteKey($keyname);

Procedural Interface

cloudkeys_azurekeys_do_deletekey($res, $keyname);

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.

DoEvents Method (CloudKeys_AzureKeys Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

cloudkeys_azurekeys_do_doevents($res);

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.

Encrypt Method (CloudKeys_AzureKeys Class)

Encrypts data using a key.

Object Oriented Interface

public function doEncrypt($keyname, $algorithm);

Procedural Interface

cloudkeys_azurekeys_do_encrypt($res, $keyname, $algorithm);

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 the specified InputFile or the InputData property. The encrypted data is output to the 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:

GetKeyInfo Method (CloudKeys_AzureKeys Class)

Gets a key's information and public key.

Object Oriented Interface

public function doGetKeyInfo($keyname);

Procedural Interface

cloudkeys_azurekeys_do_getkeyinfo($res, $keyname);

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 Keys properties and repopulates it properties with the key's tags. The KeyList event is also fired.

ListKeys Method (CloudKeys_AzureKeys Class)

Lists keys in the currently-selected vault.

Object Oriented Interface

public function doListKeys();

Procedural Interface

cloudkeys_azurekeys_do_listkeys($res);

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 Keys 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 Keys properties.

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

ListVersions Method (CloudKeys_AzureKeys Class)

Lists versions of a key.

Object Oriented Interface

public function doListVersions($keyname);

Procedural Interface

cloudkeys_azurekeys_do_listversions($res, $keyname);

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 Keys 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 Keys properties.

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

PurgeKey Method (CloudKeys_AzureKeys Class)

Permanently deletes a soft-deleted key.

Object Oriented Interface

public function doPurgeKey($keyname);

Procedural Interface

cloudkeys_azurekeys_do_purgekey($res, $keyname);

Remarks

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

RecoverKey Method (CloudKeys_AzureKeys Class)

Recovers a soft-deleted key.

Object Oriented Interface

public function doRecoverKey($keyname);

Procedural Interface

cloudkeys_azurekeys_do_recoverkey($res, $keyname);

Remarks

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

Reset Method (CloudKeys_AzureKeys Class)

Resets the class to its initial state.

Object Oriented Interface

public function doReset();

Procedural Interface

cloudkeys_azurekeys_do_reset($res);

Remarks

This method resets the class to its initial state.

RestoreKey Method (CloudKeys_AzureKeys Class)

Restores a previously backed-up key to the vault.

Object Oriented Interface

public function doRestoreKey();

Procedural Interface

cloudkeys_azurekeys_do_restorekey($res);

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

SendCustomRequest Method (CloudKeys_AzureKeys Class)

Sends a custom request to the server.

Object Oriented Interface

public function doSendCustomRequest($httpmethod, $path);

Procedural Interface

cloudkeys_azurekeys_do_sendcustomrequest($res, $httpmethod, $path);

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 QueryParams.
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 specified InputFile or InputData.
5. Sends the request to the server.
6. Stores the response headers in the ParsedHeaders properties; and the response body in 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.

SetKeyEnabled Method (CloudKeys_AzureKeys Class)

Enables or disables a key.

Object Oriented Interface

public function doSetKeyEnabled($keyname, $enabled);

Procedural Interface

cloudkeys_azurekeys_do_setkeyenabled($res, $keyname, $enabled);

Remarks

This method enables or disables the key specified by KeyName.

Sign Method (CloudKeys_AzureKeys Class)

Signs a message using a key.

Object Oriented Interface

public function doSign($keyname, $algorithm, $isdigest);

Procedural Interface

cloudkeys_azurekeys_do_sign($res, $keyname, $algorithm, $isdigest);

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 the specified InputFile or the InputData property. The signature data is output to the 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.

UnwrapKey Method (CloudKeys_AzureKeys Class)

Unwraps a symmetric key.

Object Oriented Interface

public function doUnwrapKey($keyname, $algorithm);

Procedural Interface

cloudkeys_azurekeys_do_unwrapkey($res, $keyname, $algorithm);

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.

UpdateKey Method (CloudKeys_AzureKeys Class)

Updates a key's information.

Object Oriented Interface

public function doUpdateKey($keyname, $keyops, $updatetags);

Procedural Interface

cloudkeys_azurekeys_do_updatekey($res, $keyname, $keyops, $updatetags);

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

Verify Method (CloudKeys_AzureKeys Class)

Verifies a digital signature using a key.

Object Oriented Interface

public function doVerify($keyname, $algorithm, $isdigest);

Procedural Interface

cloudkeys_azurekeys_do_verify($res, $keyname, $algorithm, $isdigest);

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

WrapKey Method (CloudKeys_AzureKeys Class)

Wraps a symmetric key.

Object Oriented Interface

public function doWrapKey($keyname, $algorithm);

Procedural Interface

cloudkeys_azurekeys_do_wrapkey($res, $keyname, $algorithm);

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.

EndTransfer Event (CloudKeys_AzureKeys Class)

This event fires when a document finishes transferring.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

cloudkeys_azurekeys_register_callback($res, 1, array($this, 'fireEndTransfer'));

Parameter List

 'direction'

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

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

cloudkeys_azurekeys_register_callback($res, 2, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

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

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

Header Event (CloudKeys_AzureKeys Class)

Fired every time a header line comes in.

Object Oriented Interface

public function fireHeader($param);

Procedural Interface

cloudkeys_azurekeys_register_callback($res, 3, array($this, 'fireHeader'));

Parameter List

 'field'
 'value'

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

Fires once for each key when listing keys.

Object Oriented Interface

public function fireKeyList($param);

Procedural Interface

cloudkeys_azurekeys_register_callback($res, 4, array($this, 'fireKeyList'));

Parameter List

 'name'
 'versionid'
 'keytype'
 'keyops'
 'enabled'
 'creationdate'
 'updatedate'
 'deletiondate'
 'purgedate'
 'publickey'

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

Fired once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

cloudkeys_azurekeys_register_callback($res, 5, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'
 'logtype'

Remarks

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

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

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

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

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

Message is the log entry.

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

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

SSLServerAuthentication Event (CloudKeys_AzureKeys Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

cloudkeys_azurekeys_register_callback($res, 6, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

Remarks

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

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

SSLStatus Event (CloudKeys_AzureKeys Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

cloudkeys_azurekeys_register_callback($res, 7, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

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

StartTransfer Event (CloudKeys_AzureKeys Class)

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

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

cloudkeys_azurekeys_register_callback($res, 8, array($this, 'fireStartTransfer'));

Parameter List

 'direction'

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

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

Object Oriented Interface

public function fireTagList($param);

Procedural Interface

cloudkeys_azurekeys_register_callback($res, 9, array($this, 'fireTagList'));

Parameter List

 'keyname'
 'versionid'
 'name'
 'value'

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

Fired while a document transfers (delivers document).

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

cloudkeys_azurekeys_register_callback($res, 10, array($this, 'fireTransfer'));

Parameter List

 'direction'
 'bytestransferred'
 'percentdone'
 'text'

Remarks

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

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

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

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

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

Config Settings (AzureKeys Class)

AzureKeys Config Settings

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

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

OAuth Config Settings

HTTP Config Settings

TCPClient Config Settings