AzureKeys Class
Properties Methods Events Config Settings Errors
The AzureKeys class makes it easy to interact with keys in Azure Key Vaults.
Syntax
AzureKeys
Remarks
The AzureKeys class provides an easy-to-use interface for the key-related functionality of the Azure Key Vault service. Azure Key Vault allows you to works with a few different kinds of resources, one of which is asymmetric key pairs. This class helps you to create, manage, and use said key pairs (or just "keys", for short) for cryptographic operations. To work with "secrets" instead, refer to the AzureSecrets class.
To begin, register for an Azure account and create one or more Key Vaults via the Azure Portal. Set the Vault property to the name of the vault you wish to work with.
This class requires authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth* properties to set the appropriate fields for the chosen OAuthClientProfile and OAuthGrantType.
The component has the following defaults:
Authorization Server URL | "https://login.microsoftonline.com/common/oauth2/v2.0/authorize" |
Token Server URL | "https://login.microsoftonline.com/common/oauth2/v2.0/token" |
Scopes | "offline_access https://vault.azure.net/user_impersonation" |
Additionaly, depending on how the application is registered (Ex. Single-tenant, Multi-tenant) and what OAuthGrantType is selected (Ex. Authorization Code, Password), it may be required to use the tenant ID rather than "common" in the OAuthServerAuthURL, and OAuthServerTokenURL properties. See below for examples of the modified URLs:
Authorization Server URL | "https://login.microsoftonline.com/{TENANT_ID}/oauth2/v2.0/authorize" |
Token Server URL | "https://login.microsoftonline.com/{TENANT_ID}/oauth2/v2.0/token" |
Application Profile
This profile encompasses the most basic grant types that OAuth supports. When this profile is set, all the requests and response handling is done by the class. Depending on the grant type, this may involve launching a browser so a user can login to authenticate with a authorization server. It may also involve starting an embedded web server to receive a response from a redirect.
To start the authentication and authorization process, the Authorize method should be called. If the authorization and authentication was successful, then the OAuthAccessToken property will be populated. Additionally, if a refresh token was provided the OAuthRefreshToken property will be populated as well. These values of the fields are for informational purposes. The class will also cache these tokens along with when the OAuthAccessToken will be expired. When a method that makes requests to the service provider is called or the Authorize method is called the class will automatically check to see if the access token is expired. If it is, it will then automatically try to get a new OAuthAccessToken. If the Authorize method was not used and user interaction would be required, the class will throw an error which can be caught. When user interaction is needed depends on what grant type is set in the OAuthGrantType property. To force the component to only check the access token when the Authorize method is called, the OAuthAutomaticRefresh configuration setting can be set to false.
A brief description of the supported values for the OAuthGrantType property are below. For more information, see the service documentation.
Authorization Code
When using the Authorization Code grant type, the class will use an authorization code to get an access token. For this OAuthGrantType the class expects a OAuthClientId, OAuthClientSecret, OAuthServerAuthURL, and OAuthServerTokenURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the class will parse the authorization code, setting the OAuthAuthorizationCode property, from the redirect. Immediately, the class will make a request to the token server to exchange the authorization code for an access token. The token server will return an access token and possibly a refresh token. If the OAuthRefreshToken property is set, or a refresh token is cached, then the class will not launch the browser and use the refresh token in its request to the token server instead of an authorization code.
Example:
AzureKeys azurekeys = new AzureKeys();
azurekeys.OAuth.ClientProfile = OAuthClientProfiles.cocpApplication;
azurekeys.OAuth.GrantType = OAuthGrantTypes.cogtAuthorizationCode;
azurekeys.OAuth.ClientId = CLIENT_ID;
azurekeys.OAuth.ClientSecret = SECRET_ID;
azurekeys.OAuth.AuthorizationScope = "offline_access https://vault.azure.net/user_impersonation";
azurekeys.OAuth.ServerAuthURL = "https://login.microsoftonline.com/" + TENANT_ID + "/oauth2/v2.0/authorize";
azurekeys.OAuth.ServerTokenURL = "https://login.microsoftonline.com/" + TENANT_ID + "/oauth2/v2.0/token";
azurekeys.Authorize();
Implicit
Note: This grant type is considered insecure and should only be used when necessary.
When using the Implicit grant type, the class will request the authorization server to get an access token. For this OAuthGrantType the class expects a OAuthClientId, OAuthClientSecret, and OAuthServerAuthURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the class will parse the access token from the redirect.
A disadvantage of the grant type is that can not use a refresh token to silently get a new access token. Most service providers offer a way to silently get a new access token. See the service documentation for specifics. This means the class will not be able to automatically get a fresh token once it expires.
Password
Note: This grant type is considered insecure and should only be used when necessary.
When using the Resource Owner Password Credentials grant type, the class will authenticate as the resource owner. This allows for the class to avoid user interaction. This grant type often has specific limitations put on it by the service provider. See the service documentation for more details.
For this OAuthGrantType the class requires OAuthPasswordGrantUsername, OAuthClientSecret, and OAuthServerTokenURL to be set. The OAuthClientSecret should be set to the password of the account instead of a typical secret. In some cases, the OAuthClientId also needs to be set. When the Authorize method is called, the component will make a request to the token server for an access token using the username and password. The token server will return an access token if the authentication was successful. When this access token is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one.
Web Profile
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.ServerAuthURL = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize";
oauth.ServerTokenURL = "https://login.microsoftonline.com/common/oauth2/v2.0/token";
oauth.AuthorizationScope = "offline_access https://vault.azure.net/user_impersonation";
oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode;
azurekeys.Authorization = oauth.GetAuthorization();
Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.
Using the Class
Keys can be created using the CreateKey method. A key's name and type (i.e., whether it is RSA or EC, and its size or curve, respectively) must be set at the time of creation, and cannot be changed later. A list of cryptographic operations that the key is valid for must also be set, but can be changed at any time using the UpdateKey. If a key with the specified name already exists, a new version of it is created; this makes it easy to "rotate" a key.
When a key will no longer be used, it can be deleted using the DeleteKey method. However, the key will only be soft-deleted; by default, Azure will permanently delete it after the waiting period configured for the vault. During this waiting period, the soft-deleted key may be recovered using RecoverKey, or permanently deleted using PurgeKey (assuming the currently-authenticated user has the permissions to do so).
azurekeys.CreateKey("mykey", "RSA_2048", "encrypt,decrypt,sign,verify,wrapKey,unwrapKey");
// ... Some time later, when the key is no longer needed ...
azurekeys.DeleteKey("mykey");
// At this point, the key is only soft-deleted. It could be recovered...
azurekeys.RecoverKey("mykey");
// ...or permanently deleted.
azurekeys.PurgeKey("mykey");
To list keys, use the ListKeys method. This method is also used to list soft-deleted keys if the GetDeleted configuration setting has been enabled first. To list a key's versions, use the ListVersions method. (You cannot list a deleted key's versions.) In all cases, the IncludeKeyDetails property can optionally be enabled to have the class attempt to retrieve the full information for each key (Azure leaves out certain fields by default when listing).
// If there are many keys to list, there may be multiple pages of results. This will
// cause all pages of results to be accumulated into the Keys collection property.
do {
azurekeys.ListKeys();
} while (!string.IsNullOrEmpty(azurekeys.KeyMarker));
// A similar thing applies to key versions as well.
do {
azurekeys.ListVersions("mykey");
} while (!string.IsNullOrEmpty(azurekeys.VersionMarker));
Depending on a key's "key ops" list, it can be used to perform different cryptographic operations. Keys with the encrypt and decrypt ops can be used in Encrypt and Decrypt operations. Keys with the sign and verify ops can be used in Sign and Verify. Finally, keys with the wrapKey and unwrapKey ops can be used in WrapKey and UnwrapKey operations (which are just like encryption and decryption, but which are intended to be used for wrapping a symmetric key, and which require different permissions to call successfully).
To perform a cryptographic operation, use InputData, InputFile, or SetInputStream to supply the input data that should be processed. All operations will output the result data to OutputData, OutputFile, or SetOutputStream (except Verify; refer to its documentation for more information).
azurekeys.CreateKey("mykey", "RSA_2048", "encrypt,decrypt");
azurekeys.InputData = "Test123";
azurekeys.OutputFile = "C:/temp/enc.dat";
azurekeys.Encrypt("mykey", "RSA-OAEP-256");
azurekeys.InputFile = "C:/temp/enc.dat";
azurekeys.OutputFile = ""; // So that the data will be output to the OutputData property.
azurekeys.Decrypt("mykey", "RSA-OAEP-256");
The class also supports a variety of other functionality, including:
- Retrieval of a single key's information (including public key) with GetKeyInfo.
- Enabling and disabling keys with SetKeyEnabled.
- Tagging support using AddTag and the Tag* properties.
- Secure key backup and restoration using BackupKey and RestoreKey.
- And more!
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
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. |
Idle | The current status of the class. |
IncludeKeyDetails | Whether to attempt to retrieve fill details when listing keys. |
InputData | The data to process. |
InputFile | The file whose data should be processed. |
KeyMarker | A marker indicating what page of keys to return next. |
KeyCount | The number of records in the Key arrays. |
KeyCreationDate | The creation date of the key. |
KeyDeletionDate | The deletion date of the key. |
KeyEnabled | Whether the key is enabled. |
KeyExpiryDate | The expiration date of the key. |
KeyOps | The operation that the key may be used for. |
KeyType | The key's type. |
KeyName | The name of the key. |
KeyNotBeforeDate | The 'not before' date of the key. |
KeyPublicKey | The key's public key. |
KeyPurgeDate | The purge date of the key. |
KeyRecoverableDays | The number of days the key will be recoverable if it gets deleted. |
KeyRecoveryLevel | The key's ability to be recovered and/or purged if it gets deleted. |
KeyUpdateDate | The update date of the key. |
KeyVersionId | The version Id of the key. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
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 username if authentication is to be used for the proxy. |
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). |
TagCount | The number of records in the Tag arrays. |
TagName | The name of the tag. |
TagValue | The value of the tag. |
Timeout | A timeout for the class. |
Vault | Selects a vault for the class to interact with. |
VersionMarker | A marker indicating what page of key versions to return next. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
AddQueryParam | Adds a query parameter to the QueryParams properties. |
AddTag | Adds an item to the Tags properties. |
Authorize | Get the authorization string required to access the protected resource. |
BackupKey | Backs up a key. |
Config | Sets or retrieves a configuration setting. |
CreateKey | Creates a new key. |
Decrypt | Decrypts data using a key. |
DeleteKey | Deletes a key. |
DoEvents | Processes events from the internal message queue. |
Encrypt | Encrypts data using a key. |
GetKeyInfo | Gets a key's information and public key. |
ListKeys | Lists keys in the currently-selected vault. |
ListVersions | Lists versions of a key. |
PurgeKey | Permanently deletes a soft-deleted key. |
RecoverKey | Recovers a soft-deleted key. |
Reset | Resets the class to its initial state. |
RestoreKey | Restores a previously backed-up key to the vault. |
SendCustomRequest | Sends a custom request to the server. |
SetInputStream | Sets the stream whose data should be processed. |
SetKeyEnabled | Enables or disables a key. |
SetOutputStream | Sets the stream to which output data should be written. |
Sign | Signs a message using a key. |
UnwrapKey | Unwraps a symmetric key. |
UpdateKey | Updates a key's information. |
Verify | Verifies a digital signature using a key. |
WrapKey | Wraps a symmetric 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 | Fired when information is available 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. |
Log | This event fires once for each log message. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
StartTransfer | This event fires when a document starts transferring (after the headers). |
TagList | Fires once for each tag returned when a key's information is retrieved. |
Transfer | This event is fired while a document transfers (delivers document). |
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. |
APIVersion | The Azure Key Vault API version that the class conforms to. |
CreateKeyEnabled | Whether new keys should be created in an enabled or disabled state. |
ExpiryDate | The expiry date to send for the key. |
GetDeleted | Whether the class should retrieve information about soft-deleted keys. |
MaxKeys | The maximum number of results to return when listing keys. |
MessageDigest | The message digest computed by the class during the last sign or verify operation, if any. |
NotBeforeDate | The 'not before' date to send for the 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. |
VersionId | The Id of the key version that the class should make requests against. |
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 | Whether or not to use the system security libraries or an internal implementation. |
Authorization Property (AzureKeys 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_azurekeys_getauthorization(void* lpObj);
int cloudkeys_azurekeys_setauthorization(void* lpObj, const char* lpszAuthorization);
QString GetAuthorization();
int SetAuthorization(QString qsAuthorization);
Default Value
""
Remarks
This class supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth class or a separate process. Once complete you should have an authorization string which looks like:
Bearer ACCESS_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 (AzureKeys 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_azurekeys_getfirewallautodetect(void* lpObj);
int cloudkeys_azurekeys_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);
bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);
Default Value
FALSE
Remarks
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
Data Type
Boolean
FirewallType Property (AzureKeys Class)
This property determines the type of firewall to connect through.
Syntax
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_azurekeys_getfirewalltype(void* lpObj);
int cloudkeys_azurekeys_setfirewalltype(void* lpObj, int iFirewallType);
int GetFirewallType();
int SetFirewallType(int iFirewallType);
Default Value
0
Remarks
This property determines the type of firewall to connect through. The applicable values are as follows:
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 (AzureKeys 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_azurekeys_getfirewallhost(void* lpObj);
int cloudkeys_azurekeys_setfirewallhost(void* lpObj, const char* lpszFirewallHost);
QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);
Default Value
""
Remarks
This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.
If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.
Data Type
String
FirewallPassword Property (AzureKeys Class)
This property contains a password if authentication is to be used when connecting through the firewall.
Syntax
ANSI (Cross Platform) char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword); Unicode (Windows) LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);
char* cloudkeys_azurekeys_getfirewallpassword(void* lpObj);
int cloudkeys_azurekeys_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);
QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);
Default Value
""
Remarks
This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
Data Type
String
FirewallPort Property (AzureKeys Class)
This property contains the transmission control protocol (TCP) port for the firewall Host .
Syntax
ANSI (Cross Platform) int GetFirewallPort();
int SetFirewallPort(int iFirewallPort); Unicode (Windows) INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);
int cloudkeys_azurekeys_getfirewallport(void* lpObj);
int cloudkeys_azurekeys_setfirewallport(void* lpObj, int iFirewallPort);
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);
Default Value
0
Remarks
This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.
Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.
Data Type
Integer
FirewallUser Property (AzureKeys Class)
This property contains a user name if authentication is to be used connecting through a firewall.
Syntax
ANSI (Cross Platform) char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser); Unicode (Windows) LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);
char* cloudkeys_azurekeys_getfirewalluser(void* lpObj);
int cloudkeys_azurekeys_setfirewalluser(void* lpObj, const char* lpszFirewallUser);
QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);
Default Value
""
Remarks
This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.
Data Type
String
Idle Property (AzureKeys Class)
The current status of the class.
Syntax
ANSI (Cross Platform) int GetIdle(); Unicode (Windows) BOOL GetIdle();
int cloudkeys_azurekeys_getidle(void* lpObj);
bool GetIdle();
Default Value
TRUE
Remarks
Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.
This property is read-only.
Data Type
Boolean
IncludeKeyDetails Property (AzureKeys Class)
Whether to attempt to retrieve fill details when listing keys.
Syntax
ANSI (Cross Platform) int GetIncludeKeyDetails();
int SetIncludeKeyDetails(int bIncludeKeyDetails); Unicode (Windows) BOOL GetIncludeKeyDetails();
INT SetIncludeKeyDetails(BOOL bIncludeKeyDetails);
int cloudkeys_azurekeys_getincludekeydetails(void* lpObj);
int cloudkeys_azurekeys_setincludekeydetails(void* lpObj, int bIncludeKeyDetails);
bool GetIncludeKeyDetails();
int SetIncludeKeyDetails(bool bIncludeKeyDetails);
Default Value
FALSE
Remarks
This property specifies whether the class should make additional requests when ListKeys or ListVersions is called in order to retrieve full information for each key. By default, Azure will omit certain fields when one of those methods is called (refer to each one's documentation for more information).
If this property is enabled, then after the initial listing is returned, the class will call GetKeyInfo internally for each key returned. For all keys for which this call is successful, the additional information will be used to populate the Key* properties. Any keys for which the GetKeyInfo call fails will not have the additional properties populated.
This property is not available at design time.
Data Type
Boolean
InputData Property (AzureKeys Class)
The data to process.
Syntax
ANSI (Cross Platform) int GetInputData(char* &lpInputData, int &lenInputData);
int SetInputData(const char* lpInputData, int lenInputData); Unicode (Windows) INT GetInputData(LPSTR &lpInputData, INT &lenInputData);
INT SetInputData(LPCSTR lpInputData, INT lenInputData);
int cloudkeys_azurekeys_getinputdata(void* lpObj, char** lpInputData, int* lenInputData);
int cloudkeys_azurekeys_setinputdata(void* lpObj, const char* lpInputData, int lenInputData);
QByteArray GetInputData();
int SetInputData(QByteArray qbaInputData);
Default Value
""
Remarks
This property specifies the data that should be processed in a cryptographic operation.
Input Sources & Output Destinations
The class automatically determines the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- 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 (AzureKeys 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_azurekeys_getinputfile(void* lpObj);
wchar_t* cloudkeys_azurekeys_getinputfile_W(void* lpObj); // Windows only
int cloudkeys_azurekeys_setinputfile(void* lpObj, const char* lpszInputFile);
int cloudkeys_azurekeys_setinputfile(void* lpObj, const wchar_t* lpszInputFile); // Windows only
QString GetInputFile();
int SetInputFile(QString qsInputFile);
Default Value
""
Remarks
This property specifies the file whose data should be processed in a cryptographic operation. It accepts both absolute and relative file paths.
Setting this property to a non-empty value will discard any stream set using the SetInputStream method. Similarly, passing a non-null value to the aforementioned method will clear this property.
Input Sources & Output Destinations
The class automatically determines the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- 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 (AzureKeys 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_azurekeys_getkeymarker(void* lpObj);
int cloudkeys_azurekeys_setkeymarker(void* lpObj, const char* lpszKeyMarker);
QString GetKeyMarker();
int SetKeyMarker(QString qsKeyMarker);
Default Value
""
Remarks
This property will be populated when ListKeys is called if the results are paged and there are more pages. To list all keys, continue to call ListKeys until this property returns empty string.
Refer to ListKeys for more information.
This property is not available at design time.
Data Type
String
KeyCount Property (AzureKeys Class)
The number of records in the Key arrays.
Syntax
ANSI (Cross Platform) int GetKeyCount(); Unicode (Windows) INT GetKeyCount();
int cloudkeys_azurekeys_getkeycount(void* lpObj);
int GetKeyCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- KeyCreationDate
- KeyDeletionDate
- KeyEnabled
- KeyExpiryDate
- KeyName
- KeyNotBeforeDate
- KeyOps
- KeyPublicKey
- KeyPurgeDate
- KeyRecoverableDays
- KeyRecoveryLevel
- KeyType
- KeyUpdateDate
- KeyVersionId
This property is read-only and not available at design time.
Data Type
Integer
KeyCreationDate Property (AzureKeys Class)
The creation date of the key.
Syntax
ANSI (Cross Platform) int64 GetKeyCreationDate(int iKeyIndex); Unicode (Windows) LONG64 GetKeyCreationDate(INT iKeyIndex);
int64 cloudkeys_azurekeys_getkeycreationdate(void* lpObj, int keyindex);
qint64 GetKeyCreationDate(int iKeyIndex);
Default Value
-1
Remarks
The creation date of the key.
This property reflects the creation date of the key, in seconds since the Unix epoch.
The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.
This property is read-only and not available at design time.
Data Type
Long64
KeyDeletionDate Property (AzureKeys Class)
The deletion date of the key.
Syntax
ANSI (Cross Platform) int64 GetKeyDeletionDate(int iKeyIndex); Unicode (Windows) LONG64 GetKeyDeletionDate(INT iKeyIndex);
int64 cloudkeys_azurekeys_getkeydeletiondate(void* lpObj, int keyindex);
qint64 GetKeyDeletionDate(int iKeyIndex);
Default Value
-1
Remarks
The deletion date of the key.
This property reflects the deletion date of the key, in seconds since the Unix epoch, or -1 if the key has not been deleted.
The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.
This property is read-only and not available at design time.
Data Type
Long64
KeyEnabled Property (AzureKeys Class)
Whether the key is enabled.
Syntax
ANSI (Cross Platform) int GetKeyEnabled(int iKeyIndex); Unicode (Windows) BOOL GetKeyEnabled(INT iKeyIndex);
int cloudkeys_azurekeys_getkeyenabled(void* lpObj, int keyindex);
bool GetKeyEnabled(int iKeyIndex);
Default Value
FALSE
Remarks
Whether the key is enabled.
This property reflects whether the key is currently enabled.
The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
KeyExpiryDate Property (AzureKeys Class)
The expiration date of the key.
Syntax
ANSI (Cross Platform) int64 GetKeyExpiryDate(int iKeyIndex); Unicode (Windows) LONG64 GetKeyExpiryDate(INT iKeyIndex);
int64 cloudkeys_azurekeys_getkeyexpirydate(void* lpObj, int keyindex);
qint64 GetKeyExpiryDate(int iKeyIndex);
Default Value
-1
Remarks
The expiration date of the key.
This property reflects the expiration date of the key, in seconds since the Unix epoch, or -1 if the key does not expire.
A key can only be used for the Decrypt, Verify, and UnwrapKey operations after its expiry date.
The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.
This property is read-only and not available at design time.
Data Type
Long64
KeyOps Property (AzureKeys Class)
The operation that the key may be used for.
Syntax
ANSI (Cross Platform) char* GetKeyOps(int iKeyIndex); Unicode (Windows) LPWSTR GetKeyOps(INT iKeyIndex);
char* cloudkeys_azurekeys_getkeyops(void* lpObj, int keyindex);
QString GetKeyOps(int iKeyIndex);
Default Value
""
Remarks
The operation that the key may be used for.
This property reflects a comma-separated list of operations that they key may be used for. Possible values are:
- encrypt
- decrypt
- sign
- verify
- wrapKey
- unwrapKey
The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.
This property is read-only and not available at design time.
Data Type
String
KeyType Property (AzureKeys Class)
The key's type.
Syntax
ANSI (Cross Platform) char* GetKeyType(int iKeyIndex); Unicode (Windows) LPWSTR GetKeyType(INT iKeyIndex);
char* cloudkeys_azurekeys_getkeytype(void* lpObj, int keyindex);
QString GetKeyType(int iKeyIndex);
Default Value
""
Remarks
The key's type.
This property reflects the key's type. Each key type has two variants, a software-based one and an HSM-based one. Possible values for this property are shown in the first two columns of the following table:
Software-based | HSM-based | Description |
EC_P256 | EC_HSM_P256 | The NIST P-256 curve (SECP256R1). |
EC_P256K | EC_HSM_P256K | The SECP256K1 curve. |
EC_P384 | EC_HSM_P384 | The NIST P-384 curve (SECP384R1). |
EC_P521 | EC_HSM_P521 | The NIST P-521 curve (SECP521R1). |
RSA_2048 | RSA_HSM_2048 | 2048-bit RSA key. |
RSA_3072 | RSA_HSM_3072 | 3072-bit RSA key. |
RSA_4096 | RSA_HSM_4096 | 4096-bit RSA 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
KeyName Property (AzureKeys Class)
The name of the key.
Syntax
ANSI (Cross Platform) char* GetKeyName(int iKeyIndex); Unicode (Windows) LPWSTR GetKeyName(INT iKeyIndex);
char* cloudkeys_azurekeys_getkeyname(void* lpObj, int keyindex);
QString GetKeyName(int iKeyIndex);
Default Value
""
Remarks
The name of the key.
This property reflects the name of the key.
The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.
This property is read-only and not available at design time.
Data Type
String
KeyNotBeforeDate Property (AzureKeys Class)
The 'not before' date of the key.
Syntax
ANSI (Cross Platform) int64 GetKeyNotBeforeDate(int iKeyIndex); Unicode (Windows) LONG64 GetKeyNotBeforeDate(INT iKeyIndex);
int64 cloudkeys_azurekeys_getkeynotbeforedate(void* lpObj, int keyindex);
qint64 GetKeyNotBeforeDate(int iKeyIndex);
Default Value
-1
Remarks
The 'not before' date of the key.
This property reflects the "not before" date of the key, in seconds since the Unix epoch, or -1 if the key doesn't have an explicit "not before" date.
A key can only be used for the Decrypt, Verify, and UnwrapKey operations prior to its "not before" date.
The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.
This property is read-only and not available at design time.
Data Type
Long64
KeyPublicKey Property (AzureKeys Class)
The key's public key.
Syntax
ANSI (Cross Platform) char* GetKeyPublicKey(int iKeyIndex); Unicode (Windows) LPWSTR GetKeyPublicKey(INT iKeyIndex);
char* cloudkeys_azurekeys_getkeypublickey(void* lpObj, int keyindex);
QString GetKeyPublicKey(int iKeyIndex);
Default Value
""
Remarks
The key's public key.
This property reflects the public key of the key, in PEM format.
The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.
This property is read-only and not available at design time.
Data Type
String
KeyPurgeDate Property (AzureKeys Class)
The purge date of the key.
Syntax
ANSI (Cross Platform) int64 GetKeyPurgeDate(int iKeyIndex); Unicode (Windows) LONG64 GetKeyPurgeDate(INT iKeyIndex);
int64 cloudkeys_azurekeys_getkeypurgedate(void* lpObj, int keyindex);
qint64 GetKeyPurgeDate(int iKeyIndex);
Default Value
-1
Remarks
The purge date of the key.
This property reflects the purge (i.e., permanent deletion) date of the key, in seconds since the Unix epoch, or -1 if the key has not been deleted.
The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.
This property is read-only and not available at design time.
Data Type
Long64
KeyRecoverableDays Property (AzureKeys Class)
The number of days the key will be recoverable if it gets deleted.
Syntax
ANSI (Cross Platform) int GetKeyRecoverableDays(int iKeyIndex); Unicode (Windows) INT GetKeyRecoverableDays(INT iKeyIndex);
int cloudkeys_azurekeys_getkeyrecoverabledays(void* lpObj, int keyindex);
int GetKeyRecoverableDays(int iKeyIndex);
Default Value
0
Remarks
The number of days the key will be recoverable if it gets deleted.
This property reflects the number of days that the key will be recoverable for if it gets deleted.
Note that this property's value is based on the retention policy of the currently-selected Vault; it will not change after the key has actually been deleted.
The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.
This property is read-only and not available at design time.
Data Type
Integer
KeyRecoveryLevel Property (AzureKeys Class)
The key's ability to be recovered and/or purged if it gets deleted.
Syntax
ANSI (Cross Platform) char* GetKeyRecoveryLevel(int iKeyIndex); Unicode (Windows) LPWSTR GetKeyRecoveryLevel(INT iKeyIndex);
char* cloudkeys_azurekeys_getkeyrecoverylevel(void* lpObj, int keyindex);
QString GetKeyRecoveryLevel(int iKeyIndex);
Default Value
""
Remarks
The key's ability to be recovered and/or purged if it gets deleted.
This property reflects the key's ability to be recovered and/or purged (i.e., permanently deleted) if it gets deleted. Possible values are as follows; please refer to this part of the Azure Key Vault documentation for more information about each one:
- CustomizedRecoverable
- CustomizedRecoverable+ProtectedSubscription
- CustomizedRecoverable+Purgeable
- Purgeable
- Recoverable
- Recoverable+ProtectedSubscription
- Recoverable+Purgeable
The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.
This property is read-only and not available at design time.
Data Type
String
KeyUpdateDate Property (AzureKeys Class)
The update date of the key.
Syntax
ANSI (Cross Platform) int64 GetKeyUpdateDate(int iKeyIndex); Unicode (Windows) LONG64 GetKeyUpdateDate(INT iKeyIndex);
int64 cloudkeys_azurekeys_getkeyupdatedate(void* lpObj, int keyindex);
qint64 GetKeyUpdateDate(int iKeyIndex);
Default Value
-1
Remarks
The update date of the key.
This property reflects the update date of the key, in seconds since the Unix epoch.
The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.
This property is read-only and not available at design time.
Data Type
Long64
KeyVersionId Property (AzureKeys Class)
The version Id of the key.
Syntax
ANSI (Cross Platform) char* GetKeyVersionId(int iKeyIndex); Unicode (Windows) LPWSTR GetKeyVersionId(INT iKeyIndex);
char* cloudkeys_azurekeys_getkeyversionid(void* lpObj, int keyindex);
QString GetKeyVersionId(int iKeyIndex);
Default Value
""
Remarks
The version Id of the key.
This property reflects the version Id of the key.
The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.
This property is read-only and not available at design time.
Data Type
String
LocalHost Property (AzureKeys Class)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
ANSI (Cross Platform) char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost); Unicode (Windows) LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);
char* cloudkeys_azurekeys_getlocalhost(void* lpObj);
int cloudkeys_azurekeys_setlocalhost(void* lpObj, const char* lpszLocalHost);
QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);
Default Value
""
Remarks
The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).
NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.
Data Type
String
OAuthAccessToken Property (AzureKeys Class)
The access token returned by the authorization server.
Syntax
ANSI (Cross Platform) char* GetOAuthAccessToken();
int SetOAuthAccessToken(const char* lpszOAuthAccessToken); Unicode (Windows) LPWSTR GetOAuthAccessToken();
INT SetOAuthAccessToken(LPCWSTR lpszOAuthAccessToken);
char* cloudkeys_azurekeys_getoauthaccesstoken(void* lpObj);
int cloudkeys_azurekeys_setoauthaccesstoken(void* lpObj, const char* lpszOAuthAccessToken);
QString GetOAuthAccessToken();
int SetOAuthAccessToken(QString qsOAuthAccessToken);
Default Value
""
Remarks
The access token returned by the authorization server. This is set when the class makes a request to the token server.
This property is not available at design time.
Data Type
String
OAuthAuthorizationCode Property (AzureKeys Class)
The authorization code that is exchanged for an access token.
Syntax
ANSI (Cross Platform) char* GetOAuthAuthorizationCode();
int SetOAuthAuthorizationCode(const char* lpszOAuthAuthorizationCode); Unicode (Windows) LPWSTR GetOAuthAuthorizationCode();
INT SetOAuthAuthorizationCode(LPCWSTR lpszOAuthAuthorizationCode);
char* cloudkeys_azurekeys_getoauthauthorizationcode(void* lpObj);
int cloudkeys_azurekeys_setoauthauthorizationcode(void* lpObj, const char* lpszOAuthAuthorizationCode);
QString GetOAuthAuthorizationCode();
int SetOAuthAuthorizationCode(QString qsOAuthAuthorizationCode);
Default Value
""
Remarks
The authorization code that is exchanged for an access token. This is required to be set when the OAuthClientProfile property is set to the Web profile. Otherwise, this field is for information purposes only.
This property is not available at design time.
Data Type
String
OAuthAuthorizationScope Property (AzureKeys Class)
The scope request or response parameter used during authorization.
Syntax
ANSI (Cross Platform) char* GetOAuthAuthorizationScope();
int SetOAuthAuthorizationScope(const char* lpszOAuthAuthorizationScope); Unicode (Windows) LPWSTR GetOAuthAuthorizationScope();
INT SetOAuthAuthorizationScope(LPCWSTR lpszOAuthAuthorizationScope);
char* cloudkeys_azurekeys_getoauthauthorizationscope(void* lpObj);
int cloudkeys_azurekeys_setoauthauthorizationscope(void* lpObj, const char* lpszOAuthAuthorizationScope);
QString GetOAuthAuthorizationScope();
int SetOAuthAuthorizationScope(QString qsOAuthAuthorizationScope);
Default Value
""
Remarks
The scope request or response parameter used during authorization.
This property is not available at design time.
Data Type
String
OAuthClientId Property (AzureKeys Class)
The id of the client assigned when registering the application.
Syntax
ANSI (Cross Platform) char* GetOAuthClientId();
int SetOAuthClientId(const char* lpszOAuthClientId); Unicode (Windows) LPWSTR GetOAuthClientId();
INT SetOAuthClientId(LPCWSTR lpszOAuthClientId);
char* cloudkeys_azurekeys_getoauthclientid(void* lpObj);
int cloudkeys_azurekeys_setoauthclientid(void* lpObj, const char* lpszOAuthClientId);
QString GetOAuthClientId();
int SetOAuthClientId(QString qsOAuthClientId);
Default Value
""
Remarks
The id of the client assigned when registering the application.
This property is not available at design time.
Data Type
String
OAuthClientProfile Property (AzureKeys Class)
The type of client that is requesting authorization.
Syntax
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_azurekeys_getoauthclientprofile(void* lpObj);
int cloudkeys_azurekeys_setoauthclientprofile(void* lpObj, int iOAuthClientProfile);
int GetOAuthClientProfile();
int SetOAuthClientProfile(int iOAuthClientProfile);
Default Value
0
Remarks
The type of client that is requesting authorization. See the introduction section for more information. Possible values are:
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 (AzureKeys 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_azurekeys_getoauthclientsecret(void* lpObj);
int cloudkeys_azurekeys_setoauthclientsecret(void* lpObj, const char* lpszOAuthClientSecret);
QString GetOAuthClientSecret();
int SetOAuthClientSecret(QString qsOAuthClientSecret);
Default Value
""
Remarks
The secret value for the client assigned when registering the application.
This property is not available at design time.
Data Type
String
OAuthGrantType Property (AzureKeys Class)
The OAuth grant type used to acquire an OAuth access token.
Syntax
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_azurekeys_getoauthgranttype(void* lpObj);
int cloudkeys_azurekeys_setoauthgranttype(void* lpObj, int iOAuthGrantType);
int GetOAuthGrantType();
int SetOAuthGrantType(int iOAuthGrantType);
Default Value
0
Remarks
The OAuth grant type used to acquire an OAuth access token. See the introduction section for more information. Possible values are:
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 (AzureKeys 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_azurekeys_getoauthrefreshtoken(void* lpObj);
int cloudkeys_azurekeys_setoauthrefreshtoken(void* lpObj, const char* lpszOAuthRefreshToken);
QString GetOAuthRefreshToken();
int SetOAuthRefreshToken(QString qsOAuthRefreshToken);
Default Value
""
Remarks
Specifies the refresh token received from or sent to the authorization server. This property is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the OAuthGrantType property is set to a grant that can use refresh tokens.
This property is not available at design time.
Data Type
String
OAuthReturnURL Property (AzureKeys Class)
The URL where the user (browser) returns after authenticating.
Syntax
ANSI (Cross Platform) char* GetOAuthReturnURL();
int SetOAuthReturnURL(const char* lpszOAuthReturnURL); Unicode (Windows) LPWSTR GetOAuthReturnURL();
INT SetOAuthReturnURL(LPCWSTR lpszOAuthReturnURL);
char* cloudkeys_azurekeys_getoauthreturnurl(void* lpObj);
int cloudkeys_azurekeys_setoauthreturnurl(void* lpObj, const char* lpszOAuthReturnURL);
QString GetOAuthReturnURL();
int SetOAuthReturnURL(QString qsOAuthReturnURL);
Default Value
""
Remarks
The URL where the user (browser) returns after authenticating. This property is mapped to the redirect_uri parameter when making a request to the authorization server. Typically, this is automatically set by the class when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this property should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing.
This property is not available at design time.
Data Type
String
OAuthServerAuthURL Property (AzureKeys Class)
The URL of the authorization server.
Syntax
ANSI (Cross Platform) char* GetOAuthServerAuthURL();
int SetOAuthServerAuthURL(const char* lpszOAuthServerAuthURL); Unicode (Windows) LPWSTR GetOAuthServerAuthURL();
INT SetOAuthServerAuthURL(LPCWSTR lpszOAuthServerAuthURL);
char* cloudkeys_azurekeys_getoauthserverauthurl(void* lpObj);
int cloudkeys_azurekeys_setoauthserverauthurl(void* lpObj, const char* lpszOAuthServerAuthURL);
QString GetOAuthServerAuthURL();
int SetOAuthServerAuthURL(QString qsOAuthServerAuthURL);
Default Value
""
Remarks
The URL of the authorization server.
This property is not available at design time.
Data Type
String
OAuthServerTokenURL Property (AzureKeys Class)
The URL of the token server used to obtain the access token.
Syntax
ANSI (Cross Platform) char* GetOAuthServerTokenURL();
int SetOAuthServerTokenURL(const char* lpszOAuthServerTokenURL); Unicode (Windows) LPWSTR GetOAuthServerTokenURL();
INT SetOAuthServerTokenURL(LPCWSTR lpszOAuthServerTokenURL);
char* cloudkeys_azurekeys_getoauthservertokenurl(void* lpObj);
int cloudkeys_azurekeys_setoauthservertokenurl(void* lpObj, const char* lpszOAuthServerTokenURL);
QString GetOAuthServerTokenURL();
int SetOAuthServerTokenURL(QString qsOAuthServerTokenURL);
Default Value
""
Remarks
The URL of the token server used to obtain the access token.
This property is not available at design time.
Data Type
String
OAuthWebAuthURL Property (AzureKeys Class)
The URL to which the user should be re-directed for authorization.
Syntax
ANSI (Cross Platform) char* GetOAuthWebAuthURL(); Unicode (Windows) LPWSTR GetOAuthWebAuthURL();
char* cloudkeys_azurekeys_getoauthwebauthurl(void* lpObj);
QString GetOAuthWebAuthURL();
Default Value
""
Remarks
The URL to which the user should be re-directed for authorization. This field is used to get the URL that the user should be redirected to when using the Web client profile. See introduction section for more information.
This property is read-only and not available at design time.
Data Type
String
OtherHeaders Property (AzureKeys Class)
This property includes other headers as determined by the user (optional).
Syntax
ANSI (Cross Platform) char* GetOtherHeaders();
int SetOtherHeaders(const char* lpszOtherHeaders); Unicode (Windows) LPWSTR GetOtherHeaders();
INT SetOtherHeaders(LPCWSTR lpszOtherHeaders);
char* cloudkeys_azurekeys_getotherheaders(void* lpObj);
int cloudkeys_azurekeys_setotherheaders(void* lpObj, const char* lpszOtherHeaders);
QString GetOtherHeaders();
int SetOtherHeaders(QString qsOtherHeaders);
Default Value
""
Remarks
This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.
The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .
Use this property with caution. If this property contains invalid headers, HTTP requests may fail.
This property is useful for extending the functionality of the class beyond what is provided.
This property is not available at design time.
Data Type
String
OutputData Property (AzureKeys Class)
The output data.
Syntax
ANSI (Cross Platform) int GetOutputData(char* &lpOutputData, int &lenOutputData);
int SetOutputData(const char* lpOutputData, int lenOutputData); Unicode (Windows) INT GetOutputData(LPSTR &lpOutputData, INT &lenOutputData);
INT SetOutputData(LPCSTR lpOutputData, INT lenOutputData);
int cloudkeys_azurekeys_getoutputdata(void* lpObj, char** lpOutputData, int* lenOutputData);
int cloudkeys_azurekeys_setoutputdata(void* lpObj, const char* lpOutputData, int lenOutputData);
QByteArray GetOutputData();
int SetOutputData(QByteArray qbaOutputData);
Default Value
""
Remarks
This property is populated with the data that was output from a successful cryptographic operation.
Note: For the Verify operation, this property functions as a secondary input property instead (along with InputData); refer to the Verify method for more information.
Input Sources & Output Destinations
The class automatically determines the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- 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 (AzureKeys 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_azurekeys_getoutputfile(void* lpObj);
wchar_t* cloudkeys_azurekeys_getoutputfile_W(void* lpObj); // Windows only
int cloudkeys_azurekeys_setoutputfile(void* lpObj, const char* lpszOutputFile);
int cloudkeys_azurekeys_setoutputfile(void* lpObj, const wchar_t* lpszOutputFile); // Windows only
QString GetOutputFile();
int SetOutputFile(QString qsOutputFile);
Default Value
""
Remarks
This property specifies the file to which data output from a successful cryptographic operation should be written.
Setting this property to a non-empty value will discard any stream set using the SetOutputStream method. Similarly, passing a non-null value to the aforementioned method will clear this property.
Note: For the Verify operation, the specified file functions as a secondary input file instead (along with InputFile); refer to the Verify method for more information.
Input Sources & Output Destinations
The class automatically determines the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- 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 (AzureKeys 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_azurekeys_getoverwrite(void* lpObj);
int cloudkeys_azurekeys_setoverwrite(void* lpObj, int bOverwrite);
bool GetOverwrite();
int SetOverwrite(bool bOverwrite);
Default Value
FALSE
Remarks
This property controls whether the specified OutputFile should be overwritten if it already exists.
Data Type
Boolean
ParsedHeaderCount Property (AzureKeys Class)
The number of records in the ParsedHeader arrays.
Syntax
ANSI (Cross Platform) int GetParsedHeaderCount(); Unicode (Windows) INT GetParsedHeaderCount();
int cloudkeys_azurekeys_getparsedheadercount(void* lpObj);
int GetParsedHeaderCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at ParsedHeaderCount - 1.This property is read-only and not available at design time.
Data Type
Integer
ParsedHeaderField Property (AzureKeys Class)
This property contains the name of the HTTP header (this is the same case as it is delivered).
Syntax
ANSI (Cross Platform) char* GetParsedHeaderField(int iParsedHeaderIndex); Unicode (Windows) LPWSTR GetParsedHeaderField(INT iParsedHeaderIndex);
char* cloudkeys_azurekeys_getparsedheaderfield(void* lpObj, int parsedheaderindex);
QString GetParsedHeaderField(int iParsedHeaderIndex);
Default Value
""
Remarks
This property contains the name of the HTTP Header (this is the same case as it is delivered).
The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.
This property is read-only and not available at design time.
Data Type
String
ParsedHeaderValue Property (AzureKeys Class)
This property contains the header contents.
Syntax
ANSI (Cross Platform) char* GetParsedHeaderValue(int iParsedHeaderIndex); Unicode (Windows) LPWSTR GetParsedHeaderValue(INT iParsedHeaderIndex);
char* cloudkeys_azurekeys_getparsedheadervalue(void* lpObj, int parsedheaderindex);
QString GetParsedHeaderValue(int iParsedHeaderIndex);
Default Value
""
Remarks
This property contains the Header contents.
The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.
This property is read-only and not available at design time.
Data Type
String
ProxyAuthScheme Property (AzureKeys Class)
This property is used to tell the class which type of authorization to perform when connecting to the proxy.
Syntax
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_azurekeys_getproxyauthscheme(void* lpObj);
int cloudkeys_azurekeys_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);
Default Value
0
Remarks
This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.
ProxyAuthScheme should be set to authNone (3) when no authentication is expected.
By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.
If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.
If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.
If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.
Data Type
Integer
ProxyAutoDetect Property (AzureKeys Class)
This property tells the class whether or not to automatically detect and use proxy system settings, if available.
Syntax
ANSI (Cross Platform) int GetProxyAutoDetect();
int SetProxyAutoDetect(int bProxyAutoDetect); Unicode (Windows) BOOL GetProxyAutoDetect();
INT SetProxyAutoDetect(BOOL bProxyAutoDetect);
int cloudkeys_azurekeys_getproxyautodetect(void* lpObj);
int cloudkeys_azurekeys_setproxyautodetect(void* lpObj, int bProxyAutoDetect);
bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);
Default Value
FALSE
Remarks
This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.
Data Type
Boolean
ProxyPassword Property (AzureKeys Class)
This property contains a password if authentication is to be used for the proxy.
Syntax
ANSI (Cross Platform) char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword); Unicode (Windows) LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);
char* cloudkeys_azurekeys_getproxypassword(void* lpObj);
int cloudkeys_azurekeys_setproxypassword(void* lpObj, const char* lpszProxyPassword);
QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);
Default Value
""
Remarks
This property contains a password if authentication is to be used for the proxy.
If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.
If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.
Data Type
String
ProxyPort Property (AzureKeys Class)
This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
Syntax
ANSI (Cross Platform) int GetProxyPort();
int SetProxyPort(int iProxyPort); Unicode (Windows) INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);
int cloudkeys_azurekeys_getproxyport(void* lpObj);
int cloudkeys_azurekeys_setproxyport(void* lpObj, int iProxyPort);
int GetProxyPort();
int SetProxyPort(int iProxyPort);
Default Value
80
Remarks
This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.
Data Type
Integer
ProxyServer Property (AzureKeys Class)
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
Syntax
ANSI (Cross Platform) char* GetProxyServer();
int SetProxyServer(const char* lpszProxyServer); Unicode (Windows) LPWSTR GetProxyServer();
INT SetProxyServer(LPCWSTR lpszProxyServer);
char* cloudkeys_azurekeys_getproxyserver(void* lpObj);
int cloudkeys_azurekeys_setproxyserver(void* lpObj, const char* lpszProxyServer);
QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);
Default Value
""
Remarks
If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.
Data Type
String
ProxySSL Property (AzureKeys Class)
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
Syntax
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_azurekeys_getproxyssl(void* lpObj);
int cloudkeys_azurekeys_setproxyssl(void* lpObj, int iProxySSL);
int GetProxySSL();
int SetProxySSL(int iProxySSL);
Default Value
0
Remarks
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:
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 (AzureKeys Class)
This property contains a username 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_azurekeys_getproxyuser(void* lpObj);
int cloudkeys_azurekeys_setproxyuser(void* lpObj, const char* lpszProxyUser);
QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);
Default Value
""
Remarks
This property contains a username if authentication is to be used for the proxy.
If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.
If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.
Data Type
String
QueryParamCount Property (AzureKeys 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_azurekeys_getqueryparamcount(void* lpObj);
int cloudkeys_azurekeys_setqueryparamcount(void* lpObj, int iQueryParamCount);
int GetQueryParamCount();
int SetQueryParamCount(int iQueryParamCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at QueryParamCount - 1.This property is not available at design time.
Data Type
Integer
QueryParamName Property (AzureKeys Class)
The name of the query parameter.
Syntax
ANSI (Cross Platform) char* GetQueryParamName(int iQueryParamIndex);
int SetQueryParamName(int iQueryParamIndex, const char* lpszQueryParamName); Unicode (Windows) LPWSTR GetQueryParamName(INT iQueryParamIndex);
INT SetQueryParamName(INT iQueryParamIndex, LPCWSTR lpszQueryParamName);
char* cloudkeys_azurekeys_getqueryparamname(void* lpObj, int queryparamindex);
int cloudkeys_azurekeys_setqueryparamname(void* lpObj, int queryparamindex, const char* lpszQueryParamName);
QString GetQueryParamName(int iQueryParamIndex);
int SetQueryParamName(int iQueryParamIndex, QString qsQueryParamName);
Default Value
""
Remarks
The name of the query parameter.
This property specifies the name of the query parameter.
The QueryParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.
This property is not available at design time.
Data Type
String
QueryParamValue Property (AzureKeys Class)
The value of the query parameter.
Syntax
ANSI (Cross Platform) char* GetQueryParamValue(int iQueryParamIndex);
int SetQueryParamValue(int iQueryParamIndex, const char* lpszQueryParamValue); Unicode (Windows) LPWSTR GetQueryParamValue(INT iQueryParamIndex);
INT SetQueryParamValue(INT iQueryParamIndex, LPCWSTR lpszQueryParamValue);
char* cloudkeys_azurekeys_getqueryparamvalue(void* lpObj, int queryparamindex);
int cloudkeys_azurekeys_setqueryparamvalue(void* lpObj, int queryparamindex, const char* lpszQueryParamValue);
QString GetQueryParamValue(int iQueryParamIndex);
int SetQueryParamValue(int iQueryParamIndex, QString qsQueryParamValue);
Default Value
""
Remarks
The value of the query parameter.
This property specifies the value of the query parameter. The class will automatically URL-encode this value when sending the request.
The QueryParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.
This property is not available at design time.
Data Type
String
SSLAcceptServerCertEncoded Property (AzureKeys Class)
This is the certificate (PEM/Base64 encoded).
Syntax
ANSI (Cross Platform) int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded); Unicode (Windows) INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);
int cloudkeys_azurekeys_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int cloudkeys_azurekeys_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);
QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.
When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SSLCertEncoded Property (AzureKeys Class)
This is the certificate (PEM/Base64 encoded).
Syntax
ANSI (Cross Platform) int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded); Unicode (Windows) INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);
int cloudkeys_azurekeys_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int cloudkeys_azurekeys_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);
QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.
When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SSLCertStore Property (AzureKeys Class)
This is the name of the certificate store for the client certificate.
Syntax
ANSI (Cross Platform) int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore); Unicode (Windows) INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);
int cloudkeys_azurekeys_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int cloudkeys_azurekeys_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);
QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.
SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.
Designations of certificate stores are platform dependent.
The following 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 (AzureKeys Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
ANSI (Cross Platform) char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword); Unicode (Windows) LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);
char* cloudkeys_azurekeys_getsslcertstorepassword(void* lpObj);
int cloudkeys_azurekeys_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);
QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
SSLCertStoreType Property (AzureKeys Class)
This is the type of certificate store for this certificate.
Syntax
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_azurekeys_getsslcertstoretype(void* lpObj);
int cloudkeys_azurekeys_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
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 (AzureKeys 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_azurekeys_getsslcertsubject(void* lpObj);
int cloudkeys_azurekeys_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);
QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are 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 (AzureKeys 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_azurekeys_getsslprovider(void* lpObj);
int cloudkeys_azurekeys_setsslprovider(void* lpObj, int iSSLProvider);
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);
Default Value
0
Remarks
This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.
Possible values are:
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 (AzureKeys 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_azurekeys_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);
QByteArray GetSSLServerCertEncoded();
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.
When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.
This property is read-only and not available at design time.
Data Type
Binary String
TagCount Property (AzureKeys Class)
The number of records in the Tag arrays.
Syntax
ANSI (Cross Platform) int GetTagCount();
int SetTagCount(int iTagCount); Unicode (Windows) INT GetTagCount();
INT SetTagCount(INT iTagCount);
int cloudkeys_azurekeys_gettagcount(void* lpObj);
int cloudkeys_azurekeys_settagcount(void* lpObj, int iTagCount);
int GetTagCount();
int SetTagCount(int iTagCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at TagCount - 1.This property is not available at design time.
Data Type
Integer
TagName Property (AzureKeys Class)
The name of the tag.
Syntax
ANSI (Cross Platform) char* GetTagName(int iTagIndex);
int SetTagName(int iTagIndex, const char* lpszTagName); Unicode (Windows) LPWSTR GetTagName(INT iTagIndex);
INT SetTagName(INT iTagIndex, LPCWSTR lpszTagName);
char* cloudkeys_azurekeys_gettagname(void* lpObj, int tagindex);
int cloudkeys_azurekeys_settagname(void* lpObj, int tagindex, const char* lpszTagName);
QString GetTagName(int iTagIndex);
int SetTagName(int iTagIndex, QString qsTagName);
Default Value
""
Remarks
The name of the tag.
This property specifies the name of the tag.
The TagIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TagCount property.
This property is not available at design time.
Data Type
String
TagValue Property (AzureKeys Class)
The value of the tag.
Syntax
ANSI (Cross Platform) char* GetTagValue(int iTagIndex);
int SetTagValue(int iTagIndex, const char* lpszTagValue); Unicode (Windows) LPWSTR GetTagValue(INT iTagIndex);
INT SetTagValue(INT iTagIndex, LPCWSTR lpszTagValue);
char* cloudkeys_azurekeys_gettagvalue(void* lpObj, int tagindex);
int cloudkeys_azurekeys_settagvalue(void* lpObj, int tagindex, const char* lpszTagValue);
QString GetTagValue(int iTagIndex);
int SetTagValue(int iTagIndex, QString qsTagValue);
Default Value
""
Remarks
The value of the tag.
This property specifies the value of the tag.
The TagIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TagCount property.
This property is not available at design time.
Data Type
String
Timeout Property (AzureKeys Class)
A timeout for the class.
Syntax
ANSI (Cross Platform) int GetTimeout();
int SetTimeout(int iTimeout); Unicode (Windows) INT GetTimeout();
INT SetTimeout(INT iTimeout);
int cloudkeys_azurekeys_gettimeout(void* lpObj);
int cloudkeys_azurekeys_settimeout(void* lpObj, int iTimeout);
int GetTimeout();
int SetTimeout(int iTimeout);
Default Value
60
Remarks
If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.
If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.
The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.
If Timeout expires, and the operation is not yet complete, the class fails with an error.
Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the Timeout property is 60 seconds.
Data Type
Integer
Vault Property (AzureKeys Class)
Selects a vault for the class to interact with.
Syntax
ANSI (Cross Platform) char* GetVault();
int SetVault(const char* lpszVault); Unicode (Windows) LPWSTR GetVault();
INT SetVault(LPCWSTR lpszVault);
char* cloudkeys_azurekeys_getvault(void* lpObj);
int cloudkeys_azurekeys_setvault(void* lpObj, const char* lpszVault);
QString GetVault();
int SetVault(QString qsVault);
Default Value
""
Remarks
This property specifies the Azure Key Vault vault, by name, that the class should interact with.
Data Type
String
VersionMarker Property (AzureKeys Class)
A marker indicating what page of key versions to return next.
Syntax
ANSI (Cross Platform) char* GetVersionMarker();
int SetVersionMarker(const char* lpszVersionMarker); Unicode (Windows) LPWSTR GetVersionMarker();
INT SetVersionMarker(LPCWSTR lpszVersionMarker);
char* cloudkeys_azurekeys_getversionmarker(void* lpObj);
int cloudkeys_azurekeys_setversionmarker(void* lpObj, const char* lpszVersionMarker);
QString GetVersionMarker();
int SetVersionMarker(QString qsVersionMarker);
Default Value
""
Remarks
This property will be populated when ListVersions is called if the results are paged and there are more pages. To list all key versions, continue to call ListVersions until this property returns empty string.
Refer to ListVersions for more information.
This property is not available at design time.
Data Type
String
AddQueryParam Method (AzureKeys Class)
Adds a query parameter to the QueryParams properties.
Syntax
ANSI (Cross Platform) int AddQueryParam(const char* lpszName, const char* lpszValue); Unicode (Windows) INT AddQueryParam(LPCWSTR lpszName, LPCWSTR lpszValue);
int cloudkeys_azurekeys_addqueryparam(void* lpObj, const char* lpszName, const char* lpszValue);
int AddQueryParam(const QString& qsName, const QString& qsValue);
Remarks
This method is used to add a query parameter to the QueryaParam* properties. Name specifies the name of the parameter, and Value specifies the value of the parameter.
All specified Values will be URL encoded by the class automatically. Consult the service documentation for details on the available parameters.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
AddTag Method (AzureKeys Class)
Adds an item to the Tags properties.
Syntax
ANSI (Cross Platform) int AddTag(const char* lpszName, const char* lpszValue); Unicode (Windows) INT AddTag(LPCWSTR lpszName, LPCWSTR lpszValue);
int cloudkeys_azurekeys_addtag(void* lpObj, const char* lpszName, const char* lpszValue);
int AddTag(const QString& qsName, const QString& qsValue);
Remarks
This method adds an item to the Tag* properties. Name specifies the name of the item, and Value specifies the value of the item.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Authorize Method (AzureKeys Class)
Get the authorization string required to access the protected resource.
Syntax
ANSI (Cross Platform) int Authorize(); Unicode (Windows) INT Authorize();
int cloudkeys_azurekeys_authorize(void* lpObj);
int Authorize();
Remarks
This method is used to get an access token that is required to access the protected resource. The method will act differently based on what is set in the OAuthClientProfile property and the OAuthGrantType property. This method is not to be used in conjunction with the Authorization property. It should instead be used when setting the OAuth* properties.
For more information, see the introduction section.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
BackupKey Method (AzureKeys Class)
Backs up a key.
Syntax
ANSI (Cross Platform) int BackupKey(const char* lpszKeyName); Unicode (Windows) INT BackupKey(LPCWSTR lpszKeyName);
int cloudkeys_azurekeys_backupkey(void* lpObj, const char* lpszKeyName);
int BackupKey(const QString& qsKeyName);
Remarks
This method backs up the key specified by KeyName, returning it in a protected form via the output stream specified via the SetOutputStream method, the specified OutputFile, or the OutputData property.
Note that the protected key cannot be used outside of Azure Key Vault, it must be restored to another vault using the RestoreKey method in order to be used.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Config Method (AzureKeys Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* cloudkeys_azurekeys_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
CreateKey Method (AzureKeys Class)
Creates a new key.
Syntax
ANSI (Cross Platform) char* CreateKey(const char* lpszKeyName, const char* lpszKeyType, const char* lpszKeyOps); Unicode (Windows) LPWSTR CreateKey(LPCWSTR lpszKeyName, LPCWSTR lpszKeyType, LPCWSTR lpszKeyOps);
char* cloudkeys_azurekeys_createkey(void* lpObj, const char* lpszKeyName, const char* lpszKeyType, const char* lpszKeyOps);
QString CreateKey(const QString& qsKeyName, const QString& qsKeyType, const QString& qsKeyOps);
Remarks
This method creates a new key with the given KeyName and KeyType. If a key with the specified KeyName already exists, a new version of it is created. The version Id of the newly-created key is returned.
The value passed for KeyName must consist solely of alphanumeric characters and hyphens (-).
The KeyType parameter specifies the type of key that should be created. Each key type has two variants, a software-based one and an HSM-based one. Possible values are shown in the first two columns of the following table:
Software-based | HSM-based | Description |
EC_P256 | EC_HSM_P256 | The NIST P-256 curve (SECP256R1). |
EC_P256K | EC_HSM_P256K | The SECP256K1 curve. |
EC_P384 | EC_HSM_P384 | The NIST P-384 curve (SECP384R1). |
EC_P521 | EC_HSM_P521 | The NIST P-521 curve (SECP521R1). |
RSA_2048 | RSA_HSM_2048 | 2048-bit RSA key. |
RSA_3072 | RSA_HSM_3072 | 3072-bit RSA key. |
RSA_4096 | RSA_HSM_4096 | 4096-bit RSA key. |
The KeyOps parameter specifies which operations the key will be valid for use with. Possible values are as follows; at least one pair of operations must be specified:
- encrypt
- decrypt
- sign
- verify
- wrapKey
- unwrapKey
If there are any items in the Tag* properties, they will be applied to the newly-created key. Keys may have up to 15 tags.
The following configuration settings can also be used to send additional values when creating the key, refer to their documentation for more information:
Note: If there is already a soft-deleted key with the specified KeyName in the currently-selected Vault, then a new key cannot be created with the same name. To resolve such a situation, the soft-deleted key would need to be recovered (using RecoverKey) or permanently deleted (using PurgeKey) first.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Decrypt Method (AzureKeys Class)
Decrypts data using a key.
Syntax
ANSI (Cross Platform) int Decrypt(const char* lpszKeyName, const char* lpszAlgorithm); Unicode (Windows) INT Decrypt(LPCWSTR lpszKeyName, LPCWSTR lpszAlgorithm);
int cloudkeys_azurekeys_decrypt(void* lpObj, const char* lpszKeyName, const char* lpszAlgorithm);
int Decrypt(const QString& qsKeyName, const QString& qsAlgorithm);
Remarks
This method decrypts data using the key specified by KeyName and the given Algorithm. The VersionId configuration setting can be used to target a specific key version.
The data to decrypt is taken from the input stream supplied via the SetInputStream method, the specified InputFile, or the InputData property. The decrypted data is output to the output stream supplied via the SetOutputStream method, the specified OutputFile, or the OutputData property.
The key specified by KeyName must be an RSA key; EC keys cannot be used for encryption/decryption.
The Algorithm parameter specifies which algorithm to use to decrypt the data; it must match the algorithm used to encrypt the data previously. Possible values are:
Algorithm | Description |
RSA1_5 | RSAES-PKCS1-v1_5 |
RSA-OAEP | RSAES OAEP using SHA-1 and MGF1 with SHA-1 |
RSA-OAEP-256 | RSAES OAEP using SHA-256 and MGF1 with SHA-256 |
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
DeleteKey Method (AzureKeys Class)
Deletes a key.
Syntax
ANSI (Cross Platform) int DeleteKey(const char* lpszKeyName); Unicode (Windows) INT DeleteKey(LPCWSTR lpszKeyName);
int cloudkeys_azurekeys_deletekey(void* lpObj, const char* lpszKeyName);
int DeleteKey(const QString& qsKeyName);
Remarks
This method deletes the key specified by KeyName. If there are multiple versions of the key, all of them are deleted.
Note that the key is only soft-deleted; it can be recovered during the retention period using the RecoverKey method, or permanently deleted using the PurgeKey method. The length of the retention period depends on the configuration of the currently-selected Vault, refer to the Azure Key Vault documentation for more information.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
DoEvents Method (AzureKeys Class)
Processes events from the internal message queue.
Syntax
ANSI (Cross Platform) int DoEvents(); Unicode (Windows) INT DoEvents();
int cloudkeys_azurekeys_doevents(void* lpObj);
int DoEvents();
Remarks
When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Encrypt Method (AzureKeys Class)
Encrypts data using a key.
Syntax
ANSI (Cross Platform) int Encrypt(const char* lpszKeyName, const char* lpszAlgorithm); Unicode (Windows) INT Encrypt(LPCWSTR lpszKeyName, LPCWSTR lpszAlgorithm);
int cloudkeys_azurekeys_encrypt(void* lpObj, const char* lpszKeyName, const char* lpszAlgorithm);
int Encrypt(const QString& qsKeyName, const QString& qsAlgorithm);
Remarks
This method encrypts data using the key specified by KeyName and the given Algorithm. The VersionId configuration setting can be used to target a specific key version.
The data to encrypt is taken from the input stream supplied via the SetInputStream method, the specified InputFile, or the InputData property. The encrypted data is output to the output stream supplied via the SetOutputStream method, the specified OutputFile, or the OutputData property.
The key specified by KeyName must be an RSA key; EC keys cannot be used for encryption/decryption.
The Algorithm parameter specifies which algorithm to use to encrypt the data. The type of key and the selected algorithm together dictate the maximum size of the input data. Refer to the following table for possible values and maximum data sizes:
Algorithm | Description | RSA_2048 | RSA_3072 | RSA_4096 |
RSA1_5 | RSAES-PKCS1-v1_5 | 245 | 373 | 509 |
RSA-OAEP | RSAES OAEP using SHA-1 and MGF1 with SHA-1 | 214 | 342 | 470 |
RSA-OAEP-256 | RSAES OAEP using SHA-256 and MGF1 with SHA-256 | 190 | 318 | 446 |
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
GetKeyInfo Method (AzureKeys Class)
Gets a key's information and public key.
Syntax
ANSI (Cross Platform) int GetKeyInfo(const char* lpszKeyName); Unicode (Windows) INT GetKeyInfo(LPCWSTR lpszKeyName);
int cloudkeys_azurekeys_getkeyinfo(void* lpObj, const char* lpszKeyName);
int GetKeyInfo(const QString& qsKeyName);
Remarks
This method gets the information, including the public key, for the key specified by KeyName. The VersionId configuration setting can be used to target a specific key version. Alternatively, the GetDeleted configuration setting can be enabled to get a soft-deleted key's information (but only for the last version).
When the information is returned, the class clears the Key* properties and repopulates them with a single item that contains the key's information, and repopulates the Tag* properties with the key's tags. The KeyList event is also fired.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ListKeys Method (AzureKeys Class)
Lists keys in the currently-selected vault.
Syntax
ANSI (Cross Platform) int ListKeys(); Unicode (Windows) INT ListKeys();
int cloudkeys_azurekeys_listkeys(void* lpObj);
int ListKeys();
Remarks
This method lists the keys in the currently-selected Vault. If the GetDeleted configuration setting is enabled, it lists the soft-deleted keys in the vault instead.
Calling this method will fire the KeyList event once for each key, and will also populate the Key* properties. However, note that by default the following properties will not be populated, since the server does not return full information for keys when listing them. The IncludeKeyDetails property can be enabled to have the class attempt to retrieve full information for each key; refer to its documentation for more information.
If there are still more keys available to list when this method returns, the KeyMarker property will be populated. Continue to call this method until KeyMarker is empty to accumulate all pages of results in the Key* properties.
The MaxKeys configuration setting can be used to control the maximum number of results to return at once.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ListVersions Method (AzureKeys Class)
Lists versions of a key.
Syntax
ANSI (Cross Platform) int ListVersions(const char* lpszKeyName); Unicode (Windows) INT ListVersions(LPCWSTR lpszKeyName);
int cloudkeys_azurekeys_listversions(void* lpObj, const char* lpszKeyName);
int ListVersions(const QString& qsKeyName);
Remarks
This method lists the versions of the key specified by KeyName.
Calling this method will fire the KeyList event once for each key version, and will also populate the Key* properties. However, note that by default the following properties will not be populated, since the server does not return full information for key versions when listing them. The IncludeKeyDetails property can be enabled to have the class attempt to retrieve full information for each key version; refer to its documentation for more information.
If there are still more key versions available to list when this method returns, the VersionMarker property will be populated. Continue to call this method until VersionMarker is empty to accumulate all pages of results in the Key* properties.
The MaxKeys configuration setting can be used to control the maximum number of results to return at once.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
PurgeKey Method (AzureKeys Class)
Permanently deletes a soft-deleted key.
Syntax
ANSI (Cross Platform) int PurgeKey(const char* lpszKeyName); Unicode (Windows) INT PurgeKey(LPCWSTR lpszKeyName);
int cloudkeys_azurekeys_purgekey(void* lpObj, const char* lpszKeyName);
int PurgeKey(const QString& qsKeyName);
Remarks
This method permanently deletes the soft-deleted key specified by KeyName.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
RecoverKey Method (AzureKeys Class)
Recovers a soft-deleted key.
Syntax
ANSI (Cross Platform) int RecoverKey(const char* lpszKeyName); Unicode (Windows) INT RecoverKey(LPCWSTR lpszKeyName);
int cloudkeys_azurekeys_recoverkey(void* lpObj, const char* lpszKeyName);
int RecoverKey(const QString& qsKeyName);
Remarks
This method recovers the soft-deleted key specified by KeyName.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Reset Method (AzureKeys Class)
Resets the class to its initial state.
Syntax
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
int cloudkeys_azurekeys_reset(void* lpObj);
int Reset();
Remarks
This method resets the class to its initial state.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
RestoreKey Method (AzureKeys Class)
Restores a previously backed-up key to the vault.
Syntax
ANSI (Cross Platform) char* RestoreKey(); Unicode (Windows) LPWSTR RestoreKey();
char* cloudkeys_azurekeys_restorekey(void* lpObj);
QString RestoreKey();
Remarks
This method restores a key previously backed up using BackupKey to the currently-selected Vault. The key is restored in its entirety, with all of its versions intact. However, note that the restore will fail if the key's name is already in use. The name of the restored key is returned.
The protected key data to restore is taken from the input stream supplied via the SetInputStream method, the specified InputFile, or the InputData property.
Note: There are certain restrictions on which vaults a key can be restored to. In particular, a key must be restored to a vault owned by the same Azure subscription that owned its original vault, and must be restored to a vault in the same geolocation as its original vault. Refer to the Azure Key Vault documentation for more information.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
SendCustomRequest Method (AzureKeys Class)
Sends a custom request to the server.
Syntax
ANSI (Cross Platform) int SendCustomRequest(const char* lpszHttpMethod, const char* lpszPath); Unicode (Windows) INT SendCustomRequest(LPCWSTR lpszHttpMethod, LPCWSTR lpszPath);
int cloudkeys_azurekeys_sendcustomrequest(void* lpObj, const char* lpszHttpMethod, const char* lpszPath);
int SendCustomRequest(const QString& qsHttpMethod, const QString& qsPath);
Remarks
This method can be used to send arbitrary requests to the server.
Valid values for HttpMethod are:
- GET (default if empty)
- HEAD
- POST
- PUT
- PATCH
- DELETE
Path is optional, and if non-empty must be specified without a leading forward slash (/).
When this method is called, the class does the following:
- Builds a request URL, including query parameters, based on the following:
- The base URL https://{Vault}.vault.azure.net/keys, where {Vault} is Vault.
- The specified Path, if any.
- An api-version query parameter whose value is APIVersion.
- All query parameters from QueryParam*.
- 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 (AzureKeys 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_azurekeys_setinputstream(void* lpObj, CloudKeysStream* sInputStream);
int SetInputStream(CloudKeysStream* sInputStream);
Remarks
This method sets the stream whose data should be processed in a cryptographic operation.
Passing a non-null value for InputStream will cause the InputFile property to be cleared. Similarly, setting InputFile to a non-empty value will discard any stream set using this method.
Input Sources & Output Destinations
The class automatically determines the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
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.)
SetKeyEnabled Method (AzureKeys Class)
Enables or disables a key.
Syntax
ANSI (Cross Platform) int SetKeyEnabled(const char* lpszKeyName, int bEnabled); Unicode (Windows) INT SetKeyEnabled(LPCWSTR lpszKeyName, BOOL bEnabled);
int cloudkeys_azurekeys_setkeyenabled(void* lpObj, const char* lpszKeyName, int bEnabled);
int SetKeyEnabled(const QString& qsKeyName, bool bEnabled);
Remarks
This method enables or disables the key specified by KeyName.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SetOutputStream Method (AzureKeys Class)
Sets the stream to which output data should be written.
Syntax
ANSI (Cross Platform) int SetOutputStream(CloudKeysStream* sOutputStream); Unicode (Windows) INT SetOutputStream(CloudKeysStream* sOutputStream);
int cloudkeys_azurekeys_setoutputstream(void* lpObj, CloudKeysStream* sOutputStream);
int SetOutputStream(CloudKeysStream* sOutputStream);
Remarks
This method sets the stream to which data output from a successful cryptographic operation should be written.
Passing a non-null value for OutputStream will cause the OutputFile property to be cleared. Similarly, setting OutputFile to a non-empty value will discard any stream set using this method.
Input Sources & Output Destinations
The class automatically determines the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- 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.)
Sign Method (AzureKeys Class)
Signs a message using a key.
Syntax
ANSI (Cross Platform) int Sign(const char* lpszKeyName, const char* lpszAlgorithm, int bIsDigest); Unicode (Windows) INT Sign(LPCWSTR lpszKeyName, LPCWSTR lpszAlgorithm, BOOL bIsDigest);
int cloudkeys_azurekeys_sign(void* lpObj, const char* lpszKeyName, const char* lpszAlgorithm, int bIsDigest);
int Sign(const QString& qsKeyName, const QString& qsAlgorithm, bool bIsDigest);
Remarks
This method signs a message using the key specified by KeyName and the given Algorithm. The VersionId configuration setting can be used to target a specific key version.
The message data to sign is taken from the input stream supplied via the SetInputStream method, the specified InputFile, or the InputData property. The signature data is output to the output stream supplied via the SetOutputStream method, the specified OutputFile, or the OutputData property.
The Algorithm parameter specifies which algorithm to use to sign the data. Possible values are:
- ES256: ECDSA using P-256 and SHA-256.
- ES256K: ECDSA using P-256K and SHA-256.
- ES384: ECDSA using P-384 and SHA-384.
- ES512: ECDSA using P-521 and SHA-512.
- PS256: RSASSA-PSS using SHA-256 and MGF1 with SHA-256.
- PS384: RSASSA-PSS using SHA-384 and MGF1 with SHA-384.
- PS512: RSASSA-PSS using SHA-512 and MGF1 with SHA-512.
- RS256: RSASSA-PKCS1-v1_5 using SHA-256.
- RS384: RSASSA-PKCS1-v1_5 using SHA-384.
- RS512: RSASSA-PKCS1-v1_5 using SHA-512.
The IsDigest parameter specifies whether the message data is the original message (false) or a message digest (true). When supplying a message digest, keep in mind that the same digest will need to be provided in order to Verify the signature later.
If IsDigest is false, the class will automatically compute an appropriate message digest before the request is made. In such cases, the computed digest is made available via the MessageDigest configuration setting.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
UnwrapKey Method (AzureKeys Class)
Unwraps a symmetric key.
Syntax
ANSI (Cross Platform) int UnwrapKey(const char* lpszKeyName, const char* lpszAlgorithm); Unicode (Windows) INT UnwrapKey(LPCWSTR lpszKeyName, LPCWSTR lpszAlgorithm);
int cloudkeys_azurekeys_unwrapkey(void* lpObj, const char* lpszKeyName, const char* lpszAlgorithm);
int UnwrapKey(const QString& qsKeyName, const QString& qsAlgorithm);
Remarks
This method unwraps (i.e., decrypts) a symmetric key using the key specified by KeyName and the given Algorithm.
This method functions exactly the same way as the Decrypt method, except that it requires the keys/unwrapKey permission instead of the keys/decrypt permission. Refer to the Decrypt method's documentation for more information.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
UpdateKey Method (AzureKeys Class)
Updates a key's information.
Syntax
ANSI (Cross Platform) int UpdateKey(const char* lpszKeyName, const char* lpszKeyOps, int bUpdateTags); Unicode (Windows) INT UpdateKey(LPCWSTR lpszKeyName, LPCWSTR lpszKeyOps, BOOL bUpdateTags);
int cloudkeys_azurekeys_updatekey(void* lpObj, const char* lpszKeyName, const char* lpszKeyOps, int bUpdateTags);
int UpdateKey(const QString& qsKeyName, const QString& qsKeyOps, bool bUpdateTags);
Remarks
This method updates the information for the key specified by KeyName. The VersionId configuration setting can be used to target a specific key version.
The KeyOps parameter, if non-empty, must be a comma-separated list of operations that the key is valid for. If empty, the key's current operations list remains unchanged. Possible values are as follows; operations should be specified in pairs:
- encrypt
- decrypt
- sign
- verify
- wrapKey
- unwrapKey
The UpdateTags parameter determines whether the class replaces the key's current tags with the items in the Tag* properties (which may be empty). Keys may have up to 15 tags.
The ExpiryDate and NotBeforeDate configuration settings may also be used to send additional values, refer to their documentation for more information.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Verify Method (AzureKeys Class)
Verifies a digital signature using a key.
Syntax
ANSI (Cross Platform) int Verify(const char* lpszKeyName, const char* lpszAlgorithm, int bIsDigest); Unicode (Windows) INT Verify(LPCWSTR lpszKeyName, LPCWSTR lpszAlgorithm, BOOL bIsDigest);
int cloudkeys_azurekeys_verify(void* lpObj, const char* lpszKeyName, const char* lpszAlgorithm, int bIsDigest);
bool Verify(const QString& qsKeyName, const QString& qsAlgorithm, bool bIsDigest);
Remarks
This method verifies a digital signature using the key specified by KeyName and the given Algorithm. The VersionId configuration setting can be used to target a specific key version. If the signature is successfully verified, this method returns true, otherwise it returns false.
The message data is taken from the input stream supplied via the SetInputStream method, the specified InputFile, or the InputData property. The digital signature data is taken from the specified OutputFile or the OutputData property.
The Algorithm parameter specifies which algorithm was used to sign the data. Possible values are:
- ES256: ECDSA using P-256 and SHA-256.
- ES256K: ECDSA using P-256K and SHA-256.
- ES384: ECDSA using P-384 and SHA-384.
- ES512: ECDSA using P-521 and SHA-512.
- PS256: RSASSA-PSS using SHA-256 and MGF1 with SHA-256.
- PS384: RSASSA-PSS using SHA-384 and MGF1 with SHA-384.
- PS512: RSASSA-PSS using SHA-512 and MGF1 with SHA-512.
- RS256: RSASSA-PKCS1-v1_5 using SHA-256.
- RS384: RSASSA-PKCS1-v1_5 using SHA-384.
- RS512: RSASSA-PKCS1-v1_5 using SHA-512.
The IsDigest parameter specifies whether the message data is the original message (false) or a message digest (true). When a message digest is supplied, keep in mind that it must be the exact same digest that was used at signing time, regardless of whether it has been recomputed.
If IsDigest is false, the class will automatically compute an appropriate message digest before the request is made. In such cases, the computed digest is made available via the MessageDigest configuration setting.
Error Handling (C++)
This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
WrapKey Method (AzureKeys Class)
Wraps a symmetric key.
Syntax
ANSI (Cross Platform) int WrapKey(const char* lpszKeyName, const char* lpszAlgorithm); Unicode (Windows) INT WrapKey(LPCWSTR lpszKeyName, LPCWSTR lpszAlgorithm);
int cloudkeys_azurekeys_wrapkey(void* lpObj, const char* lpszKeyName, const char* lpszAlgorithm);
int WrapKey(const QString& qsKeyName, const QString& qsAlgorithm);
Remarks
This method wraps (i.e., encrypts) a symmetric key using the key specified by KeyName and the given Algorithm. The VersionId configuration setting can be used to target a specific key version.
This method functions exactly the same way as the Encrypt method, except that it requires the keys/wrapKey permission instead of the keys/encrypt permission. Refer to the Encrypt method's documentation for more information.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
EndTransfer Event (AzureKeys Class)
This event fires when a document finishes transferring.
Syntax
ANSI (Cross Platform) virtual int FireEndTransfer(AzureKeysEndTransferEventParams *e);
typedef struct {
int Direction; int reserved; } AzureKeysEndTransferEventParams;
Unicode (Windows) virtual INT FireEndTransfer(AzureKeysEndTransferEventParams *e);
typedef struct {
INT Direction; INT reserved; } AzureKeysEndTransferEventParams;
#define EID_AZUREKEYS_ENDTRANSFER 1 virtual INT CLOUDKEYS_CALL FireEndTransfer(INT &iDirection);
class AzureKeysEndTransferEventParams { public: int Direction(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void EndTransfer(AzureKeysEndTransferEventParams *e);
// Or, subclass AzureKeys and override this emitter function. virtual int FireEndTransfer(AzureKeysEndTransferEventParams *e) {...}
Remarks
The EndTransfer event is fired when the document text finishes transferring from the server to the local host.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
Error Event (AzureKeys Class)
Fired when information is available about errors during data delivery.
Syntax
ANSI (Cross Platform) virtual int FireError(AzureKeysErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } AzureKeysErrorEventParams;
Unicode (Windows) virtual INT FireError(AzureKeysErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } AzureKeysErrorEventParams;
#define EID_AZUREKEYS_ERROR 2 virtual INT CLOUDKEYS_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class AzureKeysErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(AzureKeysErrorEventParams *e);
// Or, subclass AzureKeys and override this emitter function. virtual int FireError(AzureKeysErrorEventParams *e) {...}
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.
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 (AzureKeys Class)
This event is fired every time a header line comes in.
Syntax
ANSI (Cross Platform) virtual int FireHeader(AzureKeysHeaderEventParams *e);
typedef struct {
const char *Field;
const char *Value; int reserved; } AzureKeysHeaderEventParams;
Unicode (Windows) virtual INT FireHeader(AzureKeysHeaderEventParams *e);
typedef struct {
LPCWSTR Field;
LPCWSTR Value; INT reserved; } AzureKeysHeaderEventParams;
#define EID_AZUREKEYS_HEADER 3 virtual INT CLOUDKEYS_CALL FireHeader(LPSTR &lpszField, LPSTR &lpszValue);
class AzureKeysHeaderEventParams { public: const QString &Field(); const QString &Value(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Header(AzureKeysHeaderEventParams *e);
// Or, subclass AzureKeys and override this emitter function. virtual int FireHeader(AzureKeysHeaderEventParams *e) {...}
Remarks
The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.
If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).
KeyList Event (AzureKeys Class)
Fires once for each key when listing keys.
Syntax
ANSI (Cross Platform) virtual int FireKeyList(AzureKeysKeyListEventParams *e);
typedef struct {
const char *Name;
const char *VersionId;
const char *KeyType;
const char *KeyOps;
int Enabled;
int64 CreationDate;
int64 UpdateDate;
int64 DeletionDate;
int64 PurgeDate;
const char *PublicKey; int reserved; } AzureKeysKeyListEventParams;
Unicode (Windows) virtual INT FireKeyList(AzureKeysKeyListEventParams *e);
typedef struct {
LPCWSTR Name;
LPCWSTR VersionId;
LPCWSTR KeyType;
LPCWSTR KeyOps;
BOOL Enabled;
LONG64 CreationDate;
LONG64 UpdateDate;
LONG64 DeletionDate;
LONG64 PurgeDate;
LPCWSTR PublicKey; INT reserved; } AzureKeysKeyListEventParams;
#define EID_AZUREKEYS_KEYLIST 4 virtual INT CLOUDKEYS_CALL FireKeyList(LPSTR &lpszName, LPSTR &lpszVersionId, LPSTR &lpszKeyType, LPSTR &lpszKeyOps, BOOL &bEnabled, LONG64 &lCreationDate, LONG64 &lUpdateDate, LONG64 &lDeletionDate, LONG64 &lPurgeDate, LPSTR &lpszPublicKey);
class AzureKeysKeyListEventParams { public: const QString &Name(); const QString &VersionId(); const QString &KeyType(); const QString &KeyOps(); bool Enabled(); qint64 CreationDate(); qint64 UpdateDate(); qint64 DeletionDate(); qint64 PurgeDate(); const QString &PublicKey(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void KeyList(AzureKeysKeyListEventParams *e);
// Or, subclass AzureKeys and override this emitter function. virtual int FireKeyList(AzureKeysKeyListEventParams *e) {...}
Remarks
This event fires once for each key (or key version) returned when ListKeys, ListVersions, or GetKeyInfo is called. However, note that the KeyOps, KeyType, PublicKey, and (for ListKeys) VersionId parameters are not populated when one of the listing methods is called unless the IncludeKeyDetails property is enabled; refer to its documentation for more information.
Name reflects the name of the key.
VersionId reflects the Id of the key version.
KeyType reflects the key's type. Each key type has two variants, a software-based one and an HSM-based one. Possible values are shown in the first two columns of the following table:
Software-based | HSM-based | Description |
EC_P256 | EC_HSM_P256 | The NIST P-256 curve (SECP256R1). |
EC_P256K | EC_HSM_P256K | The SECP256K1 curve. |
EC_P384 | EC_HSM_P384 | The NIST P-384 curve (SECP384R1). |
EC_P521 | EC_HSM_P521 | The NIST P-521 curve (SECP521R1). |
RSA_2048 | RSA_HSM_2048 | 2048-bit RSA key. |
RSA_3072 | RSA_HSM_3072 | 3072-bit RSA key. |
RSA_4096 | RSA_HSM_4096 | 4096-bit RSA key. |
KeyOps reflects a comma-separated list of operations that the key may be used for. Possible values are:
- encrypt
- decrypt
- sign
- verify
- wrapKey
- unwrapKey
Enabled reflects whether the key is currently enabled.
CreationDate reflects the key's creation date, in seconds since the Unix epoch.
UpdateDate reflects the key's update date, in seconds since the Unix epoch.
DeletionDate reflects the key's deletion date, in seconds since the Unix epoch, or -1 if the key has not been deleted.
PurgeDate reflects the key's purge (i.e., permanent deletion) date, in seconds since the Unix epoch, or -1 if the key has not been deleted.
PublicKey reflects the key's public key, in PEM format.
Log Event (AzureKeys Class)
This event fires once for each log message.
Syntax
ANSI (Cross Platform) virtual int FireLog(AzureKeysLogEventParams *e);
typedef struct {
int LogLevel;
const char *Message;
const char *LogType; int reserved; } AzureKeysLogEventParams;
Unicode (Windows) virtual INT FireLog(AzureKeysLogEventParams *e);
typedef struct {
INT LogLevel;
LPCWSTR Message;
LPCWSTR LogType; INT reserved; } AzureKeysLogEventParams;
#define EID_AZUREKEYS_LOG 5 virtual INT CLOUDKEYS_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);
class AzureKeysLogEventParams { public: int LogLevel(); const QString &Message(); const QString &LogType(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Log(AzureKeysLogEventParams *e);
// Or, subclass AzureKeys and override this emitter function. virtual int FireLog(AzureKeysLogEventParams *e) {...}
Remarks
This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.
LogLevel indicates the level of message. Possible values are as follows:
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 (AzureKeys Class)
Fired after the server presents its certificate to the client.
Syntax
ANSI (Cross Platform) virtual int FireSSLServerAuthentication(AzureKeysSSLServerAuthenticationEventParams *e);
typedef struct {
const char *CertEncoded; int lenCertEncoded;
const char *CertSubject;
const char *CertIssuer;
const char *Status;
int Accept; int reserved; } AzureKeysSSLServerAuthenticationEventParams;
Unicode (Windows) virtual INT FireSSLServerAuthentication(AzureKeysSSLServerAuthenticationEventParams *e);
typedef struct {
LPCSTR CertEncoded; INT lenCertEncoded;
LPCWSTR CertSubject;
LPCWSTR CertIssuer;
LPCWSTR Status;
BOOL Accept; INT reserved; } AzureKeysSSLServerAuthenticationEventParams;
#define EID_AZUREKEYS_SSLSERVERAUTHENTICATION 6 virtual INT CLOUDKEYS_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);
class AzureKeysSSLServerAuthenticationEventParams { public: const QByteArray &CertEncoded(); const QString &CertSubject(); const QString &CertIssuer(); const QString &Status(); bool Accept(); void SetAccept(bool bAccept); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSLServerAuthentication(AzureKeysSSLServerAuthenticationEventParams *e);
// Or, subclass AzureKeys and override this emitter function. virtual int FireSSLServerAuthentication(AzureKeysSSLServerAuthenticationEventParams *e) {...}
Remarks
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 (AzureKeys Class)
Fired when secure connection progress messages are available.
Syntax
ANSI (Cross Platform) virtual int FireSSLStatus(AzureKeysSSLStatusEventParams *e);
typedef struct {
const char *Message; int reserved; } AzureKeysSSLStatusEventParams;
Unicode (Windows) virtual INT FireSSLStatus(AzureKeysSSLStatusEventParams *e);
typedef struct {
LPCWSTR Message; INT reserved; } AzureKeysSSLStatusEventParams;
#define EID_AZUREKEYS_SSLSTATUS 7 virtual INT CLOUDKEYS_CALL FireSSLStatus(LPSTR &lpszMessage);
class AzureKeysSSLStatusEventParams { public: const QString &Message(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSLStatus(AzureKeysSSLStatusEventParams *e);
// Or, subclass AzureKeys and override this emitter function. virtual int FireSSLStatus(AzureKeysSSLStatusEventParams *e) {...}
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
StartTransfer Event (AzureKeys Class)
This event fires when a document starts transferring (after the headers).
Syntax
ANSI (Cross Platform) virtual int FireStartTransfer(AzureKeysStartTransferEventParams *e);
typedef struct {
int Direction; int reserved; } AzureKeysStartTransferEventParams;
Unicode (Windows) virtual INT FireStartTransfer(AzureKeysStartTransferEventParams *e);
typedef struct {
INT Direction; INT reserved; } AzureKeysStartTransferEventParams;
#define EID_AZUREKEYS_STARTTRANSFER 8 virtual INT CLOUDKEYS_CALL FireStartTransfer(INT &iDirection);
class AzureKeysStartTransferEventParams { public: int Direction(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void StartTransfer(AzureKeysStartTransferEventParams *e);
// Or, subclass AzureKeys and override this emitter function. virtual int FireStartTransfer(AzureKeysStartTransferEventParams *e) {...}
Remarks
The StartTransfer event is fired when the document text starts transferring from the server to the local host.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
TagList Event (AzureKeys Class)
Fires once for each tag returned when a key's information is retrieved.
Syntax
ANSI (Cross Platform) virtual int FireTagList(AzureKeysTagListEventParams *e);
typedef struct {
const char *KeyName;
const char *VersionId;
const char *Name;
const char *Value; int reserved; } AzureKeysTagListEventParams;
Unicode (Windows) virtual INT FireTagList(AzureKeysTagListEventParams *e);
typedef struct {
LPCWSTR KeyName;
LPCWSTR VersionId;
LPCWSTR Name;
LPCWSTR Value; INT reserved; } AzureKeysTagListEventParams;
#define EID_AZUREKEYS_TAGLIST 9 virtual INT CLOUDKEYS_CALL FireTagList(LPSTR &lpszKeyName, LPSTR &lpszVersionId, LPSTR &lpszName, LPSTR &lpszValue);
class AzureKeysTagListEventParams { public: const QString &KeyName(); const QString &VersionId(); const QString &Name(); const QString &Value(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TagList(AzureKeysTagListEventParams *e);
// Or, subclass AzureKeys and override this emitter function. virtual int FireTagList(AzureKeysTagListEventParams *e) {...}
Remarks
This event fires once for each tag returned when GetKeyInfo is called.
KeyName reflects the name of the key.
VersionId reflects the Id of the key version.
Name reflects the name of the tag.
Value reflects the value of the tag.
Transfer Event (AzureKeys Class)
This event is fired while a document transfers (delivers document).
Syntax
ANSI (Cross Platform) virtual int FireTransfer(AzureKeysTransferEventParams *e);
typedef struct {
int Direction;
int64 BytesTransferred;
int PercentDone;
const char *Text; int lenText; int reserved; } AzureKeysTransferEventParams;
Unicode (Windows) virtual INT FireTransfer(AzureKeysTransferEventParams *e);
typedef struct {
INT Direction;
LONG64 BytesTransferred;
INT PercentDone;
LPCSTR Text; INT lenText; INT reserved; } AzureKeysTransferEventParams;
#define EID_AZUREKEYS_TRANSFER 10 virtual INT CLOUDKEYS_CALL FireTransfer(INT &iDirection, LONG64 &lBytesTransferred, INT &iPercentDone, LPSTR &lpText, INT &lenText);
class AzureKeysTransferEventParams { 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(AzureKeysTransferEventParams *e);
// Or, subclass AzureKeys and override this emitter function. virtual int FireTransfer(AzureKeysTransferEventParams *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.
CloudKeysStream Type
Syntax
CloudKeysStream (declared in cloudkeys.h)
Remarks
The AzureKeys 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 AzureKeys 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.
Properties | |
CanRead |
Whether the stream supports reading.
bool CanRead() { return true; } |
CanSeek |
Whether the stream supports seeking.
bool CanSeek() { return true; } |
CanWrite |
Whether the stream supports writing.
bool CanWrite() { return true; } |
Length |
Gets the length of the stream, in bytes.
int64 GetLength() = 0; |
Methods | |
Close |
Closes the stream, releasing all resources currently allocated for it.
void Close() {} This method is called automatically when a CloudKeysStream object is deleted. |
Flush |
Forces all data held by the stream's buffers to be written out to storage.
int Flush() { return 0; } Must return 0 if flushing is successful; or -1 if an error occurs or the stream is closed. If the stream does not support writing, this method must do nothing and return 0. |
Read |
Reads a sequence of bytes from the stream and advances the current position within the stream by the number of bytes read.
int Read(void* buffer, int count) = 0; Buffer specifies the buffer to populate with data from the stream. Count specifies the number of bytes that should be read from the stream. Must return the total number of bytes read into Buffer; this may be less than Count if that many bytes are not currently available, or 0 if the end of the stream has been reached. Must return -1 if an error occurs, if reading is not supported, or if the stream is closed. |
Seek |
Sets the current position within the stream based on a particular point of origin.
int64 Seek(int64 offset, int seekOrigin) = 0; Offset specifies the offset in the stream to seek to, relative to SeekOrigin. Valid values for SeekOrigin are:
Must return the new position within the stream; or -1 if an error occurs, if seeking is not supported, or if the stream is closed (however, see note below). If -1 is returned, the current position within the stream must remain unchanged. Note: If the stream is not closed, it must always be possible to call this method with an Offset of 0 and a SeekOrigin of 1 to obtain the current position within the stream, even if seeking is not otherwise supported. |
Write |
Writes a sequence of bytes to the stream and advances the current position within the stream by the number of bytes written.
int Write(const void* buffer, int count) = 0; Buffer specifies the buffer with data to write to the stream. Count specifies the number of bytes that should be written to the stream. Must return the total number of bytes written to the stream; this may be less than Count if that many bytes could not be written. Must return -1 if an error occurs, if writing is not supported, or if the stream is closed. |
Config Settings (AzureKeys 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.AzureKeys Config Settings
By default, this setting is enabled, allowing all pages of results to be accumulated in the appropriate collection properties.
By default, this setting is enabled, and keys are created in an enabled state.
A key can only be used for the Decrypt, Verify, and UnwrapKey operations after its expiry date.
By default, this setting is set to -1, and no expiry date is sent.
By default, this setting is disabled, and the class requests information about active keys.
If this setting is -1 (default), the server's default (25) is used. Otherwise, the setting must be set to a value greater than or equal to 1.
A key can only be used for the Decrypt, Verify, and UnwrapKey operations prior to its "not before" date.
By default, this setting is set to -1, and no "not before" date is sent.
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. |
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.
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.
To parse the payload for specific claims, see OAuthJWTXPath.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
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.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
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 + "]");
}
- 1 (Plain)
- 2 (S256/SHA256 - default)
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 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.
Note: This is only applicable when OAuthWebServerSSLEnabled is set to true.
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 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.
The default value is localhost.
- Decrypt
- Encrypt
- GetKeyInfo (unless GetDeleted is enabled, in which case this setting is ignored)
- Sign
- UnwrapKey
- UpdateKey
- Verify
- WrapKey
The current element is specified via the XPath configuration setting. This configuration setting is read-only.
The current element is specified via the XPath configuration setting. This configuration setting is read-only.
The current element is specified via the XPath configuration setting. This configuration setting is read-only.
The current element is specified via the XPath configuration setting. This configuration setting is read-only.
The current element is specified via the XPath configuration setting. This configuration setting is read-only.
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.
The current element is specified via the XPath configuration setting. This configuration setting is read-only.
The current element is specified in the XPath configuration setting. This configuration setting is read-only.
HTTP Config Settings
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.
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 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]".
The default value is False.
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
- "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.
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
The default value for KeepAlive is false.
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).
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.
.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"));
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
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.
Note: This setting is applicable only to Mac/iOS editions.
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.
Override the default with the name and version of your software.
TCPClient Config Settings
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.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.
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.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
Note: This configuration setting is only available in the Unix platform. It is not supported in masOS or FreeBSD.
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.
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).
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.
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.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this config is set to false.
0 | IPv4 Only |
1 | IPv6 Only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
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.
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.
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.
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".
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.
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
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
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.
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.
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 is only applicable when SSLProvider is set to Internal.
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.
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.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
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.
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-----
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.
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)
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"
- "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)
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
Note: This option is not valid for UDP ports.
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.
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
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 |
- 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.
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.
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.
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 (AzureKeys 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). |