From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 28424 invoked by alias); 12 Dec 2018 11:34:02 -0000 Mailing-List: contact libc-stable-help@sourceware.org; run by ezmlm Precedence: bulk List-Post: List-Help: List-Subscribe: List-Archive: Sender: libc-stable-owner@sourceware.org Received: (qmail 27322 invoked by uid 89); 12 Dec 2018 11:34:01 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Checked: by ClamAV 0.100.2 on sourceware.org X-Virus-Found: No X-Spam-SWARE-Status: No, score=-26.9 required=5.0 tests=BAYES_00,GIT_PATCH_0,GIT_PATCH_1,GIT_PATCH_2,GIT_PATCH_3,KAM_SHORT,SPF_HELO_PASS autolearn=ham version=3.3.2 spammy=letters, Quote X-Spam-Status: No, score=-26.9 required=5.0 tests=BAYES_00,GIT_PATCH_0,GIT_PATCH_1,GIT_PATCH_2,GIT_PATCH_3,KAM_SHORT,SPF_HELO_PASS autolearn=ham version=3.3.2 X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on sourceware.org X-Spam-Level: X-HELO: mx1.redhat.com Received: from mx1.redhat.com (HELO mx1.redhat.com) (209.132.183.28) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Wed, 12 Dec 2018 11:33:58 +0000 Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com [10.5.11.13]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 653A930001EB for ; Wed, 12 Dec 2018 11:33:57 +0000 (UTC) Received: from oldenburg2.str.redhat.com (ovpn-116-48.ams2.redhat.com [10.36.116.48]) by smtp.corp.redhat.com (Postfix) with ESMTPS id EF7E3608C5 for ; Wed, 12 Dec 2018 11:33:56 +0000 (UTC) Received: by oldenburg2.str.redhat.com (Postfix, from userid 1000) id 0893C83149B6; Wed, 12 Dec 2018 12:33:55 +0100 (CET) Date: Mon, 01 Jan 2018 00:00:00 -0000 To: libc-stable@sourceware.org Subject: [2.28 COMMITTED] support: Implement support_quote_string User-Agent: Heirloom mailx 12.5 7/5/10 MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: 7bit Message-Id: <20181212113355.0893C83149B6@oldenburg2.str.redhat.com> From: Florian Weimer X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.41]); Wed, 12 Dec 2018 11:33:57 +0000 (UTC) X-IsSubscribed: yes X-SW-Source: 2018-12/txt/msg00002.txt.bz2 Reviewed-by: Jonathan Nieder (cherry picked from commit c74a91deaa5de416237c02bbb3e41bda76ca4c7b) 2018-11-27 Florian Weimer * support/support.h (support_quote_string): Declare. * support/support_quote_string.c: New file. * support/tst-support_quote_string.c: Likewise. * support/Makefile (libsupport-routines): Add support_quote_string. (tests): Add tst-support_quote_string. diff --git a/support/Makefile b/support/Makefile index 50470fb749..6439d18343 100644 --- a/support/Makefile +++ b/support/Makefile @@ -55,6 +55,7 @@ libsupport-routines = \ support_isolate_in_subprocess \ support_openpty \ support_quote_blob \ + support_quote_string \ support_record_failure \ support_run_diff \ support_shared_allocate \ @@ -159,6 +160,7 @@ tests = \ tst-support_capture_subprocess \ tst-support_format_dns_packet \ tst-support_quote_blob \ + tst-support_quote_string \ tst-support_record_failure \ tst-test_compare \ tst-test_compare_blob \ diff --git a/support/support.h b/support/support.h index b61fe0735c..4d9f7528a6 100644 --- a/support/support.h +++ b/support/support.h @@ -65,6 +65,11 @@ void support_write_file_string (const char *path, const char *contents); the result). */ char *support_quote_blob (const void *blob, size_t length); +/* Quote the contents of the at STR, in such a way that the result + string can be included in a C literal (in single/double quotes, + without putting the quotes into the result). */ +char *support_quote_string (const char *str); + /* Error-checking wrapper functions which terminate the process on error. */ diff --git a/support/support_quote_string.c b/support/support_quote_string.c new file mode 100644 index 0000000000..d324371b13 --- /dev/null +++ b/support/support_quote_string.c @@ -0,0 +1,26 @@ +/* Quote a string so that it can be used in C literals. + Copyright (C) 2018 Free Software Foundation, Inc. + This file is part of the GNU C Library. + + The GNU C Library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + The GNU C Library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with the GNU C Library; if not, see + . */ + +#include +#include + +char * +support_quote_string (const char *str) +{ + return support_quote_blob (str, strlen (str)); +} diff --git a/support/tst-support_quote_string.c b/support/tst-support_quote_string.c new file mode 100644 index 0000000000..3c004759b7 --- /dev/null +++ b/support/tst-support_quote_string.c @@ -0,0 +1,60 @@ +/* Test the support_quote_string function. + Copyright (C) 2018 Free Software Foundation, Inc. + This file is part of the GNU C Library. + + The GNU C Library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + The GNU C Library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with the GNU C Library; if not, see + . */ + +#include +#include +#include +#include + +static int +do_test (void) +{ + char *p = support_quote_string (""); + TEST_COMPARE (strlen (p), 0); + free (p); + p = support_quote_string ("X"); + TEST_COMPARE (strlen (p), 1); + TEST_COMPARE (p[0], 'X'); + free (p); + + /* Check escaping of backslash-escaped characters, and lack of + escaping for other shell meta-characters. */ + p = support_quote_string ("$()*?`@[]{}~\'\"X"); + TEST_COMPARE (strcmp (p, "$()*?`@[]{}~\\'\\\"X"), 0); + free (p); + + /* Check lack of escaping for letters and digits. */ +#define LETTERS_AND_DIGTS \ + "abcdefghijklmnopqrstuvwxyz" \ + "ABCDEFGHIJKLMNOPQRSTUVWXYZ" \ + "0123456789" + p = support_quote_string (LETTERS_AND_DIGTS "@"); + TEST_COMPARE (strcmp (p, LETTERS_AND_DIGTS "@"), 0); + free (p); + + /* Check escaping of control characters and other non-printable + characters. */ + p = support_quote_string ("\r\n\t\a\b\f\v\1\177\200\377@"); + TEST_COMPARE (strcmp (p, "\\r\\n\\t\\a\\b\\f\\v\\001" + "\\177\\200\\377@"), 0); + free (p); + + return 0; +} + +#include