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目录中的变量命名的本地文件中找到（here $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创建该项目