cosmian-kms 4.12.0__cp37-abi3-macosx_10_12_x86_64.whl → 4.13.1__cp37-abi3-macosx_10_12_x86_64.whl

cosmian_kms/__init__.pyi

@@ -151,55 +151,56 @@ class KmsClient:
         Returns:
             Future[str]: the unique identifier of the key
         """
-    def rotate_cover_crypt_attributes(
+    def rekey_cover_crypt_access_policy(
         self,
-        attributes: List[Union[Attribute, str]],
+        access_policy: str,
         master_secret_key_identifier: UidOrTags,
     ) -> Future[Tuple[str, str]]:
-        """Rotate the given policy attributes. This will rekey in the KMS:
-            - the Master Keys
-            - all User Decryption Keys that contain one of these attributes in their policy and are not rotated.
+        """Generate new keys associated to the given access policy in the master keys.
+        This will automatically refresh the corresponding user keys.
 
         Args:
-            attributes (List[Union[Attribute, str]]): attributes to rotate e.g. ["Department::HR"]
-            master_secret_key_identifier (Union[str, List[str])): master secret key referenced by its UID or a list of tags
+            - `access_policy` (str): describe the keys to renew
+            - `master_secret_key_identifier` (Union[str, List[str])): master secret key referenced by its UID or a list of tags
 
         Returns:
             Future[Tuple[str, str]]: (Public key UID, Master secret key UID)
         """
-    async def clear_cover_crypt_attributes_rotations(
+    async def prune_cover_crypt_access_policy(
         self,
-        attributes: List[Union[Attribute, str]],
+        access_policy: str,
         master_secret_key_identifier: UidOrTags,
     ) -> Tuple[str, str]:
         """
-        Remove old rotations from the specified policy attributes.
-
-        This will rekey in the KMS:
-        - the Master Keys
-        - all User Decryption Keys that contain one of these attributes in their policy.
-
+        Removes old keys associated to the access policy from the master keys.
+        This will automatically refresh the corresponding user keys.
+        This will permanently remove access to old ciphertexts.
+    
         Args:
-            attributes (List[Union[Attribute, str]): Attributes to rotate e.g. ["Department::HR"]
-            master_secret_key_identifier (Union[str, List[str])): master secret key referenced by its UID or a list of tags
+            - `access_policy` (str): describe the keys to renew
+            - `master_secret_key_identifier` (Union[str, List[str])): master secret key referenced by its UID or a list of tags
 
         Returns:
             Tuple[str, str]: (Public key UID, Master secret key UID)
         """
     async def remove_cover_crypt_attribute(
         self,
-        attribute: Union[Attribute, str],
+        attribute: str,
         master_secret_key_identifier: UidOrTags,
     ) -> Tuple[str, str]:
         """
         Remove a specific attribute from a keypair's policy.
+        Permanently removes the ability to use this attribute in both encryptions and decryptions.
+        
+        Note that messages whose encryption policy does not contain any other attributes
+        belonging to the dimension of the deleted attribute will be lost.
 
         This will rekey in the KMS:
-        - the Master Keys
-        - all User Decryption Keys that contain one of these attributes in their policy.
+        - the master keys
+        - all user decryption keys that contain one of these attributes in their policy.
 
         Args:
-            attributes (List[Union[Attribute, str]): Attributes to remove e.g. "Department::HR"
+            attributes (Union[Attribute, str]): Attributes to remove e.g. "Department::HR"
             master_secret_key_identifier (Union[str, List[str])): master secret key referenced by its UID or a list of tags
 
         Returns:
@@ -207,18 +208,18 @@ class KmsClient:
         """
     async def disable_cover_crypt_attribute(
         self,
-        attribute: Union[Attribute, str],
+        attribute: str,
         master_secret_key_identifier: UidOrTags,
     ) -> Tuple[str, str]:
         """
         Disable a specific attribute from a keypair's policy.
+        Prevents the encryption of new messages for this attribute while keeping the ability to decrypt existing ciphertexts.
 
         This will rekey in the KMS:
-        - the Master Keys
-        - all User Decryption Keys that contain one of these attributes in their policy.
+        - the master keys
 
         Args:
-            attributes (List[Union[Attribute, str]): Attributes to disable e.g. "Department::HR"
+            attributes (Union[Attribute, str]): Attributes to disable e.g. "Department::HR"
             master_secret_key_identifier (Union[str, List[str])): master secret key referenced by its UID or a list of tags
 
         Returns:
@@ -226,7 +227,7 @@ class KmsClient:
         """
     async def add_cover_crypt_attribute(
         self,
-        attribute: Union[Attribute, str],
+        attribute: str,
         is_hybridized: bool,
         master_secret_key_identifier: UidOrTags,
     ) -> Tuple[str, str]:
@@ -234,11 +235,10 @@ class KmsClient:
         Add a specific attribute to a keypair's policy.
 
         This will rekey in the KMS:
-        - the Master Keys
-        - all User Decryption Keys that contain one of these attributes in their policy.
+        - the master keys
 
         Args:
-            attributes (List[Union[Attribute, str]): Attributes to disable e.g. "Department::HR"
+            attributes (Union[Attribute, str]): Attributes to disable e.g. "Department::HR"
             is_hybridized (bool): hint for encryption
             master_secret_key_identifier (Union[str, List[str])): master secret key referenced by its UID or a list of tags
 
@@ -248,19 +248,15 @@ class KmsClient:
         """
     async def rename_cover_crypt_attribute(
         self,
-        attribute: Union[Attribute, str],
+        attribute: str,
         new_name: str,
         master_secret_key_identifier: UidOrTags,
     ) -> Tuple[str, str]:
         """
         Add a specific attribute to a keypair's policy.
 
-        This will rekey in the KMS:
-        - the Master Keys
-        - all User Decryption Keys that contain one of these attributes in their policy.
-
         Args:
-            attributes (List[Union[Attribute, str]): Attributes to disable e.g. "Department::HR"
+            attributes (Union[Attribute, str]): Attributes to disable e.g. "Department::HR"
             new_name (str): the new name for the attribute
             master_secret_key_identifier (Union[str, List[str])): master secret key referenced by its UID or a list of tags
 
@@ -269,7 +265,7 @@ class KmsClient:
         """
     def create_cover_crypt_user_decryption_key(
         self,
-        access_policy_str: str,
+        access_policy: str,
         master_secret_key_identifier: str,
         tags: Optional[str] = None,
     ) -> Future[str]:
@@ -277,7 +273,7 @@ class KmsClient:
         A new user secret key does NOT include to old (i.e. rotated) partitions.
 
         Args:
-            access_policy_str (str): user access policy
+            access_policy(str): user access policy
             master_secret_key_identifier (str): master secret key UID
             tags (Optional[List[str]]): optional tags to use with the keys
 
@@ -289,7 +285,7 @@ class KmsClient:
         private_key: bytes,
         replace_existing: bool,
         link_master_private_key_id: str,
-        access_policy_str: str,
+        access_policy: str,
         tags: Optional[List[str]] = None,
         is_wrapped: Optional[bool] = None,
         wrapping_password: Optional[str] = None,
@@ -301,7 +297,7 @@ class KmsClient:
             private_key (bytes): key bytes
             replace_existing (bool): set to true to replace an existing key with the same identifier
             link_master_private_key_id (str): id of the matching master private key
-            access_policy_str (str): user access policy
+            access_policy(str): user access policy
             tags (Optional[List[str]]): tags associated to the key
             is_wrapped (bool): whether the key is wrapped
             wrapping_password (Optional[str]): password used to wrap the key

{cosmian_kms-4.12.0.dist-info → cosmian_kms-4.13.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: cosmian_kms
-Version: 4.12.0
+Version: 4.13.1
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy

cosmian_kms-4.13.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+cosmian_kms-4.13.1.dist-info/METADATA,sha256=qE7DwhcI0GgeIbPc8t2tlHHGXFKK6KUPakV_fbM4fPc,1037
+cosmian_kms-4.13.1.dist-info/WHEEL,sha256=w7SWGRBKOTBmBbs8zq8adZ6B1VkNFmQek3CisucTsm8,104
+cosmian_kms-4.13.1.dist-info/license_files/LICENSE.md,sha256=LfpyRX3ytu-bjM_tRWreUpT6uZPNKr9Aa_fHflEq7AM,2993
+cosmian_kms/__init__.pyi,sha256=MfWAs80uIXnhOPDTEHyzYCy-NFk9uAiFCMOdbDPCSuI,15698
+cosmian_kms/__init__.py,sha256=hFdRE02W0kEFxAj-F7jcOb91vgyojXlHWmhXKUDKl_U,352
+cosmian_kms/py.typed,sha256=bWew9mHgMy8LqMu7RuqQXFXLBxh2CRx0dUbSx-3wE48,27
+cosmian_kms/cosmian_kms.abi3.so,sha256=I65Mtuxi3MAXmKfVP9X4u8eb0RptqMufdMVqm6VwBXU,6517712
+cosmian_kms-4.13.1.dist-info/RECORD,,

{cosmian_kms-4.12.0.dist-info → cosmian_kms-4.13.1.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: maturin (1.4.0)
+Generator: maturin (1.5.0)
 Root-Is-Purelib: false
 Tag: cp37-abi3-macosx_10_12_x86_64

cosmian_kms-4.12.0.dist-info/RECORD

@@ -1,8 +0,0 @@
-cosmian_kms-4.12.0.dist-info/METADATA,sha256=tpU9Rbg2Oi4Tq-0QQePk2D2qewCWegI4m2Ucq7243sM,1037
-cosmian_kms-4.12.0.dist-info/WHEEL,sha256=TpJSAkvDKe49rLSkU55RTzL6Acgm_KccVTJYx3xxiz8,104
-cosmian_kms-4.12.0.dist-info/license_files/LICENSE.md,sha256=LfpyRX3ytu-bjM_tRWreUpT6uZPNKr9Aa_fHflEq7AM,2993
-cosmian_kms/__init__.pyi,sha256=ZuHpvjGQ4hq34EMxwWeQ2YTk3t_sXayOh5_GB5pdIII,15914
-cosmian_kms/__init__.py,sha256=hFdRE02W0kEFxAj-F7jcOb91vgyojXlHWmhXKUDKl_U,352
-cosmian_kms/py.typed,sha256=bWew9mHgMy8LqMu7RuqQXFXLBxh2CRx0dUbSx-3wE48,27
-cosmian_kms/cosmian_kms.abi3.so,sha256=xsav9alUi6sLGMvf8VVY2CZEVy2n4Gq4CcElvsFZj4s,6435664
-cosmian_kms-4.12.0.dist-info/RECORD,,