Skip to content

Commit a1901a0

Browse files
committed
fix: minor improvements
1 parent 1f47da7 commit a1901a0

File tree

3 files changed

+20
-13
lines changed

3 files changed

+20
-13
lines changed

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
from infisical_sdk.api_types import SymmetricEncryptionfrom infisical_sdk.api_types import KmsKeysOrderBy
2-
31
# Infisical Python SDK
42

53
The Infisical SDK provides a convenient way to interact with the Infisical API.
@@ -328,13 +326,13 @@ deleted_key = client.kms.delete_key(
328326
```python
329327
encrypted_data = client.kms.encrypt_data(
330328
key_id="<key-id>",
331-
plaintext="TXkgc2VjcmV0IG1lc3NhZ2U=" # must be base64 encoded
329+
base64EncodedPlaintext="TXkgc2VjcmV0IG1lc3NhZ2U=" # must be base64 encoded
332330
)
333331
```
334332

335333
**Parameters:**
336334
- `key_id` (str): The ID of the key to encrypt the data with.
337-
- `plaintext` (str): The plaintext data to encrypt (must be base64 encoded).
335+
- `base64EncodedPlaintext` (str): The plaintext data to encrypt (must be base64 encoded).
338336

339337
**Returns:**
340338
- `str`: The encrypted ciphertext.

infisical_sdk/api_types.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,17 +126,21 @@ class MachineIdentityLoginResponse(BaseModel):
126126
accessTokenMaxTTL: int
127127
tokenType: str
128128

129+
129130
class SymmetricEncryption(str, Enum):
130131
AES_GCM_256 = "aes-256-gcm"
131132
AES_GCM_128 = "aes-128-gcm"
132133

134+
133135
class OrderDirection(str, Enum):
134136
ASC = "asc"
135137
DESC = "desc"
136138

139+
137140
class KmsKeysOrderBy(str, Enum):
138141
NAME = "name"
139142

143+
140144
@dataclass
141145
class KmsKey(BaseModel):
142146
"""Infisical KMS Key"""
@@ -151,6 +155,7 @@ class KmsKey(BaseModel):
151155
version: int
152156
encryptionAlgorithm: SymmetricEncryption
153157

158+
154159
@dataclass
155160
class ListKmsKeysResponse(BaseModel):
156161
"""Complete response model for Kms Keys API"""
@@ -177,12 +182,14 @@ def from_dict(cls, data: Dict) -> 'SingleKmsKeyResponse':
177182
key=KmsKey.from_dict(data['key']),
178183
)
179184

185+
180186
@dataclass
181187
class KmsKeyEncryptDataResponse(BaseModel):
182188
"""Response model for encrypt data API"""
183189
ciphertext: str
184190

191+
185192
@dataclass
186193
class KmsKeyDecryptDataResponse(BaseModel):
187194
"""Response model for decrypt data API"""
188-
plaintext: str
195+
plaintext: str

infisical_sdk/client.py

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,11 @@
1212
from botocore.exceptions import NoCredentialsError
1313

1414
from .infisical_requests import InfisicalRequests
15-
from .api_types import ListSecretsResponse, MachineIdentityLoginResponse, ListKmsKeysResponse, SingleKmsKeyResponse, \
16-
KmsKey, SymmetricEncryption, KmsKeyEncryptDataResponse, KmsKeyDecryptDataResponse, KmsKeysOrderBy, OrderDirection
17-
from .api_types import SingleSecretResponse, BaseSecret
15+
16+
from .api_types import ListSecretsResponse, SingleSecretResponse, BaseSecret
17+
from .api_types import SymmetricEncryption, KmsKeysOrderBy, OrderDirection
18+
from .api_types import ListKmsKeysResponse, SingleKmsKeyResponse, MachineIdentityLoginResponse
19+
from .api_types import KmsKey, KmsKeyEncryptDataResponse, KmsKeyDecryptDataResponse
1820

1921

2022
class InfisicalSDKClient:
@@ -346,6 +348,7 @@ def delete_secret_by_name(
346348

347349
return result.data.secret
348350

351+
349352
class KMS:
350353
def __init__(self, client: InfisicalSDKClient) -> None:
351354
self.client = client
@@ -462,13 +465,13 @@ def delete_key(
462465
def encrypt_data(
463466
self,
464467
key_id: str,
465-
plaintext: str) -> str:
468+
base64EncodedPlaintext: str) -> str:
466469
"""
467470
Encrypt data with the specified KMS key.
468471
469472
:param key_id: The ID of the key to decrypt the ciphertext with
470473
:type key_id: str
471-
:param plaintext: The base64 encoded plaintext to encrypt
474+
:param base64EncodedPlaintext: The base64 encoded plaintext to encrypt
472475
:type plaintext: str
473476
474477
@@ -477,7 +480,7 @@ def encrypt_data(
477480
"""
478481

479482
request_body = {
480-
"plaintext": plaintext
483+
"plaintext": base64EncodedPlaintext
481484
}
482485

483486
result = self.client.api.post(
@@ -509,11 +512,10 @@ def decrypt_data(
509512
"ciphertext": ciphertext
510513
}
511514

512-
513515
result = self.client.api.post(
514516
path=f"/api/v1/kms/keys/{key_id}/decrypt",
515517
json=request_body,
516518
model=KmsKeyDecryptDataResponse
517519
)
518520

519-
return result.data.plaintext
521+
return result.data.plaintext

0 commit comments

Comments
 (0)