cgibashopts

CGIBASHOPT：CGI BASH選項解析

CGIBASHOPTS是一個小而快速的純bash庫，即使使用二進製文件上傳，也可以解析bash shell shell web cgi腳本的Web表單參數。它是無限制的免費使用（麻省理工學院許可證）。 （c）Colas Nahaboo 2017

Quickstart

• 複製服務器上某個地方的文件cgibashopts 。例如/usr/local/bin/cgibashopts
• 只需在CGI BASH腳本的開頭源來源。例如： source /usr/local/bin/cgibashopts或. /usr/local/bin/cgibashopts
• 然後可以找到Web表單參數foo （例如，html頁面中： <input type=text name=foo> ），然後可以作為shell環境變量的值$FORM_foo找到。

故障排除：

• 如果出現問題，請在服務器上的cgibashopts目錄中運行tests/tewiba -v以查看測試套件是否檢測到問題。
• CGIBASHOPT需要GNU版本的bash ， grep ， sed 。要測試這一點，請運行grep -P . /dev/null ，您不應遇到錯誤。如果這樣做，則應將它們安裝在類似於Unix的系統上，默認情況下不使用GNU實用程序，例如MacOS ，BusyBox，FreeBSD，BSD和SYSV衍生產品...
  • 在MacOS上，請參閱第10期
  • 在Busybox上，您需要安裝bash ， coreutils ， grep ， sed的GNU版本的軟件包
  • 在FreeBSD上，使用Freshports

特徵

• 易於使用：只有一個文件。
• 快而小。
• 純bash除了使用GREP，SED和截斷。
• 處理和發布請求，以及所有編碼參數的方法：application/x-www-form-urlenCoded，multipart/form-data，text/plain。
• 遺產索引搜索查詢字符串也
• 處理二進製文件的上傳，以及帶有UNIX或DOS Newlines的文本文件。我沒有發現任何現有庫為CGI Shell編程提供此功能
• 我猜僅使用bash的“經典”功能，並且應該與舊bash版本一起使用4.1+

文件

• 使用時，CGIBASHOPTS庫將Web服務器作為各種環境變量提供給腳本的瀏覽器發送的參數，並根據CGI標準（可選）的標準輸入。 Cgibashopts使它們以易於使用的形式提供到包括腳本：變量，功能和文件。
• 要使用庫，請儘早在腳本的開頭中源自多，以避免與以後在腳本中使用的變量發生衝突。
• 該庫通過編碼參數的所有可能方法來解碼GET和發布請求的參數（通過“ Enctype”）。
• 參數名稱的列表以$FORMS列出為空間分隔的名稱字符串。例如： echo "$FORMS" ==> foo bar gee 。參數名稱是html form中各種HTML元素中name屬性指定的參數名稱，或通過wget或curl等命令發送的參數名稱。參數名稱必須是bash的法律變量名稱：字母數字字符和下劃線，而不是從數字開始。
• 無效的參數名稱（例如：0to60，ab，a：b，...）被默默地忽略，其值及其值
• 每個參數值被複製為form_-前綴環境變量的值。例如： $FORM_foo用於html表單元素，名為foo 。
• 多行參數值將轉換為線路的UNIX端（新線而不是運輸返回和newline）
• 文件上傳：當文件上傳時，通過<input type=file name=file1>的表單元素，cgibashopts將參數名稱（there file1 ）放入變量$ formfiles，這是所有收到的所有文件參數名稱的空間分隔列表。上載文件的實際名稱可以在變量值（以下$FORM_file1 ）中找到，而該文件的內容可以在$CGIBASHOPTS_DIR $CGIBASHOPTS_DIR/file1 ）
  • 僅創建和列出實際上上傳的文件。如果用戶未在表單中選擇任何文件，則不會定義Shell變量或創建任何文件。
  • 但是，將創建空上傳的文件。當然，他們會空的。
  • 即使客戶端以DOS格式上傳，也不會以UNIX文本格式（行結尾）轉換收到的二進製文件和文本文件（行結束）（行以托架返回和newline結尾）。因此，您必須準備好在上傳的文本文件中處理DOS線。
  • 警告：必須在腳本末尾調用bash清理功能cgibashopts_clean ，以刪除存儲上載文件的臨時目錄$CGIBASHOPTS_DIR ，如果不使用-n選項（請參見下文）。 CGIBASHOPTS執行trap cgibashopts_clean 0 ，以便在腳本末尾自動調用此函數，因此您無需執行任何操作，除非您自己使用trap 0 ，從而確保您必須確保處理exit信號的代碼明確調用cgibashopts_clean 。
    • 採購CGIBASHOPT將刪除以前完成的任何trap 0 。因此，將陷阱0設置在採購CGIBASHOPT之後
    • 僅當您的HTML表單使用類型file的輸入元素時，才需要調用CGIBASHOPTS_CLEAN
    • 一旦您進行了上傳的文件，就可以自行明確調用cgibashopts_clean函數，因此不再需要它，並且您可以隨意使用陷阱。
    • 如果您不希望上傳文件，則可以使用-n選項（請參見下文）
• 命令行選項：
  • -n可以忽略並丟棄上傳文件的任何請求。如果您不希望文件上傳，建議這樣做，因為如果某些攻擊者嘗試上傳假文件，但不能保存一些計算加載，但不能保存一些計算加載，但不能保存。它還不能定義變量$CGIBASHOPTS_DIR或函數cgibashopts_clean ，也不使用陷阱。注意：這僅在版本3及更高版本中可用。使用的示例： . cgibashopts -n
  • -D目錄指定CGIBASHOPTIONS在文件上傳的情況下管理其臨時文件。它默認為/tmp 。 cgibashoptions將在其中創建一個cgibashopts-files.$$子目錄（其中$$是bash過程編號，每個實例唯一），顯示在$CGIBASHOPTS_DIR變量中。
• 可變CGIBASHOPTS_RELEASE持有發行版，使用所使用的cgibashopts庫的語義版本（例如4.0.1，4.4.3），在此頁面末尾列出了更改歷史上的版本...
  • 可變CGIBASHOPTS_VERSION保留了主要版本號（上面的CGIBASHOPTS_RELEASE的第一個整數，以使其向後兼容。
• 雜項好東西：
  • 提供了兩個方便的狂歡功能：
    • 在參數中使用字符串並輸出其解碼版本，在空間中轉換+的urldecode ，在HexadeCimal ASCII Code XX（例如％41變成a）中轉換 + %XX ，並刪除托架返回。
    • 執行反向操作的urlencode 。兩者都比二進制Linux命令快。
  • 兩個變量$nl和$cr保留新線和一個馬車返回字符
  • 獲取變量值的另一種方法是通過param函數。這只是與Bashlib兼容的便利函數，用於使用它的人（或腳本）。
    • param無參數輸出FORMS的值
    • param foo輸出FORM_foo的值
    • param foo a string...將FORM_foo的值設置為"a string..."
    • param -f打印$FORMFILES
    • param -f foo打印$FORMFILE_foo
    • param -f foo a string...將FORMFILE_foo的值設置為"a string..."

測試套件

提供了一個測試套件，可以通過./tests/RUN-ALL-TESTS運行，有關更多詳細信息，請參見目錄tests中的readme.md

使用它的項目

• Watermark-pdf的網絡前端，用於pipoprods的PDF水印腳本
• 在所有引用它的GitHub項目中搜索所有GitHub項目

回饋

歡迎您複製和增強該項目，並通過以下方式提供錯誤報告，反饋和建議。

• 如果您有一個GitHub帳戶，則創建問題。
• 如果您沒有Githib帳戶，請使用提供的GIT報告表格創建問題。
• 創建或參與有關此項目的討論
• 或給我發送電子郵件：[email protected]

變化的歷史

• 2023-01-11 v4.1.3：修復了測試套件的修復僅是為了避免bash版本中的錯誤<4.4。 CGIBASHOPT的實際代碼沒有變化，除非通過遺留系統的測試套件進行測試套件，否則無需升級。
• 2023-01-08 v4.1.2：錯誤修復：僅在Content-Type和Content-Disposition HTTP標頭中僅將半隆被理解為分離器。修復以也使用逗號。 “ Florin-CTU”報告的錯誤，第8期和＃9。
• 2022-11-24 v4.1.1：錯誤修復：忽略文件上傳字段後的表單字段。請升級！ “ Pipoprods”的錯誤報告，第7期。
• 2021-12-23 v4.1.0：
  • 切換到語義版本，並帶有新的var CGIBASHOPTS_RELEASE
  • 指定臨時目錄的新-D選項（“ Aufschlauer”的建議）
  • 移動到github：將大多數文件移出主視圖，在測試/Tewiba中升級到1.5.0，代碼清理以通過ShellCheck
• 2020-04-16版本4：Urlencode Goodie功能添加
• 2020-04-04該文檔中的一些化妝品更改和測試（測試套件更名為測試），但沒有對CGIBASHOPTS代碼本身的更改，因此不會增加版本編號。
• 2020-03-27版本3：-n添加到禁用文件上傳的選項
• 2018-10-09版本2：修復，參數值中的空格可以看作是 +
• 2017-12-13版本1：修復程序，以使用各種MIME類型上傳文件，現在可以使用set -U和set -e在腳本中使用庫。
• 2017-12-07創建該項目