File: //home/arjun/projects/env/lib/python3.10/site-packages/boto/kms/__pycache__/layer1.cpython-310.pyc
o
we�� � @ sl d dl Z d dlmZ d dlmZ d dlmZ d dlmZ d dl m
Z
d dlm Z d dl Z G dd � d e�Z
dS )
� N)�json)�AWSQueryConnection)�
RegionInfo)�JSONResponseError)�
exceptions)�sixc s� e Zd ZdZdZdZdZdZdZe Z
e j e j
e je je je je je je je je je je je je jd�Z� fdd �Z d
d � Z d d
� Z dAdd�Z dBdd�Z dCdd�Z!dd� Z"dd� Z#dd� Z$dd � Z%d d � Z&d d � Z' dCd!d"�Z( dAd#d$�Z) dAd%d&�Z*dDd'd(�Z+d)d*� Z,d+d,� Z-dCd-d.�Z.dCd/d0�Z/dCd1d2�Z0dCd3d4�Z1d5d6� Z2 dBd7d8�Z3d9d:� Z4d;d<� Z5d=d>� Z6d?d@� Z7� Z8S )E�
KMSConnectiona
AWS Key Management Service
AWS Key Management Service (KMS) is an encryption and key
management web service. This guide describes the KMS actions that
you can call programmatically. For general information about KMS,
see (need an address here). For the KMS developer guide, see (need
address here).
AWS provides SDKs that consist of libraries and sample code for
various programming languages and platforms (Java, Ruby, .Net,
iOS, Android, etc.). The SDKs provide a convenient way to create
programmatic access to KMS and AWS. For example, the SDKs take
care of tasks such as signing requests (see below), managing
errors, and retrying requests automatically. For more information
about the AWS SDKs, including how to download and install them,
see `Tools for Amazon Web Services`_.
We recommend that you use the AWS SDKs to make programmatic API
calls to KMS. However, you can also use the KMS Query API to make
to make direct calls to the KMS web service.
**Signing Requests**
Requests must be signed by using an access key ID and a secret
access key. We strongly recommend that you do not use your AWS
account access key ID and secret key for everyday work with KMS.
Instead, use the access key ID and secret access key for an IAM
user, or you can use the AWS Security Token Service to generate
temporary security credentials that you can use to sign requests.
All KMS operations require `Signature Version 4`_.
**Recording API Requests**
KMS supports AWS CloudTrail, a service that records AWS API calls
and related events for your AWS account and delivers them to an
Amazon S3 bucket that you specify. By using the information
collected by CloudTrail, you can determine what requests were made
to KMS, who made the request, when it was made, and so on. To
learn more about CloudTrail, including how to turn it on and find
your log files, see the `AWS CloudTrail User Guide`_
**Additional Resources**
For more information about credentials and request signing, see
the following:
+ `AWS Security Credentials`_. This topic provides general
information about the types of credentials used for accessing AWS.
+ `AWS Security Token Service`_. This guide describes how to
create and use temporary security credentials.
+ `Signing AWS API Requests`_. This set of topics walks you
through the process of signing a request using an access key ID
and a secret access key.
z
2014-11-01z us-east-1zkms.us-east-1.amazonaws.com�KMS� TrentService)�InvalidGrantTokenException�DisabledException�LimitExceededException�DependencyTimeoutException�InvalidMarkerException�AlreadyExistsException�InvalidCiphertextException�KeyUnavailableException�InvalidAliasNameException� UnsupportedOperationException�InvalidArnException�KMSInternalException�InvalidKeyUsageException� MalformedPolicyDocumentException�NotFoundExceptionc s^ |� dd �}|st| | j| j�}d|vs|d d u r |j|d< tt| �jdi |�� || _d S )N�region�host� ) �popr �DefaultRegionName�DefaultRegionEndpoint�endpoint�superr �__init__r )�self�kwargsr �� __class__r �H/home/arjun/projects/env/lib/python3.10/site-packages/boto/kms/layer1.pyr" t s �
zKMSConnection.__init__c C s dgS )Nzhmac-v4r )r# r r r' �_required_auth_capability� s z'KMSConnection._required_auth_capabilityc C � ||d�}| j dt�|�d�S )a{
Creates a display name for a customer master key. An alias can
be used to identify a key and should be unique. The console
enforces a one-to-one mapping between the alias and a key. An
alias name can contain only alphanumeric characters, forward
slashes (/), underscores (_), and dashes (-). An alias must
start with the word "alias" followed by a forward slash
(alias/). An alias that begins with "aws" after the forward
slash (alias/aws...) is reserved by Amazon Web Services (AWS).
:type alias_name: string
:param alias_name: String that contains the display name. Aliases that
begin with AWS are reserved.
:type target_key_id: string
:param target_key_id: An identifier of the key for which you are
creating the alias. This value cannot be another alias.
)� AliasName� TargetKeyId� CreateAlias��action�body�� make_requestr �dumps)r# �
alias_name�
target_key_id�paramsr r r' � create_alias� s ��zKMSConnection.create_aliasNc C s^ ||d�}|dur
||d< |dur||d< |dur ||d< |dur%||d< | j dt�|�d�S ) a
Adds a grant to a key to specify who can access the key and
under what conditions. Grants are alternate permission
mechanisms to key policies. If absent, access to the key is
evaluated based on IAM policies attached to the user. By
default, grants do not expire. Grants can be listed, retired,
or revoked as indicated by the following APIs. Typically, when
you are finished using a grant, you retire it. When you want
to end a grant immediately, revoke it. For more information
about grants, see `Grants`_.
#. ListGrants
#. RetireGrant
#. RevokeGrant
:type key_id: string
:param key_id: A unique key identifier for a customer master key. This
value can be a globally unique identifier, an ARN, or an alias.
:type grantee_principal: string
:param grantee_principal: Principal given permission by the grant to
use the key identified by the `keyId` parameter.
:type retiring_principal: string
:param retiring_principal: Principal given permission to retire the
grant. For more information, see RetireGrant.
:type operations: list
:param operations: List of operations permitted by the grant. This can
be any combination of one or more of the following values:
#. Decrypt
#. Encrypt
#. GenerateDataKey
#. GenerateDataKeyWithoutPlaintext
#. ReEncryptFrom
#. ReEncryptTo
#. CreateGrant
:type constraints: dict
:param constraints: Specifies the conditions under which the actions
specified by the `Operations` parameter are allowed.
:type grant_tokens: list
:param grant_tokens: List of grant tokens.
)�KeyId�GranteePrincipalN�RetiringPrincipal�
Operations� Constraints� GrantTokens� CreateGrantr- r0 )r# �key_id�grantee_principal�retiring_principal�
operations� constraints� grant_tokensr5 r r r' � create_grant� s 3��zKMSConnection.create_grantc C sH i }|dur
||d< |dur||d< |dur||d< | j dt�|�d�S )a�
Creates a customer master key. Customer master keys can be
used to encrypt small amounts of data (less than 4K) directly,
but they are most commonly used to encrypt or envelope data
keys that are then used to encrypt customer data. For more
information about data keys, see GenerateDataKey and
GenerateDataKeyWithoutPlaintext.
:type policy: string
:param policy: Policy to be attached to the key. This is required and
delegates back to the account. The key is the root of trust.
:type description: string
:param description: Description of the key. We recommend that you
choose a description that helps your customer decide whether the
key is appropriate for a task.
:type key_usage: string
:param key_usage: Specifies the intended use of the key. Currently this
defaults to ENCRYPT/DECRYPT, and only symmetric encryption and
decryption are supported.
N�Policy� Description�KeyUsage� CreateKeyr- r0 )r# �policy� description� key_usager5 r r r' �
create_key� s �zKMSConnection.create_keyc C s� t |tj�s
tdtj ��t�|�}d|�d�i}|dur!||d< |dur)||d< | jdt� |�d�}|�
d �durFt� |d � d��|d < |S )
a�
Decrypts ciphertext. Ciphertext is plaintext that has been
previously encrypted by using the Encrypt function.
:type ciphertext_blob: blob
:param ciphertext_blob: Ciphertext including metadata.
:type encryption_context: map
:param encryption_context: The encryption context. If this was
specified in the Encrypt function, it must be specified here or the
decryption operation will fail. For more information, see
`Encryption Context`_.
:type grant_tokens: list
:param grant_tokens: A list of grant tokens that represent grants which
can be used to provide long term permissions to perform decryption.
�9Value of argument ``ciphertext_blob`` must be of type %s.�CiphertextBlob�utf-8N�EncryptionContextr< �Decryptr- � Plaintext�
�
isinstancer � binary_type� TypeError�base64� b64encode�decoder1 r r2 �get� b64decode�encode)r# �ciphertext_blob�encryption_contextrC r5 �responser r r' �decrypt s( ��
� �zKMSConnection.decryptc C � d|i}| j dt�|�d�S )z�
Deletes the specified alias.
:type alias_name: string
:param alias_name: The alias to be deleted.
r* � DeleteAliasr- r0 )r# r3 r5 r r r' � delete_alias& s �zKMSConnection.delete_aliasc C ra )a+
Provides detailed information about the specified customer
master key.
:type key_id: string
:param key_id: Unique identifier of the customer master key to be
described. This can be an ARN, an alias, or a globally unique
identifier.
r7 � DescribeKeyr- r0 �r# r> r5 r r r' � describe_key2 � �zKMSConnection.describe_keyc C ra )a
Marks a key as disabled, thereby preventing its use.
:type key_id: string
:param key_id: Unique identifier of the customer master key to be
disabled. This can be an ARN, an alias, or a globally unique
identifier.
r7 �
DisableKeyr- r0 re r r r' � disable_keyA �
�zKMSConnection.disable_keyc C ra )a
Disables rotation of the specified key.
:type key_id: string
:param key_id: Unique identifier of the customer master key for which
rotation is to be disabled. This can be an ARN, an alias, or a
globally unique identifier.
r7 �DisableKeyRotationr- r0 re r r r' �disable_key_rotationO rj z"KMSConnection.disable_key_rotationc C ra )aF
Marks a key as enabled, thereby permitting its use. You can
have up to 25 enabled keys at one time.
:type key_id: string
:param key_id: Unique identifier of the customer master key to be
enabled. This can be an ARN, an alias, or a globally unique
identifier.
r7 � EnableKeyr- r0 re r r r' �
enable_key] rg zKMSConnection.enable_keyc C ra )a'
Enables rotation of the specified customer master key.
:type key_id: string
:param key_id: Unique identifier of the customer master key for which
rotation is to be enabled. This can be an ARN, an alias, or a
globally unique identifier.
r7 �EnableKeyRotationr- r0 re r r r' �enable_key_rotationl rj z!KMSConnection.enable_key_rotationc C s� t |tj�s
tdtj ��t�|�}||�d�d�}|dur"||d< |dur*||d< | jdt� |�d�}|�
d �durGt� |d � d��|d < |S )
a�
Encrypts plaintext into ciphertext by using a customer master
key.
:type key_id: string
:param key_id: Unique identifier of the customer master. This can be an
ARN, an alias, or the Key ID.
:type plaintext: blob
:param plaintext: Data to be encrypted.
:type encryption_context: map
:param encryption_context: Name:value pair that specifies the
encryption context to be used for authenticated encryption. For
more information, see `Authenticated Encryption`_.
:type grant_tokens: list
:param grant_tokens: A list of grant tokens that represent grants which
can be used to provide long term permissions to perform encryption.
z3Value of argument ``plaintext`` must be of type %s.rO )r7 rR NrP r< �Encryptr- rN rS )r# r> � plaintextr^ rC r5 r_ r r r' �encryptz s( ��
� �zKMSConnection.encryptc C s� d|i}|dur ||d< |dur||d< |dur ||d< |dur$||d< | j dt�|�d�}|�d �durAt�|d �d
��|d < |�d �durTt�|d �d
��|d < |S ) a�
Generates a secure data key. Data keys are used to encrypt and
decrypt data. They are wrapped by customer master keys.
:type key_id: string
:param key_id: Unique identifier of the key. This can be an ARN, an
alias, or a globally unique identifier.
:type encryption_context: map
:param encryption_context: Name/value pair that contains additional
data to be authenticated during the encryption and decryption
processes that use the key. This value is logged by AWS CloudTrail
to provide context around the data encrypted by the key.
:type number_of_bytes: integer
:param number_of_bytes: Integer that contains the number of bytes to
generate. Common values are 128, 256, 512, 1024 and so on. 1024 is
the current limit.
:type key_spec: string
:param key_spec: Value that identifies the encryption algorithm and key
size to generate a data key for. Currently this can be AES_128 or
AES_256.
:type grant_tokens: list
:param grant_tokens: A list of grant tokens that represent grants which
can be used to provide long term permissions to generate a key.
r7 NrP �
NumberOfBytes�KeySpecr< �GenerateDataKeyr- rN rO rR �r1 r r2 rZ rW r[ r\ )r# r> r^ �number_of_bytes�key_specrC r5 r_ r r r' �generate_data_key� s* � � �z KMSConnection.generate_data_keyc C s� d|i}|dur ||d< |dur||d< |dur ||d< |dur$||d< | j dt�|�d�}|�d �durAt�|d �d
��|d < |S ) aA
Returns a key wrapped by a customer master key without the
plaintext copy of that key. To retrieve the plaintext, see
GenerateDataKey.
:type key_id: string
:param key_id: Unique identifier of the key. This can be an ARN, an
alias, or a globally unique identifier.
:type encryption_context: map
:param encryption_context: Name:value pair that contains additional
data to be authenticated during the encryption and decryption
processes.
:type key_spec: string
:param key_spec: Value that identifies the encryption algorithm and key
size. Currently this can be AES_128 or AES_256.
:type number_of_bytes: integer
:param number_of_bytes: Integer that contains the number of bytes to
generate. Common values are 128, 256, 512, 1024 and so on.
:type grant_tokens: list
:param grant_tokens: A list of grant tokens that represent grants which
can be used to provide long term permissions to generate a key.
r7 NrP ru rt r< � GenerateDataKeyWithoutPlaintextr- rN rO rw )r# r> r^ ry rx rC r5 r_ r r r' �#generate_data_key_without_plaintext� s" � �z1KMSConnection.generate_data_key_without_plaintextc C sR i }|dur
||d< | j dt�|�d�}|�d�dur't�|d �d��|d< |S )a#
Generates an unpredictable byte string.
:type number_of_bytes: integer
:param number_of_bytes: Integer that contains the number of bytes to
generate. Common values are 128, 256, 512, 1024 and so on. The
current limit is 1024 bytes.
Nrt �GenerateRandomr- rR rO rw )r# rx r5 r_ r r r' �generate_random s
� �z KMSConnection.generate_randomc C r) )a�
Retrieves a policy attached to the specified key.
:type key_id: string
:param key_id: Unique identifier of the key. This can be an ARN, an
alias, or a globally unique identifier.
:type policy_name: string
:param policy_name: String that contains the name of the policy.
Currently, this must be "default". Policy names can be discovered
by calling ListKeyPolicies.
)r7 �
PolicyName� GetKeyPolicyr- r0 )r# r> � policy_namer5 r r r' �get_key_policy s
�z KMSConnection.get_key_policyc C ra )a
Retrieves a Boolean value that indicates whether key rotation
is enabled for the specified key.
:type key_id: string
:param key_id: Unique identifier of the key. This can be an ARN, an
alias, or a globally unique identifier.
r7 �GetKeyRotationStatusr- r0 re r r r' �get_key_rotation_status+ rj z%KMSConnection.get_key_rotation_statusc C �8 i }|dur
||d< |dur||d< | j dt�|�d�S )a�
Lists all of the key aliases in the account.
:type limit: integer
:param limit: Specify this parameter when paginating results to
indicate the maximum number of aliases you want in each response.
If there are additional aliases beyond the maximum you specify, the
`Truncated` response element will be set to `true.`
:type marker: string
:param marker: Use this parameter when paginating results, and only in
a subsequent request after you've received a response where the
results are truncated. Set it to the value of the `NextMarker`
element in the response you just received.
N�Limit�Marker� ListAliasesr- r0 �r# �limit�markerr5 r r r' � list_aliases9 � �zKMSConnection.list_aliasesc C �< d|i}|dur ||d< |dur||d< | j dt�|�d�S )aZ
List the grants for a specified key.
:type key_id: string
:param key_id: Unique identifier of the key. This can be an ARN, an
alias, or a globally unique identifier.
:type limit: integer
:param limit: Specify this parameter only when paginating results to
indicate the maximum number of grants you want listed in the
response. If there are additional grants beyond the maximum you
specify, the `Truncated` response element will be set to `true.`
:type marker: string
:param marker: Use this parameter only when paginating results, and
only in a subsequent request after you've received a response where
the results are truncated. Set it to the value of the `NextMarker`
in the response you just received.
r7 Nr� r� �
ListGrantsr- r0 �r# r> r� r� r5 r r r' � list_grantsR � �zKMSConnection.list_grantsc C r� )ai
Retrieves a list of policies attached to a key.
:type key_id: string
:param key_id: Unique identifier of the key. This can be an ARN, an
alias, or a globally unique identifier.
:type limit: integer
:param limit: Specify this parameter only when paginating results to
indicate the maximum number of policies you want listed in the
response. If there are additional policies beyond the maximum you
specify, the `Truncated` response element will be set to `true.`
:type marker: string
:param marker: Use this parameter only when paginating results, and
only in a subsequent request after you've received a response where
the results are truncated. Set it to the value of the `NextMarker`
in the response you just received.
r7 Nr� r� �ListKeyPoliciesr- r0 r� r r r' �list_key_policieso r� z KMSConnection.list_key_policiesc C r� )a�
Lists the customer master keys.
:type limit: integer
:param limit: Specify this parameter only when paginating results to
indicate the maximum number of keys you want listed in the
response. If there are additional keys beyond the maximum you
specify, the `Truncated` response element will be set to `true.`
:type marker: string
:param marker: Use this parameter only when paginating results, and
only in a subsequent request after you've received a response where
the results are truncated. Set it to the value of the `NextMarker`
in the response you just received.
Nr� r� �ListKeysr- r0 r� r r r' � list_keys� r� zKMSConnection.list_keysc C s |||d�}| j dt�|�d�S )a�
Attaches a policy to the specified key.
:type key_id: string
:param key_id: Unique identifier of the key. This can be an ARN, an
alias, or a globally unique identifier.
:type policy_name: string
:param policy_name: Name of the policy to be attached. Currently, the
only supported name is "default".
:type policy: string
:param policy: The policy, in JSON format, to be attached to the key.
)r7 r rE � PutKeyPolicyr- r0 )r# r> r� rI r5 r r r' �put_key_policy� s ��z KMSConnection.put_key_policyc C s� t |tj�s
tdtj ��t�|�}||d�}|dur ||d< |dur'||d< |dur/||d< | jdt�|�d�}|� d �durLt�
|d � d
��|d < |S ) aT
Encrypts data on the server side with a new customer master
key without exposing the plaintext of the data on the client
side. The data is first decrypted and then encrypted. This
operation can also be used to change the encryption context of
a ciphertext.
:type ciphertext_blob: blob
:param ciphertext_blob: Ciphertext of the data to re-encrypt.
:type source_encryption_context: map
:param source_encryption_context: Encryption context used to encrypt
and decrypt the data specified in the `CiphertextBlob` parameter.
:type destination_key_id: string
:param destination_key_id: Key identifier of the key used to re-encrypt
the data.
:type destination_encryption_context: map
:param destination_encryption_context: Encryption context to be used
when the data is re-encrypted.
:type grant_tokens: list
:param grant_tokens: Grant tokens that identify the grants that have
permissions for the encryption and decryption process.
rM )rN �DestinationKeyIdN�SourceEncryptionContext� DestinationEncryptionContextr< � ReEncryptr- rN rO ) rT r rU rV rW rX r1 r r2 rZ r[ r\ )r# r] �destination_key_id�source_encryption_context� destination_encryption_contextrC r5 r_ r r r' �
re_encrypt� s0 ��
�� �zKMSConnection.re_encryptc C ra )a8
Retires a grant. You can retire a grant when you're done using
it to clean up. You should revoke a grant when you intend to
actively deny operations that depend on it.
:type grant_token: string
:param grant_token: Token that identifies the grant to be retired.
�
GrantToken� RetireGrantr- r0 )r# � grant_tokenr5 r r r' � retire_grant� rj zKMSConnection.retire_grantc C r) )a>
Revokes a grant. You can revoke a grant to actively deny
operations that depend on it.
:type key_id: string
:param key_id: Unique identifier of the key associated with the grant.
:type grant_id: string
:param grant_id: Identifier of the grant to be revoked.
)r7 �GrantId� RevokeGrantr- r0 )r# r> �grant_idr5 r r r' � revoke_grant� s
�zKMSConnection.revoke_grantc C r) )z�
:type key_id: string
:param key_id:
:type description: string
:param description:
)r7 rF �UpdateKeyDescriptionr- r0 )r# r> rJ r5 r r r' �update_key_description s
�z$KMSConnection.update_key_descriptionc
C s� d| j |f | jjdtt|��d�}| jdddi ||d�}| j|d dd�}|�� �d �}t j
� |� |j d
kr@|r>t
�|�S d S t
�|�}|�d d �}| j�|| j�} | |j |j|d ��)
Nz%s.%szapplication/x-amz-json-1.1)z X-Amz-Target�Hostz Content-TypezContent-Length�POST�/)�method�path� auth_pathr5 �headers�data�
)�sender�override_num_retriesrO �� �__type)r/ )� TargetPrefixr r �str�len�build_base_http_request�_mexe�readrY �boto�log�debug�statusr �loadsrZ �_faults�
ResponseError�reason)
r# r. r/ r� � http_requestr_ �
response_body� json_body�
fault_name�exception_classr r r' r1 s0
���
�
�zKMSConnection.make_request)NNNN)NNN)NN)N)9�__name__�
__module__� __qualname__�__doc__�
APIVersionr r � ServiceNamer� r r� r r r r
r r r r r r r r r r r r r� r" r( r6 rD rL r` rc rf ri rl rn rp rs rz r| r~ r� r� r� r� r� r� r� r� r� r� r� r1 �
__classcell__r r r% r' r ! s� 8�
�
A"
�%
�(
�4
�
0
�4r )r� � boto.compatr �boto.connectionr �boto.regioninfor �boto.exceptionr �boto.kmsr r rW r r r r r' �<module> s