git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] gpg-interface: trim only CR characters that precede LF
@ 2025-10-16 18:44 Okhuomon Ajayi
  2025-10-16 18:52 ` Junio C Hamano
  0 siblings, 1 reply; 6+ messages in thread
From: Okhuomon Ajayi @ 2025-10-16 18:44 UTC (permalink / raw)
  To: git; +Cc: Okhuomon Ajayi

The current implementation of remove_cr_after() drops every carriage
return (CR) it finds, even when the CR is not part of a CRLF sequence.
This can damage data that legitimately contains standalone CR bytes,
such as binary payloads or text formatted for older systems.

Update remove_cr_after() to remove a CR only when it is immediately
followed by an LF. This keeps Windows-style CRLF normalization intact
while preserving lone CR characters that are part of the data itself.

Signed-off-by: Okhuomon Ajayi <okhuomonajayi54@gmail.com>
---
 gpg-interface.c | 25 ++++++++++++++++---------
 1 file changed, 16 insertions(+), 9 deletions(-)

diff --git a/gpg-interface.c b/gpg-interface.c
index 2f4f0e32cb..c961607444 100644
--- a/gpg-interface.c
+++ b/gpg-interface.c
@@ -965,19 +965,22 @@ int sign_buffer(struct strbuf *buffer, struct strbuf *signature, const char *sig
 }
 
 /*
- * Strip CR from the line endings, in case we are on Windows.
- * NEEDSWORK: make it trim only CRs before LFs and rename
+ * Trim CR characters only when they appear before LF (\r\n) line endings.
+ * This avoids removing legitimate lone CRs from teh content.
  */
-static void remove_cr_after(struct strbuf *buffer, size_t offset)
+static void trim_cr_before_lf(struct strbuf *buffer, size_t offset)
 {
 	size_t i, j;
 
 	for (i = j = offset; i < buffer->len; i++) {
-		if (buffer->buf[i] != '\r') {
+	     /* skip CR only if it comes right before LF */
+		if (buffer->buf[i] == '\r' && i + 1 < buffer->len && buffer->buf[i+1] == '\n')
+		    continue;
+ 
 			if (i != j)
 				buffer->buf[j] = buffer->buf[i];
 			j++;
-		}
+		
 	}
 	strbuf_setlen(buffer, j);
 }
@@ -1023,8 +1026,10 @@ static int sign_buffer_gpg(struct strbuf *buffer, struct strbuf *signature,
 	}
 	strbuf_release(&gpg_status);
 
-	/* Strip CR from the line endings, in case we are on Windows. */
-	remove_cr_after(signature, bottom);
+	/* Trim carriage returns (CR) only when they appear before line feeds (LF),.
+	*  mainly for handling Windows-style line endings
+ 	*/
+	trim_cr_before_lf(signature, bottom);
 
 	return 0;
 }
@@ -1110,8 +1115,10 @@ static int sign_buffer_ssh(struct strbuf *buffer, struct strbuf *signature,
 			ssh_signature_filename.buf);
 		goto out;
 	}
-	/* Strip CR from the line endings, in case we are on Windows. */
-	remove_cr_after(signature, bottom);
+	/* Trim carriage returns (CR) only when they appear before line feeds (LF),
+	*  mainly for handling Windows-style line endings.
+	*/
+	trim_cr_before_lf(signature, bottom);
 
 out:
 	if (key_file)
-- 
2.43.0


^ permalink raw reply related	[flat|nested] 6+ messages in thread

* Re: [PATCH] gpg-interface: trim only CR characters that precede LF
  2025-10-16 18:44 [PATCH] gpg-interface: trim only CR characters that precede LF Okhuomon Ajayi
@ 2025-10-16 18:52 ` Junio C Hamano
  2025-10-16 19:38   ` Okhuomon Ajayi
  0 siblings, 1 reply; 6+ messages in thread
From: Junio C Hamano @ 2025-10-16 18:52 UTC (permalink / raw)
  To: Okhuomon Ajayi; +Cc: git

Okhuomon Ajayi <okhuomonajayi54@gmail.com> writes:

>  /*
> - * Strip CR from the line endings, in case we are on Windows.
> - * NEEDSWORK: make it trim only CRs before LFs and rename
> + * Trim CR characters only when they appear before LF (\r\n) line endings.
> + * This avoids removing legitimate lone CRs from teh content.

"teh" -> "the".  I know, I myself often make teh same typo.

>   */
> -static void remove_cr_after(struct strbuf *buffer, size_t offset)
> +static void trim_cr_before_lf(struct strbuf *buffer, size_t offset)

In other words, this normalizes crlf to lf line ending.

>  {
>  	size_t i, j;
>  
>  	for (i = j = offset; i < buffer->len; i++) {
> -		if (buffer->buf[i] != '\r') {
> +	     /* skip CR only if it comes right before LF */
> +		if (buffer->buf[i] == '\r' && i + 1 < buffer->len && buffer->buf[i+1] == '\n')

Are two different mixture of tabs and spaces used in the above two
lines?  I think they wanted to begin at the same column.

Also, the second line is overly long that it does not even fit on my
92-column wide terminal (yes, 80 is the limit, but this will let a
line in the patches quoted a few times to still fit, as long as the
patch honors the 80-column limit).

> +		    continue;

>  			if (i != j)
>  				buffer->buf[j] = buffer->buf[i];
>  			j++;
> -		}
> +		

Do we need a blank line here?  I dunno.

>  	}
>  	strbuf_setlen(buffer, j);
>  }
> @@ -1023,8 +1026,10 @@ static int sign_buffer_gpg(struct strbuf *buffer, struct strbuf *signature,
>  	}
>  	strbuf_release(&gpg_status);
>  
> -	/* Strip CR from the line endings, in case we are on Windows. */
> -	remove_cr_after(signature, bottom);
> +	/* Trim carriage returns (CR) only when they appear before line feeds (LF),.
> +	*  mainly for handling Windows-style line endings
> + 	*/

	/* Convert CRLF to LF, in case we are on Windows */

> +	trim_cr_before_lf(signature, bottom);
>  
>  	return 0;
>  }
> @@ -1110,8 +1115,10 @@ static int sign_buffer_ssh(struct strbuf *buffer, struct strbuf *signature,
>  			ssh_signature_filename.buf);
>  		goto out;
>  	}
> -	/* Strip CR from the line endings, in case we are on Windows. */
> -	remove_cr_after(signature, bottom);
> +	/* Trim carriage returns (CR) only when they appear before line feeds (LF),
> +	*  mainly for handling Windows-style line endings.
> +	*/
> +	trim_cr_before_lf(signature, bottom);

Ditto.

>  
>  out:
>  	if (key_file)

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH] gpg-interface: trim only CR characters that precede LF
  2025-10-16 18:52 ` Junio C Hamano
@ 2025-10-16 19:38   ` Okhuomon Ajayi
  2025-10-16 20:50     ` Junio C Hamano
  2025-10-16 20:53     ` Kristoffer Haugsbakk
  0 siblings, 2 replies; 6+ messages in thread
From: Okhuomon Ajayi @ 2025-10-16 19:38 UTC (permalink / raw)
  To: Junio C Hamano; +Cc: git

Hi Junio,
Haha, I smiled at your “teh” comment — I myself often make teh same typo
Thanks a lot for catching the typo and for the detailed feedback on
style and indentation.
I’ll fix the tab/space mix, shorten the long line, and use your
suggested comment wording in the next revision

On Thu, Oct 16, 2025 at 7:52 PM Junio C Hamano <gitster@pobox.com> wrote:
>
> Okhuomon Ajayi <okhuomonajayi54@gmail.com> writes:
>
> >  /*
> > - * Strip CR from the line endings, in case we are on Windows.
> > - * NEEDSWORK: make it trim only CRs before LFs and rename
> > + * Trim CR characters only when they appear before LF (\r\n) line endings.
> > + * This avoids removing legitimate lone CRs from teh content.
>
> "teh" -> "the".  I know, I myself often make teh same typo.
>
> >   */
> > -static void remove_cr_after(struct strbuf *buffer, size_t offset)
> > +static void trim_cr_before_lf(struct strbuf *buffer, size_t offset)
>
> In other words, this normalizes crlf to lf line ending.
>
> >  {
> >       size_t i, j;
> >
> >       for (i = j = offset; i < buffer->len; i++) {
> > -             if (buffer->buf[i] != '\r') {
> > +          /* skip CR only if it comes right before LF */
> > +             if (buffer->buf[i] == '\r' && i + 1 < buffer->len && buffer->buf[i+1] == '\n')
>
> Are two different mixture of tabs and spaces used in the above two
> lines?  I think they wanted to begin at the same column.
>
> Also, the second line is overly long that it does not even fit on my
> 92-column wide terminal (yes, 80 is the limit, but this will let a
> line in the patches quoted a few times to still fit, as long as the
> patch honors the 80-column limit).
>
> > +                 continue;
>
> >                       if (i != j)
> >                               buffer->buf[j] = buffer->buf[i];
> >                       j++;
> > -             }
> > +
>
> Do we need a blank line here?  I dunno.
>
> >       }
> >       strbuf_setlen(buffer, j);
> >  }
> > @@ -1023,8 +1026,10 @@ static int sign_buffer_gpg(struct strbuf *buffer, struct strbuf *signature,
> >       }
> >       strbuf_release(&gpg_status);
> >
> > -     /* Strip CR from the line endings, in case we are on Windows. */
> > -     remove_cr_after(signature, bottom);
> > +     /* Trim carriage returns (CR) only when they appear before line feeds (LF),.
> > +     *  mainly for handling Windows-style line endings
> > +     */
>
>         /* Convert CRLF to LF, in case we are on Windows */
>
> > +     trim_cr_before_lf(signature, bottom);
> >
> >       return 0;
> >  }
> > @@ -1110,8 +1115,10 @@ static int sign_buffer_ssh(struct strbuf *buffer, struct strbuf *signature,
> >                       ssh_signature_filename.buf);
> >               goto out;
> >       }
> > -     /* Strip CR from the line endings, in case we are on Windows. */
> > -     remove_cr_after(signature, bottom);
> > +     /* Trim carriage returns (CR) only when they appear before line feeds (LF),
> > +     *  mainly for handling Windows-style line endings.
> > +     */
> > +     trim_cr_before_lf(signature, bottom);
>
> Ditto.
>
> >
> >  out:
> >       if (key_file)

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH] gpg-interface: trim only CR characters that precede LF
  2025-10-16 19:38   ` Okhuomon Ajayi
@ 2025-10-16 20:50     ` Junio C Hamano
  2025-10-16 20:53     ` Kristoffer Haugsbakk
  1 sibling, 0 replies; 6+ messages in thread
From: Junio C Hamano @ 2025-10-16 20:50 UTC (permalink / raw)
  To: Okhuomon Ajayi; +Cc: git

Okhuomon Ajayi <okhuomonajayi54@gmail.com> writes:

> Hi Junio,
> Haha, I smiled at your “teh” comment — I myself often make teh same typo
> Thanks a lot for catching the typo and for the detailed feedback on
> style and indentation.
> I’ll fix the tab/space mix, shorten the long line, and use your
> suggested comment wording in the next revision

I was hinting that the new function name is less than optimal, which
may not have been conveyed very well X-<.

>> > -static void remove_cr_after(struct strbuf *buffer, size_t offset)
>> > +static void trim_cr_before_lf(struct strbuf *buffer, size_t offset)
>>
>> In other words, this normalizes crlf to lf line ending.

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH] gpg-interface: trim only CR characters that precede LF
  2025-10-16 19:38   ` Okhuomon Ajayi
  2025-10-16 20:50     ` Junio C Hamano
@ 2025-10-16 20:53     ` Kristoffer Haugsbakk
  2025-10-16 21:01       ` Okhuomon Ajayi
  1 sibling, 1 reply; 6+ messages in thread
From: Kristoffer Haugsbakk @ 2025-10-16 20:53 UTC (permalink / raw)
  To: Okhuomon Ajayi, Junio C Hamano; +Cc: git

On Thu, Oct 16, 2025, at 21:38, Okhuomon Ajayi wrote:
> Hi Junio,
> Haha, I smiled at your “teh” comment — I myself often make teh same typo

But on the other hand I think the the easiest mistake to overlook is
when the article is doubled.

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH] gpg-interface: trim only CR characters that precede LF
  2025-10-16 20:53     ` Kristoffer Haugsbakk
@ 2025-10-16 21:01       ` Okhuomon Ajayi
  0 siblings, 0 replies; 6+ messages in thread
From: Okhuomon Ajayi @ 2025-10-16 21:01 UTC (permalink / raw)
  To: Kristoffer Haugsbakk; +Cc: Junio C Hamano, git

Haha, Yeah Kristoffer! , I see how “the the” can sneak in I’ll watch
out for that too 😄

On Thu, Oct 16, 2025 at 9:54 PM Kristoffer Haugsbakk
<kristofferhaugsbakk@fastmail.com> wrote:
>
> On Thu, Oct 16, 2025, at 21:38, Okhuomon Ajayi wrote:
> > Hi Junio,
> > Haha, I smiled at your “teh” comment — I myself often make teh same typo
>
> But on the other hand I think the the easiest mistake to overlook is
> when the article is doubled.

^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2025-10-16 21:01 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-10-16 18:44 [PATCH] gpg-interface: trim only CR characters that precede LF Okhuomon Ajayi
2025-10-16 18:52 ` Junio C Hamano
2025-10-16 19:38   ` Okhuomon Ajayi
2025-10-16 20:50     ` Junio C Hamano
2025-10-16 20:53     ` Kristoffer Haugsbakk
2025-10-16 21:01       ` Okhuomon Ajayi

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).