cgibashopts

CGIBASHOPTS：CGI BASHオプションの解析

CGIBASHOPTSは、バイナリファイルのアップロードであっても、Bash Shell Web CGIスクリプトのWebフォームパラメーターを解析するための小さくて高速な純粋なBashライブラリです。制限なしで自由に使用できます（MITライセンス）。 （c）Colas Nahaboo 2017

クイックスタート

• サーバーのどこかにファイルcgibashoptsをコピーします。例：as /usr/local/bin/cgibashopts
• CGIバッシュスクリプトの先頭にこのファイルを調整するだけです。例： source /usr/local/bin/cgibashoptsまたは. /usr/local/bin/cgibashopts
• Webフォームパラメーターの値foo （HTMLページ： <input type=text name=foo> ）は、シェル環境変数$FORM_fooの値として見つけることができます

トラブルシューティング：

• 何か問題が発生した場合は、サーバーのCGIBASHOPTSディレクトリでtests/tewiba -vを実行して、テストスイートが問題を検出するかどうかを確認します。
• Cgibashoptsには、GNUバージョンのbash 、 grep 、 sed必要です。これをテストするには、 grep -P . /dev/null 、エラーが発生しないでください。そうした場合は、 MacOS 、Busybox、FreeBSD、BSD、SYSV誘導体など、デフォルトでGNUユーティリティを使用しないUNIXのようなシステムにインストールする必要があります。
  • macosについては、＃10を参照してください
  • Busyboxで、GNUバージョンのbash 、 coreutils 、 grep 、 sedのパッケージをインストールする必要があります
  • FreeBSDでは、FreshPortsを使用してください

特徴

• 使いやすい：1つのファイルだけ。
• 速くて小さく。
• Grep、SED、および切り捨ての使用を除き、純粋なバッシュ。
• ハンドルは、アプリケーション/x-www-form-urlencoded、multipart/form-data、テキスト/プレーンのパラメーターをエンコードするすべての方法を使用して、リクエストを取得して投稿します。
• また、レガシーインデックス検索クエリ文字列も処理します
• バイナリファイルのアップロード、およびUNIXまたはDOS NewLinesを使用したテキストファイルを処理します。 CGIシェルプログラミングにこの機能を提供する既存のライブラリは見つかりませんでした
• Bashの「クラシック」機能のみを使用し、古いBashバージョンで動作するはずです。4.1+は推測します

ドキュメント

• 使用すると、CGIBASHOPTSライブラリは、CGI標準に従って、さまざまな環境変数、およびオプションで標準入力としてWebサーバーが提供するブラウザによって送信されたパラメーターをデコードします。 Cgibashoptsは、それらを使用しやすい形式で含めるスクリプトで使用可能にします：変数、関数、およびファイル。
• ライブラリを使用するには、スクリプトの開始時にできるだけ早く調整して、変数との競合を回避します。スクリプトの後半で使用できます。
• ライブラリは、Get Requestのパラメーターを解読し、パラメーターをエンコードするすべての可能な方法を使用して（「enctype」を介して）。
• パラメーター名のリストは、スペース分離された名前の文字列として$FORMSにリストされています。例： echo "$FORMS" ==> foo bar gee 。パラメーター名は、HTML形式のさまざまなHTML要素のname属性によって指定されたものであるか、 wgetやcurlなどのコマンドを介して送信されます。パラメーター名は、bashの法的変数名でなければなりません：数字から始めるのではなく、英数字とアンダースコアです。
• 無効なパラメーター名（例：0to60、ab、a：b、...）は静かに無視され、その値は無視されます
• 各パラメーター値は、form_-プレフィックス環境変数の値としてコピーされます。 EG： fooという名前のHTMLフォーム要素の$FORM_foo 。
• マルチラインパラメーター値は、unix end of Lineに変換されます（キャリッジリターンとNewlineの代わりに新しいライン）
• ファイルのアップロード：ファイルがアップロードされると、 <input type=file name=file1>などのフォーム要素を介して、cgibashoptsはパラメーター名（ file1 ）を変数$ formfilesに配置します。これは、受信したすべてのファイルパラメーター名のスペース分離リストです。アップロードされたファイルの実際の名前は変数値（ここでは$FORM_file1 ）で見つけることができますが、ファイルの内容は$CGIBASHOPTS_DIRディレクトリの変数によって名前が付けられたローカルファイルにあります（ここでは$CGIBASHOPTS_DIR/file1 ）
  • 実際にアップロードされたファイルのみが作成され、この方法でリストされます。ユーザーがフォーム内のファイルを選択しない場合、シェル変数は定義されておらず、ファイルが作成されません。
  • ただし、空のアップロードされたファイルが作成されます。もちろん、それらは空になります。
  • 受信したバイナリおよびテキストファイルは、クライアントがDOS形式でアップロードした場合でも、UNIXテキスト形式（行が新しいラインで終了します）で変換されません（行はキャリッジリターンと新しいラインで終了します）。そのため、アップロードされたテキストファイルのDOSラインを処理する準備ができている必要があります。
  • 警告： BASHクリーンアップ機能cgibashopts_cleanスクリプトの最後に呼び出して、アップロード-nれたファイルを保存する一時ディレクトリ$CGIBASHOPTS_DIRを削除する必要があります。 cgibashoptsはtrap cgibashopts_clean 0を行うため、この関数はスクリプトの最後に自動的に呼び出されるため、自分でtrap 0使用しない限り、何もする必要はありませcgibashopts_clean 。
    • cgibashoptsの調達は、以前に行われたtrap 0を消去します。したがって、cgibashoptsを調達した後、トラップ0を設定します
    • CGIBASHOPTS_CLEANの呼び出しは、HTMLフォームがタイプfileの入力要素を使用している場合にのみ実際に必要です
    • アップロードされたファイルを処理するとすぐに、 cgibashopts_clean機能を自分で明示的に呼び出すことができます。そうすれば、それはもう必要ではなく、その後のトラップを自由に使用できます。
    • ファイルがアップロードされるとは思わない場合は、-nオプションを使用できます（以下を参照）
• コマンドラインオプション：
  • -nは、ファイルをアップロードするリクエストを無視して破棄するために指定できます。一部の攻撃者が偽のファイルをアップロードしようとしたが必須ではない場合にコンピューティングロードを保存できるため、ファイルがアップロードされるとは思わない場合はこれをお勧めします。また、変数$CGIBASHOPTS_DIRまたは関数cgibashopts_cleanを定義せず、trapを使用しません。注：これは、バージョン3以上でのみ利用できます。使用例： . cgibashopts -n
  • -dディレクトリは、ファイルアップロードの場合にCGIBASHOPTIONSが一時ファイルを管理する場所を指定します。デフォルト/tmpになります。 cgibashoptionsは、 $CGIBASHOPTS_DIR変数に示されているcgibashopts $$ cgibashopts-files.$$
• 変数CGIBASHOPTS_RELEASE 、リリースバージョンを保持し、使用されたCGIBASHOPTS Librayのセマンティックバージョン（例えば4.0.1、4.4.3）を使用します。
  • 変数CGIBASHOPTS_VERSION 、主要なバージョン番号（上記のCGIBASHOPTS_RELEASEの最初の整数、後方互換性を保持します。
• その他のグッズ：
  • 2つの便利なバッシュ関数が提供されています。
    • パラメーターに文字列を取得し、デコードされたバージョンを出力し、ヘキサデシマルASCIIコードXXの文字でスペースと%XX +し、キャリッジリターンを削除するurldecode 。
    • 逆操作を実行するurlencode 。どちらもバイナリLinuxコマンドよりも高速です。
  • 2つの変数$nlと$cr新しいラインとキャリッジリターン文字を保持します
  • 変数値を取得する別の方法は、 param関数を使用します。これは、それを使用した人（またはスクリプト）のためのBashlibと互換性のある利便性関数です。
    • 引数のないparam 、 FORMSの値を出力します
    • param foo FORM_fooの値を出力します
    • param foo a string... FORM_fooの値を"a string..."に設定します。
    • param -f $FORMFILESを印刷します
    • param -f foo prints $FORMFILE_foo
    • param -f foo a string... FORMFILE_fooの値を"a string..."に設定します。

テストスイート

テストスイートが提供されます./tests/RUN-ALL-TESTSで実行できます。詳細については、ディレクトリtestsのreadme.mdを参照してください

それを使用するプロジェクト

• Watermark-PDF PDF透かし式スクリプトのWebフロントエンドPipoprods
• すべてのgithubで検索するすべてのgithubプロジェクトを参照してください

フィードバック

このプロジェクトをコピーして強化することを歓迎し、バグレポート、フィードバック、提案を次のように提供します。

• GitHubアカウントがある場合、問題を作成します。
• GITHIBアカウントがない場合は、提供されたGITレポートフォームを使用して問題を作成します。
• このプロジェクトに関するディスカッションを作成または参加します
• または、私にメールしてください：[email protected]

変更の歴史

• 2023-01-11 v4.1.3：バッシュバージョン<4.4のバグを避けるためにのみ、テストスイートの修正。 Cgibashoptsの実際のコードは変更されておらず、レガシーシステムでテストスイートを合格しない限り、アップグレードする必要はありません。
• 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にアップグレードされ、Code Cleanup Up Up Up Coss ShellCheck
• 2020-04-16バージョン4：Urlencode Goodie機能が追加されました
• 2020-04-04このドキュメントとテスト（テストと改名されたテストスイートdir）の化粧品の変更（テストとして変更されました）が、cgibashoptsコード自体に変更はないため、バージョン数は増加しません。
• 2020-03-27バージョン3：-nオプションがファイルアップロードを無効にするために追加されました
• 2018-10-09バージョン2：修正、パラメーター値のスペースは +として見ることができます
• 2017-12-13バージョン1：さまざまなMIMEタイプを使用したファイルのアップロードを修正すると、ライブラリをSET -UおよびSET -Eを使用してスクリプトで使用できるようになりました。
• 2017-12-07プロジェクトの作成