From: Stefan Eissing <stefan@eissing.org>
Date: Thu, 25 Sep 2025 10:59:36 +0000 (+0200)
Subject: rustls: fix comment describing cr_recv()
X-Git-Tag: rc-8_17_0-2~350
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=15b4b9618879318ffcd7d8b95f9b2692b14c8e8b;p=thirdparty%2Fcurl.git

rustls: fix comment describing cr_recv()

The comments on `cf_recv()` function were outdated and described
calling conventions that no longer are true.

Reported in Joshua's sarif data

Closes #18728
---

diff --git a/lib/vtls/rustls.c b/lib/vtls/rustls.c
index e081c4651a..a6d8a4652d 100644
--- a/lib/vtls/rustls.c
+++ b/lib/vtls/rustls.c
@@ -188,16 +188,8 @@ static ssize_t tls_recv_more(struct Curl_cfilter *cf,
 }
 
 /*
- * On each run:
- *  - Read a chunk of bytes from the socket into Rustls' TLS input buffer.
- *  - Tell Rustls to process any new packets.
- *  - Read out as many plaintext bytes from Rustls as possible, until hitting
- *    error, EOF, or EAGAIN/EWOULDBLOCK, or plainbuf/plainlen is filled up.
- *
- * it is okay to call this function with plainbuf == NULL and plainlen == 0. In
- * that case, it will copy bytes from the socket into Rustls' TLS input
- * buffer, and process packets, but will not consume bytes from Rustls'
- * plaintext output buffer.
+ * Filter receive method implementation. `plainbuf` and `plainlen`
+ * are always not NULL/0.
  */
 static CURLcode
 cr_recv(struct Curl_cfilter *cf, struct Curl_easy *data,