chacha20_poly1305_openssh: Document panic in seal_in_place.

briansmith · Jan 16, 2025 · 4f65d89 · 4f65d89
1 parent 53adab1
commit 4f65d89
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/aead/chacha20_poly1305_openssh.rs b/src/aead/chacha20_poly1305_openssh.rs
@@ -56,6 +56,10 @@ impl SealingKey {
     /// `padding_length||payload||random padding`. It will be overwritten by
     /// `encrypted_packet_length||ciphertext`, where `encrypted_packet_length`
     /// is encrypted with `K_1` and `ciphertext` is encrypted by `K_2`.
+    ///
+    /// # Panics
+    ///
+    /// Panics if `plaintext_in_ciphertext_out.len() < PACKET_LENGTH_LEN`.
     pub fn seal_in_place(
         &self,
         sequence_number: u32,