From e0a048617e03ea592469ebfe7a5c448134736884 Mon Sep 17 00:00:00 2001 From: Artyom Pavlov Date: Wed, 9 Oct 2024 15:55:38 +0300 Subject: [PATCH] Add compatibility section to the `SerializableState` docs (#1694) --- crypto-common/src/hazmat.rs | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/crypto-common/src/hazmat.rs b/crypto-common/src/hazmat.rs index 22672bee..b8df738a 100644 --- a/crypto-common/src/hazmat.rs +++ b/crypto-common/src/hazmat.rs @@ -28,6 +28,16 @@ impl core::error::Error for DeserializeStateError {} /// Types which can serialize the internal state and be restored from it. /// +/// # Compatibility +/// +/// Serialized state can be assumed to be stable across backwards compatible +/// versions of an implementation crate, i.e. any `0.x.y` version of a crate +/// should be able to decode data serialized with any other `0.x.z` version, +/// but it may not be able to correctly decode data serialized with a non-`x` +/// version. +/// +/// This guarantee is a subject to issues such as security fixes. +/// /// # SECURITY WARNING /// /// Serialized state may contain sensitive data.