Skip to content

Commit

Permalink
Add compatibility section to the SerializableState docs (#1694)
Browse files Browse the repository at this point in the history
  • Loading branch information
newpavlov authored Oct 9, 2024
1 parent e78de75 commit e0a0486
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions crypto-common/src/hazmat.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit e0a0486

Please sign in to comment.