From 9818d10355e430b1de6361dc6eb698367b8d5c48 Mon Sep 17 00:00:00 2001
From: Nils Andreas Svee <me@lochnair.net>
Date: Fri, 8 May 2026 12:20:30 +0700
Subject: [PATCH] docs(proto): document HMAC-MD5 compatibility

---
 crates/irtt-proto/src/hmac.rs | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/crates/irtt-proto/src/hmac.rs b/crates/irtt-proto/src/hmac.rs
index 6dd6790..f650b29 100644
--- a/crates/irtt-proto/src/hmac.rs
+++ b/crates/irtt-proto/src/hmac.rs
@@ -4,6 +4,9 @@ use subtle::ConstantTimeEq;
 
 use crate::{ProtoError, Result, HEADER_SIZE, HMAC_SIZE};
 
+// HMAC-MD5 is used for compatibility with the IRTT wire protocol, not as a
+// new cryptographic recommendation. Verification uses HMAC with constant-time
+// comparison; do not swap digests unless protocol negotiation supports it.
 type HmacMd5 = Hmac<Md5>;
 
 pub fn compute_hmac(key: &[u8], packet: &[u8], hmac_offset: usize) -> Result<[u8; HMAC_SIZE]> {