feat: add key management API integration to SDK #22
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
I needed to use the KMS key management capabilities in the SDK, but since they were not available, I implemented the feature myself based on the existing REST API. If this can be reviewed and merged ASAP, it would be greatly helpful for my ongoing work.
Key Changes:
New Data Models Added (
api_types.py
):BaseKey
,ListKey
,ListKeysResponse
,SingleKeyResponse
,EncryptDataResponse
,DecryptDataResponse
.Key Management Client (
client.py
):V1Keys
class to handle KMS key management operations via the REST API.list_keys
: List keys with pagination, search, and sorting support.create_key
: Create a new KMS key with optional description and encryption algorithm specification.update_key
: Update key attributes such as name, description, and active status.delete_key
: Delete a KMS key. (Note: TheDELETE
endpoint returned a500 Internal Server Error
during testing.)encrypt_data
: Encrypt plaintext using a specified KMS key.decrypt_data
: Decrypt ciphertext using a specified KMS key.V1Keys
class has been integrated into theInfisicalSDKClient
asself.keys
.Impact:
Testing:
DELETE
endpoint returned a500 Internal Server Error
during testing, preventing successful validation of thedelete_key
method.Next Steps:
DELETE
endpoint issue with the API team.DELETE
endpoint issue is resolved.