web-dev-qa-db-ja.com

Bashでevalを回避する必要があるのはなぜですか?代わりに何を使用する必要がありますか?

何度も、スタックオーバーフローでevalを使用してBashの回答が表示され、そのような「悪意のある」構成要素を使用するために、回答がbashされ、意図的にしゃがれます。なぜevalがそんなに邪悪なのですか?

evalを安全に使用できない場合、代わりに何を使用すればよいですか?

85
Zenexer

この問題には、目に見える以上のものがあります。明らかなことから始めます。evalは、「ダーティ」データを実行する可能性があります。ダーティデータとは、XYZで使用しても安全に書き換えられていないデータのことです。私たちの場合、評価のために安全になるようにフォーマットされていない文字列です。

データのサニタイズは一見簡単に見えます。オプションのリストを使用していると仮定すると、bashはすでに個々の要素をサニタイズする優れた方法と、配列全体を単一の文字列としてサニタイズする別の方法を提供しています。

function println
{
    # Send each element as a separate argument, starting with the second element.
    # Arguments to printf:
    #   1 -> "$1\n"
    #   2 -> "$2"
    #   3 -> "$3"
    #   4 -> "$4"
    #   etc.

    printf "$1\n" "${@:2}"
}

function error
{
    # Send the first element as one argument, and the rest of the elements as a combined argument.
    # Arguments to println:
    #   1 -> '\e[31mError (%d): %s\e[m'
    #   2 -> "$1"
    #   3 -> "${*:2}"

    println '\e[31mError (%d): %s\e[m' "$1" "${*:2}"
    exit "$1"
}

# This...
error 1234 Something went wrong.
# And this...
error 1234 'Something went wrong.'
# Result in the same output (as long as $IFS has not been modified).

次に、出力を引数としてprintlnにリダイレクトするオプションを追加するとします。もちろん、各呼び出しでprintlnの出力をリダイレクトすることもできますが、例のために、これを行うつもりはありません。変数を使用して出力をリダイレクトすることはできないため、evalを使用する必要があります。

function println
{
    eval printf "$2\n" "${@:3}" $1
}

function error
{
    println '>&2' '\e[31mError (%d): %s\e[m' "$1" "${*:2}"
    exit $1
}

error 1234 Something went wrong.

良さそうですね。問題は、evalがコマンドラインを2回解析することです(シェルで)。解析の最初のパスで、引用の1つの層が削除されます。引用符を削除すると、一部の可変コンテンツが実行されます。

これを修正するには、eval内で変数の展開を行います。私たちがしなければならないのは、二重引用符をそのままにして、すべてを単一引用符で囲むことです。 1つの例外:evalの前にリダイレクトを展開する必要があるため、引用符の外側に留まる必要があります。

function println
{
    eval 'printf "$2\n" "${@:3}"' $1
}

function error
{
    println '&2' '\e[31mError (%d): %s\e[m' "$1" "${*:2}"
    exit $1
}

error 1234 Something went wrong.

これは動作するはずです。 println$1が決して汚れない限り、安全です。

ちょっと待ってください。私はいつもSudoで常に使用していたのと同じ引用符なし構文を使用しています。なぜそこで動作し、ここでは動作しないのですか?なぜすべてを単一引用符で囲む必要があったのですか? Sudoはもう少し現代的です。受け取った各引数を引用符で囲むことを知っていますが、それは単純化しすぎです。 evalは、すべてを単純に連結します。

残念ながら、evalはシェル組み込みであるため、Sudoのように引数を処理するevalのドロップイン置換はありません。関数のように新しいスタックとスコープを作成するのではなく、実行時に周囲のコードの環境とスコープを使用するため、これは重要です。

評価代替

特定のユースケースには、evalに代わる実行可能な代替手段がしばしばあります。ここに便利なリストがあります。 commandは、通常evalに送信するものを表します。好きなものに置き換えてください。

ノーオペレーション

Bashのノーオペレーションの単純なコロン::

サブシェルを作成する

( command )   # Standard notation

コマンドの出力を実行する

外部コマンドに依存しないでください。常に戻り値を制御する必要があります。これらを独自の行に入れてください:

$(command)   # Preferred
`command`    # Old: should be avoided, and often considered deprecated

# Nesting:
$(command1 "$(command2)")
`command "\`command\`"`  # Careful: \ only escapes $ and \ with old style, and
                         # special case \` results in nesting.

変数に基づくリダイレ​​クト

呼び出しコードで、&3(または&2よりも高いもの)をターゲットにマッピングします。

exec 3<&0         # Redirect from stdin
exec 3>&1         # Redirect to stdout
exec 3>&2         # Redirect to stderr
exec 3> /dev/null # Don't save output anywhere
exec 3> file.txt  # Redirect to file
exec 3> "$var"    # Redirect to file stored in $var--only works for files!
exec 3<&0 4>&1    # Input and output!

1回限りの呼び出しである場合、シェル全体をリダイレクトする必要はありません。

func arg1 arg2 3>&2

呼び出される関数内で、&3にリダイレクトします。

command <&3       # Redirect stdin
command >&3       # Redirect stdout
command 2>&3      # Redirect stderr
command &>&3      # Redirect stdout and stderr
command 2>&1 >&3  # idem, but for older bash versions
command >&3 2>&1  # Redirect stdout to &3, and stderr to stdout: order matters
command <&3 >&4   # Input and output!

可変インダイレクション

シナリオ:

VAR='1 2 3'
REF=VAR

悪い:

eval "echo \"\$$REF\""

どうして? REFに二重引用符が含まれている場合、これによりコードが破損し、悪用される可能性があります。 REFをサニタイズすることは可能ですが、これがあると時間の無駄になります。

echo "${!REF}"

そうです、bashにはバージョン2の時点で変数間接指定が組み込まれています。もっと複雑なことをしたい場合は、evalより少し複雑になります。

# Add to scenario:
VAR_2='4 5 6'

# We could use:
local ref="${REF}_2"
echo "${!ref}"

# Versus the bash < 2 method, which might be simpler to those accustomed to eval:
eval "echo \"\$${REF}_2\""

とにかく、新しい方法はより直感的ですが、evalに慣れている経験豊富なプログラムの人にはそうは思えないかもしれません。

連想配列

連想配列は、bash 4で本質的に実装されます。1つの注意点は、declareを使用して作成する必要があります。

declare -A VAR   # Local
declare -gA VAR  # Global

# Use spaces between parentheses and contents; I've heard reports of subtle bugs
# on some versions when they are omitted having to do with spaces in keys.
declare -A VAR=( ['']='a' [0]='1' ['duck']='quack' )

VAR+=( ['alpha']='beta' [2]=3 )  # Combine arrays

VAR['cow']='moo'  # Set a single element
unset VAR['cow']  # Unset a single element

unset VAR     # Unset an entire array
unset VAR[@]  # Unset an entire array
unset VAR[*]  # Unset each element with a key corresponding to a file in the
              # current directory; if * doesn't expand, unset the entire array

local KEYS=( "${!VAR[@]}" )  # Get all of the keys in VAR

Bashの古いバージョンでは、変数の間接指定を使用できます。

VAR=( )  # This will store our keys.

# Store a value with a simple key.
# You will need to declare it in a global scope to make it global prior to bash 4.
# In bash 4, use the -g option.
declare "VAR_$key"="$value"
VAR+="$key"
# Or, if your version is lacking +=
VAR=( "$VAR[@]" "$key" )

# Recover a simple value.
local var_key="VAR_$key"       # The name of the variable that holds the value
local var_value="${!var_key}"  # The actual value--requires bash 2
# For < bash 2, eval is required for this method.  Safe as long as $key is not dirty.
local var_value="`eval echo -n \"\$$var_value\""

# If you don't need to enumerate the indices quickly, and you're on bash 2+, this
# can be cut down to one line per operation:
declare "VAR_$key"="$value"                         # Store
echo "`var_key="VAR_$key" echo -n "${!var_key}"`"   # Retrieve

# If you're using more complex values, you'll need to hash your keys:
function mkkey
{
    local key="`mkpasswd -5R0 "$1" 00000000`"
    echo -n "${key##*$}"
}

local var_key="VAR_`mkkey "$key"`"
# ...
135
Zenexer

evalを安全にする方法

evalは安全に使用できますが、その引数はすべて最初に引用符で囲む必要があります。方法は次のとおりです。

あなたのためにそれを行うこの関数:

function token_quote {
  local quoted=()
  for token; do
    quoted+=( "$(printf '%q' "$token")" )
  done
  printf '%s\n' "${quoted[*]}"
}

使用例:

信頼できないユーザー入力がある場合:

% input="Trying to hack you; date"

評価するコマンドを作成します。

% cmd=(echo "User gave:" "$input")

一見正しい引用符で評価します:

% eval "$(echo "${cmd[@]}")"
User gave: Trying to hack you
Thu Sep 27 20:41:31 +07 2018

ハッキングされたことに注意してください。 dateは、文字どおりに印刷されるのではなく、実行されました。

代わりにtoken_quote()を使用:

% eval "$(token_quote "${cmd[@]}")"
User gave: Trying to hack you; date
%

evalは悪ではありません-誤解されているだけです:)

12
Tom Hale