HttpMessageSecurity Class

Used for message authorization, encryption and decrtyption.

This class is intended for internal use only. Details are subject to non-compatible changes, consumers of the azure-keyvault module should not take dependencies on this class or its current implementation.

Inheritance

builtins.object

HttpMessageSecurity

Constructor

HttpMessageSecurity(client_security_token=None, client_signature_key=None, client_encryption_key=None, server_signature_key=None, server_encryption_key=None)

Parameters

client_security_token

default value: None

client_signature_key

default value: None

client_encryption_key

default value: None

server_signature_key

default value: None

server_encryption_key

default value: None

Methods

protect_request	Adds authorization header, and encrypts and signs the request if supported on the specific request. :param request: unprotected request to apply security protocol :return: protected request with appropriate security protocal applied
supports_protection	Determines if the the current HttpMessageSecurity object supports the message protection protocol. :return: True if the current object supports protection, otherwise False
unprotect_response	Removes protection from the specified response :param request: response from the key vault service :return: unprotected response with any security protocal encryption removed

protect_request

Adds authorization header, and encrypts and signs the request if supported on the specific request. :param request: unprotected request to apply security protocol :return: protected request with appropriate security protocal applied

protect_request(request)

Parameters

request

Required

supports_protection

Determines if the the current HttpMessageSecurity object supports the message protection protocol. :return: True if the current object supports protection, otherwise False

supports_protection()

unprotect_response

Removes protection from the specified response :param request: response from the key vault service :return: unprotected response with any security protocal encryption removed

unprotect_response(response, **kwargs)

Parameters

response

Required