GoogleSecrets Class

Properties   Methods   Events   Config Settings   Errors  

The GoogleSecrets class offers a simple interface for Google Secret Manager.

Class Name

CloudKeys_GoogleSecrets

Procedural Interface

 cloudkeys_googlesecrets_open();
 cloudkeys_googlesecrets_close($res);
 cloudkeys_googlesecrets_register_callback($res, $id, $function);
 cloudkeys_googlesecrets_get_last_error($res);
 cloudkeys_googlesecrets_get_last_error_code($res);
 cloudkeys_googlesecrets_set($res, $id, $index, $value);
 cloudkeys_googlesecrets_get($res, $id, $index);
 cloudkeys_googlesecrets_do_addlabel($res, $name, $value);
 cloudkeys_googlesecrets_do_addqueryparam($res, $name, $value);
 cloudkeys_googlesecrets_do_authorize($res);
 cloudkeys_googlesecrets_do_config($res, $configurationstring);
 cloudkeys_googlesecrets_do_createsecret($res, $secretname);
 cloudkeys_googlesecrets_do_createversion($res, $secretname);
 cloudkeys_googlesecrets_do_deletesecret($res, $secretname);
 cloudkeys_googlesecrets_do_destroyversion($res, $secretname, $versionid);
 cloudkeys_googlesecrets_do_doevents($res);
 cloudkeys_googlesecrets_do_getsecret($res, $secretname, $versionid);
 cloudkeys_googlesecrets_do_getsecretinfo($res, $secretname);
 cloudkeys_googlesecrets_do_getversioninfo($res, $secretname, $versionid);
 cloudkeys_googlesecrets_do_listsecrets($res);
 cloudkeys_googlesecrets_do_listversions($res, $secretname);
 cloudkeys_googlesecrets_do_reset($res);
 cloudkeys_googlesecrets_do_sendcustomrequest($res, $httpmethod, $secretname, $versionid, $action, $body);
 cloudkeys_googlesecrets_do_setversionenabled($res, $secretname, $versionid, $enabled);
 cloudkeys_googlesecrets_do_updatesecretlabels($res, $secretname);

Remarks

The GoogleSecrets class provides an easy-to-use interface for the Google Cloud Secret Manager service. Google Secret Manager allows you to securely store secrets (e.g., passwords, symmetric keys, etc.) in the cloud so that they aren't persisted locally. This class helps you to create, manage, and access these secrets.

To begin, register for a Google Cloud account. Set the GoogleProjectId property to your full Google Cloud project Id.

This class requires authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth* properties to set the appropriate fields for the chosen OAuthClientProfile and OAuthGrantType.

The class has the following defaults:

Application Profile

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

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

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

Authorization Code

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

Example: GoogleSecrets googlesecrets = new GoogleSecrets(); googlesecrets.OAuth.ClientProfile = OAuthClientProfiles.cocpApplication; googlesecrets.OAuth.GrantType = OAuthGrantTypes.cogtAuthorizationCode; googlesecrets.OAuth.ClientId = CLIENT_ID; googlesecrets.OAuth.ClientSecret = CLIENT_SECRET; googlesecrets.Authorize();

Implicit

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

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

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

Web Profile

External OAuth Support

Bearer ACCESS_TOKEN_VALUE

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

For Example: Oauth oauth = new Oauth(); oauth.ClientId = "CLIENT_ID"; oauth.ClientSecret = "CLIENT_SECRET"; oauth.AuthorizationScope = "https://www.googleapis.com/auth/cloud-platform"; oauth.ServerAuthURL = "https://accounts.google.com/o/oauth2/auth"; oauth.ServerTokenURL = "https://accounts.google.com/o/oauth2/token"; oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode; googlesecrets.Authorization = oauth.GetAuthorization(); Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.

Using the Class

In Google Secret Manager, a secret is a container for one or more secret versions, which is where secret data is actually stored. The CreateSecret method will create a new secret and then add an initial secret version to it with the specified secret data. To change a secret's data, simply create a new version of it using the CreateVersion method. Each version of the secret receives a sequentially-assigned version Id, and the first version's Id is always 1.

To retrieve a secret's data, call the GetSecret method, and specify the specific version whose data should be retrieved (if no version is specified, the latest version's data is retrieved).

Secret versions that will no longer be used can have their data destroyed using the DestroyVersion method; the version itself will still exist, but its data will not. The DeleteSecret method can be used to completely delete a secret and all of its versions. // Create a secret. googlesecrets.SecretData = "Test123"; googlesecrets.CreateSecret("MySecret"); // Create a new version of the secret. googlesecrets.SecretData = "Cats456"; googlesecrets.CreateVersion("MySecret"); // Download the latest secret version's data to a local file. googlesecrets.LocalFile = "C:\temp\secret.txt"; googlesecrets.GetSecret("MySecret", ""); // Download a previous version's data to a local file. googlesecrets.LocalFile = "C:\temp\oldsecret.txt"; googlesecrets.GetSecret("MySecret", "1"); // Destroy an old secret version's data. googlesecrets.DestroyVersion("MySecret", "1"); // Completely delete a secret, and all of its versions. googlesecrets.DeleteSecret("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 { googlesecrets.ListSecrets(); } while (!string.IsNullOrEmpty(googlesecrets.SecretMarker)); // A similar thing applies to secret versions as well. do { googlesecrets.ListVersions("MySecret"); } while (!string.IsNullOrEmpty(googlesecrets.VersionMarker));

The class also supports other functionality, including:

• Enabling and disabling secret versions with SetVersionEnabled
• Retrieval of information for a single secret or secret version with GetSecretInfo and GetVersionInfo.
• Label support using AddLabel, UpdateSecretLabels, and the Label* properties.
• And more!

Property List

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

Method List

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

Event List

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

Config Settings

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

Authorization Property (CloudKeys_GoogleSecrets Class)

OAuth 2.0 Authorization Token.

Object Oriented Interface

public function getAuthorization();


public function setAuthorization($value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 1 );


cloudkeys_googlesecrets_set($res, 1, $value );

Default Value

''

Remarks

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

Bearer ACCESS_TOKEN

Data Type

String

FirewallAutoDetect Property (CloudKeys_GoogleSecrets Class)

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

Object Oriented Interface

public function getFirewallAutoDetect();


public function setFirewallAutoDetect($value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 2 );


cloudkeys_googlesecrets_set($res, 2, $value );

Default Value

false

Remarks

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

Data Type

Boolean

FirewallType Property (CloudKeys_GoogleSecrets Class)

This property determines the type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();


public function setFirewallType($value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 3 );


cloudkeys_googlesecrets_set($res, 3, $value );

Default Value

0

Remarks

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

Data Type

Integer

FirewallHost Property (CloudKeys_GoogleSecrets Class)

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

Object Oriented Interface

public function getFirewallHost();


public function setFirewallHost($value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 4 );


cloudkeys_googlesecrets_set($res, 4, $value );

Default Value

''

Remarks

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

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

Data Type

String

FirewallPassword Property (CloudKeys_GoogleSecrets Class)

This property contains 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_googlesecrets_get($res, 5 );


cloudkeys_googlesecrets_set($res, 5, $value );

Default Value

''

Remarks

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

Data Type

String

FirewallPort Property (CloudKeys_GoogleSecrets Class)

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

Object Oriented Interface

public function getFirewallPort();


public function setFirewallPort($value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 6 );


cloudkeys_googlesecrets_set($res, 6, $value );

Default Value

0

Remarks

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

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

Data Type

Integer

FirewallUser Property (CloudKeys_GoogleSecrets Class)

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

Object Oriented Interface

public function getFirewallUser();


public function setFirewallUser($value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 7 );


cloudkeys_googlesecrets_set($res, 7, $value );

Default Value

''

Remarks

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

Data Type

String

GoogleProjectId Property (CloudKeys_GoogleSecrets Class)

The Id of the Google Cloud project to make requests against.

Object Oriented Interface

public function getGoogleProjectId();


public function setGoogleProjectId($value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 8 );


cloudkeys_googlesecrets_set($res, 8, $value );

Default Value

''

Remarks

This property specifies the Id of the Google Cloud project that the class should make requests against; it must be set before attempting any operations.

Note that the full Google Cloud project Id must be specified, not just the project number.

This property is not available at design time.

Data Type

String

Idle Property (CloudKeys_GoogleSecrets Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

cloudkeys_googlesecrets_get($res, 9 );

Default Value

true

Remarks

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

This property is read-only.

Data Type

Boolean

LabelCount Property (CloudKeys_GoogleSecrets Class)

The number of records in the Label arrays.

Object Oriented Interface

public function getLabelCount();


public function setLabelCount($value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 10 );


cloudkeys_googlesecrets_set($res, 10, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• LabelName
• LabelValue

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

This property is not available at design time.

Data Type

Integer

LabelName Property (CloudKeys_GoogleSecrets Class)

The name of the label.

Object Oriented Interface

public function getLabelName($labelindex);


public function setLabelName($labelindex, $value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 11 , $labelindex);


cloudkeys_googlesecrets_set($res, 11, $value , $labelindex);

Default Value

''

Remarks

The name of the label.

This property specifies the name of the label.

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

This property is not available at design time.

Data Type

String

LabelValue Property (CloudKeys_GoogleSecrets Class)

The value of the label.

Object Oriented Interface

public function getLabelValue($labelindex);


public function setLabelValue($labelindex, $value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 12 , $labelindex);


cloudkeys_googlesecrets_set($res, 12, $value , $labelindex);

Default Value

''

Remarks

The value of the label.

This property specifies the value of the label.

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

This property is not available at design time.

Data Type

String

LocalFile Property (CloudKeys_GoogleSecrets 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_googlesecrets_get($res, 13 );


cloudkeys_googlesecrets_set($res, 13, $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, and as the destination file when calling GetSecret.

Data Type

String

LocalHost Property (CloudKeys_GoogleSecrets 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_googlesecrets_get($res, 14 );


cloudkeys_googlesecrets_set($res, 14, $value );

Default Value

''

Remarks

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

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

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

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

Data Type

String

OAuthAccessToken Property (CloudKeys_GoogleSecrets Class)

The access token returned by the authorization server.

Object Oriented Interface

public function getOAuthAccessToken();


public function setOAuthAccessToken($value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 15 );


cloudkeys_googlesecrets_set($res, 15, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

OAuthAuthorizationCode Property (CloudKeys_GoogleSecrets Class)

The authorization code that is exchanged for an access token.

Object Oriented Interface

public function getOAuthAuthorizationCode();


public function setOAuthAuthorizationCode($value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 16 );


cloudkeys_googlesecrets_set($res, 16, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

OAuthAuthorizationScope Property (CloudKeys_GoogleSecrets Class)

The scope request or response parameter used during authorization.

Object Oriented Interface

public function getOAuthAuthorizationScope();


public function setOAuthAuthorizationScope($value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 17 );


cloudkeys_googlesecrets_set($res, 17, $value );

Default Value

''

Remarks

The scope request or response parameter used during authorization.

This property is not available at design time.

Data Type

String

OAuthClientId Property (CloudKeys_GoogleSecrets Class)

The id of the client assigned when registering the application.

Object Oriented Interface

public function getOAuthClientId();


public function setOAuthClientId($value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 18 );


cloudkeys_googlesecrets_set($res, 18, $value );

Default Value

''

Remarks

The id of the client assigned when registering the application.

This property is not available at design time.

Data Type

String

OAuthClientProfile Property (CloudKeys_GoogleSecrets Class)

The type of client that is requesting authorization.

Object Oriented Interface

public function getOAuthClientProfile();


public function setOAuthClientProfile($value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 19 );


cloudkeys_googlesecrets_set($res, 19, $value );

Default Value

0

Remarks

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

This property is not available at design time.

Data Type

Integer

OAuthClientSecret Property (CloudKeys_GoogleSecrets Class)

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

Object Oriented Interface

public function getOAuthClientSecret();


public function setOAuthClientSecret($value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 20 );


cloudkeys_googlesecrets_set($res, 20, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

OAuthGrantType Property (CloudKeys_GoogleSecrets Class)

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

Object Oriented Interface

public function getOAuthGrantType();


public function setOAuthGrantType($value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 21 );


cloudkeys_googlesecrets_set($res, 21, $value );

Default Value

0

Remarks

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

This property is not available at design time.

Data Type

Integer

OAuthRefreshToken Property (CloudKeys_GoogleSecrets Class)

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

Object Oriented Interface

public function getOAuthRefreshToken();


public function setOAuthRefreshToken($value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 22 );


cloudkeys_googlesecrets_set($res, 22, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

OAuthReturnURL Property (CloudKeys_GoogleSecrets Class)

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

Object Oriented Interface

public function getOAuthReturnURL();


public function setOAuthReturnURL($value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 23 );


cloudkeys_googlesecrets_set($res, 23, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

OAuthServerAuthURL Property (CloudKeys_GoogleSecrets Class)

The URL of the authorization server.

Object Oriented Interface

public function getOAuthServerAuthURL();


public function setOAuthServerAuthURL($value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 24 );


cloudkeys_googlesecrets_set($res, 24, $value );

Default Value

''

Remarks

The URL of the authorization server.

This property is not available at design time.

Data Type

String

OAuthServerTokenURL Property (CloudKeys_GoogleSecrets Class)

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

Object Oriented Interface

public function getOAuthServerTokenURL();


public function setOAuthServerTokenURL($value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 25 );


cloudkeys_googlesecrets_set($res, 25, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

OAuthWebAuthURL Property (CloudKeys_GoogleSecrets Class)

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

Object Oriented Interface

public function getOAuthWebAuthURL();

Procedural Interface

cloudkeys_googlesecrets_get($res, 26 );

Default Value

''

Remarks

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

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

Data Type

String

OtherHeaders Property (CloudKeys_GoogleSecrets Class)

This property includes other headers as determined by the user (optional).

Object Oriented Interface

public function getOtherHeaders();


public function setOtherHeaders($value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 27 );


cloudkeys_googlesecrets_set($res, 27, $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_GoogleSecrets Class)

Whether the local file should be overwritten if necessary.

Object Oriented Interface

public function getOverwrite();


public function setOverwrite($value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 28 );


cloudkeys_googlesecrets_set($res, 28, $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_GoogleSecrets Class)

The number of records in the ParsedHeader arrays.

Object Oriented Interface

public function getParsedHeaderCount();

Procedural Interface

cloudkeys_googlesecrets_get($res, 29 );

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_GoogleSecrets 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_googlesecrets_get($res, 30 , $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_GoogleSecrets Class)

This property contains the header contents.

Object Oriented Interface

public function getParsedHeaderValue($parsedheaderindex);

Procedural Interface

cloudkeys_googlesecrets_get($res, 31 , $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_GoogleSecrets Class)

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

Object Oriented Interface

public function getProxyAuthScheme();


public function setProxyAuthScheme($value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 32 );


cloudkeys_googlesecrets_set($res, 32, $value );

Default Value

0

Remarks

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

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

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

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

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

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

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

Data Type

Integer

ProxyAutoDetect Property (CloudKeys_GoogleSecrets Class)

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

Object Oriented Interface

public function getProxyAutoDetect();


public function setProxyAutoDetect($value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 33 );


cloudkeys_googlesecrets_set($res, 33, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ProxyPassword Property (CloudKeys_GoogleSecrets Class)

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

Object Oriented Interface

public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 34 );


cloudkeys_googlesecrets_set($res, 34, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

ProxyPort Property (CloudKeys_GoogleSecrets Class)

This property contains 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_googlesecrets_get($res, 35 );


cloudkeys_googlesecrets_set($res, 35, $value );

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (CloudKeys_GoogleSecrets 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_googlesecrets_get($res, 36 );


cloudkeys_googlesecrets_set($res, 36, $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_GoogleSecrets Class)

This property determines 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_googlesecrets_get($res, 37 );


cloudkeys_googlesecrets_set($res, 37, $value );

Default Value

0

Remarks

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

Data Type

Integer

ProxyUser Property (CloudKeys_GoogleSecrets Class)

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

Object Oriented Interface

public function getProxyUser();


public function setProxyUser($value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 38 );


cloudkeys_googlesecrets_set($res, 38, $value );

Default Value

''

Remarks

This property contains 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_GoogleSecrets Class)

The number of records in the QueryParam arrays.

Object Oriented Interface

public function getQueryParamCount();


public function setQueryParamCount($value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 39 );


cloudkeys_googlesecrets_set($res, 39, $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_GoogleSecrets Class)

The name of the query parameter.

Object Oriented Interface

public function getQueryParamName($queryparamindex);


public function setQueryParamName($queryparamindex, $value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 40 , $queryparamindex);


cloudkeys_googlesecrets_set($res, 40, $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_GoogleSecrets Class)

The value of the query parameter.

Object Oriented Interface

public function getQueryParamValue($queryparamindex);


public function setQueryParamValue($queryparamindex, $value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 41 , $queryparamindex);


cloudkeys_googlesecrets_set($res, 41, $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

SecretData Property (CloudKeys_GoogleSecrets Class)

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

Object Oriented Interface

public function getSecretData();


public function setSecretData($value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 42 );


cloudkeys_googlesecrets_set($res, 42, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SecretMarker Property (CloudKeys_GoogleSecrets Class)

A marker indicating what page of secrets to return next.

Object Oriented Interface

public function getSecretMarker();


public function setSecretMarker($value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 43 );


cloudkeys_googlesecrets_set($res, 43, $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_GoogleSecrets Class)

The number of records in the Secret arrays.

Object Oriented Interface

public function getSecretCount();

Procedural Interface

cloudkeys_googlesecrets_get($res, 44 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SecretCreationDate
• SecretDestructionDate
• SecretName
• SecretState
• SecretVersionId

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

SecretCreationDate Property (CloudKeys_GoogleSecrets Class)

The secret's creation date.

Object Oriented Interface

public function getSecretCreationDate($secretindex);

Procedural Interface

cloudkeys_googlesecrets_get($res, 45 , $secretindex);

Default Value

''

Remarks

The secret's creation date.

This property reflects the creation date of the secret or secret version, formatted as an RFC 3339 UTC timestamp.

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

SecretDestructionDate Property (CloudKeys_GoogleSecrets Class)

The secret version's destruction date.

Object Oriented Interface

public function getSecretDestructionDate($secretindex);

Procedural Interface

cloudkeys_googlesecrets_get($res, 46 , $secretindex);

Default Value

''

Remarks

The secret version's destruction date.

This property reflects the destruction date of the secret version, formatted as an RFC 3339 UTC timestamp, or empty string if the secret version has not been destroyed.

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

The name of the secret.

Object Oriented Interface

public function getSecretName($secretindex);

Procedural Interface

cloudkeys_googlesecrets_get($res, 47 , $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

SecretState Property (CloudKeys_GoogleSecrets Class)

The state of the secret version.

Object Oriented Interface

public function getSecretState($secretindex);

Procedural Interface

cloudkeys_googlesecrets_get($res, 48 , $secretindex);

Default Value

''

Remarks

The state of the secret version.

This property reflects the state of the secret version, possible values are:

• ENABLED: The secret version is enabled and accessible.
• DISABLED: The secret version is disabled, and cannot be accessed.
• DESTROYED: The data held by the secret version has been permanently destroyed.

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

SecretVersionId Property (CloudKeys_GoogleSecrets Class)

The Id of the secret version.

Object Oriented Interface

public function getSecretVersionId($secretindex);

Procedural Interface

cloudkeys_googlesecrets_get($res, 49 , $secretindex);

Default Value

''

Remarks

The Id of the secret version.

This property reflects the Id of the secret version.

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

SSLAcceptServerCertEncoded Property (CloudKeys_GoogleSecrets Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 51 );


cloudkeys_googlesecrets_set($res, 51, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (CloudKeys_GoogleSecrets Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 79 );


cloudkeys_googlesecrets_set($res, 79, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (CloudKeys_GoogleSecrets Class)

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

Object Oriented Interface

public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 95 );


cloudkeys_googlesecrets_set($res, 95, $value );

Default Value

'MY'

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLCertStorePassword Property (CloudKeys_GoogleSecrets 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_googlesecrets_get($res, 96 );


cloudkeys_googlesecrets_set($res, 96, $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_GoogleSecrets Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 97 );


cloudkeys_googlesecrets_set($res, 97, $value );

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (CloudKeys_GoogleSecrets Class)

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

Object Oriented Interface

public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 98 );


cloudkeys_googlesecrets_set($res, 98, $value );

Default Value

''

Remarks

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

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

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

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

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

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

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

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

Data Type

String

SSLProvider Property (CloudKeys_GoogleSecrets Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 106 );


cloudkeys_googlesecrets_set($res, 106, $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:

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

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

Data Type

Integer

SSLServerCertEncoded Property (CloudKeys_GoogleSecrets Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

cloudkeys_googlesecrets_get($res, 108 );

Default Value

''

Remarks

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

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

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

Data Type

Binary String

Timeout Property (CloudKeys_GoogleSecrets Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

cloudkeys_googlesecrets_get($res, 135 );


cloudkeys_googlesecrets_set($res, 135, $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.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

VersionMarker Property (CloudKeys_GoogleSecrets 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_googlesecrets_get($res, 136 );


cloudkeys_googlesecrets_set($res, 136, $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

AddLabel Method (CloudKeys_GoogleSecrets Class)

Adds an item to the Labels properties.

Object Oriented Interface

public function doAddLabel($name, $value);

Procedural Interface

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

Remarks

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

A resource may have up to 64 labels. Label names and values must consist solely of lowercase letters, numbers, underscores, and hyphens; and may be up to 63 characters in length. Label names must also be unique and begin with a lowercase letter.

AddQueryParam Method (CloudKeys_GoogleSecrets Class)

Adds a query parameter to the QueryParams properties.

Object Oriented Interface

public function doAddQueryParam($name, $value);

Procedural Interface

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

Remarks

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

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

Authorize Method (CloudKeys_GoogleSecrets Class)

Get the authorization string required to access the protected resource.

Object Oriented Interface

public function doAuthorize();

Procedural Interface

cloudkeys_googlesecrets_do_authorize($res);

Remarks

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

For more information, see the introduction section.

Config Method (CloudKeys_GoogleSecrets Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

cloudkeys_googlesecrets_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_GoogleSecrets Class)

Creates a new secret.

Object Oriented Interface

public function doCreateSecret($secretname);

Procedural Interface

cloudkeys_googlesecrets_do_createsecret($res, $secretname);

Remarks

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

The value passed for SecretName must consist solely of alphanumeric characters, hyphens (-), and underscores (_); and may be up to 255 characters in length.

If there are any items in the Label* properties, they will be applied to the newly-created secret. Secrets may have up to 64 labels.

Note that this method makes two requests: the first one creates the empty secret itself (which is just a container for secret versions), and the second one creates an initial secret version with the actual secret data (as if CreateVersion had been called). The Id of the initial secret version is always 1.

CreateVersion Method (CloudKeys_GoogleSecrets Class)

Creates a new secret version.

Object Oriented Interface

public function doCreateVersion($secretname);

Procedural Interface

cloudkeys_googlesecrets_do_createversion($res, $secretname);

Remarks

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

DeleteSecret Method (CloudKeys_GoogleSecrets Class)

Deletes a secret.

Object Oriented Interface

public function doDeleteSecret($secretname);

Procedural Interface

cloudkeys_googlesecrets_do_deletesecret($res, $secretname);

Remarks

This method permanently deletes a secret and all of its versions.

To make individual versions inaccessible (either temporarily or permanently), use the SetVersionEnabled or DestroyVersion method instead.

DestroyVersion Method (CloudKeys_GoogleSecrets Class)

Destroys a secret version's data.

Object Oriented Interface

public function doDestroyVersion($secretname, $versionid);

Procedural Interface

cloudkeys_googlesecrets_do_destroyversion($res, $secretname, $versionid);

Remarks

This method permanently destroys the secret data held by the secret version specified by SecretName and VersionId. The secret version itself remains in existence, but its SecretState changes to DESTROYED and attempting to call GetSecret on it will result in an error.

To make a secret version's data temporarily inaccessible, use the SetVersionEnabled method instead.

DoEvents Method (CloudKeys_GoogleSecrets Class)

Processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

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

GetSecret Method (CloudKeys_GoogleSecrets Class)

Retrieves a secret version's data.

Object Oriented Interface

public function doGetSecret($secretname, $versionid);

Procedural Interface

cloudkeys_googlesecrets_do_getsecret($res, $secretname, $versionid);

Remarks

This method retrieves the secret data held by the secret version specified by SecretName and VersionId. If empty string is passed for VersionId, the latest secret version's data will be retrieved.

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

Note that a secret version's data can only be retrieved if it is in the ENABLED SecretState.

GetSecretInfo Method (CloudKeys_GoogleSecrets Class)

Gets information about a secret.

Object Oriented Interface

public function doGetSecretInfo($secretname);

Procedural Interface

cloudkeys_googlesecrets_do_getsecretinfo($res, $secretname);

Remarks

This method gets information about the secret specified by SecretName.

When the information is returned, the class clears the Secret* properties and repopulates them with a single item that contains the secret's information, and also repopulates the Label* properties. The SecretList and LabelList events are also fired.

GetVersionInfo Method (CloudKeys_GoogleSecrets Class)

Gets information about a secret version.

Object Oriented Interface

public function doGetVersionInfo($secretname, $versionid);

Procedural Interface

cloudkeys_googlesecrets_do_getversioninfo($res, $secretname, $versionid);

Remarks

This method gets information about the secret version specified by SecretName and VersionId. If empty string is passed for VersionId, the latest secret version's data will be retrieved.

When the information is returned, the class clears the Secret* properties and repopulates them with a single item that contains the secret version's information. The SecretList event is also fired.

ListSecrets Method (CloudKeys_GoogleSecrets Class)

Lists the secrets in the project.

Object Oriented Interface

public function doListSecrets();

Procedural Interface

cloudkeys_googlesecrets_do_listsecrets($res);

Remarks

This method lists the secrets in the Google Cloud project selected by GoogleProjectId.

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

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

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

ListVersions Method (CloudKeys_GoogleSecrets Class)

Lists the secret versions for the specified secret.

Object Oriented Interface

public function doListVersions($secretname);

Procedural Interface

cloudkeys_googlesecrets_do_listversions($res, $secretname);

Remarks

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

Calling this method will fire the SecretList event once for each secret version, and will also populate the Secret* 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 Secret* properties.

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

Reset Method (CloudKeys_GoogleSecrets Class)

Resets the class to its initial state.

Object Oriented Interface

public function doReset();

Procedural Interface

cloudkeys_googlesecrets_do_reset($res);

Remarks

This method resets the class to its initial state.

SendCustomRequest Method (CloudKeys_GoogleSecrets Class)

Sends a custom request to the server.

Object Oriented Interface

public function doSendCustomRequest($httpmethod, $secretname, $versionid, $action, $body);

Procedural Interface

cloudkeys_googlesecrets_do_sendcustomrequest($res, $httpmethod, $secretname, $versionid, $action, $body);

Remarks

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

Valid values for HttpMethod are:

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

SecretName, VersionId, Action, and Body are optional. If SecretName is empty, VersionId will be ignored.

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

1. Builds a request URL, including query parameters, like https://secretmanager.googleapis.com/v1/projects/{GoogleProjectId}[/secrets/{SecretName}[/versions/{VersionId}]][{Action}] using:
   • The GoogleProjectId property.
   • The SecretName, VersionId, and Action parameters.
   • All query parameters from QueryParam*.
2. Adds an Authorization header with the value specified by Authorization.
3. Adds any request headers from OtherHeaders.
4. Adds the specified request Body, if non-empty.
5. Sends the request to the server.
6. Stores the response headers in the ParsedHeader* 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.

SetVersionEnabled Method (CloudKeys_GoogleSecrets Class)

Enables or disables a secret version.

Object Oriented Interface

public function doSetVersionEnabled($secretname, $versionid, $enabled);

Procedural Interface

cloudkeys_googlesecrets_do_setversionenabled($res, $secretname, $versionid, $enabled);

Remarks

This method enables or disables the secret version specified by SecretName and VersionId.

UpdateSecretLabels Method (CloudKeys_GoogleSecrets Class)

Updates a secret's labels.

Object Oriented Interface

public function doUpdateSecretLabels($secretname);

Procedural Interface

cloudkeys_googlesecrets_do_updatesecretlabels($res, $secretname);

Remarks

This method updates the labels of the secret specified by SecretName, replacing any which currently exist with those in the Label* properties (which can be empty).

EndTransfer Event (CloudKeys_GoogleSecrets Class)

This event fires when a document finishes transferring.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

cloudkeys_googlesecrets_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_GoogleSecrets Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

cloudkeys_googlesecrets_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_GoogleSecrets Class)

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

Object Oriented Interface

public function fireHeader($param);

Procedural Interface

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

LabelList Event (CloudKeys_GoogleSecrets Class)

Fires once for each label returned when a secret's information is retrieved.

Object Oriented Interface

public function fireLabelList($param);

Procedural Interface

cloudkeys_googlesecrets_register_callback($res, 4, array($this, 'fireLabelList'));

Parameter List

 'secretname'
 'name'
 'value'

Remarks

This event fires once for each label returned when GetSecretInfo is called.

SecretName reflects the name of the key.

Name reflects the name of the label.

Value reflects the value of the label.

Log Event (CloudKeys_GoogleSecrets Class)

This event fires once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

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

Parameter List

 'loglevel'
 'message'
 'logtype'

Remarks

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

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

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

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

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

Message is the log entry.

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

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

SecretList Event (CloudKeys_GoogleSecrets Class)

Fires once for each secret when listing secrets.

Object Oriented Interface

public function fireSecretList($param);

Procedural Interface

cloudkeys_googlesecrets_register_callback($res, 6, array($this, 'fireSecretList'));

Parameter List

 'name'
 'versionid'
 'state'
 'creationdate'
 'destructiondate'

Remarks

This event fires once for each secret or secret version returned when GetSecretInfo, ListSecrets, GetVersionInfo, or ListVersions is called. Note that for secrets, only the Name and CreationDate parameters will be populated.

Name reflects the name of the secret.

VersionId reflects the Id of the secret version.

State reflects the state of the secret version.

CreationDate reflects the creation date of the secret or secret version, formatted as an RFC 3339 UTC timestamp.

DestructionDate reflects the destruction date of the secret version, formatted as an RFC 3339 UTC timestamp, or empty if the secret version has not been destroyed.

SSLServerAuthentication Event (CloudKeys_GoogleSecrets Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

cloudkeys_googlesecrets_register_callback($res, 7, 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_GoogleSecrets Class)

Shows the progress of the secure connection.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

cloudkeys_googlesecrets_register_callback($res, 8, 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_GoogleSecrets Class)

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

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

cloudkeys_googlesecrets_register_callback($res, 9, 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_GoogleSecrets Class)

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

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

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

Parameter List

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

Remarks

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

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

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

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

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

Config Settings (GoogleSecrets Class)

GoogleSecrets 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
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

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

Socket Config Settings

Base Config Settings

Trappable Errors (GoogleSecrets 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