如何在Bash中转义任意字符串以用作命令行参数？

Question

我有一些字符串列表，希望能够在单个Bash命令行调用中将这些字符串作为参数传递。对于简单的字母数字字符串，只需直接传递即可：

> script.pl foo bar baz yes no
foo
bar
baz
yes
no

我明白如果一个参数包含空格、反斜杠或双引号，我需要反斜杠转义双引号和反斜杠，然后用双引号将该参数括起来。

> script.pl foo bar baz "\"yes\"\\\"no\""
foo
bar
baz
"yes"\"no"

但是当一个参数包含感叹号时，会发生以下情况：

> script.pl !foo
-bash: !foo: event not found

双引号无法正常工作：

> script.pl "!foo"
-bash: !foo: event not found

也不要进行反斜杠转义（注意输出中有文本中的反斜杠）：

> script.pl "\!foo"
\!foo

我对Bash还不是很了解，但我知道还有其他类似的特殊字符。 在Bash中，安全转义任意字符串以用作命令行参数的一般过程是什么？ 假设该字符串长度任意且包含任意组合的特殊字符。 我想要一个escape()子例程，可以像下面这样使用（Perl示例）：

$cmd = join " ", map { escape($_); } @args;

以下是一些更多的字符串示例，这些字符串应该通过此函数进行安全转义（我知道其中一些看起来像Windows，这是故意的）：

yes
no
Hello, world      [string with a comma and space in it]
C:\Program Files\ [path with backslashes and a space in it]
"                 [i.e. a double-quote]
\                 [backslash]
\\                [two backslashes]
\\\               [three backslashes]
\\\\              [four backslashes]
\\\\\             [five backslashes]
"\                [double-quote, backslash]
"\T               [double-quote, backslash, T]
"\\T              [double-quote, backslash, backslash, T]
!1                
!A                
"!\/'"            [double-quote, exclamation, backslash, forward slash, apostrophe, double quote]
"Jeff's!"         [double-quote, J, e, f, f, apostrophe, s, exclamation, double quote]
$PATH             
%PATH%            
&                 
<>|&^             
*@$$A$@#?-_       

编辑：

这个方案可行吗？使用反斜杠转义每个不寻常的字符，并省略单引号或双引号。（示例是用Perl编写的，但任何语言都可以实现）

sub escape {
    $_[0] =~ s/([^a-zA-Z0-9_])/\\$1/g;
    return $_[0];
}

- qntm

---

这里有一个相当不错的答案：http://unix.stackexchange.com/q/4770/5779 - Paŭlo Ebermann

提供的 Perl 脚本（编辑中）是不正确的。对于换行符失败，使用反斜杠进行转义时会被简单忽略。 - Score_Under

Answer 1

如果你想要安全地在Bash中引用 任何 内容，你可以使用其内置的 printf %q 格式化功能：

cat strings.txt：

yes
no
Hello, world
C:\Program Files\
"
\
\\
\\\
\\\\
\\\\\
"\
"\T
"\\T
!1
!A
"!\/'"
"Jeff's!"
$PATH
%PATH%
&
<>|&^
*@$$A$@#?-_

cat quote.sh:

#!/bin/bash
while IFS= read -r string
do
    printf '%q\n' "$string"
done < strings.txt

./quote.sh:

yes
no
Hello\,\ world
C:\\Program\ Files\\
\"
\\
\\\\
\\\\\\
\\\\\\\\
\\\\\\\\\\
\"\\
\"\\T
\"\\\\T
\!1
\!A
\"\!\\/\'\"
\"Jeff\'s\!\"
\$PATH
%PATH%
\&
\<\>\|\&\^
\*@\$\$A\$@#\?-_

这些字符串可以直接复制，例如用于echo命令来输出在strings.txt文件中的原始字符串。

- l0b0

---

我本以为需要转义 \"!'$<>|&^ 中的每个字符，但我注意到 printf 在最终字符串中也转义了 * 和 ?。我有遗漏吗？是否有一个完整的字符列表必须使用反斜杠进行转义？ - qntm

看起来任何字符都可以被反斜杠转义而不会受到惩罚，因此最安全的做法是转义除字母、数字和下划线以外的所有内容。在Perl中，我正在描述的函数是：sub escape { $_[0] =~ s/([^a-zA-Z0-9_])/\\$1/g; return $_[0]; } - qntm

@qntm：但是如果字符串（或其中的一部分）已经转义，会发生什么？你会得到双重转义，这是代码启示录中的五骑士之一。 - l0b0

如果字符串已经被单引号转义，那么它将会以双引号的形式在命令行中输出，并且在程序内部变为单引号转义。换句话说，在程序中可用的字符串将完全是原始的（单引号转义）字符串，这正是我想要的。 - qntm

@TrevorHickey 不，%q 是 Bash 中的 printf 用法。 - l0b0

Answer 2

在Bash中，安全转义任意字符串以用作命令行参数的一般过程是什么？

请将每个出现的单引号'替换为'\''，然后在开头和结尾添加'。

除了单引号之外的每个字符都可以在单引号包含的字符串中原样使用。无法在单引号包含的字符串中放置单引号，但这很容易解决：结束字符串（'），然后使用反斜杠转义它（\'），然后开始新的字符串（'）。

据我所知，这种方法总是有效的，没有例外。

- Tanner Swett

---

除了printf的答案（只有在你已经在bash中时才有效），这是该主题中唯一正确的答案。 - Score_Under

太棒了！在所有编程语言中都可以轻松应用！你甚至不需要转义换行符，它适用于所有情况 :)！ - Wojciech Kulik

这应该是被接受的答案，并且值得更多的赞同。 - Sumit Trehan

Answer 3

在Bash中，您可以使用单引号来转义字符串。但是请注意，这不会像双引号一样在引号内展开变量。在您的示例中，以下内容应该有效：

script.pl '!foo'

从 Perl 来看，这取决于你用来生成外部进程的函数。例如，如果你使用 system 函数，则可以将参数作为参数传递，因此无需转义它们。当然，你仍需要为 Perl 转义引号：

system("/usr/bin/rm", "-fr", "/tmp/CGI_test", "/var/tmp/CGI");

- jjmontes

---

如果参数本身包含单引号，例如“Jeff's!”，则使用单引号似乎无法正常工作。单引号也无法通过反斜杠进行转义。 - qntm

@qntm：使用以下内容："Jeff's"'!'。将其视为两个单独的标记并且相邻："Jeff's"和'!'。 - Hai Vu

在单引号字符串中使用单引号时，请将其替换为'''。例如，'Jeff'''s!'。这对于人类来说很荒谬，但对于脚本来说很简单：首先使用正则表达式将'转换为'''，然后将其括在'...'中。 - Dan Sheppard

Answer 4

sub text_to_shell_lit(_) {
   return $_[0] if $_[0] =~ /^[a-zA-Z0-9_\-]+\z/;
   my $s = $_[0];
   $s =~ s/'/'\\''/g;
   return "'$s'";
}

可以参考之前的文章来了解示例。

- ikegami

Answer 5

每当您发现没有得到所期望的输出时，请使用以下方法：
"""\特殊字符"""
其中特殊字符可能包括! " * ^ % $ # @等。
例如，如果您想创建一个生成另一个bash文件的bash文件，在其中有一个字符串并且您想为其赋值，您可以采用以下示例方案：

Area="(1250,600),(1400,750)"
printf "SubArea="""\""""${Area}"""\""""\n" > test.sh
printf "echo """\$"""{SubArea}" >> test.sh

然后，test.sh文件将具有以下代码：

SubArea="(1250,600),(1400,750)"
echo ${SubArea}

作为提醒，如果我们需要换行符\n，我们应该使用printf。

- Habib Karbasian

Answer 6

Bash仅在交互模式下解释感叹号。

您可以通过执行以下操作来防止此问题：

set +o histexpand

在双引号内，您必须转义美元符号、双引号、反斜杠，我想这就是全部了。

- Benoit

---

这很有用，但如果我每次调用命令都能避免打开和关闭histexpand就更好了。 - qntm

如果你正在编写一个shell脚本，那么感叹号仅在交互模式下被解析。你可以在bashrc中关闭它。 - Benoit

我不是在写一个 shell 脚本。 - qntm

Answer 7

这并不是完整的答案，但有时候我发现将两种引号结合起来来表示一个字符串是很有用的，例如echo "$HOME"'/foo!?.*'。

- micans

Answer 8

顺便说一下，我编写了这个函数，它使用不同的凭据调用一组参数。 su 命令需要序列化所有参数，这需要对它们进行转义，我使用上面建议的 printf 习惯用法来完成。

$ escape_args_then_call_as myname whoami

escape_args_then_call_as() {
    local user=$1
    shift

    local -a args
    for i in "$@"; do
        args+=( $(printf %q "${i}") )
    done

    sudo su "${user}" -c "${args[*]}"
}

- Christopher King

---

感谢您在一个十年后仍然具有参考价值的挑战中发布解决方案。但是，您的解决方案会删除循环中任何单词周围的单引号。请在shell文件测试中尝试此操作（未在注释中格式化的代码，请使用此帖子上的“编辑”查看格式化）： #!/bin/bash for i in "$@"; do args+=( $(printf %q "${i}") ) done echo "${args[*]}"然后执行以下命令：
./test sed -i 's/foo/bar' fname
结果为：
sed -i s/foo/bar fname - TonyG