學習任務

我們將以解決一個典型問題為例進行研究，該問題需要創(chuàng)建一個 shell 腳本來生成包含節(jié)點網(wǎng)絡堆棧設置的配置文件。我們假設待配置的節(jié)點只有一個名為“ens33”的網(wǎng)絡接口。該腳本必須允許指定靜態(tài) IP 地址、子網(wǎng)掩碼和默認網(wǎng)關。

基于以上考慮，我們得到以下配置文件模板：

自動 ens33
接口 ens33 inet 靜態(tài)
地址IP_ADDRESS_VALUE
子網(wǎng)掩碼NETMASK_VALUE
網(wǎng)關DEFAULT_GATEWAY_VALUE

為了進一步舉例說明，我們假設 IP 地址設置為 192.168.0.10，子網(wǎng)掩碼設置為 255.255.255.0，默認網(wǎng)關設置為 192.168.0.1。

選項 1. 將模板放置在腳本中，使用標準工具生成輸出

解決這個問題的最簡單方法（新手開發(fā)者經(jīng)常使用的方法）是將模板放在腳本主體中，并使用局部變量作為占位符值。

#!/bin/bash
 
IP="192.168.0.10"
NETMASK="255.255.255.0"
GATEWAY="192.168.0.1"
 
TEMPLATE="$(
cat << EOF
auto ens33
iface ens33 inet static
address $IP
netmask $NETMASK
gateway $GATEWAY
EOF
)"
 
echo -e "$TEMPLATE"

腳本的運行結(jié)果（以及所有后續(xù)腳本的運行結(jié)果）將如下所示：

自動 ens33
接口 ens33 inet 靜態(tài)
地址 192.168.0.10
子網(wǎng)掩碼 255.255.255.0
網(wǎng)關 192.168.0.1

這個方案各方面都很好，唯一的不足之處在于，修改模板時可能出現(xiàn)的人為錯誤（例如拼寫錯誤或其他錯誤）會導致腳本“崩潰”。因此，更合理的架構(gòu)方案是將腳本和模板分別放在不同的文件中。

細心的讀者可能會注意到，我們在腳本主體中設置了變量值，這意味著要生成具有不同設置的下一個配置文件，仍然需要修改腳本。沒錯，確實如此，但這是為了簡化操作而有意為之。當然，我們完全可以擴展腳本，例如，添加一個用戶界面，讓用戶可以通過控制臺輸入變量值。

選項 2. 將模板放在外部文件中，并使用 envsubst 填充它

讓我們創(chuàng)建一個名為“template.txt”的模板文件，內(nèi)容如下：

自動 ens33
接口 ens33 inet 靜態(tài)
地址 $IP
子網(wǎng)掩碼 $NETMASK
網(wǎng)關 $GATEWAY

#!/bin/bash
 
export IP="192.168.0.10"
export NETMASK="255.255.255.0"
export GATEWAY="192.168.0.1"
 
envsubst  < template.txt

選項 3. 將模板放在外部文件中，并使用 sed 工具填充它。

該工具sed允許您將字符串相互替換。為了避免重寫模板，我們將搜索與變量名（$IP、$NETMASK、$GATEWAY）對應的字符串，并將其替換為相應的值。請注意，要搜索字符串“$IP”，我們需要轉(zhuǎn)義“$”字符，并搜索字符串“\$IP”（其他變量也適用相同的規(guī)則）。

#!/bin/bash
 
IP="192.168.0.10"
NETMASK="255.255.255.0"
GATEWAY="192.168.0.1"
 
cat template.txt | sed "s/\$IP/$IP/" |
                sed "s/\$NETMASK/$NETMASK/" |
                sed "s/\$GATEWAY/$GATEWAY/"

選項 4. 將模板放在外部文件中，并使用 awk 填充它

這個選項在概念上與前一個選項類似，只是sed我們用代替awk，這會稍微影響腳本列表。

#!/bin/bash
 
IP="192.168.0.10"
NETMASK="255.255.255.0"
GATEWAY="192.168.0.1"
 
cat template.txt |
 awk -v replace_str="$IP"      '{ gsub( /\$IP/ ,      replace_str ); print }' |
 awk -v replace_str="$NETMASK" '{ gsub( /\$NETMASK/ , replace_str ); print }' |
 awk -v replace_str="$GATEWAY" '{ gsub( /\$GATEWAY/ , replace_str ); print }'

選項 5. 將模板放在外部文件中，并使用 eval 函數(shù)填充它

此選項與之前的選項不同之處在于，它不使用任何外部工具，而只使用內(nèi)置命令eval。用于生成模板的腳本eval如下所示：

#!/bin/bash
 
IP="192.168.0.10"
NETMASK="255.255.255.0"
GATEWAY="192.168.0.1"
 
TEMPLATE=$(< template.txt)
 
eval "echo -e \"$TEMPLATE\""

你可能想知道我們?yōu)槭裁葱枰?code>eval？這個例子會幫助你理解：

#!/bin/bash
 
VAR="A"
 
TEMPLATE_LOCAL="VAR=$VAR"
TEMPLATE_FILE="$( < template_file.txt)"
 
# VAR=$VAR
 
echo -e "$TEMPLATE_LOCAL"
 
# VAR=A
echo -e "$TEMPLATE_FILE"
 
# VAR=$VAR
eval "echo -e \"$TEMPLATE_FILE\""

如您所見，eval這使您能夠克服 Shell 的一些特性，這些特性會導致腳本對同一數(shù)據(jù)的解釋因數(shù)據(jù)是在腳本主體中指定還是從外部文件加載而有所不同?，F(xiàn)在讓我們來談談使用此功能提供的特性和功能eval。

首先需要注意的是，需要在模板文件中轉(zhuǎn)義特殊字符。例如，`" " "` 應替換為 `" \"`。

使用此功能的第二個特性eval是能夠在模板中編寫代碼。這使您可以構(gòu)建復雜的模板，這些模板不僅可以替換值，還可以根據(jù)指定的條件輸出（或不輸出）整個部分。

為了演示此功能，我們將通過添加一個可選的第二個接口設置“ens37”來使我們的教程更加復雜。這意味著“ens33”將始終配置，而“ens37”僅在必要時配置。使用后，eval配置文件模板（eval_template.txt）將如下所示：

auto ens33
iface ens33 inet static
address $ENS33_IP
netmask $ENS33_NETMASK
gateway $ENS33_GATEWAY

$(
if [[ (-n ${ENS37_IP}) && (-n ${ENS37_NETMASK}) ]]; then
cat << EOF
auto ens37
iface ens37 inet static
address $ENS37_IP
netmask $ENS37_NETMASK
EOF
fi
)

我們將對之前編寫的腳本進行一些關于變量名稱的細微修改。除此之外，所有內(nèi)容基本保持不變。

#!/bin/bash
 
ENS33_IP="192.168.0.10"
ENS33_NETMASK="255.255.255.0"
ENS33_GATEWAY="192.168.0.1"
 
ENS37_IP="10.0.0.10"
ENS37_NETMASK="255.255.0.0"
 
TEMPLATE=$(< eval_template.txt)
 
eval "echo -e \"$TEMPLATE\""

腳本運行結(jié)果：

自動配置 ens33
接口 ens33 inet 靜態(tài)
地址 192.168.0.10
子網(wǎng)掩碼 255.255.255.0
網(wǎng)關 192.168.0.1

自動配置 ens37
接口 ens37 inet 靜態(tài)
地址 10.0.0.10
子網(wǎng)掩碼 255.255.0.0

除了潛在的風險之外，在模板中編寫代碼也存在風險。攻擊者可以秘密修改模板，添加惡意代碼，這些代碼會在生成下一個配置文件時執(zhí)行。你非但無法通過自動化日常任務來簡化工作，反而會面臨清理黑客攻擊后果的棘手問題。

在上面的例子中，模板文件非常小，可以快速掃描（經(jīng)過適當?shù)挠柧殻?。但如果模板很大，幾乎不可能找到惡意代碼。而且，不斷檢查模板是否存在未經(jīng)授權(quán)的修改本身就是一個糟糕的主意。

選項 6. 將模板放在外部文件中，并使用 Bash 的內(nèi)置功能填充它

另一個純粹的 Shell 變體，其理念與awk或類似。只是這里我們使用shell的內(nèi)置工具sed進行字符串搜索和替換。

#!/bin/bash
 
IP="192.168.0.10"
NETMASK="255.255.255.0"
GATEWAY="192.168.0.1"
 
TEMPLATE="$(< template.txt)"
 
TEMP="${TEMPLATE/\$NETMASK/$NETMASK}"
TEMP="${TEMP/\$IP/$IP}"
TEMP="${TEMP/\$GATEWAY/$GATEWAY}"
 
echo -e "$TEMP"

結(jié)論

我們已經(jīng)了解了六種使用 Shell 腳本構(gòu)建配置文件的方法。你應該選擇哪一種呢？當然是選擇你最喜歡的！

在其他條件相同的情況下，可以考慮envsubst使用 `shell` 腳本。它解決了基本問題，而且使用起來非常簡潔。但是，出于eval安全考慮，最好避免使用它。

最新評論