# Struct cloudkeys::AzureKeys

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

## Syntax

```text
cloudkeys::AzureKeys
```

## Remarks

The AzureKeys struct 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 struct 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](AzureSecrets.md#AzureSecrets) struct.

To begin, register for an Azure account and create one or more Key Vaults via the Azure Portal. Set the [vault](#vault-property-azurekeys-struct) property to the name of the vault you wish to work with.

This struct requires authentication via OAuth 2.0. First, perform OAuth authentication using the o_auth property to set the appropriate fields for the chosen [o_auth_client_profile](#o_auth_client_profile-property-azurekeys-struct) and [o_auth_grant_type](#o_auth_grant_type-property-azurekeys-struct).

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

Additionally, depending on how the application is registered (e.g. Single-tenant, Multi-tenant) and what [o_auth_grant_type](#o_auth_grant_type-property-azurekeys-struct) is selected (e.g. Authorization Code, Password), it may be required to use the tenant ID rather than "common" in the [o_auth_server_auth_url](#o_auth_server_auth_url-property-azurekeys-struct), and [o_auth_server_token_url](#o_auth_server_token_url-property-azurekeys-struct) 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" |

 Below is a brief description of the different [o_auth_client_profile](#o_auth_client_profile-property-azurekeys-struct) and [o_auth_grant_type](#o_auth_grant_type-property-azurekeys-struct) values that are supported by this struct. For a more in-depth description of what needs to be set, refer to the service documentation.

### 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 struct. 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](#authorize-method-azurekeys-struct) method should be called. If the authorization and authentication was successful, then the [o_auth_access_token](#o_auth_access_token-property-azurekeys-struct) property will be populated. Additionally, if a *refresh token* was provided the [o_auth_refresh_token](#o_auth_refresh_token-property-azurekeys-struct) property will be populated as well. These values of the fields are for informational purposes. The struct will also cache these tokens along with when the [o_auth_access_token](#o_auth_access_token-property-azurekeys-struct) will be expired. When a method that makes requests to the service provider is called or the [authorize](#authorize-method-azurekeys-struct) method is called the struct will automatically check to see if the *access token* is expired. If it is, it will then automatically try to get a new [o_auth_access_token](#o_auth_access_token-property-azurekeys-struct). If the [authorize](#authorize-method-azurekeys-struct) method was not used and user interaction would be required, the struct will throw an error which can be caught. When user interaction is needed depends on what grant type is set in the [o_auth_grant_type](#o_auth_grant_type-property-azurekeys-struct) property. To force the component to only check the *access token* when the [authorize](#authorize-method-azurekeys-struct) method is called, the [OAuthAutomaticRefresh](#OAuthAutomaticRefresh) configuration setting can be set to false.

A brief description of the supported values for the [o_auth_grant_type](#o_auth_grant_type-property-azurekeys-struct) property are below. For more information, see the service documentation.

**Authorization Code**

When using the *Authorization Code* grant type, the struct will use an *authorization code* to get an *access token*. For this [o_auth_grant_type](#o_auth_grant_type-property-azurekeys-struct) the struct expects a [o_auth_client_id](#o_auth_client_id-property-azurekeys-struct), [o_auth_client_secret](#o_auth_client_secret-property-azurekeys-struct), [o_auth_server_auth_url](#o_auth_server_auth_url-property-azurekeys-struct), and [o_auth_server_token_url](#o_auth_server_token_url-property-azurekeys-struct) to be set. When the [authorize](#authorize-method-azurekeys-struct) 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 struct will parse the *authorization code*, setting the [o_auth_authorization_code](#o_auth_authorization_code-property-azurekeys-struct) property, from the redirect. Immediately, the struct 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 [o_auth_refresh_token](#o_auth_refresh_token-property-azurekeys-struct) property is set, or a *refresh token* is cached, then the struct will not launch the browser and use the *refresh token* in its request to the token server instead of an *authorization code*.

**Example: **

```csharp
AzureKeys azurekeys = new AzureKeys();

azurekeys.OAuth.ClientProfile = CloudOAuthClientProfiles.cocpApplication;
azurekeys.OAuth.GrantType = OAuthSettingsGrantTypes.cogtAuthorizationCode;
azurekeys.OAuth.ClientId = CLIENT_ID;
azurekeys.OAuth.ClientSecret = SECRET_ID;
azurekeys.OAuth.AuthorizationScope = "offline_access https://vault.azure.net/user_impersonation";
azurekeys.OAuth.ServerAuthURL = "https://login.microsoftonline.com/" + TENANT_ID + "/oauth2/v2.0/authorize";
azurekeys.OAuth.ServerTokenURL = "https://login.microsoftonline.com/" + TENANT_ID + "/oauth2/v2.0/token";

azurekeys.Authorize();
```

 **Implicit**

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

When using the *Implicit* grant type, the struct will request the authorization server to get an *access token*. For this [o_auth_grant_type](#o_auth_grant_type-property-azurekeys-struct) the struct expects a [o_auth_client_id](#o_auth_client_id-property-azurekeys-struct), [o_auth_client_secret](#o_auth_client_secret-property-azurekeys-struct), and [o_auth_server_auth_url](#o_auth_server_auth_url-property-azurekeys-struct) to be set. When the [authorize](#authorize-method-azurekeys-struct) 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 struct 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 struct 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 struct will authenticate as the resource owner. This allows for the struct 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 [o_auth_grant_type](#o_auth_grant_type-property-azurekeys-struct) the struct requires [OAuthPasswordGrantUsername](#OAuthPasswordGrantUsername), [o_auth_client_secret](#o_auth_client_secret-property-azurekeys-struct), and [o_auth_server_token_url](#o_auth_server_token_url-property-azurekeys-struct) to be set. The [o_auth_client_secret](#o_auth_client_secret-property-azurekeys-struct) should be set to the password of the account instead of a typical secret. In some cases, the [o_auth_client_id](#o_auth_client_id-property-azurekeys-struct) also needs to be set. When the [authorize](#authorize-method-azurekeys-struct) 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 struct to the Application profile and Authorization Code grant type except the struct 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 [o_auth_client_id](#o_auth_client_id-property-azurekeys-struct), [o_auth_client_secret](#o_auth_client_secret-property-azurekeys-struct), [o_auth_server_auth_url](#o_auth_server_auth_url-property-azurekeys-struct), [o_auth_server_token_url](#o_auth_server_token_url-property-azurekeys-struct), and the [o_auth_return_url](#o_auth_return_url-property-azurekeys-struct) properties to be set. Before calling the [authorize](#authorize-method-azurekeys-struct) method, the [o_auth_web_auth_url](#o_auth_web_auth_url-property-azurekeys-struct) 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 [o_auth_return_url](#o_auth_return_url-property-azurekeys-struct) property. The [o_auth_return_url](#o_auth_return_url-property-azurekeys-struct) 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 [o_auth_authorization_code](#o_auth_authorization_code-property-azurekeys-struct) property. Once that is set, the [authorize](#authorize-method-azurekeys-struct) method can be called to exchange the *authorization code* for an *access token* and *refresh token* if provided. The struct will then cache these values like normal and use them to make requests. If the [o_auth_refresh_token](#o_auth_refresh_token-property-azurekeys-struct) field is set, or a *refresh token* is cached, then the [authorize](#authorize-method-azurekeys-struct) 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 a separate OAuth client. Once complete you should have an authorization string which looks like:

```text
Bearer ACCESS_TOKEN_VALUE
```

Assign this value to the [authorization](#authorization-property-azurekeys-struct) property before attempting any operations. Setting the [authorization](#authorization-property-azurekeys-struct) property will cause the struct to ignore the values set in the o_auth property.

 For Example:

```csharp
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 Struct

Keys can be created using the [create_key](#create_key-method-azurekeys-struct) 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 [update_key](#update_key-method-azurekeys-struct). 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 [delete_key](#delete_key-method-azurekeys-struct) 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 [recover_key](#recover_key-method-azurekeys-struct), or permanently deleted using [purge_key](#purge_key-method-azurekeys-struct) (assuming the currently-authenticated user has the permissions to do so).

```csharp
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 [list_keys](#list_keys-method-azurekeys-struct) method. This method is also used to list soft-deleted keys if the [GetDeleted](#GetDeleted) configuration setting has been enabled first. To list a key's versions, use the [list_versions](#list_versions-method-azurekeys-struct) method. (You cannot list a deleted key's versions.) In all cases, the [include_key_details](#include_key_details-property-azurekeys-struct) property can optionally be enabled to have the struct attempt to retrieve the full information for each key (Azure leaves out certain fields by default when listing).

```csharp
// 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](#encrypt-method-azurekeys-struct) and [decrypt](#decrypt-method-azurekeys-struct) operations. Keys with the *sign* and *verify* ops can be used in [sign](#sign-method-azurekeys-struct) and [verify](#verify-method-azurekeys-struct). Finally, keys with the *wrapKey* and *unwrapKey* ops can be used in [wrap_key](#wrap_key-method-azurekeys-struct) and [unwrap_key](#unwrap_key-method-azurekeys-struct) 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 [input_data](#input_data-property-azurekeys-struct) or [input_file](#input_file-property-azurekeys-struct) to supply the input data that should be processed. All operations will output the result data to [output_data](#output_data-property-azurekeys-struct) or [output_file](#output_file-property-azurekeys-struct) (except [verify](#verify-method-azurekeys-struct); refer to its documentation for more information).

```csharp
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 struct also supports a variety of other functionality, including:

- Retrieval of a single key's information (including public key) with [get_key_info](#get_key_info-method-azurekeys-struct).
- Enabling and disabling keys with [set_key_enabled](#set_key_enabled-method-azurekeys-struct).
- Tagging support using [add_tag](#add_tag-method-azurekeys-struct) and the tags properties.
- Secure key backup and restoration using [backup_key](#backup_key-method-azurekeys-struct) and [restore_key](#restore_key-method-azurekeys-struct).
- And more!

### Object Lifetime

 The *new()* method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by CloudKeys. Due to this, the AzureKeys struct cannot be disposed of automatically. Please, call the *dispose(&mut; self)* method of AzureKeys when you have finished using the instance.

## Property List

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

|  |  |
| --- | --- |
| [authorization](#authorization-property-azurekeys-struct) | OAuth 2.0 Authorization Token. |
| [firewall_auto_detect](#firewall_auto_detect-property-azurekeys-struct) | Whether to automatically detect and use firewall system settings, if available. |
| [firewall_type](#firewall_type-property-azurekeys-struct) | The type of firewall to connect through. |
| [firewall_host](#firewall_host-property-azurekeys-struct) | The name or IP address of the firewall (optional). |
| [firewall_password](#firewall_password-property-azurekeys-struct) | A password if authentication is to be used when connecting through the firewall. |
| [firewall_port](#firewall_port-property-azurekeys-struct) | The Transmission Control Protocol (TCP) port for the firewall Host . |
| [firewall_user](#firewall_user-property-azurekeys-struct) | A username if authentication is to be used when connecting through a firewall. |
| [idle](#idle-property-azurekeys-struct) | The current status of the struct. |
| [include_key_details](#include_key_details-property-azurekeys-struct) | Whether to attempt to retrieve fill details when listing keys. |
| [input_data](#input_data-property-azurekeys-struct) | The data to process. |
| [input_file](#input_file-property-azurekeys-struct) | The file whose data should be processed. |
| [key_marker](#key_marker-property-azurekeys-struct) | A marker indicating what page of keys to return next. |
| [key_count](#key_count-property-azurekeys-struct) | The number of records in the Key arrays. |
| [key_creation_date](#key_creation_date-property-azurekeys-struct) | The creation date of the key. |
| [key_deletion_date](#key_deletion_date-property-azurekeys-struct) | The deletion date of the key. |
| [key_enabled](#key_enabled-property-azurekeys-struct) | Whether the key is enabled. |
| [key_expiry_date](#key_expiry_date-property-azurekeys-struct) | The expiration date of the key. |
| [key_ops](#key_ops-property-azurekeys-struct) | The operation that the key may be used for. |
| [key_type](#key_type-property-azurekeys-struct) | The key's type. |
| [key_name](#key_name-property-azurekeys-struct) | The name of the key. |
| [key_not_before_date](#key_not_before_date-property-azurekeys-struct) | The 'not before' date of the key. |
| [key_public_key](#key_public_key-property-azurekeys-struct) | The key's public key. |
| [key_purge_date](#key_purge_date-property-azurekeys-struct) | The purge date of the key. |
| [key_recoverable_days](#key_recoverable_days-property-azurekeys-struct) | The number of days the key will be recoverable if it gets deleted. |
| [key_recovery_level](#key_recovery_level-property-azurekeys-struct) | The key's ability to be recovered and/or purged if it gets deleted. |
| [key_update_date](#key_update_date-property-azurekeys-struct) | The update date of the key. |
| [key_version_id](#key_version_id-property-azurekeys-struct) | The version Id of the key. |
| [local_host](#local_host-property-azurekeys-struct) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| [o_auth_access_token](#o_auth_access_token-property-azurekeys-struct) | The access token returned by the authorization server. |
| [o_auth_authorization_code](#o_auth_authorization_code-property-azurekeys-struct) | The authorization code that is exchanged for an access token. |
| [o_auth_authorization_scope](#o_auth_authorization_scope-property-azurekeys-struct) | The scope request or response parameter used during authorization. |
| [o_auth_client_id](#o_auth_client_id-property-azurekeys-struct) | The id of the client assigned when registering the application. |
| [o_auth_client_profile](#o_auth_client_profile-property-azurekeys-struct) | The type of client that is requesting authorization. |
| [o_auth_client_secret](#o_auth_client_secret-property-azurekeys-struct) | The secret value for the client assigned when registering the application. |
| [o_auth_grant_type](#o_auth_grant_type-property-azurekeys-struct) | The OAuth grant type used to acquire an OAuth access token. |
| [o_auth_refresh_token](#o_auth_refresh_token-property-azurekeys-struct) | Specifies the refresh token received from or sent to the authorization server. |
| [o_auth_request_refresh_token](#o_auth_request_refresh_token-property-azurekeys-struct) | Specifies whether the struct will request a refresh token during authorization. |
| [o_auth_return_url](#o_auth_return_url-property-azurekeys-struct) | The URL where the user (browser) returns after authenticating. |
| [o_auth_server_auth_url](#o_auth_server_auth_url-property-azurekeys-struct) | The URL of the authorization server. |
| [o_auth_server_token_url](#o_auth_server_token_url-property-azurekeys-struct) | The URL of the token server used to obtain the access token. |
| [o_auth_timeout](#o_auth_timeout-property-azurekeys-struct) | The amount of time (in seconds) the struct will wait for a response from the browser in the LaunchBrowser event. |
| [o_auth_web_auth_url](#o_auth_web_auth_url-property-azurekeys-struct) | The URL to which the user should be re-directed for authorization. |
| [other_headers](#other_headers-property-azurekeys-struct) | Other headers as determined by the user (optional). |
| [output_data](#output_data-property-azurekeys-struct) | The output data. |
| [output_file](#output_file-property-azurekeys-struct) | The file to which output data should be written. |
| [overwrite](#overwrite-property-azurekeys-struct) | Whether the output file should be overwritten if necessary. |
| [parsed_header_count](#parsed_header_count-property-azurekeys-struct) | The number of records in the ParsedHeader arrays. |
| [parsed_header_field](#parsed_header_field-property-azurekeys-struct) | This property contains the name of the HTTP header (this is the same case as it is delivered). |
| [parsed_header_value](#parsed_header_value-property-azurekeys-struct) | This property contains the header contents. |
| [proxy_auth_scheme](#proxy_auth_scheme-property-azurekeys-struct) | The type of authorization to perform when connecting to the proxy. |
| [proxy_auto_detect](#proxy_auto_detect-property-azurekeys-struct) | Whether to automatically detect and use proxy system settings, if available. |
| [proxy_password](#proxy_password-property-azurekeys-struct) | A password if authentication is to be used for the proxy. |
| [proxy_port](#proxy_port-property-azurekeys-struct) | The Transmission Control Protocol (TCP) port for the proxy Server (default 80). |
| [proxy_server](#proxy_server-property-azurekeys-struct) | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
| [proxy_ssl](#proxy_ssl-property-azurekeys-struct) | When to use a Secure Sockets Layer (SSL) for the connection to the proxy. |
| [proxy_user](#proxy_user-property-azurekeys-struct) | A username if authentication is to be used for the proxy. |
| [query_param_count](#query_param_count-property-azurekeys-struct) | The number of records in the QueryParam arrays. |
| [query_param_name](#query_param_name-property-azurekeys-struct) | The name of the query parameter. |
| [query_param_value](#query_param_value-property-azurekeys-struct) | The value of the query parameter. |
| [ssl_accept_server_cert_effective_date](#ssl_accept_server_cert_effective_date-property-azurekeys-struct) | The date on which this certificate becomes valid. |
| [ssl_accept_server_cert_expiration_date](#ssl_accept_server_cert_expiration_date-property-azurekeys-struct) | The date on which the certificate expires. |
| [ssl_accept_server_cert_extended_key_usage](#ssl_accept_server_cert_extended_key_usage-property-azurekeys-struct) | A comma-delimited list of extended key usage identifiers. |
| [ssl_accept_server_cert_fingerprint](#ssl_accept_server_cert_fingerprint-property-azurekeys-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [ssl_accept_server_cert_fingerprint_sha1](#ssl_accept_server_cert_fingerprint_sha1-property-azurekeys-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [ssl_accept_server_cert_fingerprint_sha256](#ssl_accept_server_cert_fingerprint_sha256-property-azurekeys-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [ssl_accept_server_cert_issuer](#ssl_accept_server_cert_issuer-property-azurekeys-struct) | The issuer of the certificate. |
| [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property-azurekeys-struct) | The private key of the certificate (if available). |
| [ssl_accept_server_cert_private_key_available](#ssl_accept_server_cert_private_key_available-property-azurekeys-struct) | Whether a PrivateKey is available for the selected certificate. |
| [ssl_accept_server_cert_private_key_container](#ssl_accept_server_cert_private_key_container-property-azurekeys-struct) | The name of the PrivateKey container for the certificate (if available). |
| [ssl_accept_server_cert_public_key](#ssl_accept_server_cert_public_key-property-azurekeys-struct) | The public key of the certificate. |
| [ssl_accept_server_cert_public_key_algorithm](#ssl_accept_server_cert_public_key_algorithm-property-azurekeys-struct) | The textual description of the certificate's public key algorithm. |
| [ssl_accept_server_cert_public_key_length](#ssl_accept_server_cert_public_key_length-property-azurekeys-struct) | The length of the certificate's public key (in bits). |
| [ssl_accept_server_cert_serial_number](#ssl_accept_server_cert_serial_number-property-azurekeys-struct) | The serial number of the certificate encoded as a string. |
| [ssl_accept_server_cert_signature_algorithm](#ssl_accept_server_cert_signature_algorithm-property-azurekeys-struct) | The text description of the certificate's signature algorithm. |
| [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-azurekeys-struct) | The name of the certificate store for the client certificate. |
| [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property-azurekeys-struct) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| [ssl_accept_server_cert_store_type](#ssl_accept_server_cert_store_type-property-azurekeys-struct) | The type of certificate store for this certificate. |
| [ssl_accept_server_cert_subject_alt_names](#ssl_accept_server_cert_subject_alt_names-property-azurekeys-struct) | Comma-separated lists of alternative subject names for the certificate. |
| [ssl_accept_server_cert_thumbprint_md5](#ssl_accept_server_cert_thumbprint_md5-property-azurekeys-struct) | The MD5 hash of the certificate. |
| [ssl_accept_server_cert_thumbprint_sha1](#ssl_accept_server_cert_thumbprint_sha1-property-azurekeys-struct) | The SHA-1 hash of the certificate. |
| [ssl_accept_server_cert_thumbprint_sha256](#ssl_accept_server_cert_thumbprint_sha256-property-azurekeys-struct) | The SHA-256 hash of the certificate. |
| [ssl_accept_server_cert_usage](#ssl_accept_server_cert_usage-property-azurekeys-struct) | The text description of UsageFlags . |
| [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property-azurekeys-struct) | The flags that show intended use for the certificate. |
| [ssl_accept_server_cert_version](#ssl_accept_server_cert_version-property-azurekeys-struct) | The certificate's version number. |
| [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-azurekeys-struct) | The subject of the certificate used for client authentication. |
| [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property-azurekeys-struct) | The certificate (PEM/Base64 encoded). |
| [ssl_cert_effective_date](#ssl_cert_effective_date-property-azurekeys-struct) | The date on which this certificate becomes valid. |
| [ssl_cert_expiration_date](#ssl_cert_expiration_date-property-azurekeys-struct) | The date on which the certificate expires. |
| [ssl_cert_extended_key_usage](#ssl_cert_extended_key_usage-property-azurekeys-struct) | A comma-delimited list of extended key usage identifiers. |
| [ssl_cert_fingerprint](#ssl_cert_fingerprint-property-azurekeys-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [ssl_cert_fingerprint_sha1](#ssl_cert_fingerprint_sha1-property-azurekeys-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [ssl_cert_fingerprint_sha256](#ssl_cert_fingerprint_sha256-property-azurekeys-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [ssl_cert_issuer](#ssl_cert_issuer-property-azurekeys-struct) | The issuer of the certificate. |
| [ssl_cert_private_key](#ssl_cert_private_key-property-azurekeys-struct) | The private key of the certificate (if available). |
| [ssl_cert_private_key_available](#ssl_cert_private_key_available-property-azurekeys-struct) | Whether a PrivateKey is available for the selected certificate. |
| [ssl_cert_private_key_container](#ssl_cert_private_key_container-property-azurekeys-struct) | The name of the PrivateKey container for the certificate (if available). |
| [ssl_cert_public_key](#ssl_cert_public_key-property-azurekeys-struct) | The public key of the certificate. |
| [ssl_cert_public_key_algorithm](#ssl_cert_public_key_algorithm-property-azurekeys-struct) | The textual description of the certificate's public key algorithm. |
| [ssl_cert_public_key_length](#ssl_cert_public_key_length-property-azurekeys-struct) | The length of the certificate's public key (in bits). |
| [ssl_cert_serial_number](#ssl_cert_serial_number-property-azurekeys-struct) | The serial number of the certificate encoded as a string. |
| [ssl_cert_signature_algorithm](#ssl_cert_signature_algorithm-property-azurekeys-struct) | The text description of the certificate's signature algorithm. |
| [ssl_cert_store](#ssl_cert_store-property-azurekeys-struct) | The name of the certificate store for the client certificate. |
| [ssl_cert_store_password](#ssl_cert_store_password-property-azurekeys-struct) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| [ssl_cert_store_type](#ssl_cert_store_type-property-azurekeys-struct) | The type of certificate store for this certificate. |
| [ssl_cert_subject_alt_names](#ssl_cert_subject_alt_names-property-azurekeys-struct) | Comma-separated lists of alternative subject names for the certificate. |
| [ssl_cert_thumbprint_md5](#ssl_cert_thumbprint_md5-property-azurekeys-struct) | The MD5 hash of the certificate. |
| [ssl_cert_thumbprint_sha1](#ssl_cert_thumbprint_sha1-property-azurekeys-struct) | The SHA-1 hash of the certificate. |
| [ssl_cert_thumbprint_sha256](#ssl_cert_thumbprint_sha256-property-azurekeys-struct) | The SHA-256 hash of the certificate. |
| [ssl_cert_usage](#ssl_cert_usage-property-azurekeys-struct) | The text description of UsageFlags . |
| [ssl_cert_usage_flags](#ssl_cert_usage_flags-property-azurekeys-struct) | The flags that show intended use for the certificate. |
| [ssl_cert_version](#ssl_cert_version-property-azurekeys-struct) | The certificate's version number. |
| [ssl_cert_subject](#ssl_cert_subject-property-azurekeys-struct) | The subject of the certificate used for client authentication. |
| [ssl_cert_encoded](#ssl_cert_encoded-property-azurekeys-struct) | The certificate (PEM/Base64 encoded). |
| [ssl_provider](#ssl_provider-property-azurekeys-struct) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
| [ssl_server_cert_effective_date](#ssl_server_cert_effective_date-property-azurekeys-struct) | The date on which this certificate becomes valid. |
| [ssl_server_cert_expiration_date](#ssl_server_cert_expiration_date-property-azurekeys-struct) | The date on which the certificate expires. |
| [ssl_server_cert_extended_key_usage](#ssl_server_cert_extended_key_usage-property-azurekeys-struct) | A comma-delimited list of extended key usage identifiers. |
| [ssl_server_cert_fingerprint](#ssl_server_cert_fingerprint-property-azurekeys-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [ssl_server_cert_fingerprint_sha1](#ssl_server_cert_fingerprint_sha1-property-azurekeys-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [ssl_server_cert_fingerprint_sha256](#ssl_server_cert_fingerprint_sha256-property-azurekeys-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [ssl_server_cert_issuer](#ssl_server_cert_issuer-property-azurekeys-struct) | The issuer of the certificate. |
| [ssl_server_cert_private_key](#ssl_server_cert_private_key-property-azurekeys-struct) | The private key of the certificate (if available). |
| [ssl_server_cert_private_key_available](#ssl_server_cert_private_key_available-property-azurekeys-struct) | Whether a PrivateKey is available for the selected certificate. |
| [ssl_server_cert_private_key_container](#ssl_server_cert_private_key_container-property-azurekeys-struct) | The name of the PrivateKey container for the certificate (if available). |
| [ssl_server_cert_public_key](#ssl_server_cert_public_key-property-azurekeys-struct) | The public key of the certificate. |
| [ssl_server_cert_public_key_algorithm](#ssl_server_cert_public_key_algorithm-property-azurekeys-struct) | The textual description of the certificate's public key algorithm. |
| [ssl_server_cert_public_key_length](#ssl_server_cert_public_key_length-property-azurekeys-struct) | The length of the certificate's public key (in bits). |
| [ssl_server_cert_serial_number](#ssl_server_cert_serial_number-property-azurekeys-struct) | The serial number of the certificate encoded as a string. |
| [ssl_server_cert_signature_algorithm](#ssl_server_cert_signature_algorithm-property-azurekeys-struct) | The text description of the certificate's signature algorithm. |
| [ssl_server_cert_store](#ssl_server_cert_store-property-azurekeys-struct) | The name of the certificate store for the client certificate. |
| [ssl_server_cert_store_password](#ssl_server_cert_store_password-property-azurekeys-struct) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| [ssl_server_cert_store_type](#ssl_server_cert_store_type-property-azurekeys-struct) | The type of certificate store for this certificate. |
| [ssl_server_cert_subject_alt_names](#ssl_server_cert_subject_alt_names-property-azurekeys-struct) | Comma-separated lists of alternative subject names for the certificate. |
| [ssl_server_cert_thumbprint_md5](#ssl_server_cert_thumbprint_md5-property-azurekeys-struct) | The MD5 hash of the certificate. |
| [ssl_server_cert_thumbprint_sha1](#ssl_server_cert_thumbprint_sha1-property-azurekeys-struct) | The SHA-1 hash of the certificate. |
| [ssl_server_cert_thumbprint_sha256](#ssl_server_cert_thumbprint_sha256-property-azurekeys-struct) | The SHA-256 hash of the certificate. |
| [ssl_server_cert_usage](#ssl_server_cert_usage-property-azurekeys-struct) | The text description of UsageFlags . |
| [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property-azurekeys-struct) | The flags that show intended use for the certificate. |
| [ssl_server_cert_version](#ssl_server_cert_version-property-azurekeys-struct) | The certificate's version number. |
| [ssl_server_cert_subject](#ssl_server_cert_subject-property-azurekeys-struct) | The subject of the certificate used for client authentication. |
| [ssl_server_cert_encoded](#ssl_server_cert_encoded-property-azurekeys-struct) | The certificate (PEM/Base64 encoded). |
| [tag_count](#tag_count-property-azurekeys-struct) | The number of records in the Tag arrays. |
| [tag_name](#tag_name-property-azurekeys-struct) | The name of the tag. |
| [tag_value](#tag_value-property-azurekeys-struct) | The value of the tag. |
| [timeout](#timeout-property-azurekeys-struct) | The timeout for the struct. |
| [vault](#vault-property-azurekeys-struct) | Selects a vault for the struct to interact with. |
| [version_marker](#version_marker-property-azurekeys-struct) | A marker indicating what page of key versions to return next. |

## Method List

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

|  |  |
| --- | --- |
| [add_query_param](#add_query_param-method-azurekeys-struct) | Adds a query parameter to the QueryParams properties. |
| [add_tag](#add_tag-method-azurekeys-struct) | Adds an item to the Tags properties. |
| [authorize](#authorize-method-azurekeys-struct) | Get the authorization string required to access the protected resource. |
| [backup_key](#backup_key-method-azurekeys-struct) | Backs up a key. |
| [config](#config-method-azurekeys-struct) | Sets or retrieves a configuration setting. |
| [create_key](#create_key-method-azurekeys-struct) | Creates a new key. |
| [decrypt](#decrypt-method-azurekeys-struct) | Decrypts data using a key. |
| [delete_key](#delete_key-method-azurekeys-struct) | Deletes a key. |
| [do_events](#do_events-method-azurekeys-struct) | This method processes events from the internal message queue. |
| [encrypt](#encrypt-method-azurekeys-struct) | Encrypts data using a key. |
| [get_key_info](#get_key_info-method-azurekeys-struct) | Gets a key's information and public key. |
| [list_keys](#list_keys-method-azurekeys-struct) | Lists keys in the currently-selected vault. |
| [list_versions](#list_versions-method-azurekeys-struct) | Lists versions of a key. |
| [purge_key](#purge_key-method-azurekeys-struct) | Permanently deletes a soft-deleted key. |
| [recover_key](#recover_key-method-azurekeys-struct) | Recovers a soft-deleted key. |
| [reset](#reset-method-azurekeys-struct) | Resets the struct to its initial state. |
| [restore_key](#restore_key-method-azurekeys-struct) | Restores a previously backed-up key to the vault. |
| [send_custom_request](#send_custom_request-method-azurekeys-struct) | Sends a custom request to the server. |
| [set_key_enabled](#set_key_enabled-method-azurekeys-struct) | Enables or disables a key. |
| [sign](#sign-method-azurekeys-struct) | Signs a message using a key. |
| [unwrap_key](#unwrap_key-method-azurekeys-struct) | Unwraps a symmetric key. |
| [update_key](#update_key-method-azurekeys-struct) | Updates a key's information. |
| [verify](#verify-method-azurekeys-struct) | Verifies a digital signature using a key. |
| [wrap_key](#wrap_key-method-azurekeys-struct) | Wraps a symmetric key. |

## Event List

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

|  |  |
| --- | --- |
| [on_end_transfer](#on_end_transfer-event-azurekeys-struct) | Fired when a document finishes transferring. |
| [on_error](#on_error-event-azurekeys-struct) | Fired when information is available about errors during data delivery. |
| [on_header](#on_header-event-azurekeys-struct) | Fired every time a header line comes in. |
| [on_key_list](#on_key_list-event-azurekeys-struct) | Fires once for each key when listing keys. |
| [on_log](#on_log-event-azurekeys-struct) | Fired once for each log message. |
| [on_ssl_server_authentication](#on_ssl_server_authentication-event-azurekeys-struct) | Fired after the server presents its certificate to the client. |
| [on_ssl_status](#on_ssl_status-event-azurekeys-struct) | Fired when secure connection progress messages are available. |
| [on_start_transfer](#on_start_transfer-event-azurekeys-struct) | Fired when a document starts transferring (after the headers). |
| [on_tag_list](#on_tag_list-event-azurekeys-struct) | Fires once for each tag returned when a key's information is retrieved. |
| [on_transfer](#on_transfer-event-azurekeys-struct) | Fired while a document transfers (delivers document). |

## Config Settings

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

|  |  |
| --- | --- |
| [AccumulatePages](#AccumulatePages) | Whether the struct should accumulate subsequent pages of results when listing them. |
| [APIVersion](#APIVersion) | The Azure Key Vault API version that the struct conforms to. |
| [CreateKeyEnabled](#CreateKeyEnabled) | Whether new keys should be created in an enabled or disabled state. |
| [ExpiryDate](#ExpiryDate) | The expiry date to send for the key. |
| [GetDeleted](#GetDeleted) | Whether the struct should retrieve information about soft-deleted keys. |
| [MaxKeys](#MaxKeys) | The maximum number of results to return when listing keys. |
| [MessageDigest](#MessageDigest) | The message digest computed by the struct during the last sign or verify operation, if any. |
| [NotBeforeDate](#NotBeforeDate) | The 'not before' date to send for the key. |
| [RawRequest](#RawRequest) | Returns the data that was sent to the server. |
| [RawResponse](#RawResponse) | Returns the data that was received from the server. |
| [VersionId](#VersionId) | The Id of the key version that the struct should make requests against. |
| [XChildCount](#XChildCount) | The number of child elements of the current element. |
| [XChildName\[i\]](#XChildName[i]) | The name of the child element. |
| [XChildXText\[i\]](#XChildXText[i]) | The inner text of the child element. |
| [XElement](#XElement) | The name of the current element. |
| [XParent](#XParent) | The parent of the current element. |
| [XPath](#XPath) | Provides a way to point to a specific element in the returned XML or JSON response. |
| [XSubTree](#XSubTree) | A snapshot of the current element in the document. |
| [XText](#XText) | The text of the current element. |
| [OAuthAccessTokenExpiration](#OAuthAccessTokenExpiration) | The lifetime of the access token. |
| [OAuthAuthorizationTokenType](#OAuthAuthorizationTokenType) | The type of access token returned. |
| [OAuthAutomaticRefresh](#OAuthAutomaticRefresh) | Whether or not to refresh an expired access token automatically. |
| [OAuthBrowserResponseTimeout](#OAuthBrowserResponseTimeout) | Specifies the amount of time to wait for a response from the browser. |
| [OAuthIncludeEmptyRedirectURI](#OAuthIncludeEmptyRedirectURI) | Whether an empty redirect_uri parameter is included in requests. |
| [OAuthJWTPayload](#OAuthJWTPayload) | The payload of the JWT access token if present. |
| [OAuthJWTXChildCount](#OAuthJWTXChildCount) | The number of child elements of the current element. |
| [OauthJWTXChildName\[i\]](#OauthJWTXChildName[i]) | The name of the child element. |
| [OAuthJWTXChildXText\[i\]](#OAuthJWTXChildXText[i]) | The inner text of the child element. |
| [OAuthJWTXElement](#OAuthJWTXElement) | The name of the current element. |
| [OauthJWTXParent](#OauthJWTXParent) | The parent of the current element. |
| [OAuthJWTXPath](#OAuthJWTXPath) | Provides a way to point to a specific element in the returned payload of a JWT based access token. |
| [OAuthJWTXSubTree](#OAuthJWTXSubTree) | A snapshot of the current element in the document. |
| [OAuthJWTXText](#OAuthJWTXText) | The text of the current element. |
| [OAuthParamCount](#OAuthParamCount) | Specifies the number of additional parameters variables to include in the request. |
| [OAuthParamName\[i\]](#OAuthParamName[i]) | Specifies the parameter name at the specified index. |
| [OAuthParamValue\[i\]](#OAuthParamValue[i]) | Specifies the parameter value at the specified index. |
| [OAuthPasswordGrantUsername](#OAuthPasswordGrantUsername) | Used in the Resource Owner Password grant type. |
| [OAuthPKCEChallengeEncoding](#OAuthPKCEChallengeEncoding) | The PKCE code challenge method to use. |
| [OAuthPKCEVerifier](#OAuthPKCEVerifier) | The PKCE verifier used to generate the challenge. |
| [OAuthResetData](#OAuthResetData) | Determines if the Reset method applies to the OAuth settings. |
| [OAuthReUseWebServer](#OAuthReUseWebServer) | Determines if the same server instance is used between requests. |
| [OAuthTransferredRequest](#OAuthTransferredRequest) | The full OAuth request last sent by the client. |
| [OAuthUsePKCE](#OAuthUsePKCE) | Specifies if PKCE should be used. |
| [OAuthWebServerActive](#OAuthWebServerActive) | Specifies and controls whether the embedded web server is active. |
| [OAuthWebServerCertStore](#OAuthWebServerCertStore) | The certificate with private key to use when SSL is enabled. |
| [OAuthWebServerCertStorePassword](#OAuthWebServerCertStorePassword) | The certificate with private key to use when SSL is enabled. |
| [OAuthWebServerCertStoreType](#OAuthWebServerCertStoreType) | The certificate with private key to use when SSL is enabled. |
| [OAuthWebServerCertSubject](#OAuthWebServerCertSubject) | The certificate with private key to use when SSL is enabled. |
| [OAuthWebServerFailedResponse](#OAuthWebServerFailedResponse) | The custom response that will be displayed to the user if authentication failed. |
| [OAuthWebServerHost](#OAuthWebServerHost) | The hostname used by the embedded web server displayed in the ReturnURL. |
| [OAuthWebServerPort](#OAuthWebServerPort) | The local port on which the embedded web server listens. |
| [OAuthWebServerResponse](#OAuthWebServerResponse) | The custom response that will be displayed to the user. |
| [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) | Whether the web server requires SSL connections. |
| [AcceptEncoding](#AcceptEncoding) | Used to tell the server which types of content encodings the client supports. |
| [AllowHTTPCompression](#AllowHTTPCompression) | This property enables HTTP compression for receiving data. |
| [AllowHTTPFallback](#AllowHTTPFallback) | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
| [Append](#Append) | Whether to append data to LocalFile. |
| [Authorization](#Authorization) | The Authorization string to be sent to the server. |
| [BytesTransferred](#BytesTransferred) | Contains the number of bytes transferred in the response data. |
| [ChunkSize](#ChunkSize) | Specifies the chunk size in bytes when using chunked encoding. |
| [CompressHTTPRequest](#CompressHTTPRequest) | Set to true to compress the body of a PUT or POST request. |
| [EncodeURL](#EncodeURL) | If set to True the URL will be encoded by the struct. |
| [FollowRedirects](#FollowRedirects) | Determines what happens when the server issues a redirect. |
| [GetOn302Redirect](#GetOn302Redirect) | If set to True the struct will perform a GET on the new location. |
| [HTTP2HeadersWithoutIndexing](#HTTP2HeadersWithoutIndexing) | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
| [HTTPVersion](#HTTPVersion) | The version of HTTP used by the struct. |
| [IfModifiedSince](#IfModifiedSince) | A date determining the maximum age of the desired document. |
| [KeepAlive](#KeepAlive) | Determines whether the HTTP connection is closed after completion of the request. |
| [KerberosSPN](#KerberosSPN) | The Service Principal Name for the Kerberos Domain Controller. |
| [LogLevel](#LogLevel) | The level of detail that is logged. |
| [MaxRedirectAttempts](#MaxRedirectAttempts) | Limits the number of redirects that are followed in a request. |
| [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) | The negotiated HTTP version. |
| [OtherHeaders](#OtherHeaders) | Other headers as determined by the user (optional). |
| [ProxyAuthorization](#ProxyAuthorization) | The authorization string to be sent to the proxy server. |
| [ProxyAuthScheme](#ProxyAuthScheme) | The authorization scheme to be used for the proxy. |
| [ProxyPassword](#ProxyPassword) | A password if authentication is to be used for the proxy. |
| [ProxyPort](#ProxyPort) | Port for the proxy server (default 80). |
| [ProxyServer](#ProxyServer) | Name or IP address of a proxy server (optional). |
| [ProxyUser](#ProxyUser) | A user name if authentication is to be used for the proxy. |
| [SentHeaders](#SentHeaders) | The full set of headers as sent by the client. |
| [StatusCode](#StatusCode) | The status code of the last response from the server. |
| [StatusLine](#StatusLine) | The first line of the last response from the server. |
| [TransferredData](#TransferredData) | The contents of the last response from the server. |
| [TransferredDataLimit](#TransferredDataLimit) | The maximum number of incoming bytes to be stored by the struct. |
| [TransferredHeaders](#TransferredHeaders) | The full set of headers as received from the server. |
| [TransferredRequest](#TransferredRequest) | The full request as sent by the client. |
| [UseChunkedEncoding](#UseChunkedEncoding) | Enables or Disables HTTP chunked encoding for transfers. |
| [UseIDNs](#UseIDNs) | Whether to encode hostnames to internationalized domain names. |
| [UseProxyAutoConfigURL](#UseProxyAutoConfigURL) | Whether to use a Proxy auto-config file when attempting a connection. |
| [UserAgent](#UserAgent) | Information about the user agent (browser). |
| [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. |
| [FirewallAutoDetect](#FirewallAutoDetect) | Tells the struct whether or not to automatically detect and use firewall system settings, if available. |
| [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). |
| [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. |
| [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. |
| [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. |
| [FirewallType](#FirewallType) | Determines the type of firewall to connect through. |
| [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. |
| [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| [Linger](#Linger) | When set to True, connections are terminated gracefully. |
| [LingerTime](#LingerTime) | Time in seconds to have the connection linger. |
| [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. |
| [LocalPort](#LocalPort) | The port in the local host where the struct binds. |
| [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. |
| [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. |
| [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
| [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. |
| [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. |
| [UseIPv6](#UseIPv6) | Whether to use IPv6. |
| [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. |
| [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. |
| [OpenSSLCADir](#OpenSSLCADir) | The path to a directory containing CA certificates. |
| [OpenSSLCAFile](#OpenSSLCAFile) | Name of the file containing the list of CA's trusted by your application. |
| [OpenSSLCipherList](#OpenSSLCipherList) | A string that controls the ciphers to be used by SSL. |
| [OpenSSLPrngSeedData](#OpenSSLPrngSeedData) | The data to seed the pseudo random number generator (PRNG). |
| [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. |
| [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. |
| [SSLCheckCRL](#SSLCheckCRL) | Whether to check the Certificate Revocation List for the server certificate. |
| [SSLCheckOCSP](#SSLCheckOCSP) | Whether to use OCSP to check the status of the server certificate. |
| [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. |
| [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. |
| [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. |
| [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. |
| [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. |
| [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. |
| [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. |
| [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. |
| [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. |
| [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. |
| [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. |
| [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. |
| [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. |
| [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. |
| [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
| [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. |
| [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. |
| [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. |
| [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. |
| [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| [FirewallData](#FirewallData) | Used to send extra data to the firewall. |
| [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. |
| [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# authorization property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

OAuth 2.0 Authorization Token.

## Syntax

*Rust Syntax*

```text
fn authorization(&self ) -> Result<String, CloudKeysError> fn set_authorization(&self, value : &str) ->  Option<CloudKeysError>
fn set_authorization_ref(&self, value : &String) ->  Option<CloudKeysError>
```

## Default Value

""

## Remarks

This struct supports authentication via OAuth 2.0. First, perform OAuth authentication using the [OAuth](OAuth.md#OAuth) struct or a separate process. Once complete you should have an authorization string which looks like:

```text
Bearer ACCESS_TOKEN
```

 Assign 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

# firewall_auto_detect property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn firewall_auto_detect(&self ) -> Result<bool, CloudKeysError> fn set_firewall_auto_detect(&self, value : bool) ->  Option<CloudKeysError>
```

## Default Value

false

## Remarks

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

## Data Type

bool

# firewall_type property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The type of firewall to connect through.

## Syntax

*Rust Syntax*

```text
fn firewall_type(&self ) -> Result<i32, CloudKeysError> fn set_firewall_type(&self, value : i32) ->  Option<CloudKeysError>
```

## Possible Values

```text
0   // None1   // Tunnel2   // SOCKS43   // SOCKS510   // SOCKS4A
```

## Default Value

0

## Remarks

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. [firewall_port](#firewall_port-property-azurekeys-struct) is set to 80. |
| fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [firewall_port](#firewall_port-property-azurekeys-struct) is set to 1080. |
| fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [firewall_port](#firewall_port-property-azurekeys-struct) is set to 1080. |
| fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [firewall_port](#firewall_port-property-azurekeys-struct) is set to 1080. |

## Data Type

i32

# firewall_host property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn firewall_host(&self ) -> Result<String, CloudKeysError> fn set_firewall_host(&self, value : &str) ->  Option<CloudKeysError>
fn set_firewall_host_ref(&self, value : &String) ->  Option<CloudKeysError>
```

## Default Value

""

## Remarks

The name or IP address of the firewall (optional). If a [firewall_host](#firewall_host-property-azurekeys-struct) 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 struct fails with an error.

## Data Type

String

# firewall_password property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn firewall_password(&self ) -> Result<String, CloudKeysError> fn set_firewall_password(&self, value : &str) ->  Option<CloudKeysError>
fn set_firewall_password_ref(&self, value : &String) ->  Option<CloudKeysError>
```

## Default Value

""

## Remarks

A password if authentication is to be used when connecting through the firewall. If [firewall_host](#firewall_host-property-azurekeys-struct) is specified, the [firewall_user](#firewall_user-property-azurekeys-struct) and [firewall_password](#firewall_password-property-azurekeys-struct) properties are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error.

## Data Type

String

# firewall_port property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn firewall_port(&self ) -> Result<i32, CloudKeysError> fn set_firewall_port(&self, value : i32) ->  Option<CloudKeysError>
```

## Default Value

0

## Remarks

The Transmission Control Protocol (TCP) port for the firewall [firewall_host](#firewall_host-property-azurekeys-struct). See the description of the [firewall_host](#firewall_host-property-azurekeys-struct) property for details.

NOTE: This property is set automatically when [firewall_firewall_type](#AzureKeys_p_FirewallFirewallType) is set to a valid value. See the description of the [firewall_firewall_type](#AzureKeys_p_FirewallFirewallType) property for details.

## Data Type

i32

# firewall_user property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn firewall_user(&self ) -> Result<String, CloudKeysError> fn set_firewall_user(&self, value : &str) ->  Option<CloudKeysError>
fn set_firewall_user_ref(&self, value : &String) ->  Option<CloudKeysError>
```

## Default Value

""

## Remarks

A username if authentication is to be used when connecting through a firewall. If [firewall_host](#firewall_host-property-azurekeys-struct) is specified, this property and the [firewall_password](#firewall_password-property-azurekeys-struct) property are used to connect and authenticate to the given [Firewall](#Type_Firewall). If the authentication fails, the struct fails with an error.

## Data Type

String

# idle property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The current status of the struct.

## Syntax

*Rust Syntax*

```text
fn idle(&self ) -> Result<bool, CloudKeysError>
```

## Default Value

true

## Remarks

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

This property is read-only.

## Data Type

bool

# include_key_details property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Whether to attempt to retrieve fill details when listing keys.

## Syntax

*Rust Syntax*

```text
fn include_key_details(&self ) -> Result<bool, CloudKeysError> fn set_include_key_details(&self, value : bool) ->  Option<CloudKeysError>
```

## Default Value

false

## Remarks

This property specifies whether the struct should make additional requests when [list_keys](#list_keys-method-azurekeys-struct) or [list_versions](#list_versions-method-azurekeys-struct) 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 struct will call [get_key_info](#get_key_info-method-azurekeys-struct) internally for each key returned. For all keys for which this call is successful, the additional information will be used to populate the keys properties. Any keys for which the [get_key_info](#get_key_info-method-azurekeys-struct) call fails will not have the additional properties populated.

## Data Type

bool

# input_data property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The data to process.

## Syntax

*Rust Syntax*

```text
fn input_data(&self ) -> Result<Vec<u8>, CloudKeysError> fn set_input_data(&self, value : Vec<u8>) ->  Option<CloudKeysError>
fn set_input_data_ref(&self, value : &[u8]) ->  Option<CloudKeysError>
```

## Default Value

""

## Remarks

This property specifies the data that should be processed in a cryptographic operation.

### Input Sources & Output Destinations

The struct automatically determines the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

1. The [input_file](#input_file-property-azurekeys-struct) property
2. The input_data property

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

1. The [output_file](#output_file-property-azurekeys-struct) property
2. The [output_data](#output_data-property-azurekeys-struct) property

## Data Type

Vec

# input_file property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The file whose data should be processed.

## Syntax

*Rust Syntax*

```text
fn input_file(&self ) -> Result<String, CloudKeysError> fn set_input_file(&self, value : &str) ->  Option<CloudKeysError>
fn set_input_file_ref(&self, value : &String) ->  Option<CloudKeysError>
```

## Default Value

""

## Remarks

This property specifies the file whose data should be processed in a cryptographic operation. It accepts both absolute and relative file paths.

### Input Sources & Output Destinations

The struct automatically determines the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

1. The input_file property
2. The [input_data](#input_data-property-azurekeys-struct) property

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

1. The [output_file](#output_file-property-azurekeys-struct) property
2. The [output_data](#output_data-property-azurekeys-struct) property

## Data Type

String

# key_marker property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

A marker indicating what page of keys to return next.

## Syntax

*Rust Syntax*

```text
fn key_marker(&self ) -> Result<String, CloudKeysError> fn set_key_marker(&self, value : &str) ->  Option<CloudKeysError>
fn set_key_marker_ref(&self, value : &String) ->  Option<CloudKeysError>
```

## Default Value

""

## Remarks

This property will be populated when [list_keys](#list_keys-method-azurekeys-struct) is called if the results are paged and there are more pages. To list all keys, continue to call [list_keys](#list_keys-method-azurekeys-struct) until this property returns empty string.

Refer to [list_keys](#list_keys-method-azurekeys-struct) for more information.

## Data Type

String

# key_count property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The number of records in the Key arrays.

## Syntax

*Rust Syntax*

```text
fn key_count(&self ) -> Result<i32, CloudKeysError>
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [key_creation_date](#key_creation_date-property-azurekeys-struct)
- [key_deletion_date](#key_deletion_date-property-azurekeys-struct)
- [key_enabled](#key_enabled-property-azurekeys-struct)
- [key_expiry_date](#key_expiry_date-property-azurekeys-struct)
- [key_name](#key_name-property-azurekeys-struct)
- [key_not_before_date](#key_not_before_date-property-azurekeys-struct)
- [key_ops](#key_ops-property-azurekeys-struct)
- [key_public_key](#key_public_key-property-azurekeys-struct)
- [key_purge_date](#key_purge_date-property-azurekeys-struct)
- [key_recoverable_days](#key_recoverable_days-property-azurekeys-struct)
- [key_recovery_level](#key_recovery_level-property-azurekeys-struct)
- [key_type](#key_type-property-azurekeys-struct)
- [key_update_date](#key_update_date-property-azurekeys-struct)
- [key_version_id](#key_version_id-property-azurekeys-struct)

The array indices start at *0* and end at *key_count - 1*.

This property is read-only.

## Data Type

i32

# key_creation_date property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The creation date of the key.

## Syntax

*Rust Syntax*

```text
fn key_creation_date(&self , KeyIndex : i32) -> Result<i64, CloudKeysError>
```

## 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](#key_count-property-azurekeys-struct) property.

This property is read-only.

## Data Type

i64

# key_deletion_date property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The deletion date of the key.

## Syntax

*Rust Syntax*

```text
fn key_deletion_date(&self , KeyIndex : i32) -> Result<i64, CloudKeysError>
```

## 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](#key_count-property-azurekeys-struct) property.

This property is read-only.

## Data Type

i64

# key_enabled property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Whether the key is enabled.

## Syntax

*Rust Syntax*

```text
fn key_enabled(&self , KeyIndex : i32) -> Result<bool, CloudKeysError>
```

## 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](#key_count-property-azurekeys-struct) property.

This property is read-only.

## Data Type

bool

# key_expiry_date property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The expiration date of the key.

## Syntax

*Rust Syntax*

```text
fn key_expiry_date(&self , KeyIndex : i32) -> Result<i64, CloudKeysError>
```

## 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](#decrypt-method-azurekeys-struct), [verify](#verify-method-azurekeys-struct), and [unwrap_key](#unwrap_key-method-azurekeys-struct) 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](#key_count-property-azurekeys-struct) property.

This property is read-only.

## Data Type

i64

# key_ops property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The operation that the key may be used for.

## Syntax

*Rust Syntax*

```text
fn key_ops(&self , KeyIndex : i32) -> Result<String, CloudKeysError>
```

## 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](#key_count-property-azurekeys-struct) property.

This property is read-only.

## Data Type

String

# key_type property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The key's type.

## Syntax

*Rust Syntax*

```text
fn key_type(&self , KeyIndex : i32) -> Result<String, CloudKeysError>
```

## 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](#key_count-property-azurekeys-struct) property.

This property is read-only.

## Data Type

String

# key_name property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The name of the key.

## Syntax

*Rust Syntax*

```text
fn key_name(&self , KeyIndex : i32) -> Result<String, CloudKeysError>
```

## 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](#key_count-property-azurekeys-struct) property.

This property is read-only.

## Data Type

String

# key_not_before_date property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The 'not before' date of the key.

## Syntax

*Rust Syntax*

```text
fn key_not_before_date(&self , KeyIndex : i32) -> Result<i64, CloudKeysError>
```

## 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](#decrypt-method-azurekeys-struct), [verify](#verify-method-azurekeys-struct), and [unwrap_key](#unwrap_key-method-azurekeys-struct) 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](#key_count-property-azurekeys-struct) property.

This property is read-only.

## Data Type

i64

# key_public_key property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The key's public key.

## Syntax

*Rust Syntax*

```text
fn key_public_key(&self , KeyIndex : i32) -> Result<String, CloudKeysError>
```

## 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](#key_count-property-azurekeys-struct) property.

This property is read-only.

## Data Type

String

# key_purge_date property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The purge date of the key.

## Syntax

*Rust Syntax*

```text
fn key_purge_date(&self , KeyIndex : i32) -> Result<i64, CloudKeysError>
```

## 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](#key_count-property-azurekeys-struct) property.

This property is read-only.

## Data Type

i64

# key_recoverable_days property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn key_recoverable_days(&self , KeyIndex : i32) -> Result<i32, CloudKeysError>
```

## 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](#vault-property-azurekeys-struct); 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](#key_count-property-azurekeys-struct) property.

This property is read-only.

## Data Type

i32

# key_recovery_level property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn key_recovery_level(&self , KeyIndex : i32) -> Result<String, CloudKeysError>
```

## 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](https://docs.microsoft.com/en-us/rest/api/keyvault/getkey/getkey#deletionrecoverylevel) 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](#key_count-property-azurekeys-struct) property.

This property is read-only.

## Data Type

String

# key_update_date property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The update date of the key.

## Syntax

*Rust Syntax*

```text
fn key_update_date(&self , KeyIndex : i32) -> Result<i64, CloudKeysError>
```

## 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](#key_count-property-azurekeys-struct) property.

This property is read-only.

## Data Type

i64

# key_version_id property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The version Id of the key.

## Syntax

*Rust Syntax*

```text
fn key_version_id(&self , KeyIndex : i32) -> Result<String, CloudKeysError>
```

## 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](#key_count-property-azurekeys-struct) property.

This property is read-only.

## Data Type

String

# local_host property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn local_host(&self ) -> Result<String, CloudKeysError> fn set_local_host(&self, value : &str) ->  Option<CloudKeysError>
fn set_local_host_ref(&self, value : &String) ->  Option<CloudKeysError>
```

## Default Value

""

## Remarks

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

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

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

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

## Data Type

String

# o_auth_access_token property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The access token returned by the authorization server.

## Syntax

*Rust Syntax*

```text
fn o_auth_access_token(&self ) -> Result<String, CloudKeysError> fn set_o_auth_access_token(&self, value : &str) ->  Option<CloudKeysError>
fn set_o_auth_access_token_ref(&self, value : &String) ->  Option<CloudKeysError>
```

## Default Value

""

## Remarks

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

## Data Type

String

# o_auth_authorization_code property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The authorization code that is exchanged for an access token.

## Syntax

*Rust Syntax*

```text
fn o_auth_authorization_code(&self ) -> Result<String, CloudKeysError> fn set_o_auth_authorization_code(&self, value : &str) ->  Option<CloudKeysError>
fn set_o_auth_authorization_code_ref(&self, value : &String) ->  Option<CloudKeysError>
```

## Default Value

""

## Remarks

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

## Data Type

String

# o_auth_authorization_scope property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The scope request or response parameter used during authorization.

## Syntax

*Rust Syntax*

```text
fn o_auth_authorization_scope(&self ) -> Result<String, CloudKeysError> fn set_o_auth_authorization_scope(&self, value : &str) ->  Option<CloudKeysError>
fn set_o_auth_authorization_scope_ref(&self, value : &String) ->  Option<CloudKeysError>
```

## Default Value

""

## Remarks

The scope request or response parameter used during authorization.

## Data Type

String

# o_auth_client_id property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The id of the client assigned when registering the application.

## Syntax

*Rust Syntax*

```text
fn o_auth_client_id(&self ) -> Result<String, CloudKeysError> fn set_o_auth_client_id(&self, value : &str) ->  Option<CloudKeysError>
fn set_o_auth_client_id_ref(&self, value : &String) ->  Option<CloudKeysError>
```

## Default Value

""

## Remarks

The id of the client assigned when registering the application.

## Data Type

String

# o_auth_client_profile property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The type of client that is requesting authorization.

## Syntax

*Rust Syntax*

```text
fn o_auth_client_profile(&self ) -> Result<i32, CloudKeysError> fn set_o_auth_client_profile(&self, value : i32) ->  Option<CloudKeysError>
```

## Possible Values

```text
0   // Application1   // Web
```

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

## Data Type

i32

# o_auth_client_secret property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn o_auth_client_secret(&self ) -> Result<String, CloudKeysError> fn set_o_auth_client_secret(&self, value : &str) ->  Option<CloudKeysError>
fn set_o_auth_client_secret_ref(&self, value : &String) ->  Option<CloudKeysError>
```

## Default Value

""

## Remarks

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

## Data Type

String

# o_auth_grant_type property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn o_auth_grant_type(&self ) -> Result<i32, CloudKeysError> fn set_o_auth_grant_type(&self, value : i32) ->  Option<CloudKeysError>
```

## Possible Values

```text
0   // AuthorizationCode1   // Implicit2   // Password3   // ClientCredentials
```

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

## Data Type

i32

# o_auth_refresh_token property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn o_auth_refresh_token(&self ) -> Result<String, CloudKeysError> fn set_o_auth_refresh_token(&self, value : &str) ->  Option<CloudKeysError>
fn set_o_auth_refresh_token_ref(&self, value : &String) ->  Option<CloudKeysError>
```

## 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 o_auth_grant_type property is set to a grant that can use refresh tokens.

## Data Type

String

# o_auth_request_refresh_token property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn o_auth_request_refresh_token(&self ) -> Result<bool, CloudKeysError> fn set_o_auth_request_refresh_token(&self, value : bool) ->  Option<CloudKeysError>
```

## Default Value

true

## Remarks

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

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

NOTE: This property is only applicable when the o_auth_grant_type property is set to *cogtAuthorizationCode*.

## Data Type

bool

# o_auth_return_url property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn o_auth_return_url(&self ) -> Result<String, CloudKeysError> fn set_o_auth_return_url(&self, value : &str) ->  Option<CloudKeysError>
fn set_o_auth_return_url_ref(&self, value : &String) ->  Option<CloudKeysError>
```

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

## Data Type

String

# o_auth_server_auth_url property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The URL of the authorization server.

## Syntax

*Rust Syntax*

```text
fn o_auth_server_auth_url(&self ) -> Result<String, CloudKeysError> fn set_o_auth_server_auth_url(&self, value : &str) ->  Option<CloudKeysError>
fn set_o_auth_server_auth_url_ref(&self, value : &String) ->  Option<CloudKeysError>
```

## Default Value

""

## Remarks

The URL of the authorization server.

## Data Type

String

# o_auth_server_token_url property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn o_auth_server_token_url(&self ) -> Result<String, CloudKeysError> fn set_o_auth_server_token_url(&self, value : &str) ->  Option<CloudKeysError>
fn set_o_auth_server_token_url_ref(&self, value : &String) ->  Option<CloudKeysError>
```

## Default Value

""

## Remarks

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

## Data Type

String

# o_auth_timeout property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The amount of time (in seconds) the struct will wait for a response from the browser in the LaunchBrowser event.

## Syntax

*Rust Syntax*

```text
fn o_auth_timeout(&self ) -> Result<i32, CloudKeysError> fn set_o_auth_timeout(&self, value : i32) ->  Option<CloudKeysError>
```

## Default Value

60

## Remarks

The amount of time (in seconds) the component will wait for a response from the browser in the on_launch_browser event. The default value is 60.

## Data Type

i32

# o_auth_web_auth_url property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn o_auth_web_auth_url(&self ) -> Result<String, CloudKeysError>
```

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

## Data Type

String

# other_headers property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Other headers as determined by the user (optional).

## Syntax

*Rust Syntax*

```text
fn other_headers(&self ) -> Result<String, CloudKeysError> fn set_other_headers(&self, value : &str) ->  Option<CloudKeysError>
fn set_other_headers_ref(&self, value : &String) ->  Option<CloudKeysError>
```

## 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 content_type 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 struct beyond what is provided.

## Data Type

String

# output_data property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The output data.

## Syntax

*Rust Syntax*

```text
fn output_data(&self ) -> Result<Vec<u8>, CloudKeysError> fn set_output_data(&self, value : Vec<u8>) ->  Option<CloudKeysError>
fn set_output_data_ref(&self, value : &[u8]) ->  Option<CloudKeysError>
```

## Default Value

""

## Remarks

This property is populated with the data that was output from a successful cryptographic operation.

NOTE: For the [verify](#verify-method-azurekeys-struct) operation, this property functions as a secondary input property instead (along with [input_data](#input_data-property-azurekeys-struct)); refer to the [verify](#verify-method-azurekeys-struct) method for more information.

### Input Sources & Output Destinations

The struct automatically determines the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

1. The [input_file](#input_file-property-azurekeys-struct) property
2. The [input_data](#input_data-property-azurekeys-struct) property

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

1. The [output_file](#output_file-property-azurekeys-struct) property
2. The output_data property

## Data Type

Vec

# output_file property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The file to which output data should be written.

## Syntax

*Rust Syntax*

```text
fn output_file(&self ) -> Result<String, CloudKeysError> fn set_output_file(&self, value : &str) ->  Option<CloudKeysError>
fn set_output_file_ref(&self, value : &String) ->  Option<CloudKeysError>
```

## Default Value

""

## Remarks

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

NOTE: For the [verify](#verify-method-azurekeys-struct) operation, the specified file functions as a secondary input file instead (along with [input_file](#input_file-property-azurekeys-struct)); refer to the [verify](#verify-method-azurekeys-struct) method for more information.

### Input Sources & Output Destinations

The struct automatically determines the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

1. The [input_file](#input_file-property-azurekeys-struct) property
2. The [input_data](#input_data-property-azurekeys-struct) property

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

1. The output_file property
2. The [output_data](#output_data-property-azurekeys-struct) property

## Data Type

String

# overwrite property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Whether the output file should be overwritten if necessary.

## Syntax

*Rust Syntax*

```text
fn overwrite(&self ) -> Result<bool, CloudKeysError> fn set_overwrite(&self, value : bool) ->  Option<CloudKeysError>
```

## Default Value

false

## Remarks

This property controls whether the specified [output_file](#output_file-property-azurekeys-struct) should be overwritten if it already exists.

## Data Type

bool

# parsed_header_count property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The number of records in the ParsedHeader arrays.

## Syntax

*Rust Syntax*

```text
fn parsed_header_count(&self ) -> Result<i32, CloudKeysError>
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [parsed_header_field](#parsed_header_field-property-azurekeys-struct)
- [parsed_header_value](#parsed_header_value-property-azurekeys-struct)

The array indices start at *0* and end at *parsed_header_count - 1*.

This property is read-only.

## Data Type

i32

# parsed_header_field property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn parsed_header_field(&self , ParsedHeaderIndex : i32) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

This property contains the name of the HTTP [Header](#Type_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](#parsed_header_count-property-azurekeys-struct) property.

This property is read-only.

## Data Type

String

# parsed_header_value property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

This property contains the header contents.

## Syntax

*Rust Syntax*

```text
fn parsed_header_value(&self , ParsedHeaderIndex : i32) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

This property contains the [Header](#Type_Header) contents.

The *ParsedHeaderIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ParsedHeaderCount](#parsed_header_count-property-azurekeys-struct) property.

This property is read-only.

## Data Type

String

# proxy_auth_scheme property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn proxy_auth_scheme(&self ) -> Result<i32, CloudKeysError> fn set_proxy_auth_scheme(&self, value : i32) ->  Option<CloudKeysError>
```

## Possible Values

```text
0   // Basic1   // Digest2   // Proprietary3   // None4   // Ntlm5   // Negotiate
```

## Default Value

0

## Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the [proxy_user](#proxy_user-property-azurekeys-struct) and [proxy_password](#proxy_password-property-azurekeys-struct) properties are set.

[proxy_auth_scheme](#proxy_auth_scheme-property-azurekeys-struct) should be set to authNone (3) when no authentication is expected.

By default, [proxy_auth_scheme](#proxy_auth_scheme-property-azurekeys-struct) is authBasic (0), and if the [proxy_user](#proxy_user-property-azurekeys-struct) and [proxy_password](#proxy_password-property-azurekeys-struct) properties are set, the struct will attempt basic authentication.

If [proxy_auth_scheme](#proxy_auth_scheme-property-azurekeys-struct) is set to authDigest (1), digest authentication will be attempted instead.

If [proxy_auth_scheme](#proxy_auth_scheme-property-azurekeys-struct) is set to authProprietary (2), then the authorization token will not be generated by the struct. Look at the configuration file for the struct being used to find more information about manually setting this token.

If [proxy_auth_scheme](#proxy_auth_scheme-property-azurekeys-struct) is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of [proxy_user](#proxy_user-property-azurekeys-struct) and [proxy_password](#proxy_password-property-azurekeys-struct).

## Data Type

i32

# proxy_auto_detect property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn proxy_auto_detect(&self ) -> Result<bool, CloudKeysError> fn set_proxy_auto_detect(&self, value : bool) ->  Option<CloudKeysError>
```

## Default Value

false

## Remarks

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

## Data Type

bool

# proxy_password property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn proxy_password(&self ) -> Result<String, CloudKeysError> fn set_proxy_password(&self, value : &str) ->  Option<CloudKeysError>
fn set_proxy_password_ref(&self, value : &String) ->  Option<CloudKeysError>
```

## Default Value

""

## Remarks

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

If [proxy_auth_scheme](#proxy_auth_scheme-property-azurekeys-struct) is set to Basic Authentication, the [proxy_user](#proxy_user-property-azurekeys-struct) and [proxy_password](#proxy_password-property-azurekeys-struct) properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*.

If [proxy_auth_scheme](#proxy_auth_scheme-property-azurekeys-struct) is set to Digest Authentication, the [proxy_user](#proxy_user-property-azurekeys-struct) and [proxy_password](#proxy_password-property-azurekeys-struct) properties are used to respond to the Digest Authentication challenge from the server.

If [proxy_auth_scheme](#proxy_auth_scheme-property-azurekeys-struct) is set to NTLM Authentication, the [proxy_user](#proxy_user-property-azurekeys-struct) and [proxy_password](#proxy_password-property-azurekeys-struct) properties are used to authenticate through NTLM negotiation.

## Data Type

String

# proxy_port property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn proxy_port(&self ) -> Result<i32, CloudKeysError> fn set_proxy_port(&self, value : i32) ->  Option<CloudKeysError>
```

## Default Value

80

## Remarks

The Transmission Control Protocol (TCP) port for the proxy [proxy_server](#proxy_server-property-azurekeys-struct) (default 80). See the description of the [proxy_server](#proxy_server-property-azurekeys-struct) property for details.

## Data Type

i32

# proxy_server property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn proxy_server(&self ) -> Result<String, CloudKeysError> fn set_proxy_server(&self, value : &str) ->  Option<CloudKeysError>
fn set_proxy_server_ref(&self, value : &String) ->  Option<CloudKeysError>
```

## Default Value

""

## Remarks

If a proxy [proxy_server](#proxy_server-property-azurekeys-struct) is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the [proxy_server](#proxy_server-property-azurekeys-struct) property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the [proxy_server](#proxy_server-property-azurekeys-struct) property is set to the corresponding address. If the search is not successful, an error is returned.

## Data Type

String

# proxy_ssl property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn proxy_ssl(&self ) -> Result<i32, CloudKeysError> fn set_proxy_ssl(&self, value : i32) ->  Option<CloudKeysError>
```

## Possible Values

```text
0   // Automatic1   // Always2   // Never3   // Tunnel
```

## Default Value

0

## Remarks

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 struct will use the psTunnel option. If the URL is an http URL, the struct 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

i32

# proxy_user property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn proxy_user(&self ) -> Result<String, CloudKeysError> fn set_proxy_user(&self, value : &str) ->  Option<CloudKeysError>
fn set_proxy_user_ref(&self, value : &String) ->  Option<CloudKeysError>
```

## Default Value

""

## Remarks

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

If [proxy_auth_scheme](#proxy_auth_scheme-property-azurekeys-struct) is set to Basic Authentication, the [proxy_user](#proxy_user-property-azurekeys-struct) and [proxy_password](#proxy_password-property-azurekeys-struct) properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*.

If [proxy_auth_scheme](#proxy_auth_scheme-property-azurekeys-struct) is set to Digest Authentication, the [proxy_user](#proxy_user-property-azurekeys-struct) and [proxy_password](#proxy_password-property-azurekeys-struct) properties are used to respond to the Digest Authentication challenge from the server.

If [proxy_auth_scheme](#proxy_auth_scheme-property-azurekeys-struct) is set to NTLM Authentication, the [proxy_user](#proxy_user-property-azurekeys-struct) and [proxy_password](#proxy_password-property-azurekeys-struct) properties are used to authenticate through NTLM negotiation.

## Data Type

String

# query_param_count property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The number of records in the QueryParam arrays.

## Syntax

*Rust Syntax*

```text
fn query_param_count(&self ) -> Result<i32, CloudKeysError> fn set_query_param_count(&self, value : i32) ->  Option<CloudKeysError>
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [query_param_name](#query_param_name-property-azurekeys-struct)
- [query_param_value](#query_param_value-property-azurekeys-struct)

The array indices start at *0* and end at *query_param_count - 1*.

## Data Type

i32

# query_param_name property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The name of the query parameter.

## Syntax

*Rust Syntax*

```text
fn query_param_name(&self , QueryParamIndex : i32) -> Result<String, CloudKeysError> fn set_query_param_name(&self, QueryParamIndex : i32, value : &str) ->  Option<CloudKeysError>
fn set_query_param_name_ref(&self, QueryParamIndex : i32, value : &String) ->  Option<CloudKeysError>
```

## 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](#query_param_count-property-azurekeys-struct) property.

## Data Type

String

# query_param_value property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The value of the query parameter.

## Syntax

*Rust Syntax*

```text
fn query_param_value(&self , QueryParamIndex : i32) -> Result<String, CloudKeysError> fn set_query_param_value(&self, QueryParamIndex : i32, value : &str) ->  Option<CloudKeysError>
fn set_query_param_value_ref(&self, QueryParamIndex : i32, value : &String) ->  Option<CloudKeysError>
```

## Default Value

""

## Remarks

The value of the query parameter.

This property specifies the value of the query parameter. The struct 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](#query_param_count-property-azurekeys-struct) property.

## Data Type

String

# ssl_accept_server_cert_effective_date property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The date on which this certificate becomes valid.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_effective_date(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

## Data Type

String

# ssl_accept_server_cert_expiration_date property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The date on which the certificate expires.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_expiration_date(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

## Data Type

String

# ssl_accept_server_cert_extended_key_usage property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

A comma-delimited list of extended key usage identifiers.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_extended_key_usage(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_accept_server_cert_fingerprint property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_fingerprint(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

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

This property is read-only.

## Data Type

String

# ssl_accept_server_cert_fingerprint_sha1 property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_fingerprint_sha1(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

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

This property is read-only.

## Data Type

String

# ssl_accept_server_cert_fingerprint_sha256 property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_fingerprint_sha256(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

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

This property is read-only.

## Data Type

String

# ssl_accept_server_cert_issuer property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The issuer of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_issuer(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_accept_server_cert_private_key property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The private key of the certificate (if available).

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_private_key(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

NOTE: The [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property-azurekeys-struct) may be available but not exportable. In this case, [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property-azurekeys-struct) returns an empty string.

This property is read-only.

## Data Type

String

# ssl_accept_server_cert_private_key_available property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Whether a PrivateKey is available for the selected certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_private_key_available(&self ) -> Result<bool, CloudKeysError>
```

## Default Value

false

## Remarks

Whether a [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property-azurekeys-struct) is available for the selected certificate. If [ssl_accept_server_cert_private_key_available](#ssl_accept_server_cert_private_key_available-property-azurekeys-struct) is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

## Data Type

bool

# ssl_accept_server_cert_private_key_container property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_private_key_container(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

The name of the [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property-azurekeys-struct) container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

## Data Type

String

# ssl_accept_server_cert_public_key property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The public key of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_public_key(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_accept_server_cert_public_key_algorithm property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_public_key_algorithm(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_accept_server_cert_public_key_length property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_public_key_length(&self ) -> Result<i32, CloudKeysError>
```

## Default Value

0

## Remarks

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

This property is read-only.

## Data Type

i32

# ssl_accept_server_cert_serial_number property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The serial number of the certificate encoded as a string.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_serial_number(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_accept_server_cert_signature_algorithm property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The text description of the certificate's signature algorithm.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_signature_algorithm(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_accept_server_cert_store property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The name of the certificate store for the client certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_store(&self ) -> Result<Vec<u8>, CloudKeysError> fn set_ssl_accept_server_cert_store(&self, value : Vec<u8>) ->  Option<CloudKeysError>
fn set_ssl_accept_server_cert_store_ref(&self, value : &[u8]) ->  Option<CloudKeysError>
```

## Default Value

"MY"

## Remarks

The name of the certificate store for the client certificate.

The [ssl_accept_server_cert_store_type](#ssl_accept_server_cert_store_type-property-azurekeys-struct) property denotes the type of the certificate store specified by [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-azurekeys-struct). If the store is password-protected, specify the password in [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property-azurekeys-struct).

[ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-azurekeys-struct) is used in conjunction with the [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-azurekeys-struct) property to specify client certificates. If [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-azurekeys-struct) has a value, and [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-azurekeys-struct) or [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property-azurekeys-struct) is set, a search for a certificate is initiated. Please see the [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-azurekeys-struct) 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 *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

## Data Type

Vec

# ssl_accept_server_cert_store_password property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_store_password(&self ) -> Result<String, CloudKeysError> fn set_ssl_accept_server_cert_store_password(&self, value : &str) ->  Option<CloudKeysError>
fn set_ssl_accept_server_cert_store_password_ref(&self, value : &String) ->  Option<CloudKeysError>
```

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

# ssl_accept_server_cert_store_type property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The type of certificate store for this certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_store_type(&self ) -> Result<i32, CloudKeysError> fn set_ssl_accept_server_cert_store_type(&self, value : i32) ->  Option<CloudKeysError>
```

## Possible Values

```text
0   // User1   // Machine2   // PFXFile3   // PFXBlob4   // JKSFile5   // JKSBlob6   // PEMKeyFile7   // PEMKeyBlob8   // PublicKeyFile9   // PublicKeyBlob10   // SSHPublicKeyBlob11   // P7BFile12   // P7BBlob13   // SSHPublicKeyFile14   // PPKFile15   // PPKBlob16   // XMLFile17   // XMLBlob18   // JWKFile19   // JWKBlob20   // SecurityKey21   // BCFKSFile22   // BCFKSBlob23   // PKCS1199   // Auto
```

## Default Value

0

## Remarks

The type of certificate store for this certificate.

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

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

|  |  |
| --- | --- |
| 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, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [ssl_accept_server_cert_store_type](#ssl_accept_server_cert_store_type-property-azurekeys-struct), the full path of the PKCS#11 DLL as the [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-azurekeys-struct), and the PIN as the [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property-azurekeys-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-azurekeys-struct) and set [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property-azurekeys-struct) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 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

i32

# ssl_accept_server_cert_subject_alt_names property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_subject_alt_names(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_accept_server_cert_thumbprint_md5 property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The MD5 hash of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_thumbprint_md5(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_accept_server_cert_thumbprint_sha1 property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The SHA-1 hash of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_thumbprint_sha1(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_accept_server_cert_thumbprint_sha256 property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The SHA-256 hash of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_thumbprint_sha256(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_accept_server_cert_usage property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The text description of UsageFlags .

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_usage(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

The text description of [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property-azurekeys-struct).

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

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

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

This property is read-only.

## Data Type

String

# ssl_accept_server_cert_usage_flags property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The flags that show intended use for the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_usage_flags(&self ) -> Result<i32, CloudKeysError>
```

## Default Value

0

## Remarks

The flags that show intended use for the certificate. The value of [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property-azurekeys-struct) is a combination of the following flags:

|  |  |
| --- | --- |
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |

Please see the [ssl_accept_server_cert_usage](#ssl_accept_server_cert_usage-property-azurekeys-struct) property for a text representation of [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property-azurekeys-struct).

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

This property is read-only.

## Data Type

i32

# ssl_accept_server_cert_version property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The certificate's version number.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_version(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_accept_server_cert_subject property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The subject of the certificate used for client authentication.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_subject(&self ) -> Result<String, CloudKeysError> fn set_ssl_accept_server_cert_subject(&self, value : &str) ->  Option<CloudKeysError>
fn set_ssl_accept_server_cert_subject_ref(&self, value : &String) ->  Option<CloudKeysError>
```

## Default Value

""

## Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.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

# ssl_accept_server_cert_encoded property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The certificate (PEM/Base64 encoded).

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_encoded(&self ) -> Result<Vec<u8>, CloudKeysError> fn set_ssl_accept_server_cert_encoded(&self, value : Vec<u8>) ->  Option<CloudKeysError>
fn set_ssl_accept_server_cert_encoded_ref(&self, value : &[u8]) ->  Option<CloudKeysError>
```

## Default Value

""

## Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-azurekeys-struct) and [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-azurekeys-struct) properties also may be used to specify a certificate.

When [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property-azurekeys-struct) is set, a search is initiated in the current [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-azurekeys-struct) for the private key of the certificate. If the key is found, [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-azurekeys-struct) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-azurekeys-struct) is set to an empty string.

## Data Type

Vec

# ssl_cert_effective_date property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The date on which this certificate becomes valid.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_effective_date(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

## Data Type

String

# ssl_cert_expiration_date property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The date on which the certificate expires.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_expiration_date(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

## Data Type

String

# ssl_cert_extended_key_usage property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

A comma-delimited list of extended key usage identifiers.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_extended_key_usage(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_cert_fingerprint property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_cert_fingerprint(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

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

This property is read-only.

## Data Type

String

# ssl_cert_fingerprint_sha1 property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_cert_fingerprint_sha1(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

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

This property is read-only.

## Data Type

String

# ssl_cert_fingerprint_sha256 property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_cert_fingerprint_sha256(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

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

This property is read-only.

## Data Type

String

# ssl_cert_issuer property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The issuer of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_issuer(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_cert_private_key property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The private key of the certificate (if available).

## Syntax

*Rust Syntax*

```text
fn ssl_cert_private_key(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

NOTE: The [ssl_cert_private_key](#ssl_cert_private_key-property-azurekeys-struct) may be available but not exportable. In this case, [ssl_cert_private_key](#ssl_cert_private_key-property-azurekeys-struct) returns an empty string.

This property is read-only.

## Data Type

String

# ssl_cert_private_key_available property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Whether a PrivateKey is available for the selected certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_private_key_available(&self ) -> Result<bool, CloudKeysError>
```

## Default Value

false

## Remarks

Whether a [ssl_cert_private_key](#ssl_cert_private_key-property-azurekeys-struct) is available for the selected certificate. If [ssl_cert_private_key_available](#ssl_cert_private_key_available-property-azurekeys-struct) is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

## Data Type

bool

# ssl_cert_private_key_container property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_cert_private_key_container(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

The name of the [ssl_cert_private_key](#ssl_cert_private_key-property-azurekeys-struct) container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

## Data Type

String

# ssl_cert_public_key property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The public key of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_public_key(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_cert_public_key_algorithm property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_cert_public_key_algorithm(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_cert_public_key_length property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_cert_public_key_length(&self ) -> Result<i32, CloudKeysError>
```

## Default Value

0

## Remarks

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

This property is read-only.

## Data Type

i32

# ssl_cert_serial_number property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The serial number of the certificate encoded as a string.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_serial_number(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_cert_signature_algorithm property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The text description of the certificate's signature algorithm.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_signature_algorithm(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_cert_store property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The name of the certificate store for the client certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_store(&self ) -> Result<Vec<u8>, CloudKeysError> fn set_ssl_cert_store(&self, value : Vec<u8>) ->  Option<CloudKeysError>
fn set_ssl_cert_store_ref(&self, value : &[u8]) ->  Option<CloudKeysError>
```

## Default Value

"MY"

## Remarks

The name of the certificate store for the client certificate.

The [ssl_cert_store_type](#ssl_cert_store_type-property-azurekeys-struct) property denotes the type of the certificate store specified by [ssl_cert_store](#ssl_cert_store-property-azurekeys-struct). If the store is password-protected, specify the password in [ssl_cert_store_password](#ssl_cert_store_password-property-azurekeys-struct).

[ssl_cert_store](#ssl_cert_store-property-azurekeys-struct) is used in conjunction with the [ssl_cert_subject](#ssl_cert_subject-property-azurekeys-struct) property to specify client certificates. If [ssl_cert_store](#ssl_cert_store-property-azurekeys-struct) has a value, and [ssl_cert_subject](#ssl_cert_subject-property-azurekeys-struct) or [ssl_cert_encoded](#ssl_cert_encoded-property-azurekeys-struct) is set, a search for a certificate is initiated. Please see the [ssl_cert_subject](#ssl_cert_subject-property-azurekeys-struct) 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 *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

## Data Type

Vec

# ssl_cert_store_password property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_store_password(&self ) -> Result<String, CloudKeysError> fn set_ssl_cert_store_password(&self, value : &str) ->  Option<CloudKeysError>
fn set_ssl_cert_store_password_ref(&self, value : &String) ->  Option<CloudKeysError>
```

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

# ssl_cert_store_type property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The type of certificate store for this certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_store_type(&self ) -> Result<i32, CloudKeysError> fn set_ssl_cert_store_type(&self, value : i32) ->  Option<CloudKeysError>
```

## Possible Values

```text
0   // User1   // Machine2   // PFXFile3   // PFXBlob4   // JKSFile5   // JKSBlob6   // PEMKeyFile7   // PEMKeyBlob8   // PublicKeyFile9   // PublicKeyBlob10   // SSHPublicKeyBlob11   // P7BFile12   // P7BBlob13   // SSHPublicKeyFile14   // PPKFile15   // PPKBlob16   // XMLFile17   // XMLBlob18   // JWKFile19   // JWKBlob20   // SecurityKey21   // BCFKSFile22   // BCFKSBlob23   // PKCS1199   // Auto
```

## Default Value

0

## Remarks

The type of certificate store for this certificate.

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

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

|  |  |
| --- | --- |
| 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, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [ssl_cert_store_type](#ssl_cert_store_type-property-azurekeys-struct), the full path of the PKCS#11 DLL as the [ssl_cert_store](#ssl_cert_store-property-azurekeys-struct), and the PIN as the [ssl_cert_store_password](#ssl_cert_store_password-property-azurekeys-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [ssl_cert_store](#ssl_cert_store-property-azurekeys-struct) and set [ssl_cert_store_password](#ssl_cert_store_password-property-azurekeys-struct) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 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

i32

# ssl_cert_subject_alt_names property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_cert_subject_alt_names(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_cert_thumbprint_md5 property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The MD5 hash of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_thumbprint_md5(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_cert_thumbprint_sha1 property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The SHA-1 hash of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_thumbprint_sha1(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_cert_thumbprint_sha256 property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The SHA-256 hash of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_thumbprint_sha256(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_cert_usage property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The text description of UsageFlags .

## Syntax

*Rust Syntax*

```text
fn ssl_cert_usage(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

The text description of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property-azurekeys-struct).

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

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

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

This property is read-only.

## Data Type

String

# ssl_cert_usage_flags property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The flags that show intended use for the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_usage_flags(&self ) -> Result<i32, CloudKeysError>
```

## Default Value

0

## Remarks

The flags that show intended use for the certificate. The value of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property-azurekeys-struct) is a combination of the following flags:

|  |  |
| --- | --- |
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |

Please see the [ssl_cert_usage](#ssl_cert_usage-property-azurekeys-struct) property for a text representation of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property-azurekeys-struct).

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

This property is read-only.

## Data Type

i32

# ssl_cert_version property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The certificate's version number.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_version(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_cert_subject property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The subject of the certificate used for client authentication.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_subject(&self ) -> Result<String, CloudKeysError> fn set_ssl_cert_subject(&self, value : &str) ->  Option<CloudKeysError>
fn set_ssl_cert_subject_ref(&self, value : &String) ->  Option<CloudKeysError>
```

## Default Value

""

## Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.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

# ssl_cert_encoded property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The certificate (PEM/Base64 encoded).

## Syntax

*Rust Syntax*

```text
fn ssl_cert_encoded(&self ) -> Result<Vec<u8>, CloudKeysError> fn set_ssl_cert_encoded(&self, value : Vec<u8>) ->  Option<CloudKeysError>
fn set_ssl_cert_encoded_ref(&self, value : &[u8]) ->  Option<CloudKeysError>
```

## Default Value

""

## Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssl_cert_store](#ssl_cert_store-property-azurekeys-struct) and [ssl_cert_subject](#ssl_cert_subject-property-azurekeys-struct) properties also may be used to specify a certificate.

When [ssl_cert_encoded](#ssl_cert_encoded-property-azurekeys-struct) is set, a search is initiated in the current [ssl_cert_store](#ssl_cert_store-property-azurekeys-struct) for the private key of the certificate. If the key is found, [ssl_cert_subject](#ssl_cert_subject-property-azurekeys-struct) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_cert_subject](#ssl_cert_subject-property-azurekeys-struct) is set to an empty string.

## Data Type

Vec

# ssl_provider property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_provider(&self ) -> Result<i32, CloudKeysError> fn set_ssl_provider(&self, value : i32) ->  Option<CloudKeysError>
```

## Possible Values

```text
0   // Automatic1   // Platform2   // Internal
```

## 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 struct will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

|  |  |
| --- | --- |
| 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
| 1 (sslpPlatform) | Uses the platform/system implementation. |
| 2 (sslpInternal) | Uses the internal implementation. |

 **Additional Notes**

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

When Automatic is selected, on Windows, the struct will use the platform implementation. On Linux/macOS, the struct will use the internal implementation. When TLS 1.3 is enabled via [SSLEnabledProtocols](#SSLEnabledProtocols), the struct will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

## Data Type

i32

# ssl_server_cert_effective_date property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The date on which this certificate becomes valid.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_effective_date(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

## Data Type

String

# ssl_server_cert_expiration_date property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The date on which the certificate expires.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_expiration_date(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

## Data Type

String

# ssl_server_cert_extended_key_usage property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

A comma-delimited list of extended key usage identifiers.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_extended_key_usage(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_server_cert_fingerprint property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_fingerprint(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

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

This property is read-only.

## Data Type

String

# ssl_server_cert_fingerprint_sha1 property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_fingerprint_sha1(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

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

This property is read-only.

## Data Type

String

# ssl_server_cert_fingerprint_sha256 property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_fingerprint_sha256(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

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

This property is read-only.

## Data Type

String

# ssl_server_cert_issuer property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The issuer of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_issuer(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_server_cert_private_key property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The private key of the certificate (if available).

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_private_key(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

NOTE: The [ssl_server_cert_private_key](#ssl_server_cert_private_key-property-azurekeys-struct) may be available but not exportable. In this case, [ssl_server_cert_private_key](#ssl_server_cert_private_key-property-azurekeys-struct) returns an empty string.

This property is read-only.

## Data Type

String

# ssl_server_cert_private_key_available property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Whether a PrivateKey is available for the selected certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_private_key_available(&self ) -> Result<bool, CloudKeysError>
```

## Default Value

false

## Remarks

Whether a [ssl_server_cert_private_key](#ssl_server_cert_private_key-property-azurekeys-struct) is available for the selected certificate. If [ssl_server_cert_private_key_available](#ssl_server_cert_private_key_available-property-azurekeys-struct) is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

## Data Type

bool

# ssl_server_cert_private_key_container property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_private_key_container(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

The name of the [ssl_server_cert_private_key](#ssl_server_cert_private_key-property-azurekeys-struct) container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

## Data Type

String

# ssl_server_cert_public_key property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The public key of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_public_key(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_server_cert_public_key_algorithm property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_public_key_algorithm(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_server_cert_public_key_length property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_public_key_length(&self ) -> Result<i32, CloudKeysError>
```

## Default Value

0

## Remarks

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

This property is read-only.

## Data Type

i32

# ssl_server_cert_serial_number property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The serial number of the certificate encoded as a string.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_serial_number(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_server_cert_signature_algorithm property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The text description of the certificate's signature algorithm.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_signature_algorithm(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_server_cert_store property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The name of the certificate store for the client certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_store(&self ) -> Result<Vec<u8>, CloudKeysError>
```

## Default Value

"MY"

## Remarks

The name of the certificate store for the client certificate.

The [ssl_server_cert_store_type](#ssl_server_cert_store_type-property-azurekeys-struct) property denotes the type of the certificate store specified by [ssl_server_cert_store](#ssl_server_cert_store-property-azurekeys-struct). If the store is password-protected, specify the password in [ssl_server_cert_store_password](#ssl_server_cert_store_password-property-azurekeys-struct).

[ssl_server_cert_store](#ssl_server_cert_store-property-azurekeys-struct) is used in conjunction with the [ssl_server_cert_subject](#ssl_server_cert_subject-property-azurekeys-struct) property to specify client certificates. If [ssl_server_cert_store](#ssl_server_cert_store-property-azurekeys-struct) has a value, and [ssl_server_cert_subject](#ssl_server_cert_subject-property-azurekeys-struct) or [ssl_server_cert_encoded](#ssl_server_cert_encoded-property-azurekeys-struct) is set, a search for a certificate is initiated. Please see the [ssl_server_cert_subject](#ssl_server_cert_subject-property-azurekeys-struct) 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 *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

## Data Type

Vec

# ssl_server_cert_store_password property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_store_password(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

## Data Type

String

# ssl_server_cert_store_type property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The type of certificate store for this certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_store_type(&self ) -> Result<i32, CloudKeysError>
```

## Possible Values

```text
0   // User1   // Machine2   // PFXFile3   // PFXBlob4   // JKSFile5   // JKSBlob6   // PEMKeyFile7   // PEMKeyBlob8   // PublicKeyFile9   // PublicKeyBlob10   // SSHPublicKeyBlob11   // P7BFile12   // P7BBlob13   // SSHPublicKeyFile14   // PPKFile15   // PPKBlob16   // XMLFile17   // XMLBlob18   // JWKFile19   // JWKBlob20   // SecurityKey21   // BCFKSFile22   // BCFKSBlob23   // PKCS1199   // Auto
```

## Default Value

0

## Remarks

The type of certificate store for this certificate.

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

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

|  |  |
| --- | --- |
| 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, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [ssl_server_cert_store_type](#ssl_server_cert_store_type-property-azurekeys-struct), the full path of the PKCS#11 DLL as the [ssl_server_cert_store](#ssl_server_cert_store-property-azurekeys-struct), and the PIN as the [ssl_server_cert_store_password](#ssl_server_cert_store_password-property-azurekeys-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [ssl_server_cert_store](#ssl_server_cert_store-property-azurekeys-struct) and set [ssl_server_cert_store_password](#ssl_server_cert_store_password-property-azurekeys-struct) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 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. |

This property is read-only.

## Data Type

i32

# ssl_server_cert_subject_alt_names property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_subject_alt_names(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_server_cert_thumbprint_md5 property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The MD5 hash of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_thumbprint_md5(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_server_cert_thumbprint_sha1 property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The SHA-1 hash of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_thumbprint_sha1(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_server_cert_thumbprint_sha256 property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The SHA-256 hash of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_thumbprint_sha256(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_server_cert_usage property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The text description of UsageFlags .

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_usage(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

The text description of [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property-azurekeys-struct).

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

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

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

This property is read-only.

## Data Type

String

# ssl_server_cert_usage_flags property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The flags that show intended use for the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_usage_flags(&self ) -> Result<i32, CloudKeysError>
```

## Default Value

0

## Remarks

The flags that show intended use for the certificate. The value of [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property-azurekeys-struct) is a combination of the following flags:

|  |  |
| --- | --- |
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |

Please see the [ssl_server_cert_usage](#ssl_server_cert_usage-property-azurekeys-struct) property for a text representation of [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property-azurekeys-struct).

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

This property is read-only.

## Data Type

i32

# ssl_server_cert_version property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The certificate's version number.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_version(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_server_cert_subject property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The subject of the certificate used for client authentication.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_subject(&self ) -> Result<String, CloudKeysError>
```

## Default Value

""

## Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.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.

This property is read-only.

## Data Type

String

# ssl_server_cert_encoded property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The certificate (PEM/Base64 encoded).

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_encoded(&self ) -> Result<Vec<u8>, CloudKeysError>
```

## Default Value

""

## Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssl_server_cert_store](#ssl_server_cert_store-property-azurekeys-struct) and [ssl_server_cert_subject](#ssl_server_cert_subject-property-azurekeys-struct) properties also may be used to specify a certificate.

When [ssl_server_cert_encoded](#ssl_server_cert_encoded-property-azurekeys-struct) is set, a search is initiated in the current [ssl_server_cert_store](#ssl_server_cert_store-property-azurekeys-struct) for the private key of the certificate. If the key is found, [ssl_server_cert_subject](#ssl_server_cert_subject-property-azurekeys-struct) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_server_cert_subject](#ssl_server_cert_subject-property-azurekeys-struct) is set to an empty string.

This property is read-only.

## Data Type

Vec

# tag_count property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The number of records in the Tag arrays.

## Syntax

*Rust Syntax*

```text
fn tag_count(&self ) -> Result<i32, CloudKeysError> fn set_tag_count(&self, value : i32) ->  Option<CloudKeysError>
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [tag_name](#tag_name-property-azurekeys-struct)
- [tag_value](#tag_value-property-azurekeys-struct)

The array indices start at *0* and end at *tag_count - 1*.

## Data Type

i32

# tag_name property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The name of the tag.

## Syntax

*Rust Syntax*

```text
fn tag_name(&self , TagIndex : i32) -> Result<String, CloudKeysError> fn set_tag_name(&self, TagIndex : i32, value : &str) ->  Option<CloudKeysError>
fn set_tag_name_ref(&self, TagIndex : i32, value : &String) ->  Option<CloudKeysError>
```

## 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](#tag_count-property-azurekeys-struct) property.

## Data Type

String

# tag_value property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The value of the tag.

## Syntax

*Rust Syntax*

```text
fn tag_value(&self , TagIndex : i32) -> Result<String, CloudKeysError> fn set_tag_value(&self, TagIndex : i32, value : &str) ->  Option<CloudKeysError>
fn set_tag_value_ref(&self, TagIndex : i32, value : &String) ->  Option<CloudKeysError>
```

## 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](#tag_count-property-azurekeys-struct) property.

## Data Type

String

# timeout property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

The timeout for the struct.

## Syntax

*Rust Syntax*

```text
fn timeout(&self ) -> Result<i32, CloudKeysError> fn set_timeout(&self, value : i32) ->  Option<CloudKeysError>
```

## 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 struct will wait for the operation to complete before returning control.

The struct will use [do_events](#do_events-method-azurekeys-struct) 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 struct fails with an error.

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

The default value for the timeout property is 60 seconds.

## Data Type

i32

# vault property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Selects a vault for the struct to interact with.

## Syntax

*Rust Syntax*

```text
fn vault(&self ) -> Result<String, CloudKeysError> fn set_vault(&self, value : &str) ->  Option<CloudKeysError>
fn set_vault_ref(&self, value : &String) ->  Option<CloudKeysError>
```

## Default Value

""

## Remarks

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

## Data Type

String

# version_marker property ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
fn version_marker(&self ) -> Result<String, CloudKeysError> fn set_version_marker(&self, value : &str) ->  Option<CloudKeysError>
fn set_version_marker_ref(&self, value : &String) ->  Option<CloudKeysError>
```

## Default Value

""

## Remarks

This property will be populated when [list_versions](#list_versions-method-azurekeys-struct) is called if the results are paged and there are more pages. To list all key versions, continue to call [list_versions](#list_versions-method-azurekeys-struct) until this property returns empty string.

Refer to [list_versions](#list_versions-method-azurekeys-struct) for more information.

## Data Type

String

# add_query_param method ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Adds a query parameter to the QueryParams properties.

## Syntax

*Rust Syntax*

```text
fn add_query_param(&self, name : &str, value : &str) -> Result<(), CloudKeysError>
```

## Remarks

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

All specified *Value*s will be URL encoded by the struct automatically. Consult the service documentation for details on the available parameters.

# add_tag method ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Adds an item to the Tags properties.

## Syntax

*Rust Syntax*

```text
fn add_tag(&self, name : &str, value : &str) -> Result<(), CloudKeysError>
```

## Remarks

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

# authorize method ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Get the authorization string required to access the protected resource.

## Syntax

*Rust Syntax*

```text
fn authorize(&self) -> Result<(), CloudKeysError>
```

## 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 [o_auth_client_profile](#o_auth_client_profile-property-azurekeys-struct) property and the [o_auth_grant_type](#o_auth_grant_type-property-azurekeys-struct) property. This method is **not** to be used in conjunction with the [authorization](#authorization-property-azurekeys-struct) property. It should instead be used when setting the o_auth property.

For more information, see the introduction section.

# backup_key method ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Backs up a key.

## Syntax

*Rust Syntax*

```text
fn backup_key(&self, key_name : &str) -> Result<(), CloudKeysError>
```

## Remarks

This method backs up the key specified by *KeyName*, returning it in a protected form via the the specified [output_file](#output_file-property-azurekeys-struct) or the [output_data](#output_data-property-azurekeys-struct) property.

Note that the protected key cannot be used outside of Azure Key Vault, it must be restored to another vault using the [restore_key](#restore_key-method-azurekeys-struct) method in order to be used.

# config method ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Sets or retrieves a configuration setting.

## Syntax

*Rust Syntax*

```text
fn config(&self, configuration_string : &str) ->  Result<String, CloudKeysError>
```

## Remarks

config is a generic method available in every struct. It is used to set and retrieve [configuration settings](#config-settings-azurekeys-struct) for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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](#config-settings-azurekeys-struct), you must call *Config("PROPERTY")*. The value will be returned as a string.

# create_key method ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Creates a new key.

## Syntax

*Rust Syntax*

```text
fn create_key(&self, key_name : &str, key_type : &str, key_ops : &str) ->  Result<String, CloudKeysError>
```

## 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*

 (Note that EC keys can only be used for signing and verification.)

If there are any items in the tags properties, they will be applied to the newly-created key. Keys may have up to 15 tags.

The following configuration settings can also be used to send additional values when creating the key, refer to their documentation for more information:

- [CreateKeyEnabled](#CreateKeyEnabled)
- [ExpiryDate](#ExpiryDate)
- [NotBeforeDate](#NotBeforeDate)

Note: If there is already a soft-deleted key with the specified *KeyName* in the currently-selected [vault](#vault-property-azurekeys-struct), 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 [recover_key](#recover_key-method-azurekeys-struct)) or permanently deleted (using [purge_key](#purge_key-method-azurekeys-struct)) first.

# decrypt method ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Decrypts data using a key.

## Syntax

*Rust Syntax*

```text
fn decrypt(&self, key_name : &str, algorithm : &str) -> Result<(), CloudKeysError>
```

## Remarks

This method decrypts data using the key specified by *KeyName* and the given *Algorithm*. The [VersionId](#VersionId) configuration setting can be used to target a specific key version.

The data to decrypt is taken from the the specified [input_file](#input_file-property-azurekeys-struct) or the [input_data](#input_data-property-azurekeys-struct) property. The decrypted data is output to the the specified [output_file](#output_file-property-azurekeys-struct) or the [output_data](#output_data-property-azurekeys-struct) 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 |

# delete_key method ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Deletes a key.

## Syntax

*Rust Syntax*

```text
fn delete_key(&self, key_name : &str) -> Result<(), CloudKeysError>
```

## 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 [recover_key](#recover_key-method-azurekeys-struct) method, or permanently deleted using the [purge_key](#purge_key-method-azurekeys-struct) method. The length of the retention period depends on the configuration of the currently-selected [vault](#vault-property-azurekeys-struct), refer to the Azure Key Vault documentation for more information.

# do_events method ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

This method processes events from the internal message queue.

## Syntax

*Rust Syntax*

```text
fn do_events(&self) -> Result<(), CloudKeysError>
```

## Remarks

When do_events is called, the struct processes any available events. If no events are available, it waits for a preset period of time, and then returns.

# encrypt method ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Encrypts data using a key.

## Syntax

*Rust Syntax*

```text
fn encrypt(&self, key_name : &str, algorithm : &str) -> Result<(), CloudKeysError>
```

## Remarks

This method encrypts data using the key specified by *KeyName* and the given *Algorithm*. The [VersionId](#VersionId) configuration setting can be used to target a specific key version.

The data to encrypt is taken from the the specified [input_file](#input_file-property-azurekeys-struct) or the [input_data](#input_data-property-azurekeys-struct) property. The encrypted data is output to the the specified [output_file](#output_file-property-azurekeys-struct) or the [output_data](#output_data-property-azurekeys-struct) 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 |

# get_key_info method ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Gets a key's information and public key.

## Syntax

*Rust Syntax*

```text
fn get_key_info(&self, key_name : &str) -> Result<(), CloudKeysError>
```

## Remarks

This method gets the information, including the public key, for the key specified by *KeyName*. The [VersionId](#VersionId) configuration setting can be used to target a specific key version. Alternatively, the [GetDeleted](#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 struct clears the keys properties and repopulates it properties with the key's tags. The [on_key_list](#on_key_list-event-azurekeys-struct) event is also fired.

# list_keys method ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Lists keys in the currently-selected vault.

## Syntax

*Rust Syntax*

```text
fn list_keys(&self) -> Result<(), CloudKeysError>
```

## Remarks

This method lists the keys in the currently-selected [vault](#vault-property-azurekeys-struct). If the [GetDeleted](#GetDeleted) configuration setting is enabled, it lists the soft-deleted keys in the vault instead.

Calling this method will fire the [on_key_list](#on_key_list-event-azurekeys-struct) event once for each key, and will also populate the keys properties. However, note that by default the following properties will not be populated, since the server does not return full information for keys when listing them. The [include_key_details](#include_key_details-property-azurekeys-struct) property can be enabled to have the struct attempt to retrieve full information for each key; refer to its documentation for more information.

- [key_ops](#key_ops-property-azurekeys-struct)
- [key_type](#key_type-property-azurekeys-struct)
- [key_public_key](#key_public_key-property-azurekeys-struct)
- [key_version_id](#key_version_id-property-azurekeys-struct)

If there are still more keys available to list when this method returns, the [key_marker](#key_marker-property-azurekeys-struct) property will be populated. Continue to call this method until [key_marker](#key_marker-property-azurekeys-struct) is empty to accumulate all pages of results in the keys properties.

The [MaxKeys](#MaxKeys) configuration setting can be used to control the maximum number of results to return at once.

# list_versions method ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Lists versions of a key.

## Syntax

*Rust Syntax*

```text
fn list_versions(&self, key_name : &str) -> Result<(), CloudKeysError>
```

## Remarks

This method lists the versions of the key specified by *KeyName*.

Calling this method will fire the [on_key_list](#on_key_list-event-azurekeys-struct) event once for each key version, and will also populate the keys properties. However, note that by default the following properties will not be populated, since the server does not return full information for key versions when listing them. The [include_key_details](#include_key_details-property-azurekeys-struct) property can be enabled to have the struct attempt to retrieve full information for each key version; refer to its documentation for more information.

- [key_ops](#key_ops-property-azurekeys-struct)
- [key_type](#key_type-property-azurekeys-struct)
- [key_public_key](#key_public_key-property-azurekeys-struct)

If there are still more key versions available to list when this method returns, the [version_marker](#version_marker-property-azurekeys-struct) property will be populated. Continue to call this method until [version_marker](#version_marker-property-azurekeys-struct) is empty to accumulate all pages of results in the keys properties.

The [MaxKeys](#MaxKeys) configuration setting can be used to control the maximum number of results to return at once.

# purge_key method ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Permanently deletes a soft-deleted key.

## Syntax

*Rust Syntax*

```text
fn purge_key(&self, key_name : &str) -> Result<(), CloudKeysError>
```

## Remarks

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

# recover_key method ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Recovers a soft-deleted key.

## Syntax

*Rust Syntax*

```text
fn recover_key(&self, key_name : &str) -> Result<(), CloudKeysError>
```

## Remarks

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

# reset method ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Resets the struct to its initial state.

## Syntax

*Rust Syntax*

```text
fn reset(&self) -> Result<(), CloudKeysError>
```

## Remarks

This method resets the struct to its initial state.

# restore_key method ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Restores a previously backed-up key to the vault.

## Syntax

*Rust Syntax*

```text
fn restore_key(&self) ->  Result<String, CloudKeysError>
```

## Remarks

This method restores a key previously backed up using [backup_key](#backup_key-method-azurekeys-struct) to the currently-selected [vault](#vault-property-azurekeys-struct). The key is restored in its entirety, with all of its versions intact. However, note that the restore will fail if the key's name is already in use. The name of the restored key is returned.

The protected key data to restore is taken from the the specified [input_file](#input_file-property-azurekeys-struct) or the [input_data](#input_data-property-azurekeys-struct) 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.

# send_custom_request method ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Sends a custom request to the server.

## Syntax

*Rust Syntax*

```text
fn send_custom_request(&self, http_method : &str, path : &str) -> Result<(), CloudKeysError>
```

## 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 struct does the following:

1.  Builds a request URL, including query parameters, based on the following:

  - The base URL *https://{Vault}.vault.azure.net/keys*, where *{Vault}* is [vault](#vault-property-azurekeys-struct).
  - The specified *Path*, if any.
  - An *api-version* query parameter whose value is [APIVersion](#APIVersion).
  - All query parameters from query_params.

2. Adds an *Authorization* header with the value specified by [authorization](#authorization-property-azurekeys-struct).
3. Adds any request headers from [other_headers](#other_headers-property-azurekeys-struct).
4. Adds any request body supplied via the specified [input_file](#input_file-property-azurekeys-struct) or [input_data](#input_data-property-azurekeys-struct).
5. Sends the request to the server.
6. Stores the response headers in the parsed_headers properties; and the response body in the specified [output_file](#output_file-property-azurekeys-struct) or [output_data](#output_data-property-azurekeys-struct).

If the response body is JSON data, the [XPath](#XPath), [XText](#XText), and other **X*** configuration settings can then be used to navigate and extract information from it.

# set_key_enabled method ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Enables or disables a key.

## Syntax

*Rust Syntax*

```text
fn set_key_enabled(&self, key_name : &str, enabled : bool) -> Result<(), CloudKeysError>
```

## Remarks

This method enables or disables the key specified by *KeyName*.

# sign method ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Signs a message using a key.

## Syntax

*Rust Syntax*

```text
fn sign(&self, key_name : &str, algorithm : &str, is_digest : bool) -> Result<(), CloudKeysError>
```

## Remarks

This method signs a message using the key specified by *KeyName* and the given *Algorithm*. The [VersionId](#VersionId) configuration setting can be used to target a specific key version.

The message data to sign is taken from the the specified [input_file](#input_file-property-azurekeys-struct) or the [input_data](#input_data-property-azurekeys-struct) property. The signature data is output to the the specified [output_file](#output_file-property-azurekeys-struct) or the [output_data](#output_data-property-azurekeys-struct) 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](#verify-method-azurekeys-struct) the signature later.

If *IsDigest* is *false*, the struct will automatically compute an appropriate message digest before the request is made. In such cases, the computed digest is made available via the [MessageDigest](#MessageDigest) configuration setting.

# unwrap_key method ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Unwraps a symmetric key.

## Syntax

*Rust Syntax*

```text
fn unwrap_key(&self, key_name : &str, algorithm : &str) -> Result<(), CloudKeysError>
```

## 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](#decrypt-method-azurekeys-struct) method, except that it requires the *keys/unwrapKey* permission instead of the *keys/decrypt* permission. Refer to the [decrypt](#decrypt-method-azurekeys-struct) method's documentation for more information.

# update_key method ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Updates a key's information.

## Syntax

*Rust Syntax*

```text
fn update_key(&self, key_name : &str, key_ops : &str, update_tags : bool) -> Result<(), CloudKeysError>
```

## Remarks

This method updates the information for the key specified by *KeyName*. The [VersionId](#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*

 (Note that EC keys can only be used for signing and verification.)

The *UpdateTags* parameter determines whether the struct replaces the key's current tags with the items in the tags properties (which may be empty). Keys may have up to 15 tags.

The [ExpiryDate](#ExpiryDate) and [NotBeforeDate](#NotBeforeDate) configuration settings may also be used to send additional values, refer to their documentation for more information.

# verify method ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Verifies a digital signature using a key.

## Syntax

*Rust Syntax*

```text
fn verify(&self, key_name : &str, algorithm : &str, is_digest : bool) ->  Result<bool, CloudKeysError>
```

## Remarks

This method verifies a digital signature using the key specified by *KeyName* and the given *Algorithm*. The [VersionId](#VersionId) configuration setting can be used to target a specific key version. If the signature is successfully verified, this method returns *true*, otherwise it returns *false*.

The message data is taken from the the specified [input_file](#input_file-property-azurekeys-struct) or the [input_data](#input_data-property-azurekeys-struct) property. The digital signature data is taken from the specified [output_file](#output_file-property-azurekeys-struct) or the [output_data](#output_data-property-azurekeys-struct) 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 struct will automatically compute an appropriate message digest before the request is made. In such cases, the computed digest is made available via the [MessageDigest](#MessageDigest) configuration setting.

# wrap_key method ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Wraps a symmetric key.

## Syntax

*Rust Syntax*

```text
fn wrap_key(&self, key_name : &str, algorithm : &str) -> Result<(), CloudKeysError>
```

## Remarks

This method wraps (i.e., encrypts) a symmetric key using the key specified by *KeyName* and the given *Algorithm*. The [VersionId](#VersionId) configuration setting can be used to target a specific key version.

This method functions exactly the same way as the [encrypt](#encrypt-method-azurekeys-struct) method, except that it requires the *keys/wrapKey* permission instead of the *keys/encrypt* permission. Refer to the [encrypt](#encrypt-method-azurekeys-struct) method's documentation for more information.

# on_end_transfer event ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Fired when a document finishes transferring.

## Syntax

*Rust Syntax*

```text
// AzureKeysEndTransferEventArgs carries the AzureKeys EndTransfer event's parameters.
pub struct AzureKeysEndTransferEventArgs {
  fn direction(&self) -> i32
}

// AzureKeysEndTransferEvent defines the signature of the AzureKeys EndTransfer event's handler function.
pub trait AzureKeysEndTransferEvent {
  fn on_end_transfer(&self, sender : AzureKeys, e : &mut AzureKeysEndTransferEventArgs);
}

impl <'a> AzureKeys<'a> {
  pub fn on_end_transfer(&self) -> &'a dyn AzureKeysEndTransferEvent;
  pub fn set_on_end_transfer(&mut self, value : &'a dyn AzureKeysEndTransferEvent);
  ...
}
```

## Remarks

This event is fired first when the client finishes sending data to the server (in a *POST* or *PUT* request) and then 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.

# on_error event ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Fired when information is available about errors during data delivery.

## Syntax

*Rust Syntax*

```text
// AzureKeysErrorEventArgs carries the AzureKeys Error event's parameters.
pub struct AzureKeysErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// AzureKeysErrorEvent defines the signature of the AzureKeys Error event's handler function.
pub trait AzureKeysErrorEvent {
  fn on_error(&self, sender : AzureKeys, e : &mut AzureKeysErrorEventArgs);
}

impl <'a> AzureKeys<'a> {
  pub fn on_error(&self) -> &'a dyn AzureKeysErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn AzureKeysErrorEvent);
  ...
}
```

## Remarks

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

The *error_code* 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](#trappable-errors-azurekeys-struct) section.

# on_header event ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Fired every time a header line comes in.

## Syntax

*Rust Syntax*

```text
// AzureKeysHeaderEventArgs carries the AzureKeys Header event's parameters.
pub struct AzureKeysHeaderEventArgs {
  fn field(&self) -> &String
  fn value(&self) -> &String
}

// AzureKeysHeaderEvent defines the signature of the AzureKeys Header event's handler function.
pub trait AzureKeysHeaderEvent {
  fn on_header(&self, sender : AzureKeys, e : &mut AzureKeysHeaderEventArgs);
}

impl <'a> AzureKeys<'a> {
  pub fn on_header(&self) -> &'a dyn AzureKeysHeaderEvent;
  pub fn set_on_header(&mut self, value : &'a dyn AzureKeysHeaderEvent);
  ...
}
```

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

# on_key_list event ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Fires once for each key when listing keys.

## Syntax

*Rust Syntax*

```text
// AzureKeysKeyListEventArgs carries the AzureKeys KeyList event's parameters.
pub struct AzureKeysKeyListEventArgs {
  fn name(&self) -> &String
  fn version_id(&self) -> &String
  fn key_type(&self) -> &String
  fn key_ops(&self) -> &String
  fn enabled(&self) -> bool
  fn creation_date(&self) -> i64
  fn update_date(&self) -> i64
  fn deletion_date(&self) -> i64
  fn purge_date(&self) -> i64
  fn public_key(&self) -> &String
}

// AzureKeysKeyListEvent defines the signature of the AzureKeys KeyList event's handler function.
pub trait AzureKeysKeyListEvent {
  fn on_key_list(&self, sender : AzureKeys, e : &mut AzureKeysKeyListEventArgs);
}

impl <'a> AzureKeys<'a> {
  pub fn on_key_list(&self) -> &'a dyn AzureKeysKeyListEvent;
  pub fn set_on_key_list(&mut self, value : &'a dyn AzureKeysKeyListEvent);
  ...
}
```

## Remarks

This event fires once for each key (or key version) returned when [list_keys](#list_keys-method-azurekeys-struct), [list_versions](#list_versions-method-azurekeys-struct), or [get_key_info](#get_key_info-method-azurekeys-struct) is called. However, note that the *KeyOps*, *KeyType*, *PublicKey*, and (for [list_keys](#list_keys-method-azurekeys-struct)) *VersionId* parameters are not populated when one of the listing methods is called unless the [include_key_details](#include_key_details-property-azurekeys-struct) 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.

# on_log event ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Fired once for each log message.

## Syntax

*Rust Syntax*

```text
// AzureKeysLogEventArgs carries the AzureKeys Log event's parameters.
pub struct AzureKeysLogEventArgs {
  fn log_level(&self) -> i32
  fn message(&self) -> &String
  fn log_type(&self) -> &String
}

// AzureKeysLogEvent defines the signature of the AzureKeys Log event's handler function.
pub trait AzureKeysLogEvent {
  fn on_log(&self, sender : AzureKeys, e : &mut AzureKeysLogEventArgs);
}

impl <'a> AzureKeys<'a> {
  pub fn on_log(&self) -> &'a dyn AzureKeysLogEvent;
  pub fn set_on_log(&mut self, value : &'a dyn AzureKeysLogEvent);
  ...
}
```

## Remarks

This event is fired once for each log message generated by the struct. The verbosity is controlled by the [LogLevel](#LogLevel) setting.

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

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

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

# on_ssl_server_authentication event ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Fired after the server presents its certificate to the client.

## Syntax

*Rust Syntax*

```text
// AzureKeysSSLServerAuthenticationEventArgs carries the AzureKeys SSLServerAuthentication event's parameters.
pub struct AzureKeysSSLServerAuthenticationEventArgs {
  fn cert_encoded(&self) -> &[u8]
  fn cert_subject(&self) -> &String
  fn cert_issuer(&self) -> &String
  fn status(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// AzureKeysSSLServerAuthenticationEvent defines the signature of the AzureKeys SSLServerAuthentication event's handler function.
pub trait AzureKeysSSLServerAuthenticationEvent {
  fn on_ssl_server_authentication(&self, sender : AzureKeys, e : &mut AzureKeysSSLServerAuthenticationEventArgs);
}

impl <'a> AzureKeys<'a> {
  pub fn on_ssl_server_authentication(&self) -> &'a dyn AzureKeysSSLServerAuthenticationEvent;
  pub fn set_on_ssl_server_authentication(&mut self, value : &'a dyn AzureKeysSSLServerAuthenticationEvent);
  ...
}
```

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

# on_ssl_status event ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Fired when secure connection progress messages are available.

## Syntax

*Rust Syntax*

```text
// AzureKeysSSLStatusEventArgs carries the AzureKeys SSLStatus event's parameters.
pub struct AzureKeysSSLStatusEventArgs {
  fn message(&self) -> &String
}

// AzureKeysSSLStatusEvent defines the signature of the AzureKeys SSLStatus event's handler function.
pub trait AzureKeysSSLStatusEvent {
  fn on_ssl_status(&self, sender : AzureKeys, e : &mut AzureKeysSSLStatusEventArgs);
}

impl <'a> AzureKeys<'a> {
  pub fn on_ssl_status(&self) -> &'a dyn AzureKeysSSLStatusEvent;
  pub fn set_on_ssl_status(&mut self, value : &'a dyn AzureKeysSSLStatusEvent);
  ...
}
```

## Remarks

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

# on_start_transfer event ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Fired when a document starts transferring (after the headers).

## Syntax

*Rust Syntax*

```text
// AzureKeysStartTransferEventArgs carries the AzureKeys StartTransfer event's parameters.
pub struct AzureKeysStartTransferEventArgs {
  fn direction(&self) -> i32
}

// AzureKeysStartTransferEvent defines the signature of the AzureKeys StartTransfer event's handler function.
pub trait AzureKeysStartTransferEvent {
  fn on_start_transfer(&self, sender : AzureKeys, e : &mut AzureKeysStartTransferEventArgs);
}

impl <'a> AzureKeys<'a> {
  pub fn on_start_transfer(&self) -> &'a dyn AzureKeysStartTransferEvent;
  pub fn set_on_start_transfer(&mut self, value : &'a dyn AzureKeysStartTransferEvent);
  ...
}
```

## Remarks

This event is fired first when the client starts sending data to the server (in a *POST* or *PUT* request) and then 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.

# on_tag_list event ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

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

## Syntax

*Rust Syntax*

```text
// AzureKeysTagListEventArgs carries the AzureKeys TagList event's parameters.
pub struct AzureKeysTagListEventArgs {
  fn key_name(&self) -> &String
  fn version_id(&self) -> &String
  fn name(&self) -> &String
  fn value(&self) -> &String
}

// AzureKeysTagListEvent defines the signature of the AzureKeys TagList event's handler function.
pub trait AzureKeysTagListEvent {
  fn on_tag_list(&self, sender : AzureKeys, e : &mut AzureKeysTagListEventArgs);
}

impl <'a> AzureKeys<'a> {
  pub fn on_tag_list(&self) -> &'a dyn AzureKeysTagListEvent;
  pub fn set_on_tag_list(&mut self, value : &'a dyn AzureKeysTagListEvent);
  ...
}
```

## Remarks

This event fires once for each tag returned when [get_key_info](#get_key_info-method-azurekeys-struct) 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.

# on_transfer event ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

Fired while a document transfers (delivers document).

## Syntax

*Rust Syntax*

```text
// AzureKeysTransferEventArgs carries the AzureKeys Transfer event's parameters.
pub struct AzureKeysTransferEventArgs {
  fn direction(&self) -> i32
  fn bytes_transferred(&self) -> i64
  fn percent_done(&self) -> i32
  fn text(&self) -> &[u8]
}

// AzureKeysTransferEvent defines the signature of the AzureKeys Transfer event's handler function.
pub trait AzureKeysTransferEvent {
  fn on_transfer(&self, sender : AzureKeys, e : &mut AzureKeysTransferEventArgs);
}

impl <'a> AzureKeys<'a> {
  pub fn on_transfer(&self) -> &'a dyn AzureKeysTransferEvent;
  pub fn set_on_transfer(&mut self, value : &'a dyn AzureKeysTransferEvent);
  ...
}
```

## 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 *bytes_transferred* parameter contains the number of bytes transferred in this *direction* since the beginning of the document text (excluding HTTP response headers).

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

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

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

# Config Settings ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

 The struct 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 struct, access to these *internal properties* is provided through the [config](#config-method-azurekeys-struct) method.

### AzureKeys Config Settings

**AccumulatePages**: Whether the struct should accumulate subsequent pages of results when listing them.This setting controls how the struct behaves when listing multiple pages of results. If this setting is enabled, each successive page of results will be appended to the appropriate collection properties until the last page of results has been listed (at which point the next list call will cause said collection to be cleared first). If this setting is disabled, the collection will be cleared every time a page of results is returned.

By default, this setting is enabled, allowing all pages of results to be accumulated in the appropriate collection properties.

**APIVersion**: The Azure Key Vault API version that the struct conforms to.This setting can be queried to obtain the Azure Key Vault API version that the struct conforms to; it cannot be changed.

**CreateKeyEnabled**: Whether new keys should be created in an enabled or disabled state.This setting specifies whether new keys created using the [create_key](#create_key-method-azurekeys-struct) method should be created in an enabled or disabled state.

By default, this setting is enabled, and keys are created in an enabled state.

**ExpiryDate**: The expiry date to send for the key.This setting specifies the expiry date that should be sent when a key is created using [create_key](#create_key-method-azurekeys-struct) or updated using [update_key](#update_key-method-azurekeys-struct). The date should be specified in seconds since the Unix epoch.

A key can only be used for the [decrypt](#decrypt-method-azurekeys-struct), [verify](#verify-method-azurekeys-struct), and [unwrap_key](#unwrap_key-method-azurekeys-struct) operations after its expiry date.

By default, this setting is set to *-1*, and no expiry date is sent.

**GetDeleted**: Whether the struct should retrieve information about soft-deleted keys.This setting specifies whether the struct should retrieve information about soft-deleted keys when [list_keys](#list_keys-method-azurekeys-struct) or [get_key_info](#get_key_info-method-azurekeys-struct) is called.

By default, this setting is disabled, and the struct requests information about active keys.

**MaxKeys**: The maximum number of results to return when listing keys.This setting specifies the maximum number of results that should be returned by a call to [list_keys](#list_keys-method-azurekeys-struct) or [list_versions](#list_versions-method-azurekeys-struct).

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

**MessageDigest**: The message digest computed by the struct during the last sign or verify operation, if any.This setting can be queried after calling [sign](#sign-method-azurekeys-struct) or [verify](#verify-method-azurekeys-struct) to obtain the (hex-encoded) message digest computed by the struct during the call. If the struct did not generate a message digest as part of the call, an empty string will be returned.

**NotBeforeDate**: The 'not before' date to send for the key.This setting specifies the "not before" date that should be sent when a key is created using [create_key](#create_key-method-azurekeys-struct) or updated using [update_key](#update_key-method-azurekeys-struct). The date should be specified in seconds since the Unix epoch.

A key can only be used for the [decrypt](#decrypt-method-azurekeys-struct), [verify](#verify-method-azurekeys-struct), and [unwrap_key](#unwrap_key-method-azurekeys-struct) operations prior to its "not before" date.

By default, this setting is set to *-1*, and no "not before" date is sent.

**RawRequest**: Returns the data that was sent to the server.This setting may be queried after calling any method that sends data to the server to obtain the request data that was transmitted. Such data may be useful for troubleshooting purposes.

**RawResponse**: Returns the data that was received from the server.This setting may be queried after calling any method that sends data to the server to obtain the response data that was received. Such data may be useful for troubleshooting purposes.

**VersionId**: The Id of the key version that the struct should make requests against.This setting can be set to the Id of a specific key version before calling one of the following methods in order to have the struct make the request against the specified version rather than the latest version.

- [decrypt](#decrypt-method-azurekeys-struct)
- [encrypt](#encrypt-method-azurekeys-struct)
- [get_key_info](#get_key_info-method-azurekeys-struct) (unless [GetDeleted](#GetDeleted) is enabled, in which case this setting is ignored)
- [sign](#sign-method-azurekeys-struct)
- [unwrap_key](#unwrap_key-method-azurekeys-struct)
- [update_key](#update_key-method-azurekeys-struct)
- [verify](#verify-method-azurekeys-struct)
- [wrap_key](#wrap_key-method-azurekeys-struct)

**XChildCount**: The number of child elements of the current element.This configuration settings specifies the number of child attributes of the current element. The XChild configuration settings will be indexed from 0 to ([XChildCount](#XChildCount) - 1).

The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only.

**XChildName[i]**: The name of the child element.This configuration setting provides the name of the i-th child element of the current element.

The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only.

**XChildXText[i]**: The inner text of the child element.This configuration setting provides the inner text of the i-th child element of the current element.

The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only.

**XElement**: The name of the current element.This configuration setting provides the name of the current element.

The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only.

**XParent**: The parent of the current element.This configuration setting provides the parent of the current element.

The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only.

**XPath**: Provides a way to point to a specific element in the returned XML or JSON response.The [XPath](#XPath) setting allows you to point to specific elements in the XML or JSON response.

When [XPath](#XPath) is set to a valid path, [XElement](#XElement) points to the name of the element, with [XText](#XText), [XParent](#XParent), [XSubTree](#XSubTree), [XChildCount](#XChildCount), [XChildName\[i\]](#XChildName[i]), and [XChildXText\[i\]](#XChildXText[i]) providing other properties of the element.

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](#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. |

 NOTE: XPath indices are *1-based*.

For example, assume the following XML and JSON responses.

XML:

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

JSON:

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

The following are examples of valid XPaths for these responses:

| 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 list is not exhaustive, but it provides a general idea of the possibilities.

**XSubTree**: A snapshot of the current element in the document.This configuration setting provides the entirety of the current element (including its subelements).

The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only.

**XText**: The text of the current element.This configuration setting provides the inner text of the current element.

The current element is specified in the [XPath](#XPath) configuration setting. This configuration setting is read-only.

### OAuth Config Settings

**OAuthAccessTokenExpiration**: The lifetime of the access token.This setting holds the lifetime of the access token in seconds. For instance the value *3600* indicates that the token will expire in one hour from the time it was generated.

**OAuthAuthorizationTokenType**: The type of access token returned.The applicable values include the following:

|  |  |
| --- | --- |
| Bearer (default) | When the access token returned by the server is a Bearer type, the authorization string returned by [authorize](#authorize-method-azurekeys-struct) will be in the format "Bearer access_token". This can be supplied as the value of the HTTP Authorization header. |

**OAuthAutomaticRefresh**: Whether or not to refresh an expired access token automatically.When this setting is set to *true* and the [authorization](#authorization-property-azurekeys-struct) property is not set, the struct will automatically get a new access token if it has the necessary properties to do so without user interaction.

For example, when using the Authorization Code grant type, the [o_auth_refresh_token](#o_auth_refresh_token-property-azurekeys-struct) property should be set to a valid refresh token. When using the Client Credential grant type however, the struct does not need any additional properties set as it can already get a new access token without user interaction.

**OAuthBrowserResponseTimeout**: Specifies the amount of time to wait for a response from the browser.This setting specifies the amount of time (in seconds) the struct will wait for a response from the browser when requesting user authentication. The default value is *0*, meaning that the struct will wait indefinitely.

**OAuthIncludeEmptyRedirectURI**: Whether an empty redirect_uri parameter is included in requests.This setting specifies whether *redirect_uri* is included in the request made by [authorize](#authorize-method-azurekeys-struct) if it is empty.

If set to *true* (default) the *redirect_uri* will be sent in all cases. If set to *false* the *redirect_uri* will only be sent if it has a value.

**OAuthJWTPayload**: The payload of the JWT access token if present.This configuration setting provides the payload section of a JWT access token if the access token is a JWT and the struct is able to parse out the payload section. This setting only applies to **access tokens** that are returned from a service provider after successfully authorizing and authenticating with the service.

To parse the payload for specific claims, see [OAuthJWTXPath](#OAuthJWTXPath).

**OAuthJWTXChildCount**: The number of child elements of the current element.The number of child attributes of the current element. The OAuthJWTXChildCount configuration settings will be indexed from 0 to ([OAuthJWTXChildCount](#OAuthJWTXChildCount) - 1).

The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only.

**OauthJWTXChildName[i]**: The name of the child element.Provides the name of the i'th child element of the current element.

The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only.

**OAuthJWTXChildXText[i]**: The inner text of the child element.Provides the inner text of the i'th child element of the current element.

The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only.

**OAuthJWTXElement**: The name of the current element.Provides the name of the current element.

The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only.

**OauthJWTXParent**: The parent of the current element.Provides the parent of the current element.

The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only.

**OAuthJWTXPath**: Provides a way to point to a specific element in the returned payload of a JWT based access token.The [OAuthJWTXPath](#OAuthJWTXPath) setting allows you to point to specific claims within the payload of a JWT based access token.

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

 Here are some examples of valid XPaths and some common claims:

| 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 [OAuthJWTXText](#OAuthJWTXText).

**OAuthJWTXSubTree**: A snapshot of the current element in the document.Provides the entirety of the current element (including its sub-elements).

The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only.

**OAuthJWTXText**: The text of the current element.Provides the inner text of the current element.

The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only.

**OAuthParamCount**: Specifies the number of additional parameters variables to include in the request.This setting can be used to add query string parameters to the outgoing request. One common use for this method would be to add the "state" parameter to the request, which can be used when the [o_auth_client_profile](#o_auth_client_profile-property-azurekeys-struct) is cocpWeb to add user defined data. The authorization server will include the "state" parameter in the response and will be available in the post back to your server which will allow you to maintain state in your application. This is used in conjunction with OAuthParamName[i] and OAuthParamValue[i]. For instance:

```text
component.Config("OAuthParamCount=2");
component.Config("OAuthParamName[0]=myvar");
component.Config("OAuthParamValue[0]=myvalue");
component.Config("OAuthParamName[1]=testname");
component.Config("OAuthParamValue[1]=testvalue");
```

Additionally, this will also be updated to hold the parameters returned in the response.

```text
for (int i = 0; i < int.Parse(component.Config("OAuthParamCount")); i++)
{
  string name = component.Config("OAuthParamName[" + i + "]");
  string value = component.Config("OAuthParamValue[" + i + "]");
}
```

**OAuthParamName[i]**: Specifies the parameter name at the specified index.This setting can be used to retrieve or specify the parameter variable name at the index specified. See [OAuthParamCount](#OAuthParamCount) for details.

**OAuthParamValue[i]**: Specifies the parameter value at the specified index.This setting can be used to retrieve or specify the parameter variable value at the index specified. See [OAuthParamCount](#OAuthParamCount) for details.

**OAuthPasswordGrantUsername**: Used in the Resource Owner Password grant type.Used to set the username property when the [o_auth_grant_type](#o_auth_grant_type-property-azurekeys-struct) is set to the password grant type and [authorize](#authorize-method-azurekeys-struct) is called.

**OAuthPKCEChallengeEncoding**: The PKCE code challenge method to use.This setting controls the PKCE code challenge method used when [OAuthUsePKCE](#OAuthUsePKCE) is set to *true*. Possible values are:

- 1 (Plain)
- 2 (S256/SHA256 - default)

**OAuthPKCEVerifier**: The PKCE verifier used to generate the challenge.This configuration setting when queried provides the PKCE verifier that is used to generate the PKCE challenge for the [authorize](#authorize-method-azurekeys-struct) method and the [o_auth_web_auth_url](#o_auth_web_auth_url-property-azurekeys-struct) field when [OAuthUsePKCE](#OAuthUsePKCE) is set to true. When using the cocpWeb [o_auth_client_profile](#o_auth_client_profile-property-azurekeys-struct), the configuration setting can be set instead to allow the authorization request to be made from a different instance than the authentication (token) request.

**OAuthResetData**: Determines if the Reset method applies to the OAuth settings.If set to *true* (default), the [reset](#reset-method-azurekeys-struct) method will reset the OAuth settings including any authorization fields like [o_auth_access_token](#o_auth_access_token-property-azurekeys-struct) and [o_auth_refresh_token](#o_auth_refresh_token-property-azurekeys-struct). This means the [authorize](#authorize-method-azurekeys-struct) method must be called again to get new authorization information. When set to *false*, the [reset](#reset-method-azurekeys-struct) method will **not** reset the o_auth property and the OAuth* configuration settings. This allows for the struct to be reset without having to get authorization again.

**OAuthReUseWebServer**: Determines if the same server instance is used between requests.If set to *true* (default), the same embedded web server instance will be used for multiple requests. If set to *false* the embedded web server will be created and destroyed on each call to [authorize](#authorize-method-azurekeys-struct)

**OAuthTransferredRequest**: The full OAuth request last sent by the client.This configuration setting returns the full OAuth request last sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

.NET

```text
Gmail gmail = new Gmail();
gmail.Config("OAuthTransferredRequest=on");
gmail.Authorize();
Console.WriteLine(gmail.Config("OAuthTransferredRequest"));
```

 C++

```text
Gmail gmail;
gmail.Config("OAuthTransferredRequest=on");
gmail.Authorize();
printf("%s\r\n", gmail.Config("OAuthTransferredRequest"));
```

**OAuthUsePKCE**: Specifies if PKCE should be used.If set to *true* (default), Proof Key for Code Exchange (PKCE) defined by RFC 7636 will be used when performing authorization. This setting applies when using the Authorization Code [o_auth_grant_type](#o_auth_grant_type-property-azurekeys-struct). The [OAuthPKCEChallengeEncoding](#OAuthPKCEChallengeEncoding) configuration setting can be used to control the code challenge method that will be used.

**OAuthWebServerActive**: Specifies and controls whether the embedded web server is active.The setting when queried will return the current state of the web server. If the webserver is active, it will return *"true"* and if it is inactive it will return *"false"*.

This setting can also be set to activate or deactivate the web server. Under normal circumstances, this would not be required as the struct will automatically start and stop the web server when [authorize](#authorize-method-azurekeys-struct) is called. In certain cases, it is required to start the webserver before calling [authorize](#authorize-method-azurekeys-struct). For example, if the [o_auth_return_url](#o_auth_return_url-property-azurekeys-struct) 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](#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.

**OAuthWebServerCertStore**: The certificate with private key to use when SSL is enabled.The name of the certificate store used for the embedded web server's SSL.

The [OAuthWebServerCertStoreType](#OAuthWebServerCertStoreType) property specifies the type of the certificate store specified by [OAuthWebServerCertStore](#OAuthWebServerCertStore). If the store is password protected, specify the password in [OAuthWebServerCertStorePassword](#OAuthWebServerCertStorePassword).

[OAuthWebServerCertStore](#OAuthWebServerCertStore) is used in conjunction with the [OAuthWebServerCertSubject](#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 *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Note: This is required when [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) is set to *true*.

**OAuthWebServerCertStorePassword**: The certificate with private key to use when SSL is enabled.If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.

Note: This is only applicable when [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) is set to *true*.

**OAuthWebServerCertStoreType**: The certificate with private key to use when SSL is enabled.This specifies the type of certificate store. Possible values are:

|  |  |
| --- | --- |
| 0 | User - This is the default for Windows. This specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 | Machine - For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 | PFXFile - The certificate store is the name of a PFX (PKCS12) file containing certificates. |
| 3 | PFXBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS12) format. |
| 4 | JKSFile - The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is available only in Java. |
| 5 | JKSBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is available only in Java. |
| 6 | PEMKeyFile - The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 | PEMKeyBlob - The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 14 | PPKFile - The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 | PPKBlob - The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 | XMLFile - The certificate store is the name of a file that contains a certificate in XML format. |
| 17 | XMLBlob - The certificate store is a string that contains a certificate in XML format. |

 Note: This is required when [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) is set to *true*.

**OAuthWebServerCertSubject**: The certificate with private key to use when SSL is enabled.The subject of the SSL certificate.

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

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.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](#OAuthWebServerSSLEnabled) is set to *true*.

**OAuthWebServerFailedResponse**: The custom response that will be displayed to the user if authentication failed.When [authorize](#authorize-method-azurekeys-struct) is called the user will be redirected to the embedded web server upon completing authentication with the authorization server. If authentication failed, the HTML specified here will be sent to the user's browser.

**OAuthWebServerHost**: The hostname used by the embedded web server displayed in the ReturnURL.This setting specifies the hostname used by the embedded web server when [o_auth_client_profile](#o_auth_client_profile-property-azurekeys-struct) is set to cocpApplication. This specifies the interface on which the embedded web server listens, and also the value displayed in the [o_auth_return_url](#o_auth_return_url-property-azurekeys-struct). This should be set to the hostname only, not the full URL.

The default value is *localhost*.

**OAuthWebServerPort**: The local port on which the embedded web server listens.This property specifies the port on which the embedded web server listens. Setting this to *0* (default) enables the system to choose a port at random. The chosen port will be returned when this setting is queried after the server has started listening.This is only applicable when using the embedded web server.

**OAuthWebServerResponse**: The custom response that will be displayed to the user.When [authorize](#authorize-method-azurekeys-struct) is called the user will be redirected to the embedded web server upon completing authentication with the authorization server. This setting allows you to specify the HTML that will be sent to the user's browser.

**OAuthWebServerSSLEnabled**: Whether the web server requires SSL connections.This setting specifies whether the embedded web server will use SSL. If set to *True* OAuthWebServerCert* configs are required and the server will only accept SSL connections. If set to *False* only plaintext connects are supported.

### HTTP Config Settings

**AcceptEncoding**: Used to tell the server which types of content encodings the client supports.When [AllowHTTPCompression](#AllowHTTPCompression) is True, the struct adds an *Accept-Encoding* header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the *Accept-Encoding* header. NOTE: The struct only supports gzip and deflate decompression algorithms.

**AllowHTTPCompression**: This property enables HTTP compression for receiving data.This configuration setting enables HTTP compression for receiving data. When set to True (default), the struct will accept compressed data. It then will uncompress the data it has received. The struct will handle data compressed by both gzip and deflate compression algorithms.

When True, the struct adds an *Accept-Encoding* header to the outgoing request. The value for this header can be controlled by the [AcceptEncoding](#AcceptEncoding) configuration setting. The default value for this header is "gzip, deflate".

The default value is True.

**AllowHTTPFallback**: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when http_version is set to "2.0".

If set to True (default), the struct will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the struct fails with an error if the server does not support HTTP/2.

The default value is True.

**Append**: Whether to append data to LocalFile.This configuration setting determines whether data will be appended when writing to local_file. When set to True, downloaded data will be appended to local_file. This may be used in conjunction with range to resume a failed download. This is applicable only when local_file is set. The default value is False.

**Authorization**: The Authorization string to be sent to the server.If the [Authorization](#Authorization) property contains a nonempty string, an *Authorization* HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP struct can be extended with other security schemes in addition to the authorization schemes already implemented by the struct.

The auth_scheme 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](#authorization-property-azurekeys-struct) property in the form "Basic [encoded-user-password]".

**BytesTransferred**: Contains the number of bytes transferred in the response data.This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the [on_transfer](#on_transfer-event-azurekeys-struct) event, by [BytesTransferred](#BytesTransferred).

**ChunkSize**: Specifies the chunk size in bytes when using chunked encoding.This is applicable only when [UseChunkedEncoding](#UseChunkedEncoding) is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

**CompressHTTPRequest**: Set to true to compress the body of a PUT or POST request.If set to True, the body of a *PUT* or *POST* request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.

The default value is False.

**EncodeURL**: If set to True the URL will be encoded by the struct.If set to True, the URL passed to the struct will be URL encoded. The default value is False.

**FollowRedirects**: Determines what happens when the server issues a redirect.This option determines what happens when the server issues a redirect. Normally, the struct returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new url for the object is retrieved automatically every time.

If this property is set to 2 (Same Scheme), the new url is retrieved automatically only if the URL Scheme is the same; otherwise, the struct 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 on_redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the on_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 struct fails with an error instead.

Following are the valid options:

- 0 - Never
- 1 - Always
- 2 - Same Scheme

**GetOn302Redirect**: If set to True the struct will perform a GET on the new location.The default value is False. If set to True, the struct will perform a *GET* on the new location. Otherwise, it will use the same HTTP method again.

**HTTP2HeadersWithoutIndexing**: HTTP2 headers that should not update the dynamic header table with incremental indexing.HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.

**HTTPVersion**: The version of HTTP used by the struct.This property specifies the HTTP version used by the struct. Possible values are as follows:

- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"

When using HTTP/2 ("2.0") or HTTP/3 ("3.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 struct 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](#NegotiatedHTTPVersion) after calling a method. The [AllowHTTPFallback](#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.

**IfModifiedSince**: A date determining the maximum age of the desired document.If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:

```text
Sat, 29 Oct 2017 19:43:31 GMT.
```

**KeepAlive**: Determines whether the HTTP connection is closed after completion of the request.If *true*, the component will not send the *Connection: Close* header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. NOTE: Not all servers support persistent connections. If *false*, the connection will be closed immediately after the server response is received.

 The default value for [KeepAlive](#KeepAlive) is *false*.

**KerberosSPN**: The Service Principal Name for the Kerberos Domain Controller.If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

**LogLevel**: The level of detail that is logged.This configuration setting controls the level of detail that is logged through the [on_log](#on_log-event-azurekeys-struct) event. Possible values are as follows:

|  |  |
| --- | --- |
| 0 (None) | No events are logged. |
| 1 (Info - default) | Informational events are logged. |
| 2 (Verbose) | Detailed data are logged. |
| 3 (Debug) | Debug data are logged. |

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

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

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

**MaxRedirectAttempts**: Limits the number of redirects that are followed in a request.When follow_redirects is set to any value other than frNever, the struct will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

**NegotiatedHTTPVersion**: The negotiated HTTP version.This configuration setting may be queried after the request is complete to indicate the HTTP version used. When http_version is set to "2.0" (if the server does not support "2.0"), then the struct will fall back to using "1.1" automatically. This setting will indicate which version was used.

**OtherHeaders**: Other headers as determined by the user (optional).This configuration setting can be set to a string of headers to be appended to the HTTP request headers.

The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF (*"\r\n"*) .

Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.

This configuration setting is useful for extending the functionality of the struct beyond what is provided.

**ProxyAuthorization**: The authorization string to be sent to the proxy server.This is similar to the [Authorization](#Authorization) configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a *Proxy-Authorization* HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If [proxy_user](#proxy_user-property-azurekeys-struct) and [proxy_password](#proxy_password-property-azurekeys-struct) are specified, this value is calculated using the algorithm specified by [proxy_auth_scheme](#proxy_auth_scheme-property-azurekeys-struct).

**ProxyAuthScheme**: The authorization scheme to be used for the proxy.This configuration setting is provided for use by structs that do not directly expose Proxy properties.

**ProxyPassword**: A password if authentication is to be used for the proxy.This configuration setting is provided for use by structs that do not directly expose Proxy properties.

**ProxyPort**: Port for the proxy server (default 80).This configuration setting is provided for use by structs that do not directly expose Proxy properties.

**ProxyServer**: Name or IP address of a proxy server (optional).This configuration setting is provided for use by structs that do not directly expose Proxy properties.

**ProxyUser**: A user name if authentication is to be used for the proxy.This configuration setting is provided for use by structs that do not directly expose Proxy properties.

**SentHeaders**: The full set of headers as sent by the client.This configuration setting returns the complete set of raw headers as sent by the client.

**StatusCode**: The status code of the last response from the server.This configuration setting contains the result code of the last response from the server.

**StatusLine**: The first line of the last response from the server.This setting contains the first line of the last response from the server. The format of the line will be *[HTTP version] [Result Code] [Description]*.

**TransferredData**: The contents of the last response from the server.This configuration setting contains the contents of the last response from the server.

**TransferredDataLimit**: The maximum number of incoming bytes to be stored by the struct.If [TransferredDataLimit](#TransferredDataLimit) is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the struct.

**TransferredHeaders**: The full set of headers as received from the server.This configuration setting returns the complete set of raw headers as received from the server.

**TransferredRequest**: The full request as sent by the client.This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

 .NET

```text
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
```

 C++

```text
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
```

**UseChunkedEncoding**: Enables or Disables HTTP chunked encoding for transfers.If [UseChunkedEncoding](#UseChunkedEncoding) is set to True, the struct will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the struct will not use HTTP-chunked encoding. The default value is False.

NOTE: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

**UseIDNs**: Whether to encode hostnames to internationalized domain names.This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).

The default value is False and the hostname will always be used exactly as specified. NOTE: The [CodePage](#CodePage) setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set [CodePage](#CodePage) to *65001*. In the C++ Edition for Windows, the *W version of the class must be used. For instance, *DNSW* or *HTTPW*.

**UseProxyAutoConfigURL**: Whether to use a Proxy auto-config file when attempting a connection.This configuration specifies whether the struct will attempt to use the Proxy auto-config URL when establishing a connection and [proxy_auto_detect](#proxy_auto_detect-property-azurekeys-struct) is set to *True*.

When *True* (default), the struct will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.

**UserAgent**: Information about the user agent (browser).This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".

Override the default with the name and version of your software.

### TCPClient Config Settings

**ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the struct will use [timeout](#timeout-property-azurekeys-struct) for establishing a connection and transmitting/receiving data.

**FirewallAutoDetect**: Tells the struct whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by structs that do not directly expose Firewall properties.

**FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting.

If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#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 structs that do not directly expose Firewall properties.

**FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting.

**FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error.

NOTE: This setting is provided for use by structs that do not directly expose Firewall properties.

**FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value.

NOTE: This configuration setting is provided for use by structs that do not directly expose Firewall properties.

**FirewallType**: Determines the type of firewall to connect through.Possible values are as follows:

|  |  |
| --- | --- |
| 0 | No firewall (default setting). |
| 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. |
| 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. |
| 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. |
| 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. |

NOTE: This setting is provided for use by structs that do not directly expose Firewall properties.

**FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the struct fails with an error.

NOTE: This setting is provided for use by structs that do not directly expose Firewall properties.

**KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

NOTE: This value is not applicable in macOS.

**KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

**Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#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](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#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 struct returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

**LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

**LocalHost**: The name of the local host through which connections are initiated or accepted. The [local_host](#local_host-property-azurekeys-struct) setting contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface.

If the struct is connected, the [local_host](#local_host-property-azurekeys-struct) 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 multihomed hosts (machines with more than one IP interface).

**LocalPort**: The port in the local host where the struct binds. This configuration setting must be set before a connection is attempted. It instructs the struct to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by local_port after the connection is established.

local_port cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

**MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an eol string.

If an eol string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the on_data_in event is fired with the *EOL* parameter set to True, and the buffer is reset.

If no eol is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the on_data_in event is fired with the *EOL* parameter set to False, and the buffer is reset.

The minimum value for [MaxLineLength](#MaxLineLength) is 256 bytes. The default value is 2048 bytes.

**MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

**ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

*www.google.com;www.example.com*

**TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets.

NOTE: This value is not applicable in Java.

**TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this configuration setting is set to False.

**UseIPv6**: Whether to use IPv6.When set to *0* (default), the struct will use IPv4 exclusively. When set to *1*, the struct will use IPv6 exclusively. To instruct the struct to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows:

|  |  |
| --- | --- |
| 0 | IPv4 only |
| 1 | IPv6 only |
| 2 | IPv6 with IPv4 fallback |

**UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1.

### SSL Config Settings

**LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [ssl_provider](#ssl_provider-property-azurekeys-struct) is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes.

When enabled, SSL packet logs are output using the [on_ssl_status](#on_ssl_status-event-azurekeys-struct) event, which will fire each time an SSL packet is sent or received.

Enabling this configuration setting has no effect if [ssl_provider](#ssl_provider-property-azurekeys-struct) is set to *Platform*.

**OpenSSLCADir**: The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

**OpenSSLCAFile**: Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences:

 -----BEGIN CERTIFICATE-----

 ... (CA certificate in base64 encoding) ...

 -----END CERTIFICATE-----

 Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

**OpenSSLCipherList**: A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

**OpenSSLPrngSeedData**: The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL.

By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

**ReuseSSLSession**: Determines if the SSL session is reused.

If set to True, the struct 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 struct is the same.

**SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [ssl_provider](#ssl_provider-property-azurekeys-struct) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the ssl_cert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

**SSLCheckCRL**: Whether to check the Certificate Revocation List for the server certificate.This configuration setting specifies whether the struct will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the struct will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The struct will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the struct fails with an error.

When set to 0 (default), the CRL check will not be performed by the struct. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.

This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

**SSLCheckOCSP**: Whether to use OCSP to check the status of the server certificate.This configuration setting specifies whether the struct will use OCSP to check the validity of the server certificate. If set to 1 or 2, the struct will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The struct will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the struct fails with an error.

When set to 0 (default), the struct will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.

This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

**SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the [on_ssl_status](#on_ssl_status-event-azurekeys-struct) event.

Use this configuration 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](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting.

**SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when ssl_authenticate_clients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

**SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the struct will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#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 [ssl_provider](#ssl_provider-property-azurekeys-struct) is set to *Platform* include the following:

```text
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
```

 Possible values when [ssl_provider](#ssl_provider-property-azurekeys-struct) is set to *Platform* include the following:

- 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

 Example values when [ssl_provider](#ssl_provider-property-azurekeys-struct) is set to *Internal*include the following:

```text
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_ECDH_RSA_WITH_AES_128_CBC_SHA");
```

 Possible values when [ssl_provider](#ssl_provider-property-azurekeys-struct) is set to *Internal* include the following:

- 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_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](#SSLEnabledProtocols)), only the following cipher suites are supported:

- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256

[SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength).

**SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols.

Not all supported protocols are enabled by default. The default value is *4032* for client components, and *3072* for server components. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values:

|  |  |
| --- | --- |
| TLS1.3 | 12288 (Hex 3000) |
| TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
| TLS1.1 | 768 (Hex 300) (Default - Client) |
| TLS1 | 192 (Hex C0) (Default - Client) |
| SSL3 | 48 (Hex 30) |
| SSL2 | 12 (Hex 0C) |

Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.

**SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:**

By default when TLS 1.3 is enabled, the struct will first try to use the platform TLS 1.3 implementation when the [ssl_provider](#ssl_provider-property-azurekeys-struct) is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

In editions that are designed to run on Windows, [ssl_provider](#ssl_provider-property-azurekeys-struct) 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 supported only 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 available only on Windows 11/Windows Server 2022 and up.
- [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported.
- If [SSLEnabledProtocols](#SSLEnabledProtocols) includes both TLS 1.3 and TLS 1.2, these 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 struct when the [ssl_provider](#ssl_provider-property-azurekeys-struct) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [ssl_provider](#ssl_provider-property-azurekeys-struct) needs to be set to platform.

**SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *false* by default, but it can be set to *true* to enable the extension.

This configuration setting is applicable only when [ssl_provider](#ssl_provider-property-azurekeys-struct) is set to *Internal*.

**SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the [on_ssl_server_authentication](#on_ssl_server_authentication-event-azurekeys-struct) event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the [on_ssl_server_authentication](#on_ssl_server_authentication-event-azurekeys-struct) event.

If set to True, all certificates returned by the server will be present in the Encoded parameter of the [on_ssl_server_authentication](#on_ssl_server_authentication-event-azurekeys-struct) event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

**SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the struct 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 traffic for debugging purposes. When writing to this file, the struct will only append, it will not overwrite previous values.

NOTE: This configuration setting is applicable only when [ssl_provider](#ssl_provider-property-azurekeys-struct) is set to *Internal*.

**SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipher[connId]");
```

**SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipherStrength[connId]");
```

**SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipherSuite[connId]");
```

**SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedKeyExchange[connId]");
```

**SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
```

**SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedVersion[connId]");
```

**SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions:

|  |  |
| --- | --- |
| 0x00000001 | Ignore time validity status of certificate. |
| 0x00000002 | Ignore time validity status of CTL. |
| 0x00000004 | Ignore non-nested certificate times. |
| 0x00000010 | Allow unknown certificate authority. |
| 0x00000020 | Ignore wrong certificate usage. |
| 0x00000100 | Ignore unknown certificate revocation status. |
| 0x00000200 | Ignore unknown CTL signer revocation status. |
| 0x00000400 | Ignore unknown certificate authority revocation status. |
| 0x00000800 | Ignore unknown root revocation status. |
| 0x00008000 | Allow test root certificate. |
| 0x00004000 | Trust test root certificate. |
| 0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). |

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

**SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

**TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [ssl_provider](#ssl_provider-property-azurekeys-struct) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2.

When specified the struct will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the struct fails with an error.

The format of this value is a comma-separated list of hash-signature combinations. For instance:

```csharp
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 configuration 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*.

To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

**TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC.

The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*.

When using TLS 1.2 and [ssl_provider](#ssl_provider-property-azurekeys-struct) 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)

**TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.

NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.

In most cases, this configuration setting does not need to be modified. This should be modified only 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"

**TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following:

- "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 *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3.

**TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so.

The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*

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)
- "mlkem_512" (default)
- "mlkem_768" (default)
- "mlkem_1024" (default)
- "x25519_mlkem_768" (default)
- "secp256r1_mlkem_768" (default)

Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported:

-  Windows Server 2025
-  Windows 11 24H2
-  Windows 11 25H2

### Socket Config Settings

**AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [timeout](#timeout-property-azurekeys-struct) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout.

NOTE: This option is not valid for User Datagram Protocol (UDP) ports.

**FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes).

**InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small.

**OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct 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

**BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build.

**CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

|  |  |
| --- | --- |
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |

 The following is a list of valid code page identifiers for Mac OS only:

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

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a struct is using. It will return the following information:

- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.

**MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the struct will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the struct 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](platforms.md) section.

# Trappable Errors ([AzureKeys](#struct-cloudkeysazurekeys) Struct)

### Common Errors

|  |  |
| --- | --- |
| 600 | A server error occurred, and/or the struct 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](#RawRequest) or [RawResponse](#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 [output_file](#output_file-property-azurekeys-struct) already exists and [overwrite](#overwrite-property-azurekeys-struct) is false. |
| 607 | An exception occurred while working with the specified [input_file](#input_file-property-azurekeys-struct) or [output_file](#output_file-property-azurekeys-struct) (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. The error description contains the 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 url_scheme is invalid. |
| 155 | Range operation is not supported by server. |
| 156 | Invalid cookie index (out of range). |
| 301 | Interrupted. |
| 302 | Cannot open attached_file. |

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

### TCPClient Errors

|  |  |
| --- | --- |
| 100 | You cannot change the remote_port at this time. A connection is in progress. |
| 101 | You cannot change the remote_host (Server) at this time. A connection is in progress. |
| 102 | The remote_host 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 local_port at this time. A connection is in progress. |
| 107 | You cannot change the [local_host](#local_host-property-azurekeys-struct) at this time. A connection is in progress. |
| 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. |
| 116 | remote_port cannot be zero. Please specify a valid service port number. |
| 117 | You cannot change the UseConnection option while the struct 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 nonsocket. |
| 10039 | [10039] Destination address required. |
| 10040 | [10040] Message is too long. |
| 10041 | [10041] Protocol wrong type for socket. |
| 10042 | [10042] Bad protocol option. |
| 10043 | [10043] Protocol is not supported. |
| 10044 | [10044] Socket type is not supported. |
| 10045 | [10045] Operation is not supported on socket. |
| 10046 | [10046] Protocol family is not supported. |
| 10047 | [10047] Address family is not supported by protocol family. |
| 10048 | [10048] Address already in use. |
| 10049 | [10049] Cannot 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] Cannot send after socket shutdown. |
| 10059 | [10059] Too many references, cannot splice. |
| 10060 | [10060] Connection timed out. |
| 10061 | [10061] Connection refused. |
| 10062 | [10062] Too many levels of symbolic links. |
| 10063 | [10063] File name is too long. |
| 10064 | [10064] Host is down. |
| 10065 | [10065] No route to host. |
| 10066 | [10066] Directory is 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 is not loaded yet. |
| 11001 | [11001] Host not found. |
| 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
| 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
| 11004 | [11004] Valid name, no data record (check DNS setup). |