AmazonSecrets Class

Properties   Methods   Events   Config Settings   Errors  

The AmazonSecrets class provides an easy-to-use interface for Amazon's Secrets Manager service.

Class Name

CloudKeys_AmazonSecrets

Procedural Interface

 cloudkeys_amazonsecrets_open();
 cloudkeys_amazonsecrets_close($res);
 cloudkeys_amazonsecrets_register_callback($res, $id, $function);
 cloudkeys_amazonsecrets_get_last_error($res);
 cloudkeys_amazonsecrets_get_last_error_code($res);
 cloudkeys_amazonsecrets_set($res, $id, $index, $value);
 cloudkeys_amazonsecrets_get($res, $id, $index);
 cloudkeys_amazonsecrets_do_addqueryparam($res, $name, $value);
 cloudkeys_amazonsecrets_do_canceldeletion($res, $secretid);
 cloudkeys_amazonsecrets_do_config($res, $configurationstring);
 cloudkeys_amazonsecrets_do_createsecret($res, $secretname, $description);
 cloudkeys_amazonsecrets_do_createversion($res, $secretid, $staginglabels);
 cloudkeys_amazonsecrets_do_deletesecret($res, $secretid, $daystowait);
 cloudkeys_amazonsecrets_do_doevents($res);
 cloudkeys_amazonsecrets_do_genrandompassword($res, $length, $lowercase, $uppercase, $numbers, $punctuation, $spaces, $excludechars, $requireeach);
 cloudkeys_amazonsecrets_do_getsecret($res, $secretid, $versionid, $staginglabel);
 cloudkeys_amazonsecrets_do_getsecretinfo($res, $secretid);
 cloudkeys_amazonsecrets_do_listsecrets($res);
 cloudkeys_amazonsecrets_do_listversions($res, $secretid);
 cloudkeys_amazonsecrets_do_movestaginglabel($res, $secretid, $staginglabel, $fromversionid, $toversionid);
 cloudkeys_amazonsecrets_do_reset($res);
 cloudkeys_amazonsecrets_do_sendcustomrequest($res, $action, $body);
 cloudkeys_amazonsecrets_do_updatesecret($res, $secretid, $description);

Remarks

The AmazonSecrets class makes it easy to work with the Amazon Secrets Manager service in a secure manner using TLS. Amazon Secrets Manager allows you to securely store secrets (e.g., passwords, symmetric keys, etc.) in the cloud so that the aren't persisted locally. This class helps you to create, manage, and access those secrets.

To begin, register for an AWS account and obtain an AccessKey and SecretKey to use for authentication.

Resource Terminology

A secret in Amazon Secrets Manager is a container for one or more secret versions, which is where secret data is actually stored. Each secret version can have between zero and 20 staging labels attached to it at any given time.

A staging label is a simple string that can be used instead of a version Id to refer to a particular secret version when retrieving secret data. A staging label can only be attached to one version of a secret at any given time. The server ensures that there is always exactly one version of a secret with the special staging label AWSCURRENT, but otherwise you are free to apply any staging labels to any secret versions you choose.

Secret versions that do not have any staging labels attached to them are considered deprecated, and the server may delete them at any time without warning. Deprecated secret versions are not shown in a secret's version list unless explicitly asked for.

Using the Class

The CreateSecret method will create a new secret with an initial secret version that holds the specified secret data. To change a secret's data, create a new version of it using the CreateVersion method.

To retrieve a secret's data, call the GetSecret method, and specify the specific version (either by Id or using a staging label) whose data should be retrieved. If no particular version is specified, the version with the AWSCURRENT staging label is used.

Secrets that will no longer be used can be deleted using the DeleteSecret method, either immediately or after a waiting period. If a secret is scheduled for deletion later, then during said waiting period the deletion can be canceled using CancelDeletion. // Creates a new secret with the textual data "Test123" named MySecret. // The initial secret version will have only the "AWSCURRENT" staging label. amazonsecrets.SecretString = "Test123"; amazonsecrets.CreateSecret("MySecret", "A description of my secret."); // Creates a new secret version with the textual data "Cats456" and // attaches the staging labels "AWSCURRENT" (which gets moved from the previous version) // and "best-version" to it. amazonsecrets.SecretString = "Cats456"; amazonsecrets.CreateVersion("MySecret", "AWSCURRENT,best-version"); // Downloads the latest secret version's data to a local file. amazonsecrets.LocalFile = "C:\temp\secret.txt"; amazonsecrets.GetSecret("MySecret", "", ""); // Schedules the secret, and all its versions, for deletion after 10 days. amazonsecrets.DeleteSecret("MySecret", 10); // Cancels the scheduled deletion. amazonsecrets.CancelDeletion("MySecret");

To list secrets, use the ListSecrets method. To list a secret's versions, use the ListVersions method. // If there are many secrets to list, there may be multiple pages of results. This will // cause all pages of results to be accumulated into the Secrets collection property. do { amazonsecrets.ListSecrets(); } while (!string.IsNullOrEmpty(amazonsecrets.SecretMarker)); // A similar thing applies to secret versions as well. do { amazonsecrets.ListVersions("MySecret"); } while (!string.IsNullOrEmpty(amazonsecrets.VersionMarker));

The class also supports other functionality, including:

• Adding, removing, and moving staging labels between secret versions using MoveStagingLabel.
• Retrieval of information for a single secret with GetSecretInfo.
• Random password generation using GenRandomPassword.
• 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.

AccessKey Property (CloudKeys_AmazonSecrets Class)

The access key to use for authentication.

Object Oriented Interface

public function getAccessKey();
public function setAccessKey($value);

Procedural Interface

cloudkeys_amazonsecrets_get($res, 1 );
cloudkeys_amazonsecrets_set($res, 1, $value );

Default Value

''

Remarks

This property specifies the access key that should be used for authentication. Both this property and SecretKey must be set before attempting any operations which connect to the server.

Data Type

String

FirewallAutoDetect Property (CloudKeys_AmazonSecrets 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_amazonsecrets_get($res, 2 );
cloudkeys_amazonsecrets_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_AmazonSecrets Class)

The type of firewall to connect through.

Object Oriented Interface

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

Procedural Interface

cloudkeys_amazonsecrets_get($res, 3 );
cloudkeys_amazonsecrets_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_AmazonSecrets Class)

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

Object Oriented Interface

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

Procedural Interface

cloudkeys_amazonsecrets_get($res, 4 );
cloudkeys_amazonsecrets_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_AmazonSecrets 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_amazonsecrets_get($res, 5 );
cloudkeys_amazonsecrets_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_AmazonSecrets Class)

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

Object Oriented Interface

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

Procedural Interface

cloudkeys_amazonsecrets_get($res, 6 );
cloudkeys_amazonsecrets_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_AmazonSecrets 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_amazonsecrets_get($res, 7 );
cloudkeys_amazonsecrets_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_AmazonSecrets Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

cloudkeys_amazonsecrets_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

LocalFile Property (CloudKeys_AmazonSecrets Class)

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

Object Oriented Interface

public function getLocalFile();
public function setLocalFile($value);

Procedural Interface

cloudkeys_amazonsecrets_get($res, 9 );
cloudkeys_amazonsecrets_set($res, 9, $value );

Default Value

''

Remarks

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

When creating a secret, the class assumes that data specified via a local file is binary in nature; the PreferBinary configuration setting can be used to control this behavior, refer to its documentation for more information.

Data Type

String

LocalHost Property (CloudKeys_AmazonSecrets 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_amazonsecrets_get($res, 10 );
cloudkeys_amazonsecrets_set($res, 10, $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

OtherHeaders Property (CloudKeys_AmazonSecrets Class)

Other headers as determined by the user (optional).

Object Oriented Interface

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

Procedural Interface

cloudkeys_amazonsecrets_get($res, 11 );
cloudkeys_amazonsecrets_set($res, 11, $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

Overwrite Property (CloudKeys_AmazonSecrets Class)

Whether the local file should be overwritten if necessary.

Object Oriented Interface

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

Procedural Interface

cloudkeys_amazonsecrets_get($res, 12 );
cloudkeys_amazonsecrets_set($res, 12, $value );

Default Value

false

Remarks

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

This property is not available at design time.

Data Type

Boolean

ParsedHeaderCount Property (CloudKeys_AmazonSecrets Class)

The number of records in the ParsedHeader arrays.

Object Oriented Interface

public function getParsedHeaderCount();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 13 );

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_AmazonSecrets 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_amazonsecrets_get($res, 14 , $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_AmazonSecrets Class)

This property contains the header contents.

Object Oriented Interface

public function getParsedHeaderValue($parsedheaderindex);

Procedural Interface

cloudkeys_amazonsecrets_get($res, 15 , $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_AmazonSecrets 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_amazonsecrets_get($res, 16 );
cloudkeys_amazonsecrets_set($res, 16, $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_AmazonSecrets 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_amazonsecrets_get($res, 17 );
cloudkeys_amazonsecrets_set($res, 17, $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_AmazonSecrets 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_amazonsecrets_get($res, 18 );
cloudkeys_amazonsecrets_set($res, 18, $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_AmazonSecrets 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_amazonsecrets_get($res, 19 );
cloudkeys_amazonsecrets_set($res, 19, $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_AmazonSecrets 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_amazonsecrets_get($res, 20 );
cloudkeys_amazonsecrets_set($res, 20, $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_AmazonSecrets 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_amazonsecrets_get($res, 21 );
cloudkeys_amazonsecrets_set($res, 21, $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_AmazonSecrets 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_amazonsecrets_get($res, 22 );
cloudkeys_amazonsecrets_set($res, 22, $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_AmazonSecrets Class)

The number of records in the QueryParam arrays.

Object Oriented Interface

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

Procedural Interface

cloudkeys_amazonsecrets_get($res, 23 );
cloudkeys_amazonsecrets_set($res, 23, $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_AmazonSecrets Class)

The name of the query parameter.

Object Oriented Interface

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

Procedural Interface

cloudkeys_amazonsecrets_get($res, 24 , $queryparamindex);
cloudkeys_amazonsecrets_set($res, 24, $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_AmazonSecrets Class)

The value of the query parameter.

Object Oriented Interface

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

Procedural Interface

cloudkeys_amazonsecrets_get($res, 25 , $queryparamindex);
cloudkeys_amazonsecrets_set($res, 25, $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

Region Property (CloudKeys_AmazonSecrets Class)

The region that the class will make requests against.

Object Oriented Interface

public function getRegion();
public function setRegion($value);

Procedural Interface

cloudkeys_amazonsecrets_get($res, 26 );
cloudkeys_amazonsecrets_set($res, 26, $value );

Default Value

'us-east-1'

Remarks

This property controls which region the class will make requests against. By default the class uses us-east-1, the US East (N. Virginia) region. This property should be changed in order to create or access resources in other regions, as secrets are region-specific resources.

Regions:

The class will always convert this property's value to lowercase. If this property is cleared, the class will reset it to the default value.

Data Type

String

SecretData Property (CloudKeys_AmazonSecrets Class)

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

Object Oriented Interface

public function getSecretData();
public function setSecretData($value);

Procedural Interface

cloudkeys_amazonsecrets_get($res, 27 );
cloudkeys_amazonsecrets_set($res, 27, $value );

Remarks

Either this property or the SecretString property is populated with secret data after calling GetSecret, depending on whether the secret data is binary or textual, so long as LocalFile is not set.

This property (or the SecretString property) can also be set before calling CreateSecret or CreateVersion; its data will be sent if LocalFile is not set.

This property and SecretString are mutually exclusive; setting one will clear the other.

This property is not available at design time.

Data Type

Byte Array

SecretKey Property (CloudKeys_AmazonSecrets Class)

The secret key to use for authentication.

Object Oriented Interface

public function getSecretKey();
public function setSecretKey($value);

Procedural Interface

cloudkeys_amazonsecrets_get($res, 28 );
cloudkeys_amazonsecrets_set($res, 28, $value );

Default Value

''

Remarks

This property specifies the secret key that should be used for authentication. Both this property and AccessKey must be set before attempting any operations which connect to the server.

Data Type

String

SecretMarker Property (CloudKeys_AmazonSecrets Class)

A marker indicating what page of secrets to return next.

Object Oriented Interface

public function getSecretMarker();
public function setSecretMarker($value);

Procedural Interface

cloudkeys_amazonsecrets_get($res, 29 );
cloudkeys_amazonsecrets_set($res, 29, $value );

Default Value

''

Remarks

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

Refer to ListSecrets for more information.

This property is not available at design time.

Data Type

String

SecretCount Property (CloudKeys_AmazonSecrets Class)

The number of records in the Secret arrays.

Object Oriented Interface

public function getSecretCount();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 30 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SecretARN
• SecretCreationDate
• SecretDeletionDate
• SecretDescription
• SecretKMSKeyId
• SecretLastAccessDate
• SecretLastChangeDate
• SecretName
• SecretOwningService

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

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

Data Type

Integer

SecretARN Property (CloudKeys_AmazonSecrets Class)

The Amazon resource name (ARN) of the secret.

Object Oriented Interface

public function getSecretARN($secretindex);

Procedural Interface

cloudkeys_amazonsecrets_get($res, 31 , $secretindex);

Default Value

''

Remarks

The Amazon resource name (ARN) of the secret.

This property reflects the Amazon resource name (ARN) of the secret.

The $secretindex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretCount property.

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

Data Type

String

SecretCreationDate Property (CloudKeys_AmazonSecrets Class)

The creation date of the secret.

Object Oriented Interface

public function getSecretCreationDate($secretindex);

Procedural Interface

cloudkeys_amazonsecrets_get($res, 32 , $secretindex);

Default Value

''

Remarks

The creation date of the secret.

This property reflects the creation date of the secret, in seconds since the Unix epoch (including fractional seconds).

The $secretindex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretCount property.

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

Data Type

String

SecretDeletionDate Property (CloudKeys_AmazonSecrets Class)

The deletion date of the secret.

Object Oriented Interface

public function getSecretDeletionDate($secretindex);

Procedural Interface

cloudkeys_amazonsecrets_get($res, 33 , $secretindex);

Default Value

''

Remarks

The deletion date of the secret.

This property reflects the deletion date of the secret, in seconds since the Unix epoch (including fractional seconds).

The $secretindex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretCount property.

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

Data Type

String

SecretDescription Property (CloudKeys_AmazonSecrets Class)

The secret's description.

Object Oriented Interface

public function getSecretDescription($secretindex);

Procedural Interface

cloudkeys_amazonsecrets_get($res, 34 , $secretindex);

Default Value

''

Remarks

The secret's description.

This property reflects the secret's description.

The $secretindex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretCount property.

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

Data Type

String

SecretKMSKeyId Property (CloudKeys_AmazonSecrets Class)

The ARN or alias of the Amazon KMS KMS key used to encrypt the secret.

Object Oriented Interface

public function getSecretKMSKeyId($secretindex);

Procedural Interface

cloudkeys_amazonsecrets_get($res, 35 , $secretindex);

Default Value

''

Remarks

The ARN or alias of the Amazon KMS KMS key used to encrypt the secret.

This property reflects the ARN or alias of the Amazon KMS key used to encrypt the secret.

The $secretindex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretCount property.

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

Data Type

String

SecretLastAccessDate Property (CloudKeys_AmazonSecrets Class)

The last access date of the secret.

Object Oriented Interface

public function getSecretLastAccessDate($secretindex);

Procedural Interface

cloudkeys_amazonsecrets_get($res, 36 , $secretindex);

Default Value

''

Remarks

The last access date of the secret.

This property reflects the last access date of the secret, in seconds since the Unix epoch.

Note that this property offers date-level resolution, time is not included.

The $secretindex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretCount property.

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

Data Type

String

SecretLastChangeDate Property (CloudKeys_AmazonSecrets Class)

The last change date of the secret.

Object Oriented Interface

public function getSecretLastChangeDate($secretindex);

Procedural Interface

cloudkeys_amazonsecrets_get($res, 37 , $secretindex);

Default Value

''

Remarks

The last change date of the secret.

This property reflects the last change date of the secret, in seconds since the Unix epoch (including fractional seconds).

The $secretindex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretCount property.

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

Data Type

String

SecretName Property (CloudKeys_AmazonSecrets Class)

The name of the secret.

Object Oriented Interface

public function getSecretName($secretindex);

Procedural Interface

cloudkeys_amazonsecrets_get($res, 38 , $secretindex);

Default Value

''

Remarks

The name of the secret.

This property reflects the name of the secret.

The $secretindex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretCount property.

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

Data Type

String

SecretOwningService Property (CloudKeys_AmazonSecrets Class)

The name of the service that created the secret.

Object Oriented Interface

public function getSecretOwningService($secretindex);

Procedural Interface

cloudkeys_amazonsecrets_get($res, 39 , $secretindex);

Default Value

''

Remarks

The name of the service that created the secret.

This property reflects the name of the AWS service that created the secret.

The $secretindex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretCount property.

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

Data Type

String

SecretString Property (CloudKeys_AmazonSecrets Class)

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

Object Oriented Interface

public function getSecretString();
public function setSecretString($value);

Procedural Interface

cloudkeys_amazonsecrets_get($res, 40 );
cloudkeys_amazonsecrets_set($res, 40, $value );

Default Value

''

Remarks

Either this property or the SecretData property is populated with secret data after calling GetSecret, depending on whether the secret data is binary or textual, so long as LocalFile is not set.

This property (or the SecretData property) can also be set before calling CreateSecret or CreateVersion; its data will be sent if LocalFile is not set.

This property and SecretData are mutually exclusive; setting one will clear the other.

This property is not available at design time.

Data Type

String

SSLAcceptServerCertEffectiveDate Property (CloudKeys_AmazonSecrets Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 41 );

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_AmazonSecrets Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 42 );

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_AmazonSecrets Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 43 );

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_AmazonSecrets Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 44 );

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_AmazonSecrets Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 45 );

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_AmazonSecrets Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 46 );

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_AmazonSecrets Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 47 );

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_AmazonSecrets Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 48 );

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_AmazonSecrets Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 49 );

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_AmazonSecrets Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 50 );

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_AmazonSecrets Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 51 );

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_AmazonSecrets Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 52 );

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_AmazonSecrets Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 53 );

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_AmazonSecrets Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 54 );

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_AmazonSecrets Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 55 );

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_AmazonSecrets Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

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

Procedural Interface

cloudkeys_amazonsecrets_get($res, 56 );
cloudkeys_amazonsecrets_set($res, 56, $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_AmazonSecrets 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_amazonsecrets_get($res, 57 );
cloudkeys_amazonsecrets_set($res, 57, $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_AmazonSecrets Class)

The type of certificate store for this certificate.

Object Oriented Interface

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

Procedural Interface

cloudkeys_amazonsecrets_get($res, 58 );
cloudkeys_amazonsecrets_set($res, 58, $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_AmazonSecrets Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 59 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (CloudKeys_AmazonSecrets Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 60 );

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_AmazonSecrets Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 61 );

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_AmazonSecrets Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 62 );

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_AmazonSecrets Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 63 );

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_AmazonSecrets Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 64 );

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_AmazonSecrets Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 65 );

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_AmazonSecrets Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

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

Procedural Interface

cloudkeys_amazonsecrets_get($res, 66 );
cloudkeys_amazonsecrets_set($res, 66, $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_AmazonSecrets Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

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

Procedural Interface

cloudkeys_amazonsecrets_get($res, 67 );
cloudkeys_amazonsecrets_set($res, 67, $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_AmazonSecrets Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 68 );

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_AmazonSecrets Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 69 );

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_AmazonSecrets Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 70 );

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_AmazonSecrets Class)

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

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 71 );

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_AmazonSecrets Class)

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

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 72 );

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_AmazonSecrets Class)

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

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 73 );

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_AmazonSecrets Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 74 );

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_AmazonSecrets Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 75 );

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_AmazonSecrets Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 76 );

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_AmazonSecrets Class)

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

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 77 );

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_AmazonSecrets Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 78 );

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_AmazonSecrets Class)

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

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 79 );

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_AmazonSecrets Class)

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

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 80 );

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_AmazonSecrets Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 81 );

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_AmazonSecrets Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 82 );

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_AmazonSecrets Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

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

Procedural Interface

cloudkeys_amazonsecrets_get($res, 83 );
cloudkeys_amazonsecrets_set($res, 83, $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_AmazonSecrets 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_amazonsecrets_get($res, 84 );
cloudkeys_amazonsecrets_set($res, 84, $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_AmazonSecrets Class)

The type of certificate store for this certificate.

Object Oriented Interface

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

Procedural Interface

cloudkeys_amazonsecrets_get($res, 85 );
cloudkeys_amazonsecrets_set($res, 85, $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_AmazonSecrets Class)

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

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 86 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (CloudKeys_AmazonSecrets Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 87 );

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_AmazonSecrets Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 88 );

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_AmazonSecrets Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 89 );

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_AmazonSecrets Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 90 );

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_AmazonSecrets Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 91 );

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_AmazonSecrets Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 92 );

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_AmazonSecrets Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

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

Procedural Interface

cloudkeys_amazonsecrets_get($res, 93 );
cloudkeys_amazonsecrets_set($res, 93, $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_AmazonSecrets Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

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

Procedural Interface

cloudkeys_amazonsecrets_get($res, 94 );
cloudkeys_amazonsecrets_set($res, 94, $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_AmazonSecrets 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_amazonsecrets_get($res, 95 );
cloudkeys_amazonsecrets_set($res, 95, $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_AmazonSecrets Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 96 );

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_AmazonSecrets Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 97 );

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_AmazonSecrets Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 98 );

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_AmazonSecrets Class)

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

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 99 );

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_AmazonSecrets Class)

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 100 );

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_AmazonSecrets Class)

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 101 );

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_AmazonSecrets Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 102 );

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_AmazonSecrets Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 103 );

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_AmazonSecrets Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 104 );

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_AmazonSecrets Class)

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

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 105 );

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_AmazonSecrets Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 106 );

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_AmazonSecrets Class)

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

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 107 );

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_AmazonSecrets Class)

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

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 108 );

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_AmazonSecrets Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 109 );

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_AmazonSecrets Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 110 );

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_AmazonSecrets Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 111 );

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_AmazonSecrets 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_amazonsecrets_get($res, 112 );

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_AmazonSecrets Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 113 );

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_AmazonSecrets Class)

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

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 114 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (CloudKeys_AmazonSecrets Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 115 );

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_AmazonSecrets Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 116 );

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_AmazonSecrets Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 117 );

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_AmazonSecrets Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 118 );

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_AmazonSecrets Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 119 );

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_AmazonSecrets Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 120 );

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_AmazonSecrets Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 121 );

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_AmazonSecrets Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 122 );

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

Timeout Property (CloudKeys_AmazonSecrets Class)

The timeout for the class.

Object Oriented Interface

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

Procedural Interface

cloudkeys_amazonsecrets_get($res, 123 );
cloudkeys_amazonsecrets_set($res, 123, $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

VersionMarker Property (CloudKeys_AmazonSecrets Class)

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

Object Oriented Interface

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

Procedural Interface

cloudkeys_amazonsecrets_get($res, 124 );
cloudkeys_amazonsecrets_set($res, 124, $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 secret versions, continue to call ListVersions until this property returns empty string.

Refer to ListVersions for more information.

This property is not available at design time.

Data Type

String

VersionCount Property (CloudKeys_AmazonSecrets Class)

The number of records in the Version arrays.

Object Oriented Interface

public function getVersionCount();

Procedural Interface

cloudkeys_amazonsecrets_get($res, 125 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• VersionCreationDate
• VersionLastAccessDate
• VersionSecretARN
• VersionSecretName
• VersionStagingLabels
• VersionVersionId

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

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

Data Type

Integer

VersionCreationDate Property (CloudKeys_AmazonSecrets Class)

The creation date of the secret version.

Object Oriented Interface

public function getVersionCreationDate($versionindex);

Procedural Interface

cloudkeys_amazonsecrets_get($res, 126 , $versionindex);

Default Value

''

Remarks

The creation date of the secret version.

This property reflects the creation date of the secret version, in seconds since the Unix epoch (including fractional seconds).

The $versionindex parameter specifies the index of the item in the array. The size of the array is controlled by the VersionCount property.

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

Data Type

String

VersionLastAccessDate Property (CloudKeys_AmazonSecrets Class)

The last access date of the secret version.

Object Oriented Interface

public function getVersionLastAccessDate($versionindex);

Procedural Interface

cloudkeys_amazonsecrets_get($res, 127 , $versionindex);

Default Value

''

Remarks

The last access date of the secret version.

This property reflects the last access date of the secret version, in seconds since the Unix epoch.

Note that this property offers date-level resolution, time is not included.

The $versionindex parameter specifies the index of the item in the array. The size of the array is controlled by the VersionCount property.

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

Data Type

String

VersionSecretARN Property (CloudKeys_AmazonSecrets Class)

The Amazon resource name (ARN) of the secret this is a version of.

Object Oriented Interface

public function getVersionSecretARN($versionindex);

Procedural Interface

cloudkeys_amazonsecrets_get($res, 128 , $versionindex);

Default Value

''

Remarks

The Amazon resource name (ARN) of the secret this is a version of.

This property reflects the Amazon resource name (ARN) of the secret that this is a version of.

The $versionindex parameter specifies the index of the item in the array. The size of the array is controlled by the VersionCount property.

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

Data Type

String

VersionSecretName Property (CloudKeys_AmazonSecrets Class)

The name of the secret that this is a version of.

Object Oriented Interface

public function getVersionSecretName($versionindex);

Procedural Interface

cloudkeys_amazonsecrets_get($res, 129 , $versionindex);

Default Value

''

Remarks

The name of the secret that this is a version of.

This property reflects the name of the secret that this is a version of.

The $versionindex parameter specifies the index of the item in the array. The size of the array is controlled by the VersionCount property.

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

Data Type

String

VersionStagingLabels Property (CloudKeys_AmazonSecrets Class)

The staging labels attached to the secret version.

Object Oriented Interface

public function getVersionStagingLabels($versionindex);

Procedural Interface

cloudkeys_amazonsecrets_get($res, 130 , $versionindex);

Default Value

''

Remarks

The staging labels attached to the secret version.

This property reflects a comma-separated list of staging labels attached to the secret version.

Each secret version can have up to 20 staging labels attached to it at once, and a particular staging label can only be attached to one secret version at any given time.

The $versionindex parameter specifies the index of the item in the array. The size of the array is controlled by the VersionCount property.

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

Data Type

String

VersionVersionId Property (CloudKeys_AmazonSecrets Class)

The Id of the secret version.

Object Oriented Interface

public function getVersionVersionId($versionindex);

Procedural Interface

cloudkeys_amazonsecrets_get($res, 131 , $versionindex);

Default Value

''

Remarks

The Id of the secret version.

This property reflects the Id of the secret version.

The $versionindex parameter specifies the index of the item in the array. The size of the array is controlled by the VersionCount property.

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

Data Type

String

AddQueryParam Method (CloudKeys_AmazonSecrets Class)

Adds a query parameter to the QueryParams properties.

Object Oriented Interface

public function doAddQueryParam($name, $value);

Procedural Interface

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

CancelDeletion Method (CloudKeys_AmazonSecrets Class)

Cancels the deletion of a secret.

Object Oriented Interface

public function doCancelDeletion($secretid);

Procedural Interface

cloudkeys_amazonsecrets_do_canceldeletion($res, $secretid);

Remarks

This method cancels the deletion of the secret specified by SecretId. Refer to the DeleteSecret method's documentation for more information.

The value passed for SecretId must the ARN or name of a secret in the current account and Region.

Config Method (CloudKeys_AmazonSecrets Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

CreateSecret Method (CloudKeys_AmazonSecrets Class)

Creates a new secret.

Object Oriented Interface

public function doCreateSecret($secretname, $description);

Procedural Interface

cloudkeys_amazonsecrets_do_createsecret($res, $secretname, $description);

Remarks

This method creates a new secret with the given SecretName. The secret data is taken from the specified LocalFile or the SecretData or SecretString property; it may be up to 65536 bytes in length. The Id of the initial secret version is returned.

The value passed for SecretName may be up to 512 characters long, and must consist solely of ASCII letters, digits, and the following characters: /_+=.@-.

The Description parameter is optional; it can be any string up to 2048 characters long.

If desired, the KMSKeyId configuration setting can be set before calling this method to specify the Amazon KMS CMK (customer master key) to use to encrypt the secret (by default, an AWS-managed one is used).

CreateVersion Method (CloudKeys_AmazonSecrets Class)

Creates a new secret version.

Object Oriented Interface

public function doCreateVersion($secretid, $staginglabels);

Procedural Interface

cloudkeys_amazonsecrets_do_createversion($res, $secretid, $staginglabels);

Remarks

This method creates a new version of the secret specified by SecretId. The secret data is taken from the specified LocalFile or the SecretData or SecretString property; it may be up to 65536 bytes in length. The Id of the newly-created secret version is returned.

The value passed for SecretId must the ARN or name of a secret in the current account and Region.

The value passed for StagingLabels must be a comma-separated list of staging labels to attach to the new version; up to 20 staging labels can be attached to a secret version. If empty string is passed, AWSCURRENT is assumed. The server may do the following things depending on which staging labels are specified:

• If any of the specified staging labels are currently attached to other versions of this secret, they are moved from those versions to the new one.
• If the AWSCURRENT staging label is attached to the new version, the server will automatically move the AWSPREVIOUS staging label to the version that AWSCURRENT was previously attached to.

DeleteSecret Method (CloudKeys_AmazonSecrets Class)

Deletes a secret and all of its versions.

Object Oriented Interface

public function doDeleteSecret($secretid, $daystowait);

Procedural Interface

cloudkeys_amazonsecrets_do_deletesecret($res, $secretid, $daystowait);

Remarks

This method deletes the secret specified by SecretId, and all of its versions, either immediately or after a waiting period depending on the value passed for DaysToWait.

The value passed for SecretId must the ARN or name of a secret in the current account and Region.

If 0 is passed for DaysToWait, the secret is deleted immediately. Otherwise, DaysToWait must be a value in the range 7 to 30 (inclusive), which will cause the secret to be scheduled for deletion. During the waiting period:

• The secret's data cannot be retrieved from any secret version.
• The deletion can be canceled by calling the CancelDeletion method.

DoEvents Method (CloudKeys_AmazonSecrets Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

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

GenRandomPassword Method (CloudKeys_AmazonSecrets Class)

Returns a server-generated random password that complies with the given criteria.

Object Oriented Interface

public function doGenRandomPassword($length, $lowercase, $uppercase, $numbers, $punctuation, $spaces, $excludechars, $requireeach);

Procedural Interface

cloudkeys_amazonsecrets_do_genrandompassword($res, $length, $lowercase, $uppercase, $numbers, $punctuation, $spaces, $excludechars, $requireeach);

Remarks

This method requests and returns a random password generated by the server based on a number of criteria.

The Length parameter specifies how long the password must be; it must be a value in the range 1 to 4096 (inclusive).

The Lowercase, Uppercase, Numbers, Punctuation, and Spaces parameters specify whether the server is allowed to include characters of each type. The Lowercase and Uppercase types cover ASCII characters only. For Punctuation, the applicable characters are: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~

The ExcludeChars parameters specifies a list of characters that must not be included in the password. For example, passing &" - would exclude ampersands, double quotes, spaces, and hyphens.

The RequireEach parameter specifies whether the server must include at least one of each allowed character type in the password.

GetSecret Method (CloudKeys_AmazonSecrets Class)

Retrieves a secret version's data.

Object Oriented Interface

public function doGetSecret($secretid, $versionid, $staginglabel);

Procedural Interface

cloudkeys_amazonsecrets_do_getsecret($res, $secretid, $versionid, $staginglabel);

Remarks

This method retrieves the secret data held by a version of the secret specified by SecretId. The exact version whose data should be retrieved is specified by either VersionId or StagingLabel (if both are specified, the latter is ignored). If neither are specified, the data from the secret version with the AWSCURRENT staging label is retrieved.

The value passed for SecretId must the ARN or name of a secret in the current account and Region.

The secret data is returned via the specified LocalFile or the SecretData or SecretString property.

GetSecretInfo Method (CloudKeys_AmazonSecrets Class)

Gets information about a secret.

Object Oriented Interface

public function doGetSecretInfo($secretid);

Procedural Interface

cloudkeys_amazonsecrets_do_getsecretinfo($res, $secretid);

Remarks

This method gets information about the secret specified by SecretId.

When the information is returned, the class clears the Secrets properties and repopulates it properties (however, not all properties are populated). The SecretList and VersionList events are also fired.

ListSecrets Method (CloudKeys_AmazonSecrets Class)

Lists secrets in the current account and region.

Object Oriented Interface

public function doListSecrets();

Procedural Interface

cloudkeys_amazonsecrets_do_listsecrets($res);

Remarks

This method lists the secrets in the current account and Region. Note that, by default, secrets that have been scheduled for deletion are not included in the results; the IncludeDeleted configuration setting can be used to control this behavior.

Calling this method will fire the SecretList event once for each secret, and will also populate the Secrets properties. If the AlwaysParseVersions configuration setting is enabled, each secret's basic version information will also be parsed and used to populate the Versions properties and fire the VersionList event.

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

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

ListVersions Method (CloudKeys_AmazonSecrets Class)

List the secret versions for the specified secret.

Object Oriented Interface

public function doListVersions($secretid);

Procedural Interface

cloudkeys_amazonsecrets_do_listversions($res, $secretid);

Remarks

This method lists the secret versions for the secret specified by SecretId. Note that by default, only non-deprecated versions are returned (i.e., those with at least one staging label attached to them); the IncludeDeprecated configuration setting can be used to control this behavior.

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

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

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

MoveStagingLabel Method (CloudKeys_AmazonSecrets Class)

Adds, removes, or moves a staging label.

Object Oriented Interface

public function doMoveStagingLabel($secretid, $staginglabel, $fromversionid, $toversionid);

Procedural Interface

cloudkeys_amazonsecrets_do_movestaginglabel($res, $secretid, $staginglabel, $fromversionid, $toversionid);

Remarks

This method adds, removes, or moves a staging label between versions of the secret specified by SecretId.

The value passed for SecretId must the ARN or name of a secret in the current account and Region.

The StagingLabel parameter specifies the staging label that should be added, removed, or moved. If the staging label is AWSCURRENT, it cannot be removed, only moved, and the server will automatically move the AWSPREVIOUS staging label to the secret version specified by FromVersionId.

The FromVersionId and ToVersionId parameters specify which version(s) to operate against. When adding a new staging label to a secret version, only ToVersionId must be specified. When removing a staging label from a version, only FromVersionId must be specified. When moving an existing staging label from one version to another, both FromVersionId and ToVersionId must be specified.

Reset Method (CloudKeys_AmazonSecrets Class)

Resets the class to its initial state.

Object Oriented Interface

public function doReset();

Procedural Interface

cloudkeys_amazonsecrets_do_reset($res);

Remarks

This method resets the class to its initial state.

SendCustomRequest Method (CloudKeys_AmazonSecrets Class)

Sends a custom request to the server.

Object Oriented Interface

public function doSendCustomRequest($action, $body);

Procedural Interface

cloudkeys_amazonsecrets_do_sendcustomrequest($res, $action, $body);

Remarks

This method can be used to send arbitrary requests to the server. The value passed for the Action parameter must be one of the actions described in the Amazon Secrets Manager documentation.

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

1. Builds a request URL, including query parameters, based on the following:
   • Region
   • QueryParams
2. Adds request headers from OtherHeaders.
3. Adds the specified request Body, if non-empty.
4. Signs the request.
5. Sends the request to the server.
6. Stores the response headers in the ParsedHeaders properties; and the response body in the specified LocalFile or SecretData.

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.

UpdateSecret Method (CloudKeys_AmazonSecrets Class)

Updates a secret's information.

Object Oriented Interface

public function doUpdateSecret($secretid, $description);

Procedural Interface

cloudkeys_amazonsecrets_do_updatesecret($res, $secretid, $description);

Remarks

This method updates the information of the secret specified by SecretId.

The value passed for SecretId must the ARN or name of a secret in the current account and Region.

The Description parameter specifies the secret's new description (which may be empty).

The KMSKeyId configuration setting can also be set before calling this method to change the AWS KMS key used to encrypt the secret. However, if the KMS key used to encrypt a secret is changed, it is important that the secret's data be updated at least once using CreateVersion. When a new version is created, the server decrypts the secret using the old KMS key and re-encrypts it using the new one. If the old KMS key is deleted or disabled before this occurs, the server will no longer be able to decrypt the secret, effectively causing its data to be lost.

EndTransfer Event (CloudKeys_AmazonSecrets Class)

This event fires when a document finishes transferring.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

cloudkeys_amazonsecrets_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_AmazonSecrets Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

cloudkeys_amazonsecrets_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_AmazonSecrets Class)

Fired every time a header line comes in.

Object Oriented Interface

public function fireHeader($param);

Procedural Interface

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

Log Event (CloudKeys_AmazonSecrets Class)

Fired once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

cloudkeys_amazonsecrets_register_callback($res, 4, 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"

SecretList Event (CloudKeys_AmazonSecrets Class)

Fires once for each secret when listing secrets.

Object Oriented Interface

public function fireSecretList($param);

Procedural Interface

cloudkeys_amazonsecrets_register_callback($res, 5, array($this, 'fireSecretList'));

Parameter List

 'arn'
 'name'
 'description'
 'creationdate'
 'deletiondate'
 'lastaccessdate'
 'lastchangedate'

Remarks

This event fires once for each secret returned when ListSecrets or GetSecretInfo is called.

ARN reflects the Amazon resource name of the secret.

Name reflects the name of the secret.

Description reflects the secret's description.

CreationDate reflects the secret's creation date, in seconds since the Unix epoch (including fractional seconds).

DeletionDate reflects the secret's scheduled deletion date, if applicable, in seconds since the Unix epoch (including fractional seconds).

LastAccessDate reflects the secret's last access date, in seconds since the Unix epoch. It provides date-level resolution only, the time is not included.

LastChangeDate reflects the secret's last change date, in seconds since the Unix epoch (including fractional seconds).

SSLServerAuthentication Event (CloudKeys_AmazonSecrets Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

cloudkeys_amazonsecrets_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_AmazonSecrets Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

cloudkeys_amazonsecrets_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_AmazonSecrets Class)

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

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

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

Transfer Event (CloudKeys_AmazonSecrets Class)

Fired while a document transfers (delivers document).

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

cloudkeys_amazonsecrets_register_callback($res, 9, 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.

VersionList Event (CloudKeys_AmazonSecrets Class)

Fires once for each secret version when listing secret versions.

Object Oriented Interface

public function fireVersionList($param);

Procedural Interface

cloudkeys_amazonsecrets_register_callback($res, 10, array($this, 'fireVersionList'));

Parameter List

 'secretarn'
 'secretname'
 'versionid'
 'staginglabels'
 'creationdate'
 'lastaccessdate'

Remarks

This event fires once for each secret version returned when ListVersions, GetSecretInfo, or (if the AlwaysParseVersions configuration setting is enabled) ListSecrets is called. Note that CreationDate and LastAccessDate are only populated when ListVersions is called.

SecretARN reflects the Amazon resource name of the secret this is a version of.

SecretName reflects the name of the secret this is a version of.

VersionId reflects the Id of the secret version.

StagingLabels reflects a comma-separated list of staging labels attached to the secret version.

CreationDate reflects the secret version's creation date, in seconds since the Unix epoch (including fractional seconds).

LastAccessDate reflects the secret version's last access date, in seconds since the Unix epoch. It provides date-level resolution only, the time is not included.

Config Settings (AmazonSecrets Class)

AmazonSecrets 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"
  }
}

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (AmazonSecrets Class)

Common Errors

The class may also return one of the following error codes, which are inherited from other classes.

HTTP Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

SSL Errors

TCP/IP Errors