AzureKeys Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

class cloudkeys.AzureKeys

Remarks

The AzureKeys class provides an easy-to-use interface for the key-related functionality of the Azure Key Vault service. Azure Key Vault allows you to works with a few different kinds of resources, one of which is asymmetric key pairs. This class helps you to create, manage, and use said key pairs (or just "keys", for short) for cryptographic operations. To work with "secrets" instead, refer to the AzureSecrets class.

To begin, register for an Azure account and create one or more Key Vaults via the Azure Portal. Set the vault property to the name of the vault you wish to work with.

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

The component has the following defaults:

Additionaly, depending on how the application is registered (Ex. Single-tenant, Multi-tenant) and what o_auth_grant_type is selected (Ex. Authorization Code, Password), it may be required to use the tenant ID rather than "common" in the o_auth_server_auth_url, and o_auth_server_token_url properties. See below for examples of the modified URLs:

Application Profile

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

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

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

Authorization Code

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

Example: AzureKeys azurekeys = new AzureKeys(); azurekeys.OAuth.ClientProfile = OAuthClientProfiles.cocpApplication; azurekeys.OAuth.GrantType = OAuthGrantTypes.cogtAuthorizationCode; azurekeys.OAuth.ClientId = CLIENT_ID; azurekeys.OAuth.ClientSecret = SECRET_ID; azurekeys.OAuth.AuthorizationScope = "offline_access https://vault.azure.net/user_impersonation"; azurekeys.OAuth.ServerAuthURL = "https://login.microsoftonline.com/" + TENANT_ID + "/oauth2/v2.0/authorize"; azurekeys.OAuth.ServerTokenURL = "https://login.microsoftonline.com/" + TENANT_ID + "/oauth2/v2.0/token"; azurekeys.Authorize(); Implicit

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

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

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

Password

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

When using the Resource Owner Password Credentials grant type, the class will authenticate as the resource owner. This allows for the class to avoid user interaction. This grant type often has specific limitations put on it by the service provider. See the service documentation for more details.

For this o_auth_grant_type the class requires OAuthPasswordGrantUsername, o_auth_client_secret, and o_auth_server_token_url to be set. The o_auth_client_secret should be set to the password of the account instead of a typical secret. In some cases, the o_auth_client_id also needs to be set. When the authorize method is called, the component will make a request to the token server for an access token using the username and password. The token server will return an access token if the authentication was successful. When this access token is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one.

Web Profile

External OAuth Support

Bearer ACCESS_TOKEN_VALUE

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

For Example: Oauth oauth = new Oauth(); oauth.ClientId = "CLIENT_ID"; oauth.ClientSecret = "CLIENT_SECRET"; oauth.ServerAuthURL = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize"; oauth.ServerTokenURL = "https://login.microsoftonline.com/common/oauth2/v2.0/token"; oauth.AuthorizationScope = "offline_access https://vault.azure.net/user_impersonation"; oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode; azurekeys.Authorization = oauth.GetAuthorization(); Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.

Using the Class

Keys can be created using the create_key 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. 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 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, or permanently deleted using purge_key (assuming the currently-authenticated user has the permissions to do so). azurekeys.CreateKey("mykey", "RSA_2048", "encrypt,decrypt,sign,verify,wrapKey,unwrapKey"); // ... Some time later, when the key is no longer needed ... azurekeys.DeleteKey("mykey"); // At this point, the key is only soft-deleted. It could be recovered... azurekeys.RecoverKey("mykey"); // ...or permanently deleted. azurekeys.PurgeKey("mykey");

To list keys, use the list_keys method. This method is also used to list soft-deleted keys if the GetDeleted configuration setting has been enabled first. To list a key's versions, use the list_versions method. (You cannot list a deleted key's versions.) In all cases, the include_key_details property can optionally be enabled to have the class attempt to retrieve the full information for each key (Azure leaves out certain fields by default when listing). // If there are many keys to list, there may be multiple pages of results. This will // cause all pages of results to be accumulated into the Keys collection property. do { azurekeys.ListKeys(); } while (!string.IsNullOrEmpty(azurekeys.KeyMarker)); // A similar thing applies to key versions as well. do { azurekeys.ListVersions("mykey"); } while (!string.IsNullOrEmpty(azurekeys.VersionMarker));

Depending on a key's "key ops" list, it can be used to perform different cryptographic operations. Keys with the encrypt and decrypt ops can be used in encrypt and decrypt operations. Keys with the sign and verify ops can be used in sign and verify. Finally, keys with the wrapKey and unwrapKey ops can be used in wrap_key and unwrap_key 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 or input_file to supply the input data that should be processed. All operations will output the result data to output_data or output_file (except verify; refer to its documentation for more information). azurekeys.CreateKey("mykey", "RSA_2048", "encrypt,decrypt"); azurekeys.InputData = "Test123"; azurekeys.OutputFile = "C:/temp/enc.dat"; azurekeys.Encrypt("mykey", "RSA-OAEP-256"); azurekeys.InputFile = "C:/temp/enc.dat"; azurekeys.OutputFile = ""; // So that the data will be output to the OutputData property. azurekeys.Decrypt("mykey", "RSA-OAEP-256");

The class also supports a variety of other functionality, including:

• Retrieval of a single key's information (including public key) with get_key_info.
• Enabling and disabling keys with set_key_enabled.
• Tagging support using add_tag and the Tag* properties.
• Secure key backup and restoration using backup_key and restore_key.
• And more!

Property List

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

Method List

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

Event List

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

Config Settings

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

authorization Property

OAuth 2.0 Authorization Token.

Syntax

def get_authorization() -> str: ...
def set_authorization(value: str) -> None: ...

authorization = property(get_authorization, set_authorization)

Default Value

""

Remarks

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

Bearer ACCESS_TOKEN

firewall_auto_detect Property

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

Syntax

def get_firewall_auto_detect() -> bool: ...
def set_firewall_auto_detect(value: bool) -> None: ...

firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)

Default Value

FALSE

Remarks

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

firewall_type Property

This property determines the type of firewall to connect through.

Syntax

def get_firewall_type() -> int: ...
def set_firewall_type(value: int) -> None: ...

firewall_type = property(get_firewall_type, set_firewall_type)

Default Value

0

Remarks

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

firewall_host Property

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

Syntax

def get_firewall_host() -> str: ...
def set_firewall_host(value: str) -> None: ...

firewall_host = property(get_firewall_host, set_firewall_host)

Default Value

""

Remarks

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

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

firewall_password Property

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

def get_firewall_password() -> str: ...
def set_firewall_password(value: str) -> None: ...

firewall_password = property(get_firewall_password, set_firewall_password)

Default Value

""

Remarks

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

firewall_port Property

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

Syntax

def get_firewall_port() -> int: ...
def set_firewall_port(value: int) -> None: ...

firewall_port = property(get_firewall_port, set_firewall_port)

Default Value

0

Remarks

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

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

firewall_user Property

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

Syntax

def get_firewall_user() -> str: ...
def set_firewall_user(value: str) -> None: ...

firewall_user = property(get_firewall_user, set_firewall_user)

Default Value

""

Remarks

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

idle Property

The current status of the class.

Syntax

def get_idle() -> bool: ...

idle = property(get_idle, None)

Default Value

TRUE

Remarks

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

This property is read-only.

include_key_details Property

Whether to attempt to retrieve fill details when listing keys.

Syntax

def get_include_key_details() -> bool: ...
def set_include_key_details(value: bool) -> None: ...

include_key_details = property(get_include_key_details, set_include_key_details)

Default Value

FALSE

Remarks

This property specifies whether the class should make additional requests when list_keys or list_versions is called in order to retrieve full information for each key. By default, Azure will omit certain fields when one of those methods is called (refer to each one's documentation for more information).

If this property is enabled, then after the initial listing is returned, the class will call get_key_info internally for each key returned. For all keys for which this call is successful, the additional information will be used to populate the Key* properties. Any keys for which the get_key_info call fails will not have the additional properties populated.

input_data Property

The data to process.

Syntax

def get_input_data() -> bytes: ...
def set_input_data(value: bytes) -> None: ...

input_data = property(get_input_data, set_input_data)

Default Value

""

Remarks

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

Input Sources & Output Destinations

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

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

1. The input_file 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 property
2. The output_data property

input_file Property

The file whose data should be processed.

Syntax

def get_input_file() -> str: ...
def set_input_file(value: str) -> None: ...

input_file = property(get_input_file, set_input_file)

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 class automatically determines the source and destination of the input and output based on which properties are set.

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

1. The input_file 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 property
2. The output_data property

key_marker Property

A marker indicating what page of keys to return next.

Syntax

def get_key_marker() -> str: ...
def set_key_marker(value: str) -> None: ...

key_marker = property(get_key_marker, set_key_marker)

Default Value

""

Remarks

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

Refer to list_keys for more information.

key_count Property

The number of records in the Key arrays.

Syntax

def get_key_count() -> int: ...

key_count = property(get_key_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• key_creation_date
• key_deletion_date
• key_enabled
• key_expiry_date
• key_name
• key_not_before_date
• key_ops
• key_public_key
• key_purge_date
• key_recoverable_days
• key_recovery_level
• key_type
• key_update_date
• key_version_id

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

This property is read-only.

key_creation_date Property

The creation date of the key.

Syntax

def get_key_creation_date(key_index: int) -> int: ...

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 key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.

This property is read-only.

key_deletion_date Property

The deletion date of the key.

Syntax

def get_key_deletion_date(key_index: int) -> int: ...

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 key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.

This property is read-only.

key_enabled Property

Whether the key is enabled.

Syntax

def get_key_enabled(key_index: int) -> bool: ...

Default Value

FALSE

Remarks

Whether the key is enabled.

This property reflects whether the key is currently enabled.

The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.

This property is read-only.

key_expiry_date Property

The expiration date of the key.

Syntax

def get_key_expiry_date(key_index: int) -> int: ...

Default Value

-1

Remarks

The expiration date of the key.

This property reflects the expiration date of the key, in seconds since the Unix epoch, or -1 if the key does not expire.

A key can only be used for the decrypt, verify, and unwrap_key operations after its expiry date.

The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.

This property is read-only.

key_ops Property

The operation that the key may be used for.

Syntax

def get_key_ops(key_index: int) -> str: ...

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 key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.

This property is read-only.

key_type Property

The key's type.

Syntax

def get_key_type(key_index: int) -> str: ...

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:

The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.

This property is read-only.

key_name Property

The name of the key.

Syntax

def get_key_name(key_index: int) -> str: ...

Default Value

""

Remarks

The name of the key.

This property reflects the name of the key.

The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.

This property is read-only.

key_not_before_date Property

The 'not before' date of the key.

Syntax

def get_key_not_before_date(key_index: int) -> int: ...

Default Value

-1

Remarks

The 'not before' date of the key.

This property reflects the "not before" date of the key, in seconds since the Unix epoch, or -1 if the key doesn't have an explicit "not before" date.

A key can only be used for the decrypt, verify, and unwrap_key operations prior to its "not before" date.

The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.

This property is read-only.

key_public_key Property

The key's public key.

Syntax

def get_key_public_key(key_index: int) -> str: ...

Default Value

""

Remarks

The key's public key.

This property reflects the public key of the key, in PEM format.

The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.

This property is read-only.

key_purge_date Property

The purge date of the key.

Syntax

def get_key_purge_date(key_index: int) -> int: ...

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 key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.

This property is read-only.

key_recoverable_days Property

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

Syntax

def get_key_recoverable_days(key_index: int) -> int: ...

Default Value

0

Remarks

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

This property reflects the number of days that the key will be recoverable for if it gets deleted.

Note that this property's value is based on the retention policy of the currently-selected vault; it will not change after the key has actually been deleted.

The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.

This property is read-only.

key_recovery_level Property

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

Syntax

def get_key_recovery_level(key_index: int) -> str: ...

Default Value

""

Remarks

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

This property reflects the key's ability to be recovered and/or purged (i.e., permanently deleted) if it gets deleted. Possible values are as follows; please refer to this part of the Azure Key Vault documentation for more information about each one:

• CustomizedRecoverable
• CustomizedRecoverable+ProtectedSubscription
• CustomizedRecoverable+Purgeable
• Purgeable
• Recoverable
• Recoverable+ProtectedSubscription
• Recoverable+Purgeable

The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.

This property is read-only.

key_update_date Property

The update date of the key.

Syntax

def get_key_update_date(key_index: int) -> int: ...

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 key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.

This property is read-only.

key_version_id Property

The version Id of the key.

Syntax

def get_key_version_id(key_index: int) -> str: ...

Default Value

""

Remarks

The version Id of the key.

This property reflects the version Id of the key.

The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.

This property is read-only.

local_host Property

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

Syntax

def get_local_host() -> str: ...
def set_local_host(value: str) -> None: ...

local_host = property(get_local_host, set_local_host)

Default Value

""

Remarks

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

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

If the class is connected, the 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 multi-homed 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.

o_auth_access_token Property

The access token returned by the authorization server.

Syntax

def get_o_auth_access_token() -> str: ...
def set_o_auth_access_token(value: str) -> None: ...

o_auth_access_token = property(get_o_auth_access_token, set_o_auth_access_token)

Default Value

""

Remarks

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

o_auth_authorization_code Property

The authorization code that is exchanged for an access token.

Syntax

def get_o_auth_authorization_code() -> str: ...
def set_o_auth_authorization_code(value: str) -> None: ...

o_auth_authorization_code = property(get_o_auth_authorization_code, set_o_auth_authorization_code)

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.

o_auth_authorization_scope Property

The scope request or response parameter used during authorization.

Syntax

def get_o_auth_authorization_scope() -> str: ...
def set_o_auth_authorization_scope(value: str) -> None: ...

o_auth_authorization_scope = property(get_o_auth_authorization_scope, set_o_auth_authorization_scope)

Default Value

""

Remarks

The scope request or response parameter used during authorization.

o_auth_client_id Property

The id of the client assigned when registering the application.

Syntax

def get_o_auth_client_id() -> str: ...
def set_o_auth_client_id(value: str) -> None: ...

o_auth_client_id = property(get_o_auth_client_id, set_o_auth_client_id)

Default Value

""

Remarks

The id of the client assigned when registering the application.

o_auth_client_profile Property

The type of client that is requesting authorization.

Syntax

def get_o_auth_client_profile() -> int: ...
def set_o_auth_client_profile(value: int) -> None: ...

o_auth_client_profile = property(get_o_auth_client_profile, set_o_auth_client_profile)

Default Value

0

Remarks

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

o_auth_client_secret Property

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

Syntax

def get_o_auth_client_secret() -> str: ...
def set_o_auth_client_secret(value: str) -> None: ...

o_auth_client_secret = property(get_o_auth_client_secret, set_o_auth_client_secret)

Default Value

""

Remarks

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

o_auth_grant_type Property

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

Syntax

def get_o_auth_grant_type() -> int: ...
def set_o_auth_grant_type(value: int) -> None: ...

o_auth_grant_type = property(get_o_auth_grant_type, set_o_auth_grant_type)

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:

o_auth_refresh_token Property

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

Syntax

def get_o_auth_refresh_token() -> str: ...
def set_o_auth_refresh_token(value: str) -> None: ...

o_auth_refresh_token = property(get_o_auth_refresh_token, set_o_auth_refresh_token)

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.

o_auth_return_url Property

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

Syntax

def get_o_auth_return_url() -> str: ...
def set_o_auth_return_url(value: str) -> None: ...

o_auth_return_url = property(get_o_auth_return_url, set_o_auth_return_url)

Default Value

""

Remarks

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

o_auth_server_auth_url Property

The URL of the authorization server.

Syntax

def get_o_auth_server_auth_url() -> str: ...
def set_o_auth_server_auth_url(value: str) -> None: ...

o_auth_server_auth_url = property(get_o_auth_server_auth_url, set_o_auth_server_auth_url)

Default Value

""

Remarks

The URL of the authorization server.

o_auth_server_token_url Property

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

Syntax

def get_o_auth_server_token_url() -> str: ...
def set_o_auth_server_token_url(value: str) -> None: ...

o_auth_server_token_url = property(get_o_auth_server_token_url, set_o_auth_server_token_url)

Default Value

""

Remarks

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

o_auth_web_auth_url Property

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

Syntax

def get_o_auth_web_auth_url() -> str: ...

o_auth_web_auth_url = property(get_o_auth_web_auth_url, None)

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.

other_headers Property

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

Syntax

def get_other_headers() -> str: ...
def set_other_headers(value: str) -> None: ...

other_headers = property(get_other_headers, set_other_headers)

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 class beyond what is provided.

output_data Property

The output data.

Syntax

def get_output_data() -> bytes: ...
def set_output_data(value: bytes) -> None: ...

output_data = property(get_output_data, set_output_data)

Default Value

""

Remarks

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

Note: For the verify operation, this property functions as a secondary input property instead (along with input_data); refer to the verify method for more information.

Input Sources & Output Destinations

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

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

1. The input_file 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 property
2. The output_data property

output_file Property

The file to which output data should be written.

Syntax

def get_output_file() -> str: ...
def set_output_file(value: str) -> None: ...

output_file = property(get_output_file, set_output_file)

Default Value

""

Remarks

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

Note: For the verify operation, the specified file functions as a secondary input file instead (along with input_file); refer to the verify method for more information.

Input Sources & Output Destinations

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

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

1. The input_file 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 property
2. The output_data property

overwrite Property

Whether the output file should be overwritten if necessary.

Syntax

def get_overwrite() -> bool: ...
def set_overwrite(value: bool) -> None: ...

overwrite = property(get_overwrite, set_overwrite)

Default Value

FALSE

Remarks

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

parsed_header_count Property

The number of records in the ParsedHeader arrays.

Syntax

def get_parsed_header_count() -> int: ...

parsed_header_count = property(get_parsed_header_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• parsed_header_field
• parsed_header_value

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

This property is read-only.

parsed_header_field Property

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

Syntax

def get_parsed_header_field(parsed_header_index: int) -> str: ...

Default Value

""

Remarks

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

The parsed_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the parsed_header_count property.

This property is read-only.

parsed_header_value Property

This property contains the header contents.

Syntax

def get_parsed_header_value(parsed_header_index: int) -> str: ...

Default Value

""

Remarks

This property contains the Header contents.

The parsed_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the parsed_header_count property.

This property is read-only.

proxy_auth_scheme Property

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

Syntax

def get_proxy_auth_scheme() -> int: ...
def set_proxy_auth_scheme(value: int) -> None: ...

proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)

Default Value

0

Remarks

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

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

By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the component will attempt basic authentication.

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

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

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

For security reasons, setting this property will clear the values of proxy_user and proxy_password.

proxy_auto_detect Property

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

Syntax

def get_proxy_auto_detect() -> bool: ...
def set_proxy_auto_detect(value: bool) -> None: ...

proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)

Default Value

FALSE

Remarks

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

proxy_password Property

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

Syntax

def get_proxy_password() -> str: ...
def set_proxy_password(value: str) -> None: ...

proxy_password = property(get_proxy_password, set_proxy_password)

Default Value

""

Remarks

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

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

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

proxy_port Property

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

def get_proxy_port() -> int: ...
def set_proxy_port(value: int) -> None: ...

proxy_port = property(get_proxy_port, set_proxy_port)

Default Value

80

Remarks

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

proxy_server Property

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

Syntax

def get_proxy_server() -> str: ...
def set_proxy_server(value: str) -> None: ...

proxy_server = property(get_proxy_server, set_proxy_server)

Default Value

""

Remarks

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

If the proxy_server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the proxy_server property is set to the corresponding address. If the search is not successful, an error is returned.

proxy_ssl Property

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

def get_proxy_ssl() -> int: ...
def set_proxy_ssl(value: int) -> None: ...

proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)

Default Value

0

Remarks

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

proxy_user Property

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

Syntax

def get_proxy_user() -> str: ...
def set_proxy_user(value: str) -> None: ...

proxy_user = property(get_proxy_user, set_proxy_user)

Default Value

""

Remarks

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

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

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

query_param_count Property

The number of records in the QueryParam arrays.

Syntax

def get_query_param_count() -> int: ...
def set_query_param_count(value: int) -> None: ...

query_param_count = property(get_query_param_count, set_query_param_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• query_param_name
• query_param_value

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

query_param_name Property

The name of the query parameter.

Syntax

def get_query_param_name(query_param_index: int) -> str: ...
def set_query_param_name(query_param_index: int, value: str) -> None: ...

Default Value

""

Remarks

The name of the query parameter.

This property specifies the name of the query parameter.

The query_param_index parameter specifies the index of the item in the array. The size of the array is controlled by the query_param_count property.

query_param_value Property

The value of the query parameter.

Syntax

def get_query_param_value(query_param_index: int) -> str: ...
def set_query_param_value(query_param_index: int, value: str) -> None: ...

Default Value

""

Remarks

The value of the query parameter.

This property specifies the value of the query parameter. The class will automatically URL-encode this value when sending the request.

The query_param_index parameter specifies the index of the item in the array. The size of the array is controlled by the query_param_count property.

ssl_accept_server_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_store Property

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

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

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

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password protected, specify the password in ssl_cert_store_password.

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

Designations of certificate stores are platform dependent.

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

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

ssl_cert_store_password Property

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

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

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.

ssl_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

ssl_cert_subject Property

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

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

Default Value

""

Remarks

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

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

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

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

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

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

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

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

ssl_provider Property

This specifies the SSL/TLS implementation to use.

Syntax

def get_ssl_provider() -> int: ...
def set_ssl_provider(value: int) -> None: ...

ssl_provider = property(get_ssl_provider, set_ssl_provider)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

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

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

ssl_server_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

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

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

This property is read-only.

tag_count Property

The number of records in the Tag arrays.

Syntax

def get_tag_count() -> int: ...
def set_tag_count(value: int) -> None: ...

tag_count = property(get_tag_count, set_tag_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• tag_name
• tag_value

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

tag_name Property

The name of the tag.

Syntax

def get_tag_name(tag_index: int) -> str: ...
def set_tag_name(tag_index: int, value: str) -> None: ...

Default Value

""

Remarks

The name of the tag.

This property specifies the name of the tag.

The tag_index parameter specifies the index of the item in the array. The size of the array is controlled by the tag_count property.

tag_value Property

The value of the tag.

Syntax

def get_tag_value(tag_index: int) -> str: ...
def set_tag_value(tag_index: int, value: str) -> None: ...

Default Value

""

Remarks

The value of the tag.

This property specifies the value of the tag.

The tag_index parameter specifies the index of the item in the array. The size of the array is controlled by the tag_count property.

timeout Property

A timeout for the class.

Syntax

def get_timeout() -> int: ...
def set_timeout(value: int) -> None: ...

timeout = property(get_timeout, set_timeout)

Default Value

60

Remarks

If the timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use do_events to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If timeout expires, and the operation is not yet complete, the class fails with an error.

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

The default value for the timeout property is 60 seconds.

vault Property

Selects a vault for the class to interact with.

Syntax

def get_vault() -> str: ...
def set_vault(value: str) -> None: ...

vault = property(get_vault, set_vault)

Default Value

""

Remarks

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

version_marker Property

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

Syntax

def get_version_marker() -> str: ...
def set_version_marker(value: str) -> None: ...

version_marker = property(get_version_marker, set_version_marker)

Default Value

""

Remarks

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

Refer to list_versions for more information.

add_query_param Method

Adds a query parameter to the QueryParams properties.

Syntax

def add_query_param(name: str, value: str) -> None: ...

Remarks

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

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

add_tag Method

Adds an item to the Tags properties.

Syntax

def add_tag(name: str, value: str) -> None: ...

Remarks

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

authorize Method

Get the authorization string required to access the protected resource.

Syntax

def authorize() -> None: ...

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 property and the o_auth_grant_type property. This method is not to be used in conjunction with the authorization property. It should instead be used when setting the OAuth* properties.

For more information, see the introduction section.

backup_key Method

Backs up a key.

Syntax

def backup_key(key_name: str) -> None: ...

Remarks

This method backs up the key specified by KeyName, returning it in a protected form via the the specified output_file or the output_data 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 method in order to be used.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

create_key Method

Creates a new key.

Syntax

def create_key(key_name: str, key_type: str, key_ops: str) -> str: ...

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:

The KeyOps parameter specifies which operations the key will be valid for use with. Possible values are as follows; at least one pair of operations must be specified:

• encrypt
• decrypt
• sign
• verify
• wrapKey
• unwrapKey

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

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

• CreateKeyEnabled
• ExpiryDate
• NotBeforeDate

Note: If there is already a soft-deleted key with the specified KeyName in the currently-selected vault, then a new key cannot be created with the same name. To resolve such a situation, the soft-deleted key would need to be recovered (using recover_key) or permanently deleted (using purge_key) first.

decrypt Method

Decrypts data using a key.

Syntax

def decrypt(key_name: str, algorithm: str) -> None: ...

Remarks

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

The data to decrypt is taken from the the specified input_file or the input_data property. The decrypted data is output to the the specified output_file or the output_data 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:

delete_key Method

Deletes a key.

Syntax

def delete_key(key_name: str) -> None: ...

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

do_events Method

Processes events from the internal message queue.

Syntax

def do_events() -> None: ...

Remarks

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

encrypt Method

Encrypts data using a key.

Syntax

def encrypt(key_name: str, algorithm: str) -> None: ...

Remarks

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

The data to encrypt is taken from the the specified input_file or the input_data property. The encrypted data is output to the the specified output_file or the output_data 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:

get_key_info Method

Gets a key's information and public key.

Syntax

def get_key_info(key_name: str) -> None: ...

Remarks

This method gets the information, including the public key, for the key specified by KeyName. The VersionId configuration setting can be used to target a specific key version. Alternatively, the GetDeleted configuration setting can be enabled to get a soft-deleted key's information (but only for the last version).

When the information is returned, the class clears the Key* properties and repopulates them with a single item that contains the key's information, and repopulates the Tag* properties with the key's tags. The on_key_list event is also fired.

list_keys Method

Lists keys in the currently-selected vault.

Syntax

def list_keys() -> None: ...

Remarks

This method lists the keys in the currently-selected vault. If the GetDeleted configuration setting is enabled, it lists the soft-deleted keys in the vault instead.

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

• key_ops
• key_type
• key_public_key
• key_version_id

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

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

list_versions Method

Lists versions of a key.

Syntax

def list_versions(key_name: str) -> None: ...

Remarks

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

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

• key_ops
• key_type
• key_public_key

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

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

purge_key Method

Permanently deletes a soft-deleted key.

Syntax

def purge_key(key_name: str) -> None: ...

Remarks

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

recover_key Method

Recovers a soft-deleted key.

Syntax

def recover_key(key_name: str) -> None: ...

Remarks

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

reset Method

Resets the class to its initial state.

Syntax

def reset() -> None: ...

Remarks

This method resets the class to its initial state.

restore_key Method

Restores a previously backed-up key to the vault.

Syntax

def restore_key() -> str: ...

Remarks

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

The protected key data to restore is taken from the the specified input_file or the input_data 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

Sends a custom request to the server.

Syntax

def send_custom_request(http_method: str, path: str) -> None: ...

Remarks

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

Valid values for HttpMethod are:

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

Path is optional, and if non-empty must be specified without a leading forward slash (/).

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

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.
   • The specified Path, if any.
   • An api-version query parameter whose value is APIVersion.
   • All query parameters from QueryParam*.
2. Adds an Authorization header with the value specified by authorization.
3. Adds any request headers from other_headers.
4. Adds any request body supplied via the specified input_file or input_data.
5. Sends the request to the server.
6. Stores the response headers in the ParsedHeader* properties; and the response body in the specified output_file or output_data.

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

set_key_enabled Method

Enables or disables a key.

Syntax

def set_key_enabled(key_name: str, enabled: bool) -> None: ...

Remarks

This method enables or disables the key specified by KeyName.

sign Method

Signs a message using a key.

Syntax

def sign(key_name: str, algorithm: str, is_digest: bool) -> None: ...

Remarks

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

The message data to sign is taken from the the specified input_file or the input_data property. The signature data is output to the the specified output_file or the output_data property.

The Algorithm parameter specifies which algorithm to use to sign the data. Possible values are:

• ES256: ECDSA using P-256 and SHA-256.
• ES256K: ECDSA using P-256K and SHA-256.
• ES384: ECDSA using P-384 and SHA-384.
• ES512: ECDSA using P-521 and SHA-512.
• PS256: RSASSA-PSS using SHA-256 and MGF1 with SHA-256.
• PS384: RSASSA-PSS using SHA-384 and MGF1 with SHA-384.
• PS512: RSASSA-PSS using SHA-512 and MGF1 with SHA-512.
• RS256: RSASSA-PKCS1-v1_5 using SHA-256.
• RS384: RSASSA-PKCS1-v1_5 using SHA-384.
• RS512: RSASSA-PKCS1-v1_5 using SHA-512.

The IsDigest parameter specifies whether the message data is the original message (False) or a message digest (True). When supplying a message digest, keep in mind that the same digest will need to be provided in order to verify the signature later.

If IsDigest is False, the class will automatically compute an appropriate message digest before the request is made. In such cases, the computed digest is made available via the MessageDigest configuration setting.

unwrap_key Method

Unwraps a symmetric key.

Syntax

def unwrap_key(key_name: str, algorithm: str) -> None: ...

Remarks

This method unwraps (i.e., decrypts) a symmetric key using the key specified by KeyName and the given Algorithm.

This method functions exactly the same way as the decrypt method, except that it requires the keys/unwrapKey permission instead of the keys/decrypt permission. Refer to the decrypt method's documentation for more information.

update_key Method

Updates a key's information.

Syntax

def update_key(key_name: str, key_ops: str, update_tags: bool) -> None: ...

Remarks

This method updates the information for the key specified by KeyName. The VersionId configuration setting can be used to target a specific key version.

The KeyOps parameter, if non-empty, must be a comma-separated list of operations that the key is valid for. If empty, the key's current operations list remains unchanged. Possible values are as follows; operations should be specified in pairs:

• encrypt
• decrypt
• sign
• verify
• wrapKey
• unwrapKey

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

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

verify Method

Verifies a digital signature using a key.

Syntax

def verify(key_name: str, algorithm: str, is_digest: bool) -> bool: ...

Remarks

This method verifies a digital signature using the key specified by KeyName and the given Algorithm. The VersionId configuration setting can be used to target a specific key version. If the signature is successfully verified, this method returns True, otherwise it returns False.

The message data is taken from the the specified input_file or the input_data property. The digital signature data is taken from the specified output_file or the output_data property.

The Algorithm parameter specifies which algorithm was used to sign the data. Possible values are:

• ES256: ECDSA using P-256 and SHA-256.
• ES256K: ECDSA using P-256K and SHA-256.
• ES384: ECDSA using P-384 and SHA-384.
• ES512: ECDSA using P-521 and SHA-512.
• PS256: RSASSA-PSS using SHA-256 and MGF1 with SHA-256.
• PS384: RSASSA-PSS using SHA-384 and MGF1 with SHA-384.
• PS512: RSASSA-PSS using SHA-512 and MGF1 with SHA-512.
• RS256: RSASSA-PKCS1-v1_5 using SHA-256.
• RS384: RSASSA-PKCS1-v1_5 using SHA-384.
• RS512: RSASSA-PKCS1-v1_5 using SHA-512.

The IsDigest parameter specifies whether the message data is the original message (False) or a message digest (True). When a message digest is supplied, keep in mind that it must be the exact same digest that was used at signing time, regardless of whether it has been recomputed.

If IsDigest is False, the class will automatically compute an appropriate message digest before the request is made. In such cases, the computed digest is made available via the MessageDigest configuration setting.

wrap_key Method

Wraps a symmetric key.

Syntax

def wrap_key(key_name: str, algorithm: str) -> None: ...

Remarks

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

This method functions exactly the same way as the encrypt method, except that it requires the keys/wrapKey permission instead of the keys/encrypt permission. Refer to the encrypt method's documentation for more information.

on_end_transfer Event

This event fires when a document finishes transferring.

Syntax

class AzureKeysEndTransferEventParams(object):
  @property
  def direction() -> int: ...

# In class AzureKeys:
@property
def on_end_transfer() -> Callable[[AzureKeysEndTransferEventParams], None]: ...
@on_end_transfer.setter
def on_end_transfer(event_hook: Callable[[AzureKeysEndTransferEventParams], None]) -> None: ...

Remarks

The on_end_transfer event is fired when the document text finishes transferring from the server to the local host.

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

on_error Event

Information about errors during data delivery.

Syntax

class AzureKeysErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class AzureKeys:
@property
def on_error() -> Callable[[AzureKeysErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[AzureKeysErrorEventParams], None]) -> None: ...

Remarks

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

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_header Event

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

Syntax

class AzureKeysHeaderEventParams(object):
  @property
  def field() -> str: ...

  @property
  def value() -> str: ...

# In class AzureKeys:
@property
def on_header() -> Callable[[AzureKeysHeaderEventParams], None]: ...
@on_header.setter
def on_header(event_hook: Callable[[AzureKeysHeaderEventParams], None]) -> None: ...

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

Fires once for each key when listing keys.

Syntax

class AzureKeysKeyListEventParams(object):
  @property
  def name() -> str: ...

  @property
  def version_id() -> str: ...

  @property
  def key_type() -> str: ...

  @property
  def key_ops() -> str: ...

  @property
  def enabled() -> bool: ...

  @property
  def creation_date() -> int: ...

  @property
  def update_date() -> int: ...

  @property
  def deletion_date() -> int: ...

  @property
  def purge_date() -> int: ...

  @property
  def public_key() -> str: ...

# In class AzureKeys:
@property
def on_key_list() -> Callable[[AzureKeysKeyListEventParams], None]: ...
@on_key_list.setter
def on_key_list(event_hook: Callable[[AzureKeysKeyListEventParams], None]) -> None: ...

Remarks

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

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

This event fires once for each log message.

Syntax

class AzureKeysLogEventParams(object):
  @property
  def log_level() -> int: ...

  @property
  def message() -> str: ...

  @property
  def log_type() -> str: ...

# In class AzureKeys:
@property
def on_log() -> Callable[[AzureKeysLogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[AzureKeysLogEventParams], None]) -> None: ...

Remarks

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

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

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

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

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

Message is the log entry.

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

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

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class AzureKeysSSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class AzureKeys:
@property
def on_ssl_server_authentication() -> Callable[[AzureKeysSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[AzureKeysSSLServerAuthenticationEventParams], None]) -> None: ...

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

Shows the progress of the secure connection.

Syntax

class AzureKeysSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class AzureKeys:
@property
def on_ssl_status() -> Callable[[AzureKeysSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[AzureKeysSSLStatusEventParams], None]) -> None: ...

Remarks

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

on_start_transfer Event

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

Syntax

class AzureKeysStartTransferEventParams(object):
  @property
  def direction() -> int: ...

# In class AzureKeys:
@property
def on_start_transfer() -> Callable[[AzureKeysStartTransferEventParams], None]: ...
@on_start_transfer.setter
def on_start_transfer(event_hook: Callable[[AzureKeysStartTransferEventParams], None]) -> None: ...

Remarks

The on_start_transfer event is fired when the document text starts transferring from the server to the local host.

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

on_tag_list Event

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

Syntax

class AzureKeysTagListEventParams(object):
  @property
  def key_name() -> str: ...

  @property
  def version_id() -> str: ...

  @property
  def name() -> str: ...

  @property
  def value() -> str: ...

# In class AzureKeys:
@property
def on_tag_list() -> Callable[[AzureKeysTagListEventParams], None]: ...
@on_tag_list.setter
def on_tag_list(event_hook: Callable[[AzureKeysTagListEventParams], None]) -> None: ...

Remarks

This event fires once for each tag returned when get_key_info 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

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

Syntax

class AzureKeysTransferEventParams(object):
  @property
  def direction() -> int: ...

  @property
  def bytes_transferred() -> int: ...

  @property
  def percent_done() -> int: ...

  @property
  def text() -> bytes: ...

# In class AzureKeys:
@property
def on_transfer() -> Callable[[AzureKeysTransferEventParams], None]: ...
@on_transfer.setter
def on_transfer(event_hook: Callable[[AzureKeysTransferEventParams], None]) -> None: ...

Remarks

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

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

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

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

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

AzureKeys Config Settings

AzureKeys Config Settings

<firstlevel>
  <one>value</one>
  <two>
    <item>first</item>
    <item>second</item>
  </two>
  <three>value three</three>
</firstlevel>

{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

AzureKeys Errors

Common Errors

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

HTTP Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors