GoogleKMS Class
Properties Methods Events Config Settings Errors
The GoogleKMS class provides an easy-to-use interface for the Google Cloud Key Management Service.
Syntax
GoogleKMS
Remarks
The GoogleKMS class makes it easy to work with the Google Cloud Key Management Service (KMS) in a secure manner using TLS. Google KMS allows you to create and manage key rings that contain symmetric and asymmetric keys. Each key has one or more versions which can be used for cryptographic operations.
To begin, register for a Google Cloud account. Set the GoogleProjectId property to your full Google Cloud project Id, and set the Location property to the Google Cloud location you'd like to make requests against (by default, the us multi-regional location is used). Note that each location's resources are completely separate from the others'.
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:
Authorization Server URL | "https://accounts.google.com/o/oauth2/auth" |
Token Server URL | "https://accounts.google.com/o/oauth2/token" |
Scopes | "https://www.googleapis.com/auth/cloud-platform" |
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:
GoogleKMS googlekms = new GoogleKMS();
googlekms.OAuth.ClientProfile = OAuthClientProfiles.cocpApplication;
googlekms.OAuth.GrantType = OAuthGrantTypes.cogtAuthorizationCode;
googlekms.OAuth.ClientId = CLIENT_ID;
googlekms.OAuth.ClientSecret = CLIENT_SECRET;
googlekms.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
This profile is similar to setting the class to the Application profile and Authorization Code grant type except the class will not launch the browser. It is typically used in situations where there is a back-end that is supporting some front end. This profile expects that OAuthClientId, OAuthClientSecret, OAuthServerAuthURL, OAuthServerTokenURL, and the OAuthReturnURL properties to be set. Before calling the Authorize method, the OAuthWebAuthURL property should be queried to get a URL. This URL should be used to redirect the user to the authorization page for the service provider. The redirect_uri parameter of this URL is mapped to the OAuthReturnURL property. The OAuthReturnURL property should be set to some web server that will parse the authorization code out of the query parameter from the redirect. Once the authorization code is parsed, it should be passed back to the server where it is then set to the OAuthAuthorizationCode property. Once that is set, the Authorize method can be called to exchange the authorization code for an access token and refresh token if provided. The class will then cache these values like normal and use them to make requests. If the OAuthRefreshToken field is set, or a refresh token is cached, then the Authorize method can immediately be called to make a request to the token server to get a new access token.
External OAuth Support
For complex profiles or grant types, or for more control of the flow, it is possible to 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_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;
googlekms.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
First, select which key ring the class should interact with using the KeyRing property. If the selected key ring does not yet exist, use the CreateKeyRing method to create it. Note that key rings cannot be deleted later, and therefore key ring names can never be reused within a given Location (unless you create a new Google Cloud project).
Once a key ring has been selected (and created, if necessary), keys can be created in it using the CreateKey method. A key consists of one or more key versions (which themselves can be thought of as distinct resources), each of which has its own cryptographic material. Symmetric keys have a primary version which is used when encrypting data. Asymmetric keys do not have a primary version; a specific version must always be targeted.
When a key is created, a single key version is automatically created for it as well (and for symmetric keys, this becomes the primary version). Additional key versions can be created using the CreateVersion method. Each key version receives a sequentially-assigned version Id, and the first version's Id is always 1. As will become apparent, most operations are performed with key versions, not keys.
googlekms.KeyRing = "MyKeyRing";
googlekms.CreateKeyRing();
// When a key is created, you specify its name, purpose, algorithm, and protection level.
// Refer to the CreateKey method's documentation for more information.
googlekms.CreateKey("MyKey", 1, "GOOGLE_SYMMETRIC_ENCRYPTION", false);
// When a new version is created, the algorithm and protection level are reused.
googlekms.CreateVersion("MyKey");
Like key rings, keys and key versions cannot be deleted. However, a key version can be disabled, or its cryptographic material can be destroyed, making it permanently unusable. To enable or disable a key version, use the SetVersionEnabled method; to destroy a key version's cryptographic material, use the DestroyVersion method. Note that the latter doesn't destroy the cryptographic material immediately; instead, it schedules it for destruction 24 hours from the time of the call. The CancelDestruction method can be called within this waiting period to cancel the destruction.
// Disable a key version to make it unusable until it is re-enabled.
googlekms.SetVersionEnabled("MyKey", "7", false);
// Destroy a key version's cryptographic material to make it permanently unusable.
googlekms.DestroyVersion("MyKey", "7");
// The destruction takes place after a 24 hour waiting period; it can be canceled during that period.
// If destruction is canceled, the key version is always placed into a disabled state.
googlekms.CancelDestruction("MyKey", "7");
To list key rings, keys, or key versions, use the ListKeyRings, ListKeys, or ListVersions method. If there are multiple pages of results when listing a resource, the appropriate marker property will be populated, and all pages of results can be accumulated by continuing to call the relevant listing method until the marker property is empty.
do {
googlekms.ListKeyRings();
} while (!string.IsNullOrEmpty(googlekms.KeyRingMarker));
foreach (GoogleKeyRing keyring in googlekms.KeyRings) {
Console.WriteLine(keyring.Name);
}
googlekms.KeyRing = "MyKeyRing";
do {
googlekms.ListKeys();
} while (!string.IsNullOrEmpty(googlekms.KeyMarker));
foreach (GoogleKey key in googlekms.Keys) {
Console.WriteLine(key.Name);
}
do {
googlekms.ListKeyVersions("MyKey");
} while (!string.IsNullOrEmpty(googlekms.VersionMarker));
foreach (GoogleKeyVersion version in googlekms.Versions) {
Console.WriteLine(version.Name + " " + version.VersionId);
}
Depending on a key's purpose, it can be used to perform different cryptographic operations. Keys whose purpose is encryption/decryption can be used in Encrypt and Decrypt operations. Keys whose purpose is sign/verify can be used in Sign and Verify operations. To perform a cryptographic operation, use InputData, InputFile, or SetInputStream to supply the input data that should be processed. All operations will output the result data to OutputData, OutputFile, or SetOutputStream (except Verify; refer to its documentation for more information).
Note that Google does not support server-side asymmetric encryption or asymmetric verification. The class performs these operations locally as a convenience to account for this.
// Create an asymmetric key whose purpose is encryption/decryption.
googlekms.CreateKey("MyAsymmEncKey", 3, "RSA_DECRYPT_OAEP_3072_SHA256", false);
// Encrypt the string "Test123" and write the encrypted data to an output file.
googlekms.InputData = "Test123";
googlekms.OutputFile = "C:/temp/enc.dat";
googlekms.Encrypt("MyAsymmEncKey", "1");
// ...Later, decrypt the data again.
googlekms.InputFile = "C:/temp/enc.dat";
googlekms.OutputFile = ""; // So that the data will be output to the OutputData property.
googlekms.Decrypt("MyAsymmEncKey", "1");
The class also supports a variety of other functionality, including:
- Retrieval of a single resource's information with GetKeyRingInfo, GetKeyInfo, or GetVersionInfo.
- Getting an asymmetric key's public key using GetPublicKey.
- Label support using AddLabel and the Label* properties.
- Updating key information with UpdateKey and SetPrimaryVersion.
- 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.
AdditionalData | Additional data to send when performing symmetric encryption or decryption. |
Authorization | OAuth 2.0 Authorization Token. |
FirewallAutoDetect | This property tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallType | This property determines the type of firewall to connect through. |
FirewallHost | This property contains the name or IP address of firewall (optional). |
FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
FirewallPort | This property contains the transmission control protocol (TCP) port for the firewall Host . |
FirewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
GoogleProjectId | The Id of the Google Cloud project to make requests against. |
Idle | The current status of the class. |
InputData | The data to process. |
InputFile | The file whose data should be processed. |
KeyMarker | A marker indicating what page of keys to return next. |
KeyRing | Selects a key ring for the class to interact with. |
KeyRingMarker | A marker indicating what page of key rings to return next. |
KeyRingCount | The number of records in the KeyRing arrays. |
KeyRingCreationDate | The key ring's creation date. |
KeyRingName | The name of the key ring. |
KeyCount | The number of records in the Key arrays. |
KeyCreationDate | The key's creation date. |
KeyName | The name of the key. |
KeyNextRotateDate | The key's next rotation date. |
KeyPrimaryVersion | The Id of the key's primary version. |
KeyPurpose | The key's purpose. |
KeyRotationPeriod | The key's rotation period. |
KeyTemplateAlgorithm | The algorithm to use when new versions of the key are created. |
KeyTemplateProtectionLevel | The protection level to use when new versions of the key are created. |
LabelCount | The number of records in the Label arrays. |
LabelName | The name of the label. |
LabelValue | The value of the label. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
Location | The Google Cloud location to make requests against. |
OAuthAccessToken | The access token returned by the authorization server. |
OAuthAuthorizationCode | The authorization code that is exchanged for an access token. |
OAuthAuthorizationScope | The scope request or response parameter used during authorization. |
OAuthClientId | The id of the client assigned when registering the application. |
OAuthClientProfile | The type of client that is requesting authorization. |
OAuthClientSecret | The secret value for the client assigned when registering the application. |
OAuthGrantType | The OAuth grant type used to acquire an OAuth access token. |
OAuthRefreshToken | Specifies the refresh token received from or sent to the authorization server. |
OAuthReturnURL | The URL where the user (browser) returns after authenticating. |
OAuthServerAuthURL | The URL of the authorization server. |
OAuthServerTokenURL | The URL of the token server used to obtain the access token. |
OAuthWebAuthURL | The URL to which the user should be re-directed for authorization. |
OtherHeaders | This property includes other headers as determined by the user (optional). |
OutputData | The output data. |
OutputFile | The file to which output data should be written. |
Overwrite | Whether the output file should be overwritten if necessary. |
ParsedHeaderCount | The number of records in the ParsedHeader arrays. |
ParsedHeaderField | This property contains the name of the HTTP header (this is the same case as it is delivered). |
ParsedHeaderValue | This property contains the header contents. |
ProxyAuthScheme | This property is used to tell the class which type of authorization to perform when connecting to the proxy. |
ProxyAutoDetect | This property tells the class whether or not to automatically detect and use proxy system settings, if available. |
ProxyPassword | This property contains a password if authentication is to be used for the proxy. |
ProxyPort | This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80). |
ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
ProxySSL | This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. |
ProxyUser | This property contains a user name, if authentication is to be used for the proxy. |
PublicKey | The public key of an asymmetric key pair. |
PublicKeyAlgorithm | The algorithm of an asymmetric key pair. |
QueryParamCount | The number of records in the QueryParam arrays. |
QueryParamName | The name of the query parameter. |
QueryParamValue | The value of the query parameter. |
SSLAcceptServerCertEncoded | This is the certificate (PEM/base64 encoded). |
SSLCertEncoded | This is the certificate (PEM/base64 encoded). |
SSLCertStore | This is the name of the certificate store for the client certificate. |
SSLCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLCertStoreType | This is the type of certificate store for this certificate. |
SSLCertSubject | This is the subject of the certificate used for client authentication. |
SSLProvider | This specifies the SSL/TLS implementation to use. |
SSLServerCertEncoded | This is the certificate (PEM/base64 encoded). |
Timeout | A timeout for the class. |
VersionMarker | A marker indicating what page of key versions to return next. |
VersionCount | The number of records in the Version arrays. |
VersionAlgorithm | The key version's algorithm. |
VersionCreationDate | The key version's creation date. |
VersionDestructionDate | The key version's destruction date. |
VersionGenerationDate | The generation date of the key version's cryptographic material. |
VersionName | The name of the key. |
VersionProtectionLevel | The key version's protection level. |
VersionState | The key version's state. |
VersionVersionId | The Id of the key version. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
AddLabel | Adds an item to the Labels properties. |
AddQueryParam | Adds a query parameter to the QueryParams properties. |
Authorize | Get the authorization string required to access the protected resource. |
CancelDestruction | Cancels the destruction of a key version's cryptographic material. |
Config | Sets or retrieves a configuration setting. |
CreateKey | Creates a new key. |
CreateKeyRing | Creates a new key ring. |
CreateVersion | Creates a new key version. |
Decrypt | Decrypts data using a key. |
DestroyVersion | Schedules the specified key version's cryptographic material for destruction. |
DoEvents | Processes events from the internal message queue. |
Encrypt | Encrypts data using a key. |
GetKeyInfo | Gets information about a key. |
GetKeyRingInfo | Gets information about a key ring. |
GetPublicKey | Retrieves the public key of an asymmetric key pair. |
GetVersionInfo | Gets information about a key version. |
ListKeyRings | Lists the key rings in the currently-selected location. |
ListKeys | Lists the keys in the currently-selected key ring. |
ListVersions | Lists the key versions for the specified key. |
Reset | Resets the class to its initial state. |
SendCustomRequest | Sends a custom request to the server. |
SetInputStream | Sets the stream whose data should be processed. |
SetOutputStream | Sets the stream to which output data should be written. |
SetPrimaryVersion | Sets the primary version of a symmetric key. |
SetVersionEnabled | Enables or disables a key version. |
Sign | Signs a message using a key. |
UpdateKey | Updates a key. |
Verify | Verifies a digital signature using a key. |
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.
EndTransfer | This event fires when a document finishes transferring. |
Error | Information about errors during data delivery. |
Header | This event is fired every time a header line comes in. |
KeyList | Fires once for each key when listing keys. |
KeyRingList | Fires once for each key ring when listing key rings. |
LabelList | Fires once for each label returned when a key's information is retrieved. |
Log | This event fires once for each log message. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Shows the progress of the secure connection. |
StartTransfer | This event fires when a document starts transferring (after the headers). |
Transfer | This event is fired while a document transfers (delivers document). |
VersionList | Fires once for each key version when listing key versions. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
AccumulatePages | Whether the class should accumulate subsequent pages of results when listing them. |
ForceSymmetricEncryption | Whether the Encrypt method should always perform symmetric encryption. |
MaxKeyRings | The maximum number of results to return when listing key rings. |
MaxKeys | The maximum number of results to return when listing keys. |
MaxVersions | The maximum number of results to return when listing key versions. |
MessageDigest | The message digest computed by the class during the last sign or verify operation, if any. |
NextRotateDate | The next rotation date to send when creating or updating a key. |
OAuthAccessTokenExpiration | The lifetime of the access token. |
OAuthAuthorizationTokenType | The type of access token returned. |
OAuthAutomaticRefresh | Whether or not to refresh an expired access token automatically. |
OAuthBrowserResponseTimeout | Specifies the amount of time to wait for a response from the browser. |
OAuthIncludeEmptyRedirectURI | Whether an empty redirect_uri parameter is included in requests. |
OAuthJWTPayload | The payload of the JWT access token if present. |
OAuthJWTXChildCount | The number of child elements of the current element. |
OauthJWTXChildName[i] | The name of the child element. |
OAuthJWTXChildXText[i] | The inner text of the child element. |
OAuthJWTXElement | The name of the current element. |
OauthJWTXParent | The parent of the current element. |
OAuthJWTXPath | Provides a way to point to a specific element in the returned payload of a JWT based access token. |
OAuthJWTXSubTree | A snapshot of the current element in the document. |
OAuthJWTXText | The text of the current element. |
OAuthParamCount | Specifies the number of additional parameters variables to include in the request. |
OAuthParamName[i] | Specifies the parameter name at the specified index. |
OAuthParamValue[i] | Specifies the parameter value at the specified index. |
OAuthPasswordGrantUsername | Used in the Resource Owner Password grant type. |
OAuthPKCEChallengeEncoding | The PKCE code challenge method to use. |
OAuthPKCEVerifier | The PKCE verifier used to generate the challenge. |
OAuthReUseWebServer | Determines if the same server instance is used between requests. |
OAuthUsePKCE | Specifies if PKCE should be used. |
OAuthWebServerActive | Specifies and controls whether the embedded web server is active. |
OAuthWebServerCertStore | The certificate with private key to use when SSL is enabled. |
OAuthWebServerCertStorePassword | The certificate with private key to use when SSL is enabled. |
OAuthWebServerCertStoreType | The certificate with private key to use when SSL is enabled. |
OAuthWebServerCertSubject | The certificate with private key to use when SSL is enabled. |
OAuthWebServerFailedResponse | The custom response that will be displayed to the user if authentication failed. |
OAuthWebServerHost | The hostname used by the embedded web server displayed in the ReturnURL. |
OAuthWebServerPort | The local port on which the embedded web server listens. |
OAuthWebServerResponse | The custom response that will be displayed to the user. |
OAuthWebServerSSLEnabled | Whether the web server requires SSL connections. |
RawRequest | Returns the data that was sent to the server. |
RawResponse | Returns the data that was received from the server. |
RotationPeriod | The rotation period to send when creating or updating a key. |
XChildCount | The number of child elements of the current element. |
XChildName[i] | The name of the child element. |
XChildXText[i] | The inner text of the child element. |
XElement | The name of the current element. |
XParent | The parent of the current element. |
XPath | Provides a way to point to a specific element in the returned XML or JSON response. |
XSubTree | A snapshot of the current element in the document. |
XText | The text of the current element. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to True the URL will be encoded by the class. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to True the class will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the class. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
SentHeaders | The full set of headers as sent by the client. |
StatusCode | The status code of the last response from the server. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the class. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
UserAgent | Information about the user agent (browser). |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveRetryCount | The number of keep-alive packets to be sent before the remotehost is considered disconnected. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseFIPSCompliantAPI | Tells the class whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |
AdditionalData Property (GoogleKMS Class)
Additional data to send when performing symmetric encryption or decryption.
Syntax
ANSI (Cross Platform) int GetAdditionalData(char* &lpAdditionalData, int &lenAdditionalData);
int SetAdditionalData(const char* lpAdditionalData, int lenAdditionalData); Unicode (Windows) INT GetAdditionalData(LPSTR &lpAdditionalData, INT &lenAdditionalData);
INT SetAdditionalData(LPCSTR lpAdditionalData, INT lenAdditionalData);
int cloudkeys_googlekms_getadditionaldata(void* lpObj, char** lpAdditionalData, int* lenAdditionalData);
int cloudkeys_googlekms_setadditionaldata(void* lpObj, const char* lpAdditionalData, int lenAdditionalData);
QByteArray GetAdditionalData();
int SetAdditionalData(QByteArray qbaAdditionalData);
Default Value
""
Remarks
This property can be set before calling Encrypt or Decrypt with a symmetric key to have the server include the specified data, known as additional authenticated data, when performing the cryptographic operation. If such data is provided during encryption, it must also be provided in order to successfully decrypt the data. Refer to the Google Cloud KMS documentation for more information.
Up to 65536 bytes of data may be provided. Note that this property is ignored when asymmetric encryption or decryption is performed.
This property is not available at design time.
Data Type
Binary String
Authorization Property (GoogleKMS Class)
OAuth 2.0 Authorization Token.
Syntax
ANSI (Cross Platform) char* GetAuthorization();
int SetAuthorization(const char* lpszAuthorization); Unicode (Windows) LPWSTR GetAuthorization();
INT SetAuthorization(LPCWSTR lpszAuthorization);
char* cloudkeys_googlekms_getauthorization(void* lpObj);
int cloudkeys_googlekms_setauthorization(void* lpObj, const char* lpszAuthorization);
QString GetAuthorization();
int SetAuthorization(QString qsAuthorization);
Default Value
""
Remarks
This class supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth class or a separate process. Once complete you should have an authorization string which looks like:
Bearer ACCESS_TOKENAssign this value to the Authorization property before attempting any operations. Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.
Data Type
String
FirewallAutoDetect Property (GoogleKMS Class)
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
Syntax
ANSI (Cross Platform) int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect); Unicode (Windows) BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);
int cloudkeys_googlekms_getfirewallautodetect(void* lpObj);
int cloudkeys_googlekms_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);
bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);
Default Value
FALSE
Remarks
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
Data Type
Boolean
FirewallType Property (GoogleKMS Class)
This property determines the type of firewall to connect through.
Syntax
ANSI (Cross Platform) int GetFirewallType();
int SetFirewallType(int iFirewallType); Unicode (Windows) INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);
Possible Values
FW_NONE(0),
FW_TUNNEL(1),
FW_SOCKS4(2),
FW_SOCKS5(3),
FW_SOCKS4A(10)
int cloudkeys_googlekms_getfirewalltype(void* lpObj);
int cloudkeys_googlekms_setfirewalltype(void* lpObj, int iFirewallType);
int GetFirewallType();
int SetFirewallType(int iFirewallType);
Default Value
0
Remarks
This property determines the type of firewall to connect through. The applicable values are as follows:
fwNone (0) | No firewall (default setting). |
fwTunnel (1) | Connect through a tunneling proxy. FirewallPort is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Data Type
Integer
FirewallHost Property (GoogleKMS Class)
This property contains the name or IP address of firewall (optional).
Syntax
ANSI (Cross Platform) char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost); Unicode (Windows) LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);
char* cloudkeys_googlekms_getfirewallhost(void* lpObj);
int cloudkeys_googlekms_setfirewallhost(void* lpObj, const char* lpszFirewallHost);
QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);
Default Value
""
Remarks
This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.
If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.
Data Type
String
FirewallPassword Property (GoogleKMS Class)
This property contains a password if authentication is to be used when connecting through the firewall.
Syntax
ANSI (Cross Platform) char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword); Unicode (Windows) LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);
char* cloudkeys_googlekms_getfirewallpassword(void* lpObj);
int cloudkeys_googlekms_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);
QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);
Default Value
""
Remarks
This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
Data Type
String
FirewallPort Property (GoogleKMS Class)
This property contains the transmission control protocol (TCP) port for the firewall Host .
Syntax
ANSI (Cross Platform) int GetFirewallPort();
int SetFirewallPort(int iFirewallPort); Unicode (Windows) INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);
int cloudkeys_googlekms_getfirewallport(void* lpObj);
int cloudkeys_googlekms_setfirewallport(void* lpObj, int iFirewallPort);
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);
Default Value
0
Remarks
This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.
Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.
Data Type
Integer
FirewallUser Property (GoogleKMS Class)
This property contains a user name if authentication is to be used connecting through a firewall.
Syntax
ANSI (Cross Platform) char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser); Unicode (Windows) LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);
char* cloudkeys_googlekms_getfirewalluser(void* lpObj);
int cloudkeys_googlekms_setfirewalluser(void* lpObj, const char* lpszFirewallUser);
QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);
Default Value
""
Remarks
This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.
Data Type
String
GoogleProjectId Property (GoogleKMS Class)
The Id of the Google Cloud project to make requests against.
Syntax
ANSI (Cross Platform) char* GetGoogleProjectId();
int SetGoogleProjectId(const char* lpszGoogleProjectId); Unicode (Windows) LPWSTR GetGoogleProjectId();
INT SetGoogleProjectId(LPCWSTR lpszGoogleProjectId);
char* cloudkeys_googlekms_getgoogleprojectid(void* lpObj);
int cloudkeys_googlekms_setgoogleprojectid(void* lpObj, const char* lpszGoogleProjectId);
QString GetGoogleProjectId();
int SetGoogleProjectId(QString qsGoogleProjectId);
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 (GoogleKMS Class)
The current status of the class.
Syntax
ANSI (Cross Platform) int GetIdle(); Unicode (Windows) BOOL GetIdle();
int cloudkeys_googlekms_getidle(void* lpObj);
bool GetIdle();
Default Value
TRUE
Remarks
Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.
This property is read-only.
Data Type
Boolean
InputData Property (GoogleKMS Class)
The data to process.
Syntax
ANSI (Cross Platform) int GetInputData(char* &lpInputData, int &lenInputData);
int SetInputData(const char* lpInputData, int lenInputData); Unicode (Windows) INT GetInputData(LPSTR &lpInputData, INT &lenInputData);
INT SetInputData(LPCSTR lpInputData, INT lenInputData);
int cloudkeys_googlekms_getinputdata(void* lpObj, char** lpInputData, int* lenInputData);
int cloudkeys_googlekms_setinputdata(void* lpObj, const char* lpInputData, int lenInputData);
QByteArray GetInputData();
int SetInputData(QByteArray qbaInputData);
Default Value
""
Remarks
This property specifies the data that should be processed in a cryptographic operation.
Input Sources & Output Destinations
The class automatically determines the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- An input stream supplied via the SetInputStream method
- The InputFile property
- The InputData property
The first valid input source found is used. The order in which the output properties are considered is as follows:
- An output stream supplied via the SetOutputStream method
- The OutputFile property
- The OutputData property
This property is not available at design time.
Data Type
Binary String
InputFile Property (GoogleKMS Class)
The file whose data should be processed.
Syntax
ANSI (Cross Platform) char* GetInputFile();
wchar_t* GetInputFile_W(); // Windows only
int SetInputFile(const char* lpszInputFile);
int SetInputFile(const wchar_t* lpszInputFile); // Windows only Unicode (Windows) LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);
char* cloudkeys_googlekms_getinputfile(void* lpObj);
wchar_t* cloudkeys_googlekms_getinputfile_W(void* lpObj); // Windows only
int cloudkeys_googlekms_setinputfile(void* lpObj, const char* lpszInputFile);
int cloudkeys_googlekms_setinputfile(void* lpObj, const wchar_t* lpszInputFile); // Windows only
QString GetInputFile();
int SetInputFile(QString qsInputFile);
Default Value
""
Remarks
This property specifies the file whose data should be processed in a cryptographic operation. It accepts both absolute and relative file paths.
Setting this property to a non-empty value will discard any stream set using the SetInputStream method. Similarly, passing a non-null value to the aforementioned method will clear this property.
Input Sources & Output Destinations
The class automatically determines the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- An input stream supplied via the SetInputStream method
- The InputFile property
- The InputData property
The first valid input source found is used. The order in which the output properties are considered is as follows:
- An output stream supplied via the SetOutputStream method
- The OutputFile property
- The OutputData property
Data Type
String
KeyMarker Property (GoogleKMS Class)
A marker indicating what page of keys to return next.
Syntax
ANSI (Cross Platform) char* GetKeyMarker();
int SetKeyMarker(const char* lpszKeyMarker); Unicode (Windows) LPWSTR GetKeyMarker();
INT SetKeyMarker(LPCWSTR lpszKeyMarker);
char* cloudkeys_googlekms_getkeymarker(void* lpObj);
int cloudkeys_googlekms_setkeymarker(void* lpObj, const char* lpszKeyMarker);
QString GetKeyMarker();
int SetKeyMarker(QString qsKeyMarker);
Default Value
""
Remarks
This property will be populated when ListKeys is called if the results are paged and there are more pages. To list all keys, continue to call ListKeys until this property returns empty string.
Refer to ListKeys for more information.
This property is not available at design time.
Data Type
String
KeyRing Property (GoogleKMS Class)
Selects a key ring for the class to interact with.
Syntax
ANSI (Cross Platform) char* GetKeyRing();
int SetKeyRing(const char* lpszKeyRing); Unicode (Windows) LPWSTR GetKeyRing();
INT SetKeyRing(LPCWSTR lpszKeyRing);
char* cloudkeys_googlekms_getkeyring(void* lpObj);
int cloudkeys_googlekms_setkeyring(void* lpObj, const char* lpszKeyRing);
QString GetKeyRing();
int SetKeyRing(QString qsKeyRing);
Default Value
""
Remarks
This property specifies the key ring, by name, that the class should interact with.
This property is not available at design time.
Data Type
String
KeyRingMarker Property (GoogleKMS Class)
A marker indicating what page of key rings to return next.
Syntax
ANSI (Cross Platform) char* GetKeyRingMarker();
int SetKeyRingMarker(const char* lpszKeyRingMarker); Unicode (Windows) LPWSTR GetKeyRingMarker();
INT SetKeyRingMarker(LPCWSTR lpszKeyRingMarker);
char* cloudkeys_googlekms_getkeyringmarker(void* lpObj);
int cloudkeys_googlekms_setkeyringmarker(void* lpObj, const char* lpszKeyRingMarker);
QString GetKeyRingMarker();
int SetKeyRingMarker(QString qsKeyRingMarker);
Default Value
""
Remarks
This property will be populated when ListKeyRings is called if the results are paged and there are more pages. To list all key rings, continue to call ListKeyRings until this property returns empty string.
Refer to ListKeyRings for more information.
This property is not available at design time.
Data Type
String
KeyRingCount Property (GoogleKMS Class)
The number of records in the KeyRing arrays.
Syntax
ANSI (Cross Platform) int GetKeyRingCount(); Unicode (Windows) INT GetKeyRingCount();
int cloudkeys_googlekms_getkeyringcount(void* lpObj);
int GetKeyRingCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at KeyRingCount - 1.
This property is read-only and not available at design time.
Data Type
Integer
KeyRingCreationDate Property (GoogleKMS Class)
The key ring's creation date.
Syntax
ANSI (Cross Platform) char* GetKeyRingCreationDate(int iKeyRingIndex); Unicode (Windows) LPWSTR GetKeyRingCreationDate(INT iKeyRingIndex);
char* cloudkeys_googlekms_getkeyringcreationdate(void* lpObj, int keyringindex);
QString GetKeyRingCreationDate(int iKeyRingIndex);
Default Value
""
Remarks
The key ring's creation date.
This property reflects the key ring's creation date, formatted as an RFC 3339 UTC timestamp.
The KeyRingIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyRingCount property.
This property is read-only and not available at design time.
Data Type
String
KeyRingName Property (GoogleKMS Class)
The name of the key ring.
Syntax
ANSI (Cross Platform) char* GetKeyRingName(int iKeyRingIndex); Unicode (Windows) LPWSTR GetKeyRingName(INT iKeyRingIndex);
char* cloudkeys_googlekms_getkeyringname(void* lpObj, int keyringindex);
QString GetKeyRingName(int iKeyRingIndex);
Default Value
""
Remarks
The name of the key ring.
This property reflects the name of the key ring.
The KeyRingIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyRingCount property.
This property is read-only and not available at design time.
Data Type
String
KeyCount Property (GoogleKMS Class)
The number of records in the Key arrays.
Syntax
ANSI (Cross Platform) int GetKeyCount(); Unicode (Windows) INT GetKeyCount();
int cloudkeys_googlekms_getkeycount(void* lpObj);
int GetKeyCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- KeyCreationDate
- KeyName
- KeyNextRotateDate
- KeyPrimaryVersion
- KeyPurpose
- KeyRingCreationDate
- KeyRingName
- KeyRotationPeriod
- KeyTemplateAlgorithm
- KeyTemplateProtectionLevel
The array indices start at 0 and end at KeyCount - 1.
This property is read-only and not available at design time.
Data Type
Integer
KeyCreationDate Property (GoogleKMS Class)
The key's creation date.
Syntax
ANSI (Cross Platform) char* GetKeyCreationDate(int iKeyIndex); Unicode (Windows) LPWSTR GetKeyCreationDate(INT iKeyIndex);
char* cloudkeys_googlekms_getkeycreationdate(void* lpObj, int keyindex);
QString GetKeyCreationDate(int iKeyIndex);
Default Value
""
Remarks
The key's creation date.
This property reflects the key's creation date, formatted as an RFC 3339 UTC timestamp.
The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.
This property is read-only and not available at design time.
Data Type
String
KeyName Property (GoogleKMS Class)
The name of the key.
Syntax
ANSI (Cross Platform) char* GetKeyName(int iKeyIndex); Unicode (Windows) LPWSTR GetKeyName(INT iKeyIndex);
char* cloudkeys_googlekms_getkeyname(void* lpObj, int keyindex);
QString GetKeyName(int iKeyIndex);
Default Value
""
Remarks
The name of the key.
This property reflects the name of the key.
The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.
This property is read-only and not available at design time.
Data Type
String
KeyNextRotateDate Property (GoogleKMS Class)
The key's next rotation date.
Syntax
ANSI (Cross Platform) char* GetKeyNextRotateDate(int iKeyIndex); Unicode (Windows) LPWSTR GetKeyNextRotateDate(INT iKeyIndex);
char* cloudkeys_googlekms_getkeynextrotatedate(void* lpObj, int keyindex);
QString GetKeyNextRotateDate(int iKeyIndex);
Default Value
""
Remarks
The key's next rotation date.
This property reflects the key's next rotation date, formatted as an RFC 3339 UTC timestamp, or empty string if automatic rotation is not enabled.
Note that automatic rotation is only supported for symmetric keys.
The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.
This property is read-only and not available at design time.
Data Type
String
KeyPrimaryVersion Property (GoogleKMS Class)
The Id of the key's primary version.
Syntax
ANSI (Cross Platform) char* GetKeyPrimaryVersion(int iKeyIndex); Unicode (Windows) LPWSTR GetKeyPrimaryVersion(INT iKeyIndex);
char* cloudkeys_googlekms_getkeyprimaryversion(void* lpObj, int keyindex);
QString GetKeyPrimaryVersion(int iKeyIndex);
Default Value
""
Remarks
The Id of the key's primary version.
For symmetric keys, this property reflects the Id of the key's primary version. For asymmetric keys, this property is always empty, since asymmetric keys cannot have a primary version.
The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.
This property is read-only and not available at design time.
Data Type
String
KeyPurpose Property (GoogleKMS Class)
The key's purpose.
Syntax
ANSI (Cross Platform) int GetKeyPurpose(int iKeyIndex); Unicode (Windows) INT GetKeyPurpose(INT iKeyIndex);
Possible Values
GKP_UNSPECIFIED(0),
GKP_ENCRYPT_DECRYPT(1),
GKP_ASYMMETRIC_SIGN(2),
GKP_ASYMMETRIC_DECRYPT(3)
int cloudkeys_googlekms_getkeypurpose(void* lpObj, int keyindex);
int GetKeyPurpose(int iKeyIndex);
Default Value
0
Remarks
The key's purpose.
This property reflects the key's purpose. Possible values are:
- gkpUnspecified (0)
- gkpEncryptDecrypt (1) (indicates the key is symmetric)
- gkpAsymmetricSign (2)
- gkpAsymmetricDecrypt (3)
The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.
This property is read-only and not available at design time.
Data Type
Integer
KeyRotationPeriod Property (GoogleKMS Class)
The key's rotation period.
Syntax
ANSI (Cross Platform) char* GetKeyRotationPeriod(int iKeyIndex); Unicode (Windows) LPWSTR GetKeyRotationPeriod(INT iKeyIndex);
char* cloudkeys_googlekms_getkeyrotationperiod(void* lpObj, int keyindex);
QString GetKeyRotationPeriod(int iKeyIndex);
Default Value
""
Remarks
The key's rotation period.
This property reflects the key's rotation period, formatted as a number of seconds with up to nine fractional digits with a trailing s (e.g., 3.5984s); or empty string if automatic rotation is not enabled.
Note that automatic rotation is only supported for symmetric keys.
The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.
This property is read-only and not available at design time.
Data Type
String
KeyTemplateAlgorithm Property (GoogleKMS Class)
The algorithm to use when new versions of the key are created.
Syntax
ANSI (Cross Platform) char* GetKeyTemplateAlgorithm(int iKeyIndex); Unicode (Windows) LPWSTR GetKeyTemplateAlgorithm(INT iKeyIndex);
char* cloudkeys_googlekms_getkeytemplatealgorithm(void* lpObj, int keyindex);
QString GetKeyTemplateAlgorithm(int iKeyIndex);
Default Value
""
Remarks
The algorithm to use when new versions of the key are created.
This property reflects the algorithm to use when new versions of the key are created by CreateVersion.
The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.
This property is read-only and not available at design time.
Data Type
String
KeyTemplateProtectionLevel Property (GoogleKMS Class)
The protection level to use when new versions of the key are created.
Syntax
ANSI (Cross Platform) char* GetKeyTemplateProtectionLevel(int iKeyIndex); Unicode (Windows) LPWSTR GetKeyTemplateProtectionLevel(INT iKeyIndex);
char* cloudkeys_googlekms_getkeytemplateprotectionlevel(void* lpObj, int keyindex);
QString GetKeyTemplateProtectionLevel(int iKeyIndex);
Default Value
""
Remarks
The protection level to use when new versions of the key are created.
This property reflects the protection level to use when new versions of the key are created by CreateVersion. Possible values are:
- SOFTWARE
- HSM
- EXTERNAL
The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.
This property is read-only and not available at design time.
Data Type
String
LabelCount Property (GoogleKMS Class)
The number of records in the Label arrays.
Syntax
ANSI (Cross Platform) int GetLabelCount();
int SetLabelCount(int iLabelCount); Unicode (Windows) INT GetLabelCount();
INT SetLabelCount(INT iLabelCount);
int cloudkeys_googlekms_getlabelcount(void* lpObj);
int cloudkeys_googlekms_setlabelcount(void* lpObj, int iLabelCount);
int GetLabelCount();
int SetLabelCount(int iLabelCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at LabelCount - 1.
This property is not available at design time.
Data Type
Integer
LabelName Property (GoogleKMS Class)
The name of the label.
Syntax
ANSI (Cross Platform) char* GetLabelName(int iLabelIndex);
int SetLabelName(int iLabelIndex, const char* lpszLabelName); Unicode (Windows) LPWSTR GetLabelName(INT iLabelIndex);
INT SetLabelName(INT iLabelIndex, LPCWSTR lpszLabelName);
char* cloudkeys_googlekms_getlabelname(void* lpObj, int labelindex);
int cloudkeys_googlekms_setlabelname(void* lpObj, int labelindex, const char* lpszLabelName);
QString GetLabelName(int iLabelIndex);
int SetLabelName(int iLabelIndex, QString qsLabelName);
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 (GoogleKMS Class)
The value of the label.
Syntax
ANSI (Cross Platform) char* GetLabelValue(int iLabelIndex);
int SetLabelValue(int iLabelIndex, const char* lpszLabelValue); Unicode (Windows) LPWSTR GetLabelValue(INT iLabelIndex);
INT SetLabelValue(INT iLabelIndex, LPCWSTR lpszLabelValue);
char* cloudkeys_googlekms_getlabelvalue(void* lpObj, int labelindex);
int cloudkeys_googlekms_setlabelvalue(void* lpObj, int labelindex, const char* lpszLabelValue);
QString GetLabelValue(int iLabelIndex);
int SetLabelValue(int iLabelIndex, QString qsLabelValue);
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
LocalHost Property (GoogleKMS Class)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
ANSI (Cross Platform) char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost); Unicode (Windows) LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);
char* cloudkeys_googlekms_getlocalhost(void* lpObj);
int cloudkeys_googlekms_setlocalhost(void* lpObj, const char* lpszLocalHost);
QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);
Default Value
""
Remarks
The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).
NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.
Data Type
String
Location Property (GoogleKMS Class)
The Google Cloud location to make requests against.
Syntax
ANSI (Cross Platform) char* GetLocation();
int SetLocation(const char* lpszLocation); Unicode (Windows) LPWSTR GetLocation();
INT SetLocation(LPCWSTR lpszLocation);
char* cloudkeys_googlekms_getlocation(void* lpObj);
int cloudkeys_googlekms_setlocation(void* lpObj, const char* lpszLocation);
QString GetLocation();
int SetLocation(QString qsLocation);
Default Value
"us"
Remarks
This property specifies the Google Cloud location that the class should make requests against.
Regional Locations:
A regional location's data centers exist in a specific geographical place.
Value | Description |
asia-east1 | Taiwan |
asia-east2 | Hong Kong |
asia-northeast1 | Tokyo |
asia-northeast2 | Osaka |
asia-northeast3 | Seoul |
asia-south1 | Mumbai |
asia-southeast1 | Singapore |
asia-southeast2 | Jakarta |
australia-southeast1 | Sydney |
europe-north1 | Finland |
europe-west1 | Belgium |
europe-west2 | London |
europe-west3 | Frankfurt |
europe-west4 | Netherlands |
europe-west6 | Zurich |
northamerica-northeast1 | Montreal |
us-central1 | Iowa |
us-east1 | South Carolina |
us-east4 | Northern Virginia |
us-west1 | Oregon |
us-west2 | Los Angeles |
us-west3 | Salt Lake City |
us-west4 | Las Vegas |
southamerica-east1 | Sao Paulo |
Dual-Regional Locations:
A dual-regional location's data centers exist in two specific geographical places (plus a third region included for data replication and durability).
Value | Description (bold indicates third replica) |
asia1 | Tokyo, Osaka, and Seoul |
eur4 | Finland, Netherlands, and Belgium |
nam4 | Iowa, South Carolina, and Oklahoma |
Multi-Regional Locations:
A multi-regional location's data centers are spread across a geographical area; it is not possible to predict or control exactly which data centers are selected or where they are located.
Value | Description |
global | Multiple data centers throughout the world |
asia | Multiple data centers in Asia |
europe | Multiple data centers in Europe |
us (default) | Multiple data centers in the US |
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.
This property is not available at design time.
Data Type
String
OAuthAccessToken Property (GoogleKMS Class)
The access token returned by the authorization server.
Syntax
ANSI (Cross Platform) char* GetOAuthAccessToken();
int SetOAuthAccessToken(const char* lpszOAuthAccessToken); Unicode (Windows) LPWSTR GetOAuthAccessToken();
INT SetOAuthAccessToken(LPCWSTR lpszOAuthAccessToken);
char* cloudkeys_googlekms_getoauthaccesstoken(void* lpObj);
int cloudkeys_googlekms_setoauthaccesstoken(void* lpObj, const char* lpszOAuthAccessToken);
QString GetOAuthAccessToken();
int SetOAuthAccessToken(QString qsOAuthAccessToken);
Default Value
""
Remarks
The access token returned by the authorization server. This is set when the class makes a request to the token server.
This property is not available at design time.
Data Type
String
OAuthAuthorizationCode Property (GoogleKMS Class)
The authorization code that is exchanged for an access token.
Syntax
ANSI (Cross Platform) char* GetOAuthAuthorizationCode();
int SetOAuthAuthorizationCode(const char* lpszOAuthAuthorizationCode); Unicode (Windows) LPWSTR GetOAuthAuthorizationCode();
INT SetOAuthAuthorizationCode(LPCWSTR lpszOAuthAuthorizationCode);
char* cloudkeys_googlekms_getoauthauthorizationcode(void* lpObj);
int cloudkeys_googlekms_setoauthauthorizationcode(void* lpObj, const char* lpszOAuthAuthorizationCode);
QString GetOAuthAuthorizationCode();
int SetOAuthAuthorizationCode(QString qsOAuthAuthorizationCode);
Default Value
""
Remarks
The authorization code that is exchanged for an access token. This is required to be set when the OAuthClientProfile property is set to the Web profile. Otherwise, this field is for information purposes only.
This property is not available at design time.
Data Type
String
OAuthAuthorizationScope Property (GoogleKMS Class)
The scope request or response parameter used during authorization.
Syntax
ANSI (Cross Platform) char* GetOAuthAuthorizationScope();
int SetOAuthAuthorizationScope(const char* lpszOAuthAuthorizationScope); Unicode (Windows) LPWSTR GetOAuthAuthorizationScope();
INT SetOAuthAuthorizationScope(LPCWSTR lpszOAuthAuthorizationScope);
char* cloudkeys_googlekms_getoauthauthorizationscope(void* lpObj);
int cloudkeys_googlekms_setoauthauthorizationscope(void* lpObj, const char* lpszOAuthAuthorizationScope);
QString GetOAuthAuthorizationScope();
int SetOAuthAuthorizationScope(QString qsOAuthAuthorizationScope);
Default Value
""
Remarks
The scope request or response parameter used during authorization.
This property is not available at design time.
Data Type
String
OAuthClientId Property (GoogleKMS Class)
The id of the client assigned when registering the application.
Syntax
ANSI (Cross Platform) char* GetOAuthClientId();
int SetOAuthClientId(const char* lpszOAuthClientId); Unicode (Windows) LPWSTR GetOAuthClientId();
INT SetOAuthClientId(LPCWSTR lpszOAuthClientId);
char* cloudkeys_googlekms_getoauthclientid(void* lpObj);
int cloudkeys_googlekms_setoauthclientid(void* lpObj, const char* lpszOAuthClientId);
QString GetOAuthClientId();
int SetOAuthClientId(QString qsOAuthClientId);
Default Value
""
Remarks
The id of the client assigned when registering the application.
This property is not available at design time.
Data Type
String
OAuthClientProfile Property (GoogleKMS Class)
The type of client that is requesting authorization.
Syntax
ANSI (Cross Platform) int GetOAuthClientProfile();
int SetOAuthClientProfile(int iOAuthClientProfile); Unicode (Windows) INT GetOAuthClientProfile();
INT SetOAuthClientProfile(INT iOAuthClientProfile);
Possible Values
COCP_APPLICATION(0),
COCP_WEB(1)
int cloudkeys_googlekms_getoauthclientprofile(void* lpObj);
int cloudkeys_googlekms_setoauthclientprofile(void* lpObj, int iOAuthClientProfile);
int GetOAuthClientProfile();
int SetOAuthClientProfile(int iOAuthClientProfile);
Default Value
0
Remarks
The type of client that is requesting authorization. See the introduction section for more information. Possible values are:
0 (cocpApplication - Default) | The application profile is applicable to applications that are run by the user directly. For instance a windows form application would use the application profile. To authorize your application (client) using the application profile see the introduction section. |
1 (cocpWeb) | The Web profile is applicable to applications that are run on the server side where the user uses the application from a web browser. To authorize your application (client) using this profile follow see the introduction section. |
This property is not available at design time.
Data Type
Integer
OAuthClientSecret Property (GoogleKMS Class)
The secret value for the client assigned when registering the application.
Syntax
ANSI (Cross Platform) char* GetOAuthClientSecret();
int SetOAuthClientSecret(const char* lpszOAuthClientSecret); Unicode (Windows) LPWSTR GetOAuthClientSecret();
INT SetOAuthClientSecret(LPCWSTR lpszOAuthClientSecret);
char* cloudkeys_googlekms_getoauthclientsecret(void* lpObj);
int cloudkeys_googlekms_setoauthclientsecret(void* lpObj, const char* lpszOAuthClientSecret);
QString GetOAuthClientSecret();
int SetOAuthClientSecret(QString qsOAuthClientSecret);
Default Value
""
Remarks
The secret value for the client assigned when registering the application.
This property is not available at design time.
Data Type
String
OAuthGrantType Property (GoogleKMS Class)
The OAuth grant type used to acquire an OAuth access token.
Syntax
ANSI (Cross Platform) int GetOAuthGrantType();
int SetOAuthGrantType(int iOAuthGrantType); Unicode (Windows) INT GetOAuthGrantType();
INT SetOAuthGrantType(INT iOAuthGrantType);
Possible Values
COGT_AUTHORIZATION_CODE(0),
COGT_IMPLICIT(1),
COGT_PASSWORD(2),
COGT_CLIENT_CREDENTIALS(3)
int cloudkeys_googlekms_getoauthgranttype(void* lpObj);
int cloudkeys_googlekms_setoauthgranttype(void* lpObj, int iOAuthGrantType);
int GetOAuthGrantType();
int SetOAuthGrantType(int iOAuthGrantType);
Default Value
0
Remarks
The OAuth grant type used to acquire an OAuth access token. See the introduction section for more information. Possible values are:
0 (cogtAuthorizationCode - Default) | Authorization Code grant type |
1 (cogtImplicit) | Implicit grant type |
2 (cogtPassword) | Resource Owner Password Credentials grant type |
3 (cogtClientCredentials) | Client Credentials grant type |
This property is not available at design time.
Data Type
Integer
OAuthRefreshToken Property (GoogleKMS Class)
Specifies the refresh token received from or sent to the authorization server.
Syntax
ANSI (Cross Platform) char* GetOAuthRefreshToken();
int SetOAuthRefreshToken(const char* lpszOAuthRefreshToken); Unicode (Windows) LPWSTR GetOAuthRefreshToken();
INT SetOAuthRefreshToken(LPCWSTR lpszOAuthRefreshToken);
char* cloudkeys_googlekms_getoauthrefreshtoken(void* lpObj);
int cloudkeys_googlekms_setoauthrefreshtoken(void* lpObj, const char* lpszOAuthRefreshToken);
QString GetOAuthRefreshToken();
int SetOAuthRefreshToken(QString qsOAuthRefreshToken);
Default Value
""
Remarks
Specifies the refresh token received from or sent to the authorization server. This property is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the OAuthGrantType property is set to a grant that can use refresh tokens.
This property is not available at design time.
Data Type
String
OAuthReturnURL Property (GoogleKMS Class)
The URL where the user (browser) returns after authenticating.
Syntax
ANSI (Cross Platform) char* GetOAuthReturnURL();
int SetOAuthReturnURL(const char* lpszOAuthReturnURL); Unicode (Windows) LPWSTR GetOAuthReturnURL();
INT SetOAuthReturnURL(LPCWSTR lpszOAuthReturnURL);
char* cloudkeys_googlekms_getoauthreturnurl(void* lpObj);
int cloudkeys_googlekms_setoauthreturnurl(void* lpObj, const char* lpszOAuthReturnURL);
QString GetOAuthReturnURL();
int SetOAuthReturnURL(QString qsOAuthReturnURL);
Default Value
""
Remarks
The URL where the user (browser) returns after authenticating. This property is mapped to the redirect_uri parameter when making a request to the authorization server. Typically, this is automatically set by the class when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this property should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing.
This property is not available at design time.
Data Type
String
OAuthServerAuthURL Property (GoogleKMS Class)
The URL of the authorization server.
Syntax
ANSI (Cross Platform) char* GetOAuthServerAuthURL();
int SetOAuthServerAuthURL(const char* lpszOAuthServerAuthURL); Unicode (Windows) LPWSTR GetOAuthServerAuthURL();
INT SetOAuthServerAuthURL(LPCWSTR lpszOAuthServerAuthURL);
char* cloudkeys_googlekms_getoauthserverauthurl(void* lpObj);
int cloudkeys_googlekms_setoauthserverauthurl(void* lpObj, const char* lpszOAuthServerAuthURL);
QString GetOAuthServerAuthURL();
int SetOAuthServerAuthURL(QString qsOAuthServerAuthURL);
Default Value
""
Remarks
The URL of the authorization server.
This property is not available at design time.
Data Type
String
OAuthServerTokenURL Property (GoogleKMS Class)
The URL of the token server used to obtain the access token.
Syntax
ANSI (Cross Platform) char* GetOAuthServerTokenURL();
int SetOAuthServerTokenURL(const char* lpszOAuthServerTokenURL); Unicode (Windows) LPWSTR GetOAuthServerTokenURL();
INT SetOAuthServerTokenURL(LPCWSTR lpszOAuthServerTokenURL);
char* cloudkeys_googlekms_getoauthservertokenurl(void* lpObj);
int cloudkeys_googlekms_setoauthservertokenurl(void* lpObj, const char* lpszOAuthServerTokenURL);
QString GetOAuthServerTokenURL();
int SetOAuthServerTokenURL(QString qsOAuthServerTokenURL);
Default Value
""
Remarks
The URL of the token server used to obtain the access token.
This property is not available at design time.
Data Type
String
OAuthWebAuthURL Property (GoogleKMS Class)
The URL to which the user should be re-directed for authorization.
Syntax
ANSI (Cross Platform) char* GetOAuthWebAuthURL(); Unicode (Windows) LPWSTR GetOAuthWebAuthURL();
char* cloudkeys_googlekms_getoauthwebauthurl(void* lpObj);
QString GetOAuthWebAuthURL();
Default Value
""
Remarks
The URL to which the user should be re-directed for authorization. This field is used to get the URL that the user should be redirected to when using the Web client profile. See introduction section for more information.
This property is read-only and not available at design time.
Data Type
String
OtherHeaders Property (GoogleKMS Class)
This property includes other headers as determined by the user (optional).
Syntax
ANSI (Cross Platform) char* GetOtherHeaders();
int SetOtherHeaders(const char* lpszOtherHeaders); Unicode (Windows) LPWSTR GetOtherHeaders();
INT SetOtherHeaders(LPCWSTR lpszOtherHeaders);
char* cloudkeys_googlekms_getotherheaders(void* lpObj);
int cloudkeys_googlekms_setotherheaders(void* lpObj, const char* lpszOtherHeaders);
QString GetOtherHeaders();
int SetOtherHeaders(QString qsOtherHeaders);
Default Value
""
Remarks
This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.
The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .
Use this property with caution. If this property contains invalid headers, HTTP requests may fail.
This property is useful for extending the functionality of the class beyond what is provided.
This property is not available at design time.
Data Type
String
OutputData Property (GoogleKMS Class)
The output data.
Syntax
ANSI (Cross Platform) int GetOutputData(char* &lpOutputData, int &lenOutputData);
int SetOutputData(const char* lpOutputData, int lenOutputData); Unicode (Windows) INT GetOutputData(LPSTR &lpOutputData, INT &lenOutputData);
INT SetOutputData(LPCSTR lpOutputData, INT lenOutputData);
int cloudkeys_googlekms_getoutputdata(void* lpObj, char** lpOutputData, int* lenOutputData);
int cloudkeys_googlekms_setoutputdata(void* lpObj, const char* lpOutputData, int lenOutputData);
QByteArray GetOutputData();
int SetOutputData(QByteArray qbaOutputData);
Default Value
""
Remarks
This property is populated with the data that was output from a successful cryptographic operation.
Note: For the Verify operation, this property functions as a secondary input property instead (along with InputData); refer to the Verify method for more information.
Input Sources & Output Destinations
The class automatically determines the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- An input stream supplied via the SetInputStream method
- The InputFile property
- The InputData property
The first valid input source found is used. The order in which the output properties are considered is as follows:
- An output stream supplied via the SetOutputStream method
- The OutputFile property
- The OutputData property
This property is not available at design time.
Data Type
Binary String
OutputFile Property (GoogleKMS Class)
The file to which output data should be written.
Syntax
ANSI (Cross Platform) char* GetOutputFile();
wchar_t* GetOutputFile_W(); // Windows only
int SetOutputFile(const char* lpszOutputFile);
int SetOutputFile(const wchar_t* lpszOutputFile); // Windows only Unicode (Windows) LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);
char* cloudkeys_googlekms_getoutputfile(void* lpObj);
wchar_t* cloudkeys_googlekms_getoutputfile_W(void* lpObj); // Windows only
int cloudkeys_googlekms_setoutputfile(void* lpObj, const char* lpszOutputFile);
int cloudkeys_googlekms_setoutputfile(void* lpObj, const wchar_t* lpszOutputFile); // Windows only
QString GetOutputFile();
int SetOutputFile(QString qsOutputFile);
Default Value
""
Remarks
This property specifies the file to which data output from a successful cryptographic operation should be written.
Setting this property to a non-empty value will discard any stream set using the SetOutputStream method. Similarly, passing a non-null value to the aforementioned method will clear this property.
Note: For the Verify operation, the specified file functions as a secondary input file instead (along with InputFile); refer to the Verify method for more information.
Input Sources & Output Destinations
The class automatically determines the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- An input stream supplied via the SetInputStream method
- The InputFile property
- The InputData property
The first valid input source found is used. The order in which the output properties are considered is as follows:
- An output stream supplied via the SetOutputStream method
- The OutputFile property
- The OutputData property
Data Type
String
Overwrite Property (GoogleKMS Class)
Whether the output file should be overwritten if necessary.
Syntax
ANSI (Cross Platform) int GetOverwrite();
int SetOverwrite(int bOverwrite); Unicode (Windows) BOOL GetOverwrite();
INT SetOverwrite(BOOL bOverwrite);
int cloudkeys_googlekms_getoverwrite(void* lpObj);
int cloudkeys_googlekms_setoverwrite(void* lpObj, int bOverwrite);
bool GetOverwrite();
int SetOverwrite(bool bOverwrite);
Default Value
FALSE
Remarks
This property controls whether the specified OutputFile should be overwritten if it already exists.
Data Type
Boolean
ParsedHeaderCount Property (GoogleKMS Class)
The number of records in the ParsedHeader arrays.
Syntax
ANSI (Cross Platform) int GetParsedHeaderCount(); Unicode (Windows) INT GetParsedHeaderCount();
int cloudkeys_googlekms_getparsedheadercount(void* lpObj);
int GetParsedHeaderCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
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 (GoogleKMS Class)
This property contains the name of the HTTP header (this is the same case as it is delivered).
Syntax
ANSI (Cross Platform) char* GetParsedHeaderField(int iParsedHeaderIndex); Unicode (Windows) LPWSTR GetParsedHeaderField(INT iParsedHeaderIndex);
char* cloudkeys_googlekms_getparsedheaderfield(void* lpObj, int parsedheaderindex);
QString GetParsedHeaderField(int iParsedHeaderIndex);
Default Value
""
Remarks
This property contains the name of the HTTP Header (this is the same case as it is delivered).
The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.
This property is read-only and not available at design time.
Data Type
String
ParsedHeaderValue Property (GoogleKMS Class)
This property contains the header contents.
Syntax
ANSI (Cross Platform) char* GetParsedHeaderValue(int iParsedHeaderIndex); Unicode (Windows) LPWSTR GetParsedHeaderValue(INT iParsedHeaderIndex);
char* cloudkeys_googlekms_getparsedheadervalue(void* lpObj, int parsedheaderindex);
QString GetParsedHeaderValue(int iParsedHeaderIndex);
Default Value
""
Remarks
This property contains the Header contents.
The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.
This property is read-only and not available at design time.
Data Type
String
ProxyAuthScheme Property (GoogleKMS Class)
This property is used to tell the class which type of authorization to perform when connecting to the proxy.
Syntax
ANSI (Cross Platform) int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme); Unicode (Windows) INT GetProxyAuthScheme();
INT SetProxyAuthScheme(INT iProxyAuthScheme);
Possible Values
AUTH_BASIC(0),
AUTH_DIGEST(1),
AUTH_PROPRIETARY(2),
AUTH_NONE(3),
AUTH_NTLM(4),
AUTH_NEGOTIATE(5)
int cloudkeys_googlekms_getproxyauthscheme(void* lpObj);
int cloudkeys_googlekms_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);
Default Value
0
Remarks
This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.
ProxyAuthScheme should be set to authNone (3) when no authentication is expected.
By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.
If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.
If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.
If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.
Data Type
Integer
ProxyAutoDetect Property (GoogleKMS Class)
This property tells the class whether or not to automatically detect and use proxy system settings, if available.
Syntax
ANSI (Cross Platform) int GetProxyAutoDetect();
int SetProxyAutoDetect(int bProxyAutoDetect); Unicode (Windows) BOOL GetProxyAutoDetect();
INT SetProxyAutoDetect(BOOL bProxyAutoDetect);
int cloudkeys_googlekms_getproxyautodetect(void* lpObj);
int cloudkeys_googlekms_setproxyautodetect(void* lpObj, int bProxyAutoDetect);
bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);
Default Value
FALSE
Remarks
This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.
Data Type
Boolean
ProxyPassword Property (GoogleKMS Class)
This property contains a password if authentication is to be used for the proxy.
Syntax
ANSI (Cross Platform) char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword); Unicode (Windows) LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);
char* cloudkeys_googlekms_getproxypassword(void* lpObj);
int cloudkeys_googlekms_setproxypassword(void* lpObj, const char* lpszProxyPassword);
QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);
Default Value
""
Remarks
This property contains a password if authentication is to be used for the proxy.
If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.
If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.
Data Type
String
ProxyPort Property (GoogleKMS Class)
This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
Syntax
ANSI (Cross Platform) int GetProxyPort();
int SetProxyPort(int iProxyPort); Unicode (Windows) INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);
int cloudkeys_googlekms_getproxyport(void* lpObj);
int cloudkeys_googlekms_setproxyport(void* lpObj, int iProxyPort);
int GetProxyPort();
int SetProxyPort(int iProxyPort);
Default Value
80
Remarks
This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.
Data Type
Integer
ProxyServer Property (GoogleKMS Class)
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
Syntax
ANSI (Cross Platform) char* GetProxyServer();
int SetProxyServer(const char* lpszProxyServer); Unicode (Windows) LPWSTR GetProxyServer();
INT SetProxyServer(LPCWSTR lpszProxyServer);
char* cloudkeys_googlekms_getproxyserver(void* lpObj);
int cloudkeys_googlekms_setproxyserver(void* lpObj, const char* lpszProxyServer);
QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);
Default Value
""
Remarks
If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.
Data Type
String
ProxySSL Property (GoogleKMS Class)
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
Syntax
ANSI (Cross Platform) int GetProxySSL();
int SetProxySSL(int iProxySSL); Unicode (Windows) INT GetProxySSL();
INT SetProxySSL(INT iProxySSL);
Possible Values
PS_AUTOMATIC(0),
PS_ALWAYS(1),
PS_NEVER(2),
PS_TUNNEL(3)
int cloudkeys_googlekms_getproxyssl(void* lpObj);
int cloudkeys_googlekms_setproxyssl(void* lpObj, int iProxySSL);
int GetProxySSL();
int SetProxySSL(int iProxySSL);
Default Value
0
Remarks
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:
psAutomatic (0) | Default setting. If the URL is an https URL, the class will use the psTunnel option. If the URL is an http URL, the class will use the psNever option. |
psAlways (1) | The connection is always SSL enabled. |
psNever (2) | The connection is not SSL enabled. |
psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. |
Data Type
Integer
ProxyUser Property (GoogleKMS Class)
This property contains a user name, if authentication is to be used for the proxy.
Syntax
ANSI (Cross Platform) char* GetProxyUser();
int SetProxyUser(const char* lpszProxyUser); Unicode (Windows) LPWSTR GetProxyUser();
INT SetProxyUser(LPCWSTR lpszProxyUser);
char* cloudkeys_googlekms_getproxyuser(void* lpObj);
int cloudkeys_googlekms_setproxyuser(void* lpObj, const char* lpszProxyUser);
QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);
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
PublicKey Property (GoogleKMS Class)
The public key of an asymmetric key pair.
Syntax
ANSI (Cross Platform) char* GetPublicKey(); Unicode (Windows) LPWSTR GetPublicKey();
char* cloudkeys_googlekms_getpublickey(void* lpObj);
QString GetPublicKey();
Default Value
""
Remarks
This property reflects the public key of an asymmetric key pair stored on the server, in PEM format; it is populated anytime the GetPublicKey method is called successfully.
This property is read-only and not available at design time.
Data Type
String
PublicKeyAlgorithm Property (GoogleKMS Class)
The algorithm of an asymmetric key pair.
Syntax
ANSI (Cross Platform) char* GetPublicKeyAlgorithm(); Unicode (Windows) LPWSTR GetPublicKeyAlgorithm();
char* cloudkeys_googlekms_getpublickeyalgorithm(void* lpObj);
QString GetPublicKeyAlgorithm();
Default Value
""
Remarks
This property reflects the algorithm of an asymmetric key pair stored on the server; it is populated anytime the GetPublicKey method is called successfully. Possible values are:
- RSA_SIGN_PSS_2048_SHA256: RSASSA-PSS 2048 bit key with a SHA256 digest
- RSA_SIGN_PSS_3072_SHA256: RSASSA-PSS 3072 bit key with a SHA256 digest
- RSA_SIGN_PSS_4096_SHA256: RSASSA-PSS 4096 bit key with a SHA256 digest
- RSA_SIGN_PSS_4096_SHA512: RSASSA-PSS 4096 bit key with a SHA512 digest
- RSA_SIGN_PKCS1_2048_SHA256: RSASSA-PKCS1-v1_5 with a 2048 bit key and a SHA256 digest
- RSA_SIGN_PKCS1_3072_SHA256: RSASSA-PKCS1-v1_5 with a 3072 bit key and a SHA256 digest
- RSA_SIGN_PKCS1_4096_SHA256: RSASSA-PKCS1-v1_5 with a 4096 bit key and a SHA256 digest
- RSA_SIGN_PKCS1_4096_SHA512: RSASSA-PKCS1-v1_5 with a 4096 bit key and a SHA512 digest
- RSA_DECRYPT_OAEP_2048_SHA256: RSAES-OAEP 2048 bit key with a SHA256 digest
- RSA_DECRYPT_OAEP_3072_SHA256: RSAES-OAEP 3072 bit key with a SHA256 digest
- RSA_DECRYPT_OAEP_4096_SHA256: RSAES-OAEP 4096 bit key with a SHA256 digest
- RSA_DECRYPT_OAEP_4096_SHA512: RSAES-OAEP 4096 bit key with a SHA512 digest
- EC_SIGN_P256_SHA256: ECDSA on the NIST P-256 curve with a SHA256 digest
- EC_SIGN_P384_SHA384: ECDSA on the NIST P-384 curve with a SHA384 digest
Refer to Google's CryptoKeyVersionAlgorithm documentation page for more information.
This property is read-only and not available at design time.
Data Type
String
QueryParamCount Property (GoogleKMS Class)
The number of records in the QueryParam arrays.
Syntax
ANSI (Cross Platform) int GetQueryParamCount();
int SetQueryParamCount(int iQueryParamCount); Unicode (Windows) INT GetQueryParamCount();
INT SetQueryParamCount(INT iQueryParamCount);
int cloudkeys_googlekms_getqueryparamcount(void* lpObj);
int cloudkeys_googlekms_setqueryparamcount(void* lpObj, int iQueryParamCount);
int GetQueryParamCount();
int SetQueryParamCount(int iQueryParamCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at QueryParamCount - 1.
This property is not available at design time.
Data Type
Integer
QueryParamName Property (GoogleKMS Class)
The name of the query parameter.
Syntax
ANSI (Cross Platform) char* GetQueryParamName(int iQueryParamIndex);
int SetQueryParamName(int iQueryParamIndex, const char* lpszQueryParamName); Unicode (Windows) LPWSTR GetQueryParamName(INT iQueryParamIndex);
INT SetQueryParamName(INT iQueryParamIndex, LPCWSTR lpszQueryParamName);
char* cloudkeys_googlekms_getqueryparamname(void* lpObj, int queryparamindex);
int cloudkeys_googlekms_setqueryparamname(void* lpObj, int queryparamindex, const char* lpszQueryParamName);
QString GetQueryParamName(int iQueryParamIndex);
int SetQueryParamName(int iQueryParamIndex, QString qsQueryParamName);
Default Value
""
Remarks
The name of the query parameter.
This property specifies the name of the query parameter.
The QueryParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.
This property is not available at design time.
Data Type
String
QueryParamValue Property (GoogleKMS Class)
The value of the query parameter.
Syntax
ANSI (Cross Platform) char* GetQueryParamValue(int iQueryParamIndex);
int SetQueryParamValue(int iQueryParamIndex, const char* lpszQueryParamValue); Unicode (Windows) LPWSTR GetQueryParamValue(INT iQueryParamIndex);
INT SetQueryParamValue(INT iQueryParamIndex, LPCWSTR lpszQueryParamValue);
char* cloudkeys_googlekms_getqueryparamvalue(void* lpObj, int queryparamindex);
int cloudkeys_googlekms_setqueryparamvalue(void* lpObj, int queryparamindex, const char* lpszQueryParamValue);
QString GetQueryParamValue(int iQueryParamIndex);
int SetQueryParamValue(int iQueryParamIndex, QString qsQueryParamValue);
Default Value
""
Remarks
The value of the query parameter.
This property specifies the value of the query parameter. The class will automatically URL-encode this value when sending the request.
The QueryParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.
This property is not available at design time.
Data Type
String
SSLAcceptServerCertEncoded Property (GoogleKMS Class)
This is the certificate (PEM/base64 encoded).
Syntax
ANSI (Cross Platform) int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded); Unicode (Windows) INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);
int cloudkeys_googlekms_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int cloudkeys_googlekms_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);
QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.
When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SSLCertEncoded Property (GoogleKMS Class)
This is the certificate (PEM/base64 encoded).
Syntax
ANSI (Cross Platform) int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded); Unicode (Windows) INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);
int cloudkeys_googlekms_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int cloudkeys_googlekms_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);
QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.
When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SSLCertStore Property (GoogleKMS Class)
This is the name of the certificate store for the client certificate.
Syntax
ANSI (Cross Platform) int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore); Unicode (Windows) INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);
int cloudkeys_googlekms_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int cloudkeys_googlekms_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);
QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.
SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
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 (GoogleKMS Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
ANSI (Cross Platform) char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword); Unicode (Windows) LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);
char* cloudkeys_googlekms_getsslcertstorepassword(void* lpObj);
int cloudkeys_googlekms_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);
QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
SSLCertStoreType Property (GoogleKMS Class)
This is the type of certificate store for this certificate.
Syntax
ANSI (Cross Platform) int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType); Unicode (Windows) INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);
Possible Values
CST_USER(0),
CST_MACHINE(1),
CST_PFXFILE(2),
CST_PFXBLOB(3),
CST_JKSFILE(4),
CST_JKSBLOB(5),
CST_PEMKEY_FILE(6),
CST_PEMKEY_BLOB(7),
CST_PUBLIC_KEY_FILE(8),
CST_PUBLIC_KEY_BLOB(9),
CST_SSHPUBLIC_KEY_BLOB(10),
CST_P7BFILE(11),
CST_P7BBLOB(12),
CST_SSHPUBLIC_KEY_FILE(13),
CST_PPKFILE(14),
CST_PPKBLOB(15),
CST_XMLFILE(16),
CST_XMLBLOB(17),
CST_JWKFILE(18),
CST_JWKBLOB(19),
CST_SECURITY_KEY(20),
CST_BCFKSFILE(21),
CST_BCFKSBLOB(22),
CST_PKCS11(23),
CST_AUTO(99)
int cloudkeys_googlekms_getsslcertstoretype(void* lpObj);
int cloudkeys_googlekms_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
Data Type
Integer
SSLCertSubject Property (GoogleKMS Class)
This is the subject of the certificate used for client authentication.
Syntax
ANSI (Cross Platform) char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject); Unicode (Windows) LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);
char* cloudkeys_googlekms_getsslcertsubject(void* lpObj);
int cloudkeys_googlekms_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);
QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Data Type
String
SSLProvider Property (GoogleKMS Class)
This specifies the SSL/TLS implementation to use.
Syntax
ANSI (Cross Platform) int GetSSLProvider();
int SetSSLProvider(int iSSLProvider); Unicode (Windows) INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);
Possible Values
SSLP_AUTOMATIC(0),
SSLP_PLATFORM(1),
SSLP_INTERNAL(2)
int cloudkeys_googlekms_getsslprovider(void* lpObj);
int cloudkeys_googlekms_setsslprovider(void* lpObj, int iSSLProvider);
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);
Default Value
0
Remarks
This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.
Possible values are:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
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 (GoogleKMS Class)
This is the certificate (PEM/base64 encoded).
Syntax
ANSI (Cross Platform) int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded); Unicode (Windows) INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);
int cloudkeys_googlekms_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);
QByteArray GetSSLServerCertEncoded();
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.
When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.
This property is read-only and not available at design time.
Data Type
Binary String
Timeout Property (GoogleKMS Class)
A timeout for the class.
Syntax
ANSI (Cross Platform) int GetTimeout();
int SetTimeout(int iTimeout); Unicode (Windows) INT GetTimeout();
INT SetTimeout(INT iTimeout);
int cloudkeys_googlekms_gettimeout(void* lpObj);
int cloudkeys_googlekms_settimeout(void* lpObj, int iTimeout);
int GetTimeout();
int SetTimeout(int iTimeout);
Default Value
60
Remarks
If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.
If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.
The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.
If Timeout expires, and the operation is not yet complete, the class fails with an error.
Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the Timeout property is 60 seconds.
Data Type
Integer
VersionMarker Property (GoogleKMS Class)
A marker indicating what page of key versions to return next.
Syntax
ANSI (Cross Platform) char* GetVersionMarker();
int SetVersionMarker(const char* lpszVersionMarker); Unicode (Windows) LPWSTR GetVersionMarker();
INT SetVersionMarker(LPCWSTR lpszVersionMarker);
char* cloudkeys_googlekms_getversionmarker(void* lpObj);
int cloudkeys_googlekms_setversionmarker(void* lpObj, const char* lpszVersionMarker);
QString GetVersionMarker();
int SetVersionMarker(QString qsVersionMarker);
Default Value
""
Remarks
This property will be populated when ListVersions is called if the results are paged and there are more pages. To list all key versions, continue to call ListVersions until this property returns empty string.
Refer to ListVersions for more information.
This property is not available at design time.
Data Type
String
VersionCount Property (GoogleKMS Class)
The number of records in the Version arrays.
Syntax
ANSI (Cross Platform) int GetVersionCount(); Unicode (Windows) INT GetVersionCount();
int cloudkeys_googlekms_getversioncount(void* lpObj);
int GetVersionCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- VersionAlgorithm
- VersionCreationDate
- VersionDestructionDate
- VersionGenerationDate
- VersionName
- VersionProtectionLevel
- VersionState
- 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
VersionAlgorithm Property (GoogleKMS Class)
The key version's algorithm.
Syntax
ANSI (Cross Platform) char* GetVersionAlgorithm(int iVersionIndex); Unicode (Windows) LPWSTR GetVersionAlgorithm(INT iVersionIndex);
char* cloudkeys_googlekms_getversionalgorithm(void* lpObj, int versionindex);
QString GetVersionAlgorithm(int iVersionIndex);
Default Value
""
Remarks
The key version's algorithm.
This property reflects the key version's algorithm. For symmetric keys, this property will always be GOOGLE_SYMMETRIC_ENCRYPTION. For asymmetric keys, this value describes both the key type and the algorithm that must be used during cryptographic operations, and possible values are:
- RSA_SIGN_PSS_2048_SHA256: RSASSA-PSS 2048 bit key with a SHA256 digest
- RSA_SIGN_PSS_3072_SHA256: RSASSA-PSS 3072 bit key with a SHA256 digest
- RSA_SIGN_PSS_4096_SHA256: RSASSA-PSS 4096 bit key with a SHA256 digest
- RSA_SIGN_PSS_4096_SHA512: RSASSA-PSS 4096 bit key with a SHA512 digest
- RSA_SIGN_PKCS1_2048_SHA256: RSASSA-PKCS1-v1_5 with a 2048 bit key and a SHA256 digest
- RSA_SIGN_PKCS1_3072_SHA256: RSASSA-PKCS1-v1_5 with a 3072 bit key and a SHA256 digest
- RSA_SIGN_PKCS1_4096_SHA256: RSASSA-PKCS1-v1_5 with a 4096 bit key and a SHA256 digest
- RSA_SIGN_PKCS1_4096_SHA512: RSASSA-PKCS1-v1_5 with a 4096 bit key and a SHA512 digest
- RSA_DECRYPT_OAEP_2048_SHA256: RSAES-OAEP 2048 bit key with a SHA256 digest
- RSA_DECRYPT_OAEP_3072_SHA256: RSAES-OAEP 3072 bit key with a SHA256 digest
- RSA_DECRYPT_OAEP_4096_SHA256: RSAES-OAEP 4096 bit key with a SHA256 digest
- RSA_DECRYPT_OAEP_4096_SHA512: RSAES-OAEP 4096 bit key with a SHA512 digest
- EC_SIGN_P256_SHA256: ECDSA on the NIST P-256 curve with a SHA256 digest
- EC_SIGN_P384_SHA384: ECDSA on the NIST P-384 curve with a SHA384 digest
Refer to Google's CryptoKeyVersionAlgorithm documentation page for more information.
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
VersionCreationDate Property (GoogleKMS Class)
The key version's creation date.
Syntax
ANSI (Cross Platform) char* GetVersionCreationDate(int iVersionIndex); Unicode (Windows) LPWSTR GetVersionCreationDate(INT iVersionIndex);
char* cloudkeys_googlekms_getversioncreationdate(void* lpObj, int versionindex);
QString GetVersionCreationDate(int iVersionIndex);
Default Value
""
Remarks
The key version's creation date.
This property reflects the key version's creation date, formatted as an RFC 3339 UTC timestamp.
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
VersionDestructionDate Property (GoogleKMS Class)
The key version's destruction date.
Syntax
ANSI (Cross Platform) char* GetVersionDestructionDate(int iVersionIndex); Unicode (Windows) LPWSTR GetVersionDestructionDate(INT iVersionIndex);
char* cloudkeys_googlekms_getversiondestructiondate(void* lpObj, int versionindex);
QString GetVersionDestructionDate(int iVersionIndex);
Default Value
""
Remarks
The key version's destruction date.
This property reflects the date at which the key version's cryptographic material was (or will be) destroyed, formatted as an RFC 3339 UTC timestamp; or empty string if the key version's cryptographic material has not been, and is not scheduled to be, destroyed.
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
VersionGenerationDate Property (GoogleKMS Class)
The generation date of the key version's cryptographic material.
Syntax
ANSI (Cross Platform) char* GetVersionGenerationDate(int iVersionIndex); Unicode (Windows) LPWSTR GetVersionGenerationDate(INT iVersionIndex);
char* cloudkeys_googlekms_getversiongenerationdate(void* lpObj, int versionindex);
QString GetVersionGenerationDate(int iVersionIndex);
Default Value
""
Remarks
The generation date of the key version's cryptographic material.
This property reflects the generation date of the key version's cryptographic material, formatted as an RFC 3339 UTC timestamp.
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
VersionName Property (GoogleKMS Class)
The name of the key.
Syntax
ANSI (Cross Platform) char* GetVersionName(int iVersionIndex); Unicode (Windows) LPWSTR GetVersionName(INT iVersionIndex);
char* cloudkeys_googlekms_getversionname(void* lpObj, int versionindex);
QString GetVersionName(int iVersionIndex);
Default Value
""
Remarks
The name of the key.
This property reflects the name of the key that the key version is associated with.
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
VersionProtectionLevel Property (GoogleKMS Class)
The key version's protection level.
Syntax
ANSI (Cross Platform) char* GetVersionProtectionLevel(int iVersionIndex); Unicode (Windows) LPWSTR GetVersionProtectionLevel(INT iVersionIndex);
char* cloudkeys_googlekms_getversionprotectionlevel(void* lpObj, int versionindex);
QString GetVersionProtectionLevel(int iVersionIndex);
Default Value
""
Remarks
The key version's protection level.
This property reflects the key version's protection level. Possible values are:
- SOFTWARE
- HSM
- EXTERNAL
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
VersionState Property (GoogleKMS Class)
The key version's state.
Syntax
ANSI (Cross Platform) char* GetVersionState(int iVersionIndex); Unicode (Windows) LPWSTR GetVersionState(INT iVersionIndex);
char* cloudkeys_googlekms_getversionstate(void* lpObj, int versionindex);
QString GetVersionState(int iVersionIndex);
Default Value
""
Remarks
The key version's state.
This property reflects the key version's state. Possible values are:
- PENDING_GENERATION: The version is still being generated, and cannot be used yet. Once generation has finished, it will become ENABLED.
- ENABLED: The version is enabled and available for use.
- DISABLED: The version is disabled; it cannot be used unless it is enabled again. It may be destroyed.
- DESTROY_SCHEDULED: The version's cryptographic material is scheduled for destruction, and will be destroyed at the time reflected by VersionDestructionDate unless CancelDestruction before then.
- DESTROYED: The version's cryptographic material has been destroyed, and the version is no longer usable. This state is permanent once entered.
- PENDING_IMPORT*: Cryptographic material has not finished importing, and the version cannot be used yet. Once the import has finished, it will become ENABLED.
- IMPORT_FAILED*: The version was not imported successfully; it cannot be used, and any imported cryptographic material has been discarded.
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 (GoogleKMS Class)
The Id of the key version.
Syntax
ANSI (Cross Platform) char* GetVersionVersionId(int iVersionIndex); Unicode (Windows) LPWSTR GetVersionVersionId(INT iVersionIndex);
char* cloudkeys_googlekms_getversionversionid(void* lpObj, int versionindex);
QString GetVersionVersionId(int iVersionIndex);
Default Value
""
Remarks
The Id of the key version.
This property reflects the Id of the key 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
AddLabel Method (GoogleKMS Class)
Adds an item to the Labels properties.
Syntax
ANSI (Cross Platform) int AddLabel(const char* lpszName, const char* lpszValue); Unicode (Windows) INT AddLabel(LPCWSTR lpszName, LPCWSTR lpszValue);
int cloudkeys_googlekms_addlabel(void* lpObj, const char* lpszName, const char* lpszValue);
int AddLabel(const QString& qsName, const QString& qsValue);
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.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
AddQueryParam Method (GoogleKMS Class)
Adds a query parameter to the QueryParams properties.
Syntax
ANSI (Cross Platform) int AddQueryParam(const char* lpszName, const char* lpszValue); Unicode (Windows) INT AddQueryParam(LPCWSTR lpszName, LPCWSTR lpszValue);
int cloudkeys_googlekms_addqueryparam(void* lpObj, const char* lpszName, const char* lpszValue);
int AddQueryParam(const QString& qsName, const QString& qsValue);
Remarks
This method is used to add a query parameter to the QueryaParam* properties. Name specifies the name of the parameter, and Value specifies the value of the parameter.
All specified Values will be URL encoded by the class automatically. Consult the service documentation for details on the available parameters.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Authorize Method (GoogleKMS Class)
Get the authorization string required to access the protected resource.
Syntax
ANSI (Cross Platform) int Authorize(); Unicode (Windows) INT Authorize();
int cloudkeys_googlekms_authorize(void* lpObj);
int Authorize();
Remarks
This method is used to get an access token that is required to access the protected resource. The method will act differently based on what is set in the OAuthClientProfile property and the OAuthGrantType property. This method is not to be used in conjunction with the Authorization property. It should instead be used when setting the OAuth* properties.
For more information, see the introduction section.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
CancelDestruction Method (GoogleKMS Class)
Cancels the destruction of a key version's cryptographic material.
Syntax
ANSI (Cross Platform) int CancelDestruction(const char* lpszKeyName, const char* lpszVersionId); Unicode (Windows) INT CancelDestruction(LPCWSTR lpszKeyName, LPCWSTR lpszVersionId);
int cloudkeys_googlekms_canceldestruction(void* lpObj, const char* lpszKeyName, const char* lpszVersionId);
int CancelDestruction(const QString& qsKeyName, const QString& qsVersionId);
Remarks
This method cancels the destruction of the cryptographic material for the key version specified by KeyName and VersionId. If successful, the key version's VersionState changes to DISABLED.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Config Method (GoogleKMS Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* cloudkeys_googlekms_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
CreateKey Method (GoogleKMS Class)
Creates a new key.
Syntax
ANSI (Cross Platform) int CreateKey(const char* lpszKeyName, int iPurpose, const char* lpszAlgorithm, int bUseHSM); Unicode (Windows) INT CreateKey(LPCWSTR lpszKeyName, INT iPurpose, LPCWSTR lpszAlgorithm, BOOL bUseHSM);
int cloudkeys_googlekms_createkey(void* lpObj, const char* lpszKeyName, int iPurpose, const char* lpszAlgorithm, int bUseHSM);
int CreateKey(const QString& qsKeyName, int iPurpose, const QString& qsAlgorithm, bool bUseHSM);
Remarks
This method creates a new key with the specified KeyName in the currently-selected KeyRing. A key version is automatically created when this occurs (and for symmetric keys, it automatically becomes the primary version).
The value passed for KeyName must consist solely of alphanumeric characters, underscores, and hyphens; and may be up to 63 characters in length.
The Purpose parameter specifies what the key's purpose should be. Possible values are:
- 1: A symmetric key used for encryption and decryption.
- 2: An asymmetric key used for signing and verification.
- 3: An asymmetric key used for encryption and decryption.
For symmetric keys, the only valid value for Algorithm is GOOGLE_SYMMETRIC_ENCRYPTION (which is assumed if empty string is passed). For asymmetric keys, the algorithm specifies the key type, repeats the purpose (either SIGN or DECRYPT), and dictates the algorithm that will be used for the relevant cryptographic operations; and valid values are:
- RSA_SIGN_PSS_2048_SHA256: RSASSA-PSS 2048 bit key with a SHA256 digest
- RSA_SIGN_PSS_3072_SHA256: RSASSA-PSS 3072 bit key with a SHA256 digest
- RSA_SIGN_PSS_4096_SHA256: RSASSA-PSS 4096 bit key with a SHA256 digest
- RSA_SIGN_PSS_4096_SHA512: RSASSA-PSS 4096 bit key with a SHA512 digest
- RSA_SIGN_PKCS1_2048_SHA256: RSASSA-PKCS1-v1_5 with a 2048 bit key and a SHA256 digest
- RSA_SIGN_PKCS1_3072_SHA256: RSASSA-PKCS1-v1_5 with a 3072 bit key and a SHA256 digest
- RSA_SIGN_PKCS1_4096_SHA256: RSASSA-PKCS1-v1_5 with a 4096 bit key and a SHA256 digest
- RSA_SIGN_PKCS1_4096_SHA512: RSASSA-PKCS1-v1_5 with a 4096 bit key and a SHA512 digest
- RSA_DECRYPT_OAEP_2048_SHA256: RSAES-OAEP 2048 bit key with a SHA256 digest
- RSA_DECRYPT_OAEP_3072_SHA256: RSAES-OAEP 3072 bit key with a SHA256 digest
- RSA_DECRYPT_OAEP_4096_SHA256: RSAES-OAEP 4096 bit key with a SHA256 digest
- RSA_DECRYPT_OAEP_4096_SHA512: RSAES-OAEP 4096 bit key with a SHA512 digest
- EC_SIGN_P256_SHA256: ECDSA on the NIST P-256 curve with a SHA256 digest
- EC_SIGN_P384_SHA384: ECDSA on the NIST P-384 curve with a SHA384 digest
Refer to Google's CryptoKeyVersionAlgorithm documentation page for more information.
The UseHSM parameter specifies whether the key's protection level should be SOFTWARE (false) or HSM (true).
Note that the values passed for Algorithm and UseHSM will be stored on the server as template values, and used again anytime a new key version is created with CreateVersion. The template algorithm can be changed at any time using UpdateKey; the template protection level cannot be changed.
If there are any items in the Label* properties, they will be applied to the newly-created key. Keys may have up to 64 labels.
For symmetric keys, the RotationPeriod and NextRotateDate configuration settings can also be used to enable automatic rotation, refer to their documentation for more information.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
CreateKeyRing Method (GoogleKMS Class)
Creates a new key ring.
Syntax
ANSI (Cross Platform) int CreateKeyRing(); Unicode (Windows) INT CreateKeyRing();
int cloudkeys_googlekms_createkeyring(void* lpObj);
int CreateKeyRing();
Remarks
This method creates a new key ring using the name specified by the KeyRing property.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
CreateVersion Method (GoogleKMS Class)
Creates a new key version.
Syntax
ANSI (Cross Platform) char* CreateVersion(const char* lpszKeyName); Unicode (Windows) LPWSTR CreateVersion(LPCWSTR lpszKeyName);
char* cloudkeys_googlekms_createversion(void* lpObj, const char* lpszKeyName);
QString CreateVersion(const QString& qsKeyName);
Remarks
This method creates a new version of the key specified by KeyName and returns the Id of the version. Note that, for symmetric keys, the new version will not become the primary version; SetPrimaryVersion can be used to update the primary version if desired.
The key's current KeyTemplateAlgorithm and KeyTemplateProtectionLevel are used to create the key version. To change the key's template algorithm prior to creating a new version, use the UpdateKey method.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Decrypt Method (GoogleKMS Class)
Decrypts data using a key.
Syntax
ANSI (Cross Platform) int Decrypt(const char* lpszKeyName, const char* lpszVersionId); Unicode (Windows) INT Decrypt(LPCWSTR lpszKeyName, LPCWSTR lpszVersionId);
int cloudkeys_googlekms_decrypt(void* lpObj, const char* lpszKeyName, const char* lpszVersionId);
int Decrypt(const QString& qsKeyName, const QString& qsVersionId);
Remarks
This method decrypts data using the key specified by KeyName and (for asymmetric keys) VersionId.
The data to decrypt is taken from the input stream supplied via the SetInputStream method, the specified InputFile, or the InputData property. The decrypted data is output to the output stream supplied via the SetOutputStream method, the specified OutputFile, or the OutputData property.
For symmetric keys, VersionId must be empty; the server automatically detects which version of the symmetric key to use for decryption.
For asymmetric keys, VersionId must be specified.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
DestroyVersion Method (GoogleKMS Class)
Schedules the specified key version's cryptographic material for destruction.
Syntax
ANSI (Cross Platform) int DestroyVersion(const char* lpszKeyName, const char* lpszVersionId); Unicode (Windows) INT DestroyVersion(LPCWSTR lpszKeyName, LPCWSTR lpszVersionId);
int cloudkeys_googlekms_destroyversion(void* lpObj, const char* lpszKeyName, const char* lpszVersionId);
int DestroyVersion(const QString& qsKeyName, const QString& qsVersionId);
Remarks
This method schedules the destruction of the cryptographic material for the key version specified by KeyName and VersionId. The key version itself is not deleted, just its cryptographic material.
If this method is successful, the key version's VersionState changes to DESTROY_SCHEDULED, and the its cryptographic material will be destroyed after 24 hours. During this waiting period, the destruction can be canceled using the CancelDestruction method.
Important: Destroying a key version's cryptographic material makes the key version permanently unusable. If a key version must not be used by may be needed again in the future, disable using SetVersionEnabled instead.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
DoEvents Method (GoogleKMS Class)
Processes events from the internal message queue.
Syntax
ANSI (Cross Platform) int DoEvents(); Unicode (Windows) INT DoEvents();
int cloudkeys_googlekms_doevents(void* lpObj);
int DoEvents();
Remarks
When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Encrypt Method (GoogleKMS Class)
Encrypts data using a key.
Syntax
ANSI (Cross Platform) int Encrypt(const char* lpszKeyName, const char* lpszVersionId); Unicode (Windows) INT Encrypt(LPCWSTR lpszKeyName, LPCWSTR lpszVersionId);
int cloudkeys_googlekms_encrypt(void* lpObj, const char* lpszKeyName, const char* lpszVersionId);
int Encrypt(const QString& qsKeyName, const QString& qsVersionId);
Remarks
This method encrypts data using the key specified by KeyName and (for asymmetric keys) VersionId.
The data to encrypt is taken from the input stream supplied via the SetInputStream method, the specified InputFile, or the InputData property. The encrypted data is output to the output stream supplied via the SetOutputStream method, the specified OutputFile, or the OutputData property.
For symmetric keys, VersionId must be empty; the server always uses the primary version of the symmetric key. (Unless the ForceSymmetricEncryption configuration setting is enabled, in which case VersionId can be used to specify a non-primary version.)
For asymmetric keys, VersionId must be specified. Note, however, that Google does not support server-side asymmetric encryption (only decryption), so this method will instead call GetPublicKey internally and then use the public key to encrypt the input data locally. This functionality is offered as a convenience.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
GetKeyInfo Method (GoogleKMS Class)
Gets information about a key.
Syntax
ANSI (Cross Platform) int GetKeyInfo(const char* lpszKeyName); Unicode (Windows) INT GetKeyInfo(LPCWSTR lpszKeyName);
int cloudkeys_googlekms_getkeyinfo(void* lpObj, const char* lpszKeyName);
int GetKeyInfo(const QString& qsKeyName);
Remarks
This method gets information about the key specified by KeyName.
When the information is returned, the class clears the Key* properties and repopulates them with a single item that contains the key's information, and also repopulates the Label* properties. The KeyList and LabelList events are also fired.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
GetKeyRingInfo Method (GoogleKMS Class)
Gets information about a key ring.
Syntax
ANSI (Cross Platform) int GetKeyRingInfo(); Unicode (Windows) INT GetKeyRingInfo();
int cloudkeys_googlekms_getkeyringinfo(void* lpObj);
int GetKeyRingInfo();
Remarks
This method gets information about the currently-selected KeyRing.
When the information is returned, the class clears the KeyRing* properties and repopulates them with a single item that contains the key ring's information. The KeyRingList event is also fired.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
GetPublicKey Method (GoogleKMS Class)
Retrieves the public key of an asymmetric key pair.
Syntax
ANSI (Cross Platform) int GetPublicKey(const char* lpszKeyName, const char* lpszVersionId); Unicode (Windows) INT GetPublicKey(LPCWSTR lpszKeyName, LPCWSTR lpszVersionId);
int cloudkeys_googlekms_getpublickey(void* lpObj, const char* lpszKeyName, const char* lpszVersionId);
int GetPublicKey(const QString& qsKeyName, const QString& qsVersionId);
Remarks
This method retrieves the public key of the asymmetric key pair version specified by KeyName and VersionId. The algorithm of the key pair version is also retrieved. If successful, this method populates the PublicKey and PublicKeyAlgorithm properties.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
GetVersionInfo Method (GoogleKMS Class)
Gets information about a key version.
Syntax
ANSI (Cross Platform) int GetVersionInfo(const char* lpszKeyName, const char* lpszVersionId); Unicode (Windows) INT GetVersionInfo(LPCWSTR lpszKeyName, LPCWSTR lpszVersionId);
int cloudkeys_googlekms_getversioninfo(void* lpObj, const char* lpszKeyName, const char* lpszVersionId);
int GetVersionInfo(const QString& qsKeyName, const QString& qsVersionId);
Remarks
This method gets information about the key version specified by KeyName and VersionId.
When the information is returned, the class clears the Version* properties and repopulates them with a single item that contains the key version's information. The VersionList event is also fired.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ListKeyRings Method (GoogleKMS Class)
Lists the key rings in the currently-selected location.
Syntax
ANSI (Cross Platform) int ListKeyRings(); Unicode (Windows) INT ListKeyRings();
int cloudkeys_googlekms_listkeyrings(void* lpObj);
int ListKeyRings();
Remarks
This method lists the key rings in the currently-selected Location.
Calling this method will fire the KeyRingList event once for each key ring, and will also populate the KeyRing* properties.
If there are still more key rings available to list when this method returns, the KeyRingMarker property will be populated. Continue to call this method until KeyRingMarker is empty to accumulate all pages of results in the KeyRing* properties.
The MaxKeyRings configuration setting can be used to control the maximum number of results to return at once.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ListKeys Method (GoogleKMS Class)
Lists the keys in the currently-selected key ring.
Syntax
ANSI (Cross Platform) int ListKeys(); Unicode (Windows) INT ListKeys();
int cloudkeys_googlekms_listkeys(void* lpObj);
int ListKeys();
Remarks
This method lists the keys in the currently-selected KeyRing.
Calling this method will fire the KeyList event once for each key, and will also populate the Key* properties.
If there are still more keys available to list when this method returns, the KeyMarker property will be populated. Continue to call this method until KeyMarker is empty to accumulate all pages of results in the Key* properties.
The MaxKeys configuration setting can be used to control the maximum number of results to return at once.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ListVersions Method (GoogleKMS Class)
Lists the key versions for the specified key.
Syntax
ANSI (Cross Platform) int ListVersions(const char* lpszKeyName); Unicode (Windows) INT ListVersions(LPCWSTR lpszKeyName);
int cloudkeys_googlekms_listversions(void* lpObj, const char* lpszKeyName);
int ListVersions(const QString& qsKeyName);
Remarks
This method lists the key versions for the key specified by KeyName.
Calling this method will fire the VersionList event once for each key version, and will also populate the Version* properties.
If there are still more key versions available to list when this method returns, the VersionMarker property will be populated. Continue to call this method until VersionMarker is empty to accumulate all pages of results in the Version* properties.
The MaxVersions configuration setting can be used to control the maximum number of results to return at once.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Reset Method (GoogleKMS Class)
Resets the class to its initial state.
Syntax
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
int cloudkeys_googlekms_reset(void* lpObj);
int Reset();
Remarks
This method resets the class to its initial state.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SendCustomRequest Method (GoogleKMS Class)
Sends a custom request to the server.
Syntax
ANSI (Cross Platform) int SendCustomRequest(const char* lpszHttpMethod, const char* lpszKeyName, const char* lpszVersionId, const char* lpszAction); Unicode (Windows) INT SendCustomRequest(LPCWSTR lpszHttpMethod, LPCWSTR lpszKeyName, LPCWSTR lpszVersionId, LPCWSTR lpszAction);
int cloudkeys_googlekms_sendcustomrequest(void* lpObj, const char* lpszHttpMethod, const char* lpszKeyName, const char* lpszVersionId, const char* lpszAction);
int SendCustomRequest(const QString& qsHttpMethod, const QString& qsKeyName, const QString& qsVersionId, const QString& qsAction);
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
KeyName and VersionId are optional. The former must be specified if the latter is specified; both are ignored if KeyRing is empty. Action is also optional.
When this method is called, the class does the following:
- Builds a request URL, including query parameters, like https://cloudkms.googleapis.com/v1/projects/{GoogleProjectId}/locations/{Location}[/keyRings/{KeyRing}[/cryptoKeys/{KeyName}[/cryptoKeyVersions/{VersionId}]]][{Action}] using:
- The GoogleProjectId, Location, and (if non-empty) KeyRing properties.
- The KeyName, VersionId, and Action parameters.
- All query parameters from QueryParam*.
- Adds an Authorization header with the value specified by Authorization.
- Adds any request headers from OtherHeaders.
- Adds any request body supplied via the stream specified using SetInputStream, the specified InputFile, or InputData.
- Sends the request to the server.
- Stores the response headers in the ParsedHeader* properties; and the response body in the stream specified using SetOutputStream, the specified OutputFile, or OutputData.
If the response body is JSON data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SetInputStream Method (GoogleKMS Class)
Sets the stream whose data should be processed.
Syntax
ANSI (Cross Platform) int SetInputStream(CloudKeysStream* sInputStream); Unicode (Windows) INT SetInputStream(CloudKeysStream* sInputStream);
int cloudkeys_googlekms_setinputstream(void* lpObj, CloudKeysStream* sInputStream);
int SetInputStream(CloudKeysStream* sInputStream);
Remarks
This method sets the stream whose data should be processed in a cryptographic operation.
Passing a non-null value for InputStream will cause the InputFile property to be cleared. Similarly, setting InputFile to a non-empty value will discard any stream set using this method.
Input Sources & Output Destinations
The class automatically determines the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
The first valid input source found is used. The order in which the output properties are considered is as follows:
- An output stream supplied via the SetOutputStream method
- The OutputFile property
- The OutputData property
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SetOutputStream Method (GoogleKMS Class)
Sets the stream to which output data should be written.
Syntax
ANSI (Cross Platform) int SetOutputStream(CloudKeysStream* sOutputStream); Unicode (Windows) INT SetOutputStream(CloudKeysStream* sOutputStream);
int cloudkeys_googlekms_setoutputstream(void* lpObj, CloudKeysStream* sOutputStream);
int SetOutputStream(CloudKeysStream* sOutputStream);
Remarks
This method sets the stream to which data output from a successful cryptographic operation should be written.
Passing a non-null value for OutputStream will cause the OutputFile property to be cleared. Similarly, setting OutputFile to a non-empty value will discard any stream set using this method.
Input Sources & Output Destinations
The class automatically determines the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- An input stream supplied via the SetInputStream method
- The InputFile property
- The InputData property
The first valid input source found is used. The order in which the output properties are considered is as follows:
- An output stream supplied via the SetOutputStream method
- The OutputFile property
- The OutputData property
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SetPrimaryVersion Method (GoogleKMS Class)
Sets the primary version of a symmetric key.
Syntax
ANSI (Cross Platform) int SetPrimaryVersion(const char* lpszKeyName, const char* lpszVersionId); Unicode (Windows) INT SetPrimaryVersion(LPCWSTR lpszKeyName, LPCWSTR lpszVersionId);
int cloudkeys_googlekms_setprimaryversion(void* lpObj, const char* lpszKeyName, const char* lpszVersionId);
int SetPrimaryVersion(const QString& qsKeyName, const QString& qsVersionId);
Remarks
This method sets the primary version of the symmetric key specified by KeyName to the version identified by VersionId.
A symmetric key's primary version is the one used by the server when Encrypt is called. It can be changed at any time. Asymmetric keys cannot have primary versions.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SetVersionEnabled Method (GoogleKMS Class)
Enables or disables a key version.
Syntax
ANSI (Cross Platform) int SetVersionEnabled(const char* lpszKeyName, const char* lpszVersionId, int bEnabled); Unicode (Windows) INT SetVersionEnabled(LPCWSTR lpszKeyName, LPCWSTR lpszVersionId, BOOL bEnabled);
int cloudkeys_googlekms_setversionenabled(void* lpObj, const char* lpszKeyName, const char* lpszVersionId, int bEnabled);
int SetVersionEnabled(const QString& qsKeyName, const QString& qsVersionId, bool bEnabled);
Remarks
This method enables or disables the key version specified by KeyName and VersionId.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Sign Method (GoogleKMS Class)
Signs a message using a key.
Syntax
ANSI (Cross Platform) int Sign(const char* lpszKeyName, const char* lpszVersionId, const char* lpszAlgorithm, int bIsDigest); Unicode (Windows) INT Sign(LPCWSTR lpszKeyName, LPCWSTR lpszVersionId, LPCWSTR lpszAlgorithm, BOOL bIsDigest);
int cloudkeys_googlekms_sign(void* lpObj, const char* lpszKeyName, const char* lpszVersionId, const char* lpszAlgorithm, int bIsDigest);
int Sign(const QString& qsKeyName, const QString& qsVersionId, const QString& qsAlgorithm, bool bIsDigest);
Remarks
This method signs a message using the asymmetric key version specified by KeyName and VersionId.
The message data to sign is taken from the input stream supplied via the SetInputStream method, the specified InputFile, or the InputData property. The signature data is output to the output stream supplied via the SetOutputStream method, the specified OutputFile, or the OutputData property.
The Algorithm parameter specifies the hash algorithm used to generate a message digest; this must be the same algorithm that appears in the key version's VersionAlgorithm string. The value passed must contain one of the following strings (passing the key version's complete algorithm string is acceptable):
- SHA256
- SHA384
- SHA512
The IsDigest parameter specifies whether the message data is the original message (false) or a message digest (true). When supplying a message digest, keep in mind that the same digest will need to be provided in order to Verify the signature later.
If IsDigest is false, the class will automatically compute an appropriate message digest before the request is made. In such cases, the computed digest is made available via the MessageDigest configuration setting.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
UpdateKey Method (GoogleKMS Class)
Updates a key.
Syntax
ANSI (Cross Platform) int UpdateKey(const char* lpszKeyName, const char* lpszTemplateAlgorithm, int bUpdateLabels); Unicode (Windows) INT UpdateKey(LPCWSTR lpszKeyName, LPCWSTR lpszTemplateAlgorithm, BOOL bUpdateLabels);
int cloudkeys_googlekms_updatekey(void* lpObj, const char* lpszKeyName, const char* lpszTemplateAlgorithm, int bUpdateLabels);
int UpdateKey(const QString& qsKeyName, const QString& qsTemplateAlgorithm, bool bUpdateLabels);
Remarks
This method updates the key specified by KeyName.
The TemplateAlgorithm parameter specifies the algorithm value that the server should use when creating new versions of the key (i.e., when CreateVersion is called). If TemplateAlgorithm is empty, the existing template value remains unchanged; otherwise, TemplateAlgorithm must be one of the following:
- RSA_SIGN_PSS_2048_SHA256: RSASSA-PSS 2048 bit key with a SHA256 digest
- RSA_SIGN_PSS_3072_SHA256: RSASSA-PSS 3072 bit key with a SHA256 digest
- RSA_SIGN_PSS_4096_SHA256: RSASSA-PSS 4096 bit key with a SHA256 digest
- RSA_SIGN_PSS_4096_SHA512: RSASSA-PSS 4096 bit key with a SHA512 digest
- RSA_SIGN_PKCS1_2048_SHA256: RSASSA-PKCS1-v1_5 with a 2048 bit key and a SHA256 digest
- RSA_SIGN_PKCS1_3072_SHA256: RSASSA-PKCS1-v1_5 with a 3072 bit key and a SHA256 digest
- RSA_SIGN_PKCS1_4096_SHA256: RSASSA-PKCS1-v1_5 with a 4096 bit key and a SHA256 digest
- RSA_SIGN_PKCS1_4096_SHA512: RSASSA-PKCS1-v1_5 with a 4096 bit key and a SHA512 digest
- RSA_DECRYPT_OAEP_2048_SHA256: RSAES-OAEP 2048 bit key with a SHA256 digest
- RSA_DECRYPT_OAEP_3072_SHA256: RSAES-OAEP 3072 bit key with a SHA256 digest
- RSA_DECRYPT_OAEP_4096_SHA256: RSAES-OAEP 4096 bit key with a SHA256 digest
- RSA_DECRYPT_OAEP_4096_SHA512: RSAES-OAEP 4096 bit key with a SHA512 digest
- EC_SIGN_P256_SHA256: ECDSA on the NIST P-256 curve with a SHA256 digest
- EC_SIGN_P384_SHA384: ECDSA on the NIST P-384 curve with a SHA384 digest
Refer to Google's CryptoKeyVersionAlgorithm documentation page for more information.
The UpdateLabels parameter determines whether the class replaces the key's current labels with the items in the Label* properties (which may be empty). Keys may have up to 64 labels.
The RotationPeriod and NextRotateDate configuration settings may also be used to send additional values, refer to their documentation for more information.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Verify Method (GoogleKMS Class)
Verifies a digital signature using a key.
Syntax
ANSI (Cross Platform) int Verify(const char* lpszKeyName, const char* lpszVersionId, int bIsDigest); Unicode (Windows) INT Verify(LPCWSTR lpszKeyName, LPCWSTR lpszVersionId, BOOL bIsDigest);
int cloudkeys_googlekms_verify(void* lpObj, const char* lpszKeyName, const char* lpszVersionId, int bIsDigest);
bool Verify(const QString& qsKeyName, const QString& qsVersionId, bool bIsDigest);
Remarks
This method verifies a digital signature using the asymmetric key version specified by KeyName and VersionId. If the signature is successfully verified, this method return true, otherwise it returns false.
The message data is taken from the input stream supplied via the SetInputStream method, the specified InputFile, or the InputData property. The digital signature data is taken from the specified OutputFile or the OutputData property.
The IsDigest parameter specifies whether the message data is the original message (false) or a message digest (true). When a message digest is supplied, keep in mind that it must be the exact same digest that was used at signing time, regardless of whether it has been recomputed.
Google does not support server-side signature verification, so this method will call GetPublicKey internally and then use the public key to verify the digital signature locally. This functionality is offered as a convenience.
Error Handling (C++)
This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
EndTransfer Event (GoogleKMS Class)
This event fires when a document finishes transferring.
Syntax
ANSI (Cross Platform) virtual int FireEndTransfer(GoogleKMSEndTransferEventParams *e);
typedef struct {
int Direction; int reserved; } GoogleKMSEndTransferEventParams;
Unicode (Windows) virtual INT FireEndTransfer(GoogleKMSEndTransferEventParams *e);
typedef struct {
INT Direction; INT reserved; } GoogleKMSEndTransferEventParams;
#define EID_GOOGLEKMS_ENDTRANSFER 1 virtual INT CLOUDKEYS_CALL FireEndTransfer(INT &iDirection);
class GoogleKMSEndTransferEventParams { public: int Direction(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void EndTransfer(GoogleKMSEndTransferEventParams *e);
// Or, subclass GoogleKMS and override this emitter function. virtual int FireEndTransfer(GoogleKMSEndTransferEventParams *e) {...}
Remarks
The EndTransfer event is fired when the document text finishes transferring from the server to the local host.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
Error Event (GoogleKMS Class)
Information about errors during data delivery.
Syntax
ANSI (Cross Platform) virtual int FireError(GoogleKMSErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } GoogleKMSErrorEventParams;
Unicode (Windows) virtual INT FireError(GoogleKMSErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } GoogleKMSErrorEventParams;
#define EID_GOOGLEKMS_ERROR 2 virtual INT CLOUDKEYS_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class GoogleKMSErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(GoogleKMSErrorEventParams *e);
// Or, subclass GoogleKMS and override this emitter function. virtual int FireError(GoogleKMSErrorEventParams *e) {...}
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
Header Event (GoogleKMS Class)
This event is fired every time a header line comes in.
Syntax
ANSI (Cross Platform) virtual int FireHeader(GoogleKMSHeaderEventParams *e);
typedef struct {
const char *Field;
const char *Value; int reserved; } GoogleKMSHeaderEventParams;
Unicode (Windows) virtual INT FireHeader(GoogleKMSHeaderEventParams *e);
typedef struct {
LPCWSTR Field;
LPCWSTR Value; INT reserved; } GoogleKMSHeaderEventParams;
#define EID_GOOGLEKMS_HEADER 3 virtual INT CLOUDKEYS_CALL FireHeader(LPSTR &lpszField, LPSTR &lpszValue);
class GoogleKMSHeaderEventParams { public: const QString &Field(); const QString &Value(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Header(GoogleKMSHeaderEventParams *e);
// Or, subclass GoogleKMS and override this emitter function. virtual int FireHeader(GoogleKMSHeaderEventParams *e) {...}
Remarks
The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.
If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).
KeyList Event (GoogleKMS Class)
Fires once for each key when listing keys.
Syntax
ANSI (Cross Platform) virtual int FireKeyList(GoogleKMSKeyListEventParams *e);
typedef struct {
const char *Name;
int Purpose;
const char *CreationDate;
const char *PrimaryVersion; int reserved; } GoogleKMSKeyListEventParams;
Unicode (Windows) virtual INT FireKeyList(GoogleKMSKeyListEventParams *e);
typedef struct {
LPCWSTR Name;
INT Purpose;
LPCWSTR CreationDate;
LPCWSTR PrimaryVersion; INT reserved; } GoogleKMSKeyListEventParams;
#define EID_GOOGLEKMS_KEYLIST 4 virtual INT CLOUDKEYS_CALL FireKeyList(LPSTR &lpszName, INT &iPurpose, LPSTR &lpszCreationDate, LPSTR &lpszPrimaryVersion);
class GoogleKMSKeyListEventParams { public: const QString &Name(); int Purpose(); const QString &CreationDate(); const QString &PrimaryVersion(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void KeyList(GoogleKMSKeyListEventParams *e);
// Or, subclass GoogleKMS and override this emitter function. virtual int FireKeyList(GoogleKMSKeyListEventParams *e) {...}
Remarks
This event fires once for each key returned when ListKeys or GetKeyInfo is called.
Name reflects the name of the key.
Purpose reflects the key's purpose. Possible values are:
- 0: Unspecified.
- 1: A symmetric key used for encryption and decryption.
- 2: An asymmetric key used for signing and verification.
- 3: An asymmetric key used for encryption and decryption.
CreationDate reflects the key's creation date, formatted as an RFC 3339 UTC timestamp.
PrimaryVersion reflects the Id of the key's primary version if it is symmetric. For asymmetric keys, it is always empty, since asymmetric keys cannot have a primary version.
KeyRingList Event (GoogleKMS Class)
Fires once for each key ring when listing key rings.
Syntax
ANSI (Cross Platform) virtual int FireKeyRingList(GoogleKMSKeyRingListEventParams *e);
typedef struct {
const char *Name;
const char *CreationDate; int reserved; } GoogleKMSKeyRingListEventParams;
Unicode (Windows) virtual INT FireKeyRingList(GoogleKMSKeyRingListEventParams *e);
typedef struct {
LPCWSTR Name;
LPCWSTR CreationDate; INT reserved; } GoogleKMSKeyRingListEventParams;
#define EID_GOOGLEKMS_KEYRINGLIST 5 virtual INT CLOUDKEYS_CALL FireKeyRingList(LPSTR &lpszName, LPSTR &lpszCreationDate);
class GoogleKMSKeyRingListEventParams { public: const QString &Name(); const QString &CreationDate(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void KeyRingList(GoogleKMSKeyRingListEventParams *e);
// Or, subclass GoogleKMS and override this emitter function. virtual int FireKeyRingList(GoogleKMSKeyRingListEventParams *e) {...}
Remarks
This event fires once for each key ring returned when ListKeyRings or GetKeyRingInfo is called.
Name reflects the name of the key ring.
CreationDate reflects the key ring's creation date, formatted as an RFC 3339 UTC timestamp.
LabelList Event (GoogleKMS Class)
Fires once for each label returned when a key's information is retrieved.
Syntax
ANSI (Cross Platform) virtual int FireLabelList(GoogleKMSLabelListEventParams *e);
typedef struct {
const char *KeyName;
const char *Name;
const char *Value; int reserved; } GoogleKMSLabelListEventParams;
Unicode (Windows) virtual INT FireLabelList(GoogleKMSLabelListEventParams *e);
typedef struct {
LPCWSTR KeyName;
LPCWSTR Name;
LPCWSTR Value; INT reserved; } GoogleKMSLabelListEventParams;
#define EID_GOOGLEKMS_LABELLIST 6 virtual INT CLOUDKEYS_CALL FireLabelList(LPSTR &lpszKeyName, LPSTR &lpszName, LPSTR &lpszValue);
class GoogleKMSLabelListEventParams { public: const QString &KeyName(); const QString &Name(); const QString &Value(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void LabelList(GoogleKMSLabelListEventParams *e);
// Or, subclass GoogleKMS and override this emitter function. virtual int FireLabelList(GoogleKMSLabelListEventParams *e) {...}
Remarks
This event fires once for each label returned when GetKeyInfo is called.
KeyName reflects the name of the key.
Name reflects the name of the label.
Value reflects the value of the label.
Log Event (GoogleKMS Class)
This event fires once for each log message.
Syntax
ANSI (Cross Platform) virtual int FireLog(GoogleKMSLogEventParams *e);
typedef struct {
int LogLevel;
const char *Message;
const char *LogType; int reserved; } GoogleKMSLogEventParams;
Unicode (Windows) virtual INT FireLog(GoogleKMSLogEventParams *e);
typedef struct {
INT LogLevel;
LPCWSTR Message;
LPCWSTR LogType; INT reserved; } GoogleKMSLogEventParams;
#define EID_GOOGLEKMS_LOG 7 virtual INT CLOUDKEYS_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);
class GoogleKMSLogEventParams { public: int LogLevel(); const QString &Message(); const QString &LogType(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Log(GoogleKMSLogEventParams *e);
// Or, subclass GoogleKMS and override this emitter function. virtual int FireLog(GoogleKMSLogEventParams *e) {...}
Remarks
This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.
LogLevel indicates the level of message. Possible values are as follows:
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data are logged. |
3 (Debug) | Debug data are logged. |
The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.
The value 2 (Verbose) logs additional information about the request and response.
The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).
Message is the log entry.
LogType identifies the type of log entry. Possible values are as follows:
- "Info"
- "RequestHeaders"
- "ResponseHeaders"
- "RequestBody"
- "ResponseBody"
- "ProxyRequest"
- "ProxyResponse"
- "FirewallRequest"
- "FirewallResponse"
SSLServerAuthentication Event (GoogleKMS Class)
Fired after the server presents its certificate to the client.
Syntax
ANSI (Cross Platform) virtual int FireSSLServerAuthentication(GoogleKMSSSLServerAuthenticationEventParams *e);
typedef struct {
const char *CertEncoded; int lenCertEncoded;
const char *CertSubject;
const char *CertIssuer;
const char *Status;
int Accept; int reserved; } GoogleKMSSSLServerAuthenticationEventParams;
Unicode (Windows) virtual INT FireSSLServerAuthentication(GoogleKMSSSLServerAuthenticationEventParams *e);
typedef struct {
LPCSTR CertEncoded; INT lenCertEncoded;
LPCWSTR CertSubject;
LPCWSTR CertIssuer;
LPCWSTR Status;
BOOL Accept; INT reserved; } GoogleKMSSSLServerAuthenticationEventParams;
#define EID_GOOGLEKMS_SSLSERVERAUTHENTICATION 8 virtual INT CLOUDKEYS_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);
class GoogleKMSSSLServerAuthenticationEventParams { public: const QByteArray &CertEncoded(); const QString &CertSubject(); const QString &CertIssuer(); const QString &Status(); bool Accept(); void SetAccept(bool bAccept); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSLServerAuthentication(GoogleKMSSSLServerAuthenticationEventParams *e);
// Or, subclass GoogleKMS and override this emitter function. virtual int FireSSLServerAuthentication(GoogleKMSSSLServerAuthenticationEventParams *e) {...}
Remarks
During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
SSLStatus Event (GoogleKMS Class)
Shows the progress of the secure connection.
Syntax
ANSI (Cross Platform) virtual int FireSSLStatus(GoogleKMSSSLStatusEventParams *e);
typedef struct {
const char *Message; int reserved; } GoogleKMSSSLStatusEventParams;
Unicode (Windows) virtual INT FireSSLStatus(GoogleKMSSSLStatusEventParams *e);
typedef struct {
LPCWSTR Message; INT reserved; } GoogleKMSSSLStatusEventParams;
#define EID_GOOGLEKMS_SSLSTATUS 9 virtual INT CLOUDKEYS_CALL FireSSLStatus(LPSTR &lpszMessage);
class GoogleKMSSSLStatusEventParams { public: const QString &Message(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSLStatus(GoogleKMSSSLStatusEventParams *e);
// Or, subclass GoogleKMS and override this emitter function. virtual int FireSSLStatus(GoogleKMSSSLStatusEventParams *e) {...}
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
StartTransfer Event (GoogleKMS Class)
This event fires when a document starts transferring (after the headers).
Syntax
ANSI (Cross Platform) virtual int FireStartTransfer(GoogleKMSStartTransferEventParams *e);
typedef struct {
int Direction; int reserved; } GoogleKMSStartTransferEventParams;
Unicode (Windows) virtual INT FireStartTransfer(GoogleKMSStartTransferEventParams *e);
typedef struct {
INT Direction; INT reserved; } GoogleKMSStartTransferEventParams;
#define EID_GOOGLEKMS_STARTTRANSFER 10 virtual INT CLOUDKEYS_CALL FireStartTransfer(INT &iDirection);
class GoogleKMSStartTransferEventParams { public: int Direction(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void StartTransfer(GoogleKMSStartTransferEventParams *e);
// Or, subclass GoogleKMS and override this emitter function. virtual int FireStartTransfer(GoogleKMSStartTransferEventParams *e) {...}
Remarks
The StartTransfer event is fired when the document text starts transferring from the server to the local host.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
Transfer Event (GoogleKMS Class)
This event is fired while a document transfers (delivers document).
Syntax
ANSI (Cross Platform) virtual int FireTransfer(GoogleKMSTransferEventParams *e);
typedef struct {
int Direction;
int64 BytesTransferred;
int PercentDone;
const char *Text; int lenText; int reserved; } GoogleKMSTransferEventParams;
Unicode (Windows) virtual INT FireTransfer(GoogleKMSTransferEventParams *e);
typedef struct {
INT Direction;
LONG64 BytesTransferred;
INT PercentDone;
LPCSTR Text; INT lenText; INT reserved; } GoogleKMSTransferEventParams;
#define EID_GOOGLEKMS_TRANSFER 11 virtual INT CLOUDKEYS_CALL FireTransfer(INT &iDirection, LONG64 &lBytesTransferred, INT &iPercentDone, LPSTR &lpText, INT &lenText);
class GoogleKMSTransferEventParams { public: int Direction(); qint64 BytesTransferred(); int PercentDone(); const QByteArray &Text(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Transfer(GoogleKMSTransferEventParams *e);
// Or, subclass GoogleKMS and override this emitter function. virtual int FireTransfer(GoogleKMSTransferEventParams *e) {...}
Remarks
The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.
The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.
Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.
VersionList Event (GoogleKMS Class)
Fires once for each key version when listing key versions.
Syntax
ANSI (Cross Platform) virtual int FireVersionList(GoogleKMSVersionListEventParams *e);
typedef struct {
const char *Name;
const char *VersionId;
const char *State;
const char *Algorithm;
const char *ProtectionLevel;
const char *CreationDate;
const char *DestructionDate; int reserved; } GoogleKMSVersionListEventParams;
Unicode (Windows) virtual INT FireVersionList(GoogleKMSVersionListEventParams *e);
typedef struct {
LPCWSTR Name;
LPCWSTR VersionId;
LPCWSTR State;
LPCWSTR Algorithm;
LPCWSTR ProtectionLevel;
LPCWSTR CreationDate;
LPCWSTR DestructionDate; INT reserved; } GoogleKMSVersionListEventParams;
#define EID_GOOGLEKMS_VERSIONLIST 12 virtual INT CLOUDKEYS_CALL FireVersionList(LPSTR &lpszName, LPSTR &lpszVersionId, LPSTR &lpszState, LPSTR &lpszAlgorithm, LPSTR &lpszProtectionLevel, LPSTR &lpszCreationDate, LPSTR &lpszDestructionDate);
class GoogleKMSVersionListEventParams { public: const QString &Name(); const QString &VersionId(); const QString &State(); const QString &Algorithm(); const QString &ProtectionLevel(); const QString &CreationDate(); const QString &DestructionDate(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void VersionList(GoogleKMSVersionListEventParams *e);
// Or, subclass GoogleKMS and override this emitter function. virtual int FireVersionList(GoogleKMSVersionListEventParams *e) {...}
Remarks
This event fires once for each key version returned when ListVersions or GetVersionInfo is called.
Name reflects the name of the key.
VersionId reflects the Id of the key version.
State reflects the state of the key version. Possible values are:
- PENDING_GENERATION: The version is still being generated, and cannot be used yet. Once generation has finished, it will become ENABLED.
- ENABLED: The version is enabled and available for use.
- DISABLED: The version is disabled; it cannot be used unless it is enabled again. It may be destroyed.
- DESTROY_SCHEDULED: The version's cryptographic material is scheduled for destruction, and will be destroyed at the time reflected by unless CancelDestruction before then.
- DESTROYED: The version's cryptographic material has been destroyed, and the version is no longer usable. This state is permanent once entered.
- PENDING_IMPORT*: Cryptographic material has not finished importing, and the version cannot be used yet. Once the import has finished, it will become ENABLED.
- IMPORT_FAILED*: The version was not imported successfully; it cannot be used, and any imported cryptographic material has been discarded.
Algorithm reflects the key version's algorithm. For symmetric keys, this will always be GOOGLE_SYMMETRIC_ENCRYPTION. For asymmetric keys, this value describes both the key type and the algorithm that must be used during cryptographic operations, and possible values are:
- RSA_SIGN_PSS_2048_SHA256: RSASSA-PSS 2048 bit key with a SHA256 digest
- RSA_SIGN_PSS_3072_SHA256: RSASSA-PSS 3072 bit key with a SHA256 digest
- RSA_SIGN_PSS_4096_SHA256: RSASSA-PSS 4096 bit key with a SHA256 digest
- RSA_SIGN_PSS_4096_SHA512: RSASSA-PSS 4096 bit key with a SHA512 digest
- RSA_SIGN_PKCS1_2048_SHA256: RSASSA-PKCS1-v1_5 with a 2048 bit key and a SHA256 digest
- RSA_SIGN_PKCS1_3072_SHA256: RSASSA-PKCS1-v1_5 with a 3072 bit key and a SHA256 digest
- RSA_SIGN_PKCS1_4096_SHA256: RSASSA-PKCS1-v1_5 with a 4096 bit key and a SHA256 digest
- RSA_SIGN_PKCS1_4096_SHA512: RSASSA-PKCS1-v1_5 with a 4096 bit key and a SHA512 digest
- RSA_DECRYPT_OAEP_2048_SHA256: RSAES-OAEP 2048 bit key with a SHA256 digest
- RSA_DECRYPT_OAEP_3072_SHA256: RSAES-OAEP 3072 bit key with a SHA256 digest
- RSA_DECRYPT_OAEP_4096_SHA256: RSAES-OAEP 4096 bit key with a SHA256 digest
- RSA_DECRYPT_OAEP_4096_SHA512: RSAES-OAEP 4096 bit key with a SHA512 digest
- EC_SIGN_P256_SHA256: ECDSA on the NIST P-256 curve with a SHA256 digest
- EC_SIGN_P384_SHA384: ECDSA on the NIST P-384 curve with a SHA384 digest
Refer to Google's CryptoKeyVersionAlgorithm documentation page for more information.
ProtectionLevel reflects the key version's protection level. Possible values are:
- SOFTWARE
- HSM
- EXTERNAL
CreationDate reflects the key version's creation date, formatted as an RFC 3339 UTC timestamp.
DestructionDate reflects the date at which the key version's cryptographic material was (or will be) destroyed, formatted as an RFC 3339 UTC timestamp; or empty string if the key version's cryptographic material has not been, and is not scheduled to be, destroyed.
CloudKeysStream Type
Syntax
CloudKeysStream (declared in cloudkeys.h)
Remarks
The GoogleKMS class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the CloudKeysStream interface and pass the GoogleKMS class an instance of that concrete class.
When implementing the CloudKeysStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.
Config Settings (GoogleKMS Class)
The class accepts one or more of the following configuration settings. Configuration 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.GoogleKMS Config Settings
This setting controls how the class behaves when listing multiple pages of results. If this setting is enabled, each successive page of results will be appended to the appropriate collection properties until the last page of results has been listed (at which point the next list call will cause said collection to be cleared first). If this setting is disabled, the collection will be cleared every time a page of results is returned.
By default, this setting is enabled, allowing all pages of results to be accumulated in the appropriate collection properties.
Normally, the Encrypt method detects whether to perform symmetric or asymmetric encryption based on whether the VersionId parameter is empty (symmetric) or non-empty (asymmetric). Enabling this setting will force symmetric encryption to be performed even if VersionId is non-empty, allowing a non-primary version of a symmetric encryption key to be used.
By default, this setting is disabled.
This setting specifies the maximum number of results that should be returned by a call to ListKeyRings.
If this setting is -1 (default), the server chooses an appropriate default. Otherwise, the setting must be set to a value greater than or equal to 1.
This setting specifies the maximum number of results that should be returned by a call to ListKeys.
If this setting is -1 (default), the server chooses an appropriate default. Otherwise, the setting must be set to a value greater than or equal to 1.
This setting specifies the maximum number of results that should be returned by a call to ListVersions.
If this setting is -1 (default), the server chooses an appropriate default. Otherwise, the setting must be set to a value greater than or equal to 1.
This setting can be queried after calling Sign or Verify to obtain the (hex-encoded) message digest computed by the class during the call. If the class did not generate a message digest as part of the call, an empty string will be returned.
This setting specifies the next rotation date to send when CreateKey or UpdateKey is called. If non-empty, it must be formatted as an RFC 3339 UTC timestamp.
If this setting is set, and CreateKey is being called, then the RotationPeriod setting must also be set. When UpdateKey is called, this restriction does not apply.
Note that automatic rotation is only supported for symmetric keys. When CreateKey is called, this setting is only used if the value passed for the Purpose parameter is 1. When UpdateKey is called, no such safeguard exists; it is up to the application to ensure that this setting is not populated when updating an asymmetric key.
This setting holds the lifetime of the access token in seconds. For instance the value 3600 indicates that the token will expire in one hour from the time it was generated.
The applicable values include the following:
Bearer (default) | When the access token returned by the server is a Bearer type, the authorization string returned by Authorize will be in the format "Bearer access_token". This can be supplied as the value of the HTTP Authorization header. |
When this setting is set to true and the Authorization property is not set, the class will automatically get a new access token if it has the necessary properties to do so without user interaction.
For example, when using the Authorization Code grant type, the OAuthRefreshToken property should be set to a valid refresh token. When using the Client Credential grant type however, the class does not need any additional properties set as it can already get a new access token without user interaction.
This setting specifies the amount of time (in seconds) the class will wait for a response from the browser when requesting user authentication. The default value is 0, meaning that the class will wait indefinitely.
This setting specifies whether redirect_uri is included in the request made by Authorize if it is empty.
If set to true (default) the redirect_uri will be sent in all cases. If set to false the redirect_uri will only be sent if it has a value.
This configuration setting provides the payload section of a JWT access token if the access token is a JWT and the class is able to parse out the payload section. This setting only applies to access tokens that are returned from a service provider after successfully authorizing and authenticating with the service.
To parse the payload for specific claims, see OAuthJWTXPath.
The number of child attributes of the current element. The OAuthJWTXChildCount configuration settings will be indexed from 0 to (OAuthJWTXChildCount - 1).
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
Provides the name of the i'th child element of the current element.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
Provides the inner text of the i'th child element of the current element.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
Provides the name of the current element.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
Provides the parent of the current element.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The JWTXPath setting allows you to point to specific claims within the payload of a JWT based access token.
XPath Syntax
XPath syntax is available for the payload of JWT based access tokens if available. An XPath is a series of one or more element accessors separated by the / character, for example: /A/B/C/D.
The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors which proceed it in the overall XPath string:
Accessor | Description |
name | The first element with a particular name. Can be *. |
[i] | The i-th element. |
name[i] | The i-th element with a particular name. |
[last()] | The last element. |
[last()-i] | The element i before the last element. |
Description | JSON XPath |
Document root | /json |
Specific element | /json/element_one |
Username Claim (Microsoft Specific) | /json/preferred_username |
Registered Application Name Claim (Microsoft Specific) | /json/app_displayname |
This is not an exhaustive list by any means, but should provide a general idea of the possibilities. To get the text of the specified element, see JWTXText.
Provides the entirety of the current element (including its sub-elements).
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
Provides the inner text of the current element.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
This setting can be used to add query string parameters to the outgoing request. One common use for this method would be to add the "state" parameter to the request, which can be used when the OAuthClientProfile is ocpWeb to add user defined data. The authorization server will include the "state" parameter in the response and will be available in the post back to your server which will allow you to maintain state in your application. This is used in conjunction with OAuthParamName[i] and OAuthParamValue[i]. For instance:
component.Config("OAuthParamCount=2");
component.Config("OAuthParamName[0]=myvar");
component.Config("OAuthParamValue[0]=myvalue");
component.Config("OAuthParamName[1]=testname");
component.Config("OAuthParamValue[1]=testvalue");
Addtionally, this will also be updated to hold the parameters returned in the response.
for (int i = 0; i < int.Parse(component.Config("OAuthParamCount")); i++)
{
string name = component.Config("OAuthParamName["+i+"]");
string value = component.Config("OAuthParamValue[" + i + "]");
}
This setting can be used to retrieve or specify the parameter variable name at the index specified. See OAuthParamCount for details.
This setting can be used to retrieve or specify the parameter variable value at the index specified. See OAuthParamCount for details.
Used to set the username property when the OAuthGrantType is set to the password grant type and Authorize is called.
This setting controls the PKCE code challenge method used when OAuthUsePKCE is set to true. Possible values are:
- 1 (Plain)
- 2 (S256/SHA256 - default)
This configuration setting when queried provides the PKCE verifier that is used to generate the PKCE challenge for the Authorize method and the OAuthWebAuthURL field when OAuthUsePKCE is set to true. When using the cocpWeb OAuthClientProfile, the configuration setting can be set instead to allow the authorization request to be made from a different instance than the authentication (token) request.
If set to true (default), the same embedded web server instance will be used for multiple requests. If set to false the embedded web server will be created and destroyed on each call to Authorize
If set to true (default), Proof Key for Code Exchange (PKCE) defined by RFC 7636 will be used when performing authorization. This setting applies when using the Authorization Code OAuthGrantType. The OAuthPKCEChallengeEncoding configuration setting can be used to control the code challenge method that will be used.
The setting when queried will return the current state of the web server. If the webserver is active, it will return "true" and if it is inactive it will return "false".
This setting can also be set to activate or deactivate the web server. Under normal circumstances, this would not be required as the class will automatically start and stop the web server when Authorize is called. In certain cases, it is required to start the webserver before calling Authorize. For example, if the OAuthReturnURL needs to be set to a relay server, then you will need to start the web server manually. Another example would be when the OAuthReUseWebServer is set to true, the server will not be automatically stopped, and this configuration setting must be set to "false" to stop the embedded web server.
The name of the certificate store used for the embedded web server's SSL.
The OAuthWebServerCertStoreType property specifies the type of the certificate store specified by OAuthWebServerCertStore. If the store is password protected, specify the password in OAuthWebServerCertStorePassword.
OAuthWebServerCertStore is used in conjunction with the OAuthWebServerCertSubject property in order to specify the certificate to be used during SSL.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
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).
Note: This is required when OAuthWebServerSSLEnabled is set to true.
If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
Note: This is only applicable when OAuthWebServerSSLEnabled is set to true.
This specifies the type of certificate store. Possible values are:
0 | User - This is the default for Windows. This specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java. |
1 | Machine - For Windows, this specifies that the certificate store is a machine store. Note: This store type is not available in Java. |
2 | PFXFile - The certificate store is the name of a PFX (PKCS12) file containing certificates. |
3 | PFXBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS12) format. |
4 | JKSFile - The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: This store type is available only in Java. |
5 | JKSBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: This store type is available only in Java. |
6 | PEMKeyFile - The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 | PEMKeyBlob - The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
14 | PPKFile - The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 | PPKBlob - The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 | XMLFile - The certificate store is the name of a file that contains a certificate in XML format. |
17 | XMLBlob - The certificate store is a string that contains a certificate in XML format. |
The subject of the SSL certificate.
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:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Note: This is required when OAuthWebServerSSLEnabled is set to true.
When Authorize is called the user will be redirected to the embedded web server upon completing authentication with the authorization server. If authentication failed, the HTML specified here will be sent to the user's browser.
This setting specifies the hostname used by the embedded web server when OAuthClientProfile is set to cocpApplication. This specifies the interface on which the embedded web server listens, and also the value displayed in the OAuthReturnURL. This should be set to the hostname only, not the full URL.
The default value is localhost.
This property specifies the port on which the embedded web server listens. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be returned when this setting is queried after the server has started listening.This is only applicable when using the embedded web server.
When Authorize is called the user will be redirected to the embedded web server upon completing authentication with the authorization server. This setting allows you to specify the HTML that will be sent to the user's browser.
This setting specifies whether the embedded web server will use SSL. If set to True OAuthWebServerCert* configs are required and the server will only accept SSL connections. If set to False only plaintext connects are supported.
This setting may be queried after calling any method that sends data to the server to obtain the request data that was transmitted. Such data may be useful for troubleshooting purposes.
This setting may be queried after calling any method that sends data to the server to obtain the response data that was received. Such data may be useful for troubleshooting purposes.
This setting specifies the rotation period to send when CreateKey or UpdateKey is called. If non-empty, it must be formatted as a number of seconds with up to nine fractional digits and a trailing s (e.g., 3.5984s). The minimum rotation period is 24 hours; the maximum rotation period is 876,000 hours.
If this setting is set, and CreateKey is being called, then the NextRotateDate setting must also be set. When UpdateKey is called, this restriction does not apply.
Note that automatic rotation is only supported for symmetric keys. When CreateKey is called, this setting is only used if the value passed for the Purpose parameter is 1. When UpdateKey is called, no such safeguard exists; it is up to the application to ensure that this setting is not populated when updating an asymmetric key.
The number of child attributes of the current element. The XChild configuration settings will be indexed from 0 to (XChildCount - 1).
The current element is specified via the XPath configuration setting. This configuration setting is read-only.
Provides the name of the i'th child element of the current element.
The current element is specified via the XPath configuration setting. This configuration setting is read-only.
Provides the inner text of the i'th child element of the current element.
The current element is specified via the XPath configuration setting. This configuration setting is read-only.
Provides the name of the current element.
The current element is specified via the XPath configuration setting. This configuration setting is read-only.
Provides the parent of the current element.
The current element is specified via the XPath configuration setting. This configuration setting is read-only.
The XPath setting allows you to point to specific elements in the XML or JSON response.
When XPath is set to a valid path, XElement points to the name of the element, with XText, XParent, XSubTree, XChildCount, XChildName[i], and XChildXText[i] providing other properties of the element.
XPath Syntax
XPath syntax is available for both XML and JSON documents. An XPath is a series of one or more element accessors separated by the / character, for example: /A/B/C/D. An XPath can be absolute (i.e., it starts with /), or it can be relative to the current XPath location.
The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors which proceed it in the overall XPath string:
Accessor | Description |
name | The first element with a particular name. Can be *. |
[i] | The i-th element. |
name[i] | The i-th element with a particular name. |
[last()] | The last element. |
[last()-i] | The element i before the last element. |
name[@attrname="attrvalue"] | The first element with a particular name that contains the specified attribute-value pair.
Supports single and double quotes. (XML Only) |
. | The current element. |
.. | The parent element. |
XPath Examples
Assuming the following XML response:
<firstlevel> <one>value</one> <two> <item>first</item> <item>second</item> </two> <three>value three</three> </firstlevel>
Or, alternatively, the following JSON response:
{ "firstlevel": { "one": "value", "two": ["first", "second"], "three": "value three" } }
Here are some examples of valid XPaths:
Description | XML XPath | JSON XPath |
Document root | / | /json |
Specific element | /firstlevel/one | /json/firstlevel/one |
i-th child | /firstlevel/two/item[2] | /json/firstlevel/two/[2] |
This is not an exhaustive list by any means, but should provide a general idea of the possibilities.
Provides the entirety of the current element (including its sub-elements).
The current element is specified via the XPath configuration setting. This configuration setting is read-only.
Provides the inner text of the current element.
The current element is specified in the XPath configuration setting. This configuration setting is read-only.
HTTP Config Settings
When AllowHTTPCompression is True, the class adds an Accept-Encoding header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the Accept-Encoding header. Note: The class only supports gzip and deflate decompression algorithms.
This configuration setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms.
When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".
The default value is True.
This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0".
If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class fails with an error if the server does not support HTTP/2.
The default value is True.
This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False.
If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.
This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.
The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".
This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the Transfer event, by BytesTransferred.
This is applicable only when UseChunkedEncoding is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.
If set to True, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.
The default value is False.
If set to True, the URL passed to the class will be URL encoded. The default value is False.
This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time.
If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the class fails with an error.
Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.
Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.
A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).
The default value is 0 (Never). In this case, redirects are never followed, and the class fails with an error instead.
Following are the valid options:
- 0 - Never
- 1 - Always
- 2 - Same Scheme
The default value is False. If set to True, the class will perform a GET on the new location. Otherwise, it will use the same HTTP method again.
HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.
This property specifies the HTTP version used by the class. Possible values are as follows:
- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"
When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.
HTTP/2 Notes
When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.
If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.
HTTP/3 Notes
HTTP/3 is supported only in .NET and Java.
When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.
If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
If true, the component will not send the Connection: Close header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. Note: Not all servers support persistent connections. If false, the connection will be closed immediately after the server response is received.
The default value for KeepAlive is false.
If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.
This configuration setting controls the level of detail that is logged through the Log event. Possible values are as follows:
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data are logged. |
3 (Debug) | Debug data are logged. |
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).
When FollowRedirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20.
This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used.
This configuration setting can be set to a string of headers to be appended to the HTTP request headers.
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 configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.
This configuration setting is useful for extending the functionality of the class beyond what is provided.
This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If ProxyUser and ProxyPassword are specified, this value is calculated using the algorithm specified by ProxyAuthScheme.
This configuration setting is provided for use by classs that do not directly expose Proxy properties.
This configuration setting is provided for use by classs that do not directly expose Proxy properties.
This configuration setting is provided for use by classs that do not directly expose Proxy properties.
This configuration setting is provided for use by classs that do not directly expose Proxy properties.
This configuration setting is provided for use by classs that do not directly expose Proxy properties.
This configuration setting returns the complete set of raw headers as sent by the client.
This configuration setting contains the result code of the last response from the server.
This setting contains the first line of the last response from the server. The format of the line will be [HTTP version] [Result Code] [Description].
This configuration setting contains the contents of the last response from the server.
If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class.
This configuration setting returns the complete set of raw headers as received from the server.
This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:
.NET
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
C++
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
If UseChunkedEncoding is set to True, the class will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the class will not use HTTP-chunked encoding. The default value is False.
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).
The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001. In the C++ Edition for Windows, the *W version of the class must be used. For instance, DNSW or HTTPW.
When using this configuration setting, if True, the component will use the default HTTP client for the platform (URLConnection in Java, WebRequest in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine).
Note: This setting is applicable only to Mac/iOS editions.
This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and ProxyAutoDetect is set to True.
When True (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.
This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".
Override the default with the name and version of your software.
TCPClient Config Settings
When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data.
This configuration setting is provided for use by classs that do not directly expose Firewall properties.
If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
The FirewallPort is set automatically when FirewallType is set to a valid value.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.
The appropriate values are as follows:
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.
Note: This value is not applicable in macOS.
When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the number of times that the keep-alive packets will be sent before the remote host is considered disconnected. The system default if this value is not specified here is 9.
Note: This configuration setting is only available in the Unix platform. It is not supported in masOS or FreeBSD.
When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.
This property controls how a connection is closed. The default is True.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.
The LocalHost setting 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 setting 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).
This must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.
LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.
MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.
If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.
If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.
This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.
This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:
www.google.com;www.nsoftware.com
If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.
Note: This value is not applicable in Java.
When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.
By default, this config is set to false.
When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are:
0 | IPv4 Only |
1 | IPv6 Only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
When SSLProvider is set to Internal, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes.
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.
Enabling this setting has no effect if SSLProvider is set to Platform.
This functionality is available only when the provider is OpenSSL.
The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
This functionality is available only when the provider is OpenSSL.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
This functionality is available only when the provider is OpenSSL.
The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".
This functionality is available only when the provider is OpenSSL.
By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.
If set to true, the class will reuse the context if and only if the following criteria are met:
- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the class is the same.
This setting specifies the paths on disk to CA certificate files on Unix/Linux.
The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.
The default value is:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
This setting specifies one or more CA certificates to be included in the request when performing SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.
Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.
Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.
The enabled cipher suites to be used in SSL negotiation.
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Example values when SSLProvider is set to Platform:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when SSLProvider is set to Platform include:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
- TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
Used to enable/disable the supported security protocols.
Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default) |
TLS1.1 | 768 (Hex 300) (Default) |
TLS1 | 192 (Hex C0) (Default) |
SSL3 | 48 (Hex 30) [Platform Only] |
SSL2 | 12 (Hex 0C) [Platform Only] |
SSLEnabledProtocols - TLS 1.3 Notes
By default when TLS 1.3 is enabled the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions which are designed to run on Windows SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider) please be aware of the following notes:
- The platform provider is only available on Windows 11 / Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This setting is true by default, but can be set to false to disable the extension.
This setting is only applicable when SSLProvider is set to Internal.
This setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event.
If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
This setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.
When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values.
Note: This setting is only applicable when SSLProvider is set to Internal.
Returns the cipher suite negotiated during the SSL handshake.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Returns the strength of the cipher suite negotiated during the SSL handshake.
Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Returns the cipher suite negotiated during the SSL handshake represented as a single string.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Returns the key exchange algorithm negotiated during the SSL handshake.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Returns the protocol version negotiated during the SSL handshake.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:
0x00000001 | Ignore time validity status of certificate. |
0x00000002 | Ignore time validity status of CTL. |
0x00000004 | Ignore non-nested certificate times. |
0x00000010 | Allow unknown Certificate Authority. |
0x00000020 | Ignore wrong certificate usage. |
0x00000100 | Ignore unknown certificate revocation status. |
0x00000200 | Ignore unknown CTL signer revocation status. |
0x00000400 | Ignore unknown Certificate Authority revocation status. |
0x00000800 | Ignore unknown Root revocation status. |
0x00008000 | Allow test Root certificate. |
0x00004000 | Trust test Root certificate. |
0x80000000 | Ignore non-matching CN (certificate CN not-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.
The value of this setting is a newline (CrLf) separated list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
This setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.
When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class fails with an error.
The format of this value is a comma separated list of hash-signature combinations. For instance:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server.
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.
In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
This setting holds a comma separated list of allowed signature algorithms. Possible values are:
- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)
This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
Socket Config Settings
If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.
Note: This option is not valid for UDP ports.
When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).
This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Base Config Settings
When queried, this setting will return a string containing information about the product's build.
The default code page is Unicode UTF-8 (65001).
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.
If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.
When set to true, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle FIPS, while all the other Windows editions make use of Microsoft security libraries.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting which applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.
For more details please see the FIPS 140-2 Compliance article.
Note: This setting is only applicable on Windows.
Note: Enabling FIPS-compliance requires a special license; please contact sales@nsoftware.com for details.
When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.
Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
Trappable Errors (GoogleKMS Class)
Error Handling (C++)
Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Common Errors
600 A server error occurred, and/or the class was unable to process the server's response. Please refer to the error message for more information. | |
601 An unsupported operation or action was attempted. | |
602 The RawRequest or RawResponse configuration setting was queried without first setting the TransferredRequest configuration setting to ON. | |
603 The login credentials specified were invalid. Please refer to the error message for more information. | |
604 An invalid remote resource identifier (i.e., a name, path, Id, etc.) was specified. | |
605 An invalid index was specified. | |
606 An operation failed because the specified OutputFile already exists and Overwrite is false. | |
607 An exception occurred while working with the specified InputFile or OutputFile (or the current value of one of those properties is invalid). Please refer to the error message for more information. | |
608 An exception occurred while working with the specified input or output stream. Please refer to the error message for more information. |
The class may also return one of the following error codes, which are inherited from other classes.
HTTP Errors
118 Firewall Error. Error description contains detailed message. | |
143 Busy executing current method. | |
151 HTTP protocol error. The error message has the server response. | |
152 No server specified in URL | |
153 Specified URLScheme is invalid. | |
155 Range operation is not supported by server. | |
156 Invalid cookie index (out of range). | |
301 Interrupted. | |
302 Can't open AttachedFile. |
The class may also return one of the following error codes, which are inherited from other classes.
TCPClient Errors
100 You cannot change the RemotePort at this time. A connection is in progress. | |
101 You cannot change the RemoteHost (Server) at this time. A connection is in progress. | |
102 The RemoteHost address is invalid (0.0.0.0). | |
104 Already connected. If you want to reconnect, close the current connection first. | |
106 You cannot change the LocalPort at this time. A connection is in progress. | |
107 You cannot change the LocalHost at this time. A connection is in progress. | |
112 You cannot change MaxLineLength at this time. A connection is in progress. | |
116 RemotePort cannot be zero. Please specify a valid service port number. | |
117 You cannot change the UseConnection option while the class is active. | |
135 Operation would block. | |
201 Timeout. | |
211 Action impossible in control's present state. | |
212 Action impossible while not connected. | |
213 Action impossible while listening. | |
301 Timeout. | |
302 Could not open file. | |
434 Unable to convert string to selected CodePage. | |
1105 Already connecting. If you want to reconnect, close the current connection first. | |
1117 You need to connect first. | |
1119 You cannot change the LocalHost at this time. A connection is in progress. | |
1120 Connection dropped by remote host. |
SSL Errors
270 Cannot load specified security library. | |
271 Cannot open certificate store. | |
272 Cannot find specified certificate. | |
273 Cannot acquire security credentials. | |
274 Cannot find certificate chain. | |
275 Cannot verify certificate chain. | |
276 Error during handshake. | |
280 Error verifying certificate. | |
281 Could not find client certificate. | |
282 Could not find server certificate. | |
283 Error encrypting data. | |
284 Error decrypting data. |
TCP/IP Errors
10004 [10004] Interrupted system call. | |
10009 [10009] Bad file number. | |
10013 [10013] Access denied. | |
10014 [10014] Bad address. | |
10022 [10022] Invalid argument. | |
10024 [10024] Too many open files. | |
10035 [10035] Operation would block. | |
10036 [10036] Operation now in progress. | |
10037 [10037] Operation already in progress. | |
10038 [10038] Socket operation on non-socket. | |
10039 [10039] Destination address required. | |
10040 [10040] Message too long. | |
10041 [10041] Protocol wrong type for socket. | |
10042 [10042] Bad protocol option. | |
10043 [10043] Protocol not supported. | |
10044 [10044] Socket type not supported. | |
10045 [10045] Operation not supported on socket. | |
10046 [10046] Protocol family not supported. | |
10047 [10047] Address family not supported by protocol family. | |
10048 [10048] Address already in use. | |
10049 [10049] Can't assign requested address. | |
10050 [10050] Network is down. | |
10051 [10051] Network is unreachable. | |
10052 [10052] Net dropped connection or reset. | |
10053 [10053] Software caused connection abort. | |
10054 [10054] Connection reset by peer. | |
10055 [10055] No buffer space available. | |
10056 [10056] Socket is already connected. | |
10057 [10057] Socket is not connected. | |
10058 [10058] Can't send after socket shutdown. | |
10059 [10059] Too many references, can't splice. | |
10060 [10060] Connection timed out. | |
10061 [10061] Connection refused. | |
10062 [10062] Too many levels of symbolic links. | |
10063 [10063] File name too long. | |
10064 [10064] Host is down. | |
10065 [10065] No route to host. | |
10066 [10066] Directory not empty | |
10067 [10067] Too many processes. | |
10068 [10068] Too many users. | |
10069 [10069] Disc Quota Exceeded. | |
10070 [10070] Stale NFS file handle. | |
10071 [10071] Too many levels of remote in path. | |
10091 [10091] Network subsystem is unavailable. | |
10092 [10092] WINSOCK DLL Version out of range. | |
10093 [10093] Winsock not loaded yet. | |
11001 [11001] Host not found. | |
11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
11004 [11004] Valid name, no data record (check DNS setup). |