Nginx + CGI/FastCGI + C/Cpp

缺乏、安全感 2022-07-12 08:16 292阅读 0赞

接着上篇《[Nginx安装与使用][Nginx]》，本篇介绍CGI/FASTCGI的原理、及如何使用C/C++编写简单的CGI/FastCGI，最后将CGI/FASTCGI部署到nginx。内容大纲如下：

1.     CGI

1.1.     环境变量

1.2.     标准输入

2.     FastCGI

3. nginx cgi/fastcgi

3.1. nginx + fastcgi

3.1.1. spawn-fcgi

3.1.2. 编写fastcgi应用程序

3.1.3. nginx fastcgi配置

3.2. nginx + cgi

3.2.1 fastcgi-wrapper

3.2.2. nginx fcgiwrap配置

3.2.3. 编写cgi应用程序

参考链接

# 1.CGI #

**通用网关接口**（**C**ommon **G**ateway **I**nterface/**CGI**）**描述了客户端和服务器程序之间传输数据的一种标准**，可以让一个客户端，从网页浏览器向执行在网络服务器上的程序请求数据。CGI 独立于任何语言的，CGI 程序可以用任何[脚本语言][Link 1]或者是完全独立[编程语言][Link 2]实现，只要这个语言可以在这个系统上运行。[Unix shell][]script, [Python][], [Ruby][], [PHP][], perl, [Tcl][], [C][]/[C++][C 1], 和 [Visual Basic][] 都可以用来编写 CGI 程序。([http://www.dwz.cn/yFFgQ][http_www.dwz.cn_yFFgQ])

最初，CGI 是在 1993 年由美国[国家超级电脑应用中心][Link 3]（NCSA）为 NCSA HTTPd Web 服务器开发的。这个 Web 服务器使用了 UNIX [shell][] [环境变量][Link 4] 来保存从 Web 服务器传递出去的参数，然后生成一个运行 CGI 的独立的[进程][Link 5]。cgi的处理流程如下图所示：

[![clip\_image002][clip_image002]][clip_image002_clip_image002]

l   step1. web 服务器收到客户端（浏览器）的请求Http Request，启动CGI程序，并通过**环境变量**、**标准输入**传递数据

l   step2. cgi进程启动解析器、加载配置（如业务相关配置）、连接其它服务器（如[数据库][Link 6]服务器）、逻辑处理等

l   step3. cgi程将处理结果通过**标准输出**、**标准错误**，传递给web 服务器

l   step4. web 服务器收到cgi返回的结果，构建Http Response返回给客户端，并杀死cgi进程

web服务器与cgi通过环境变量、标准输入、标准输出、标准错误互相传递数据。

## 1.1.环境变量 ##

GET请求，它将数据打包放置在环境变量QUERY\_STRING中，CGI从环境变量QUERY\_STRING中获取数据。常见的环境变量如下表所示：

<table> 
 <tbody> 
 <tr> 
 <td> 环境变数 </td> 
 <td> 内容 </td> 
 </tr> 
 <tr> 
 <td> AUTH_TYPE </td> 
 <td> 存取认证类型。 </td> 
 </tr> 
 <tr> 
 <td> CONTENT_LENGTH </td> 
 <td> 由标准输入传递给CGI程序的数据长度，以bytes或字元数来计算。 </td> 
 </tr> 
 <tr> 
 <td> CONTENT_TYPE </td> 
 <td> 请求的MIME类型。 </td> 
 </tr> 
 <tr> 
 <td> GATEWAY_INTERFACE </td> 
 <td> 服务器的CGI版本编号。 </td> 
 </tr> 
 <tr> 
 <td> HTTP_ACCEPT </td> 
 <td> 浏览器能直接接收的Content-types,&nbsp;可以有HTTP Accept header定义. </td> 
 </tr> 
 <tr> 
 <td> HTTP_USER_AGENT </td> 
 <td> 递交表单的浏览器的名称、版本&nbsp;和其他平台性的附加信息。 </td> 
 </tr> 
 <tr> 
 <td> HTTP_REFERER </td> 
 <td> 递交表单的文本的&nbsp;URL，不是所有的浏览器都发出这个信息，不要依赖它 </td> 
 </tr> 
 <tr> 
 <td> PATH_INFO </td> 
 <td> 传递给cgi程式的路径信息。 </td> 
 </tr> 
 <tr> 
 <td> QUERY_STRING </td> 
 <td> 传递给CGI程式的请求参数，也就是用"?"隔开，添加在URL后面的字串。 </td> 
 </tr> 
 <tr> 
 <td> REMOTE_ADDR </td> 
 <td> client端的host名称。 </td> 
 </tr> 
 <tr> 
 <td> REMOTE_HOST </td> 
 <td> client端的IP位址。 </td> 
 </tr> 
 <tr> 
 <td> REMOTE_USER </td> 
 <td> client端送出来的使用者名称。 </td> 
 </tr> 
 <tr> 
 <td> REMOTE_METHOD </td> 
 <td> client端发出请求的方法（如get、post）。 </td> 
 </tr> 
 <tr> 
 <td> SCRIPT_NAME </td> 
 <td> CGI程式所在的虚拟路径，如/cgi-bin/echo。 </td> 
 </tr> 
 <tr> 
 <td> SERVER_NAME </td> 
 <td> server的host名称或IP地址。 </td> 
 </tr> 
 <tr> 
 <td> SERVER_PORT </td> 
 <td> 收到request的server端口。 </td> 
 </tr> 
 <tr> 
 <td> SERVER_PROTOCOL </td> 
 <td> 所使用的通讯协定和版本编号。 </td> 
 </tr> 
 <tr> 
 <td> SERVER_SOFTWARE </td> 
 <td> server程序的名称和版本。 </td> 
 </tr> 
 </tbody> 
</table>

## 1.2.标准输入 ##

环境变量的大小是有一定的限制的，当需要传送的数据量大时，储存环境变量的空间可能会不足，造成数据接收不完全，甚至无法执行CGI程序。因此后来又发展出另外一种方法：POST，也就是利用I/O重新导向的技巧，让CGI程序可以由STDIN和STDOUT直接跟浏览器沟通。

当我们指定用这种方法传递请求的数据时，web 服务器收到数据后会先放在一块输入缓冲区中，并且将数据的大小记录在CONTENT_LENGTH这个环境变数，然后调用CGI程式并将CGI程序的STDIN指向这块缓冲区，于是我们就可以很顺利的通过STDIN和环境变数CONTENT_LENGTH得到所有的资料，再没有资料大小的限制了。

**总结：**CGI使外部程序与Web服务器之间交互成为可能。CGI程式运行在独立的进程中，并对每个Web请求建立一个进程，这种方法非常容易实现，但效率很差，难以扩展。面对大量请求，进程的大量建立和消亡使[操作系统][Link 7]性能大大下降。此外，由于地址空间无法共享，也限制了资源重用。

# 2.FastCGI #

快速通用网关接口（Fast Common Gateway Interface／FastCGI）是[通用网关接口][Link 8]（CGI）的改进，描述了客户端和服务器程序之间传输数据的一种标准。F**astCGI致力于减少**[**Web服务器**][Web]**与**[**CGI**][CGI][**程式**][Link 9]**之间互动的开销，从而使**[**服务器**][Link 10]**可以同时处理更多的Web请求**。与为每个请求创建一个新的进程不同，FastCGI使用持续的进程来处理一连串的请求。这些进程由FastCGI进程管理器管理，而不是web服务器。([http://www.dwz.cn/yFMap][http_www.dwz.cn_yFMap])

[![clip\_image004][clip_image004]][clip_image004_clip_image004]

当进来一个请求时，Web 服务器把环境变量和这个页面请求通过一个unix domain socket(都位于同一物理服务器）或者一个IP Socket（FastCGI部署在其它物理服务器）传递给FastCGI进程。

[![clip\_image006][clip_image006]][clip_image006_clip_image006]

l  step1. Web 服务器启动时载入初始化FastCGI执行环境 。 例如IIS ISAPI、apache mod\_fastcgi、nginx ngx\_http\_fastcgi\_module、lighttpd mod\_fastcgi

l  step2. FastCGI进程管理器自身初始化，启动多个CGI解释器进程并等待来自Web 服务器的连接。启动FastCGI进程时，可以配置以ip和UNIX 域socket两种方式启动。

l  step3. 当客户端请求到达Web 服务器时， Web 服务器将请求采用socket方式转发到 FastCGI主进程，FastCGI主进程选择并连接到一个CGI解释器。Web 服务器将CGI环境变量和标准输入发送到FastCGI子进程。

l  step4. FastCGI子进程完成处理后将标准输出和错误信息从同一socket连接返回Web 服务器。当FastCGI子进程关闭连接时，请求便处理完成。

l  step5. FastCGI子进程接着等待并处理来自Web 服务器的下一个连接。

由于 FastCGI 程序并不需要不断的产生新进程，可以大大降低服务器的压力并且产生较高的应用效率。它的速度效率最少要比CGI 技术提高 5 倍以上。它还支持分布式的部署， 即 FastCGI 程序可以在web 服务器以外的主机上执行。

**总结：**CGI 就是所谓的短生存期应用程序，FastCGI 就是所谓的长生存期应用程序。FastCGI像是一个常驻(long-live)型的CGI，它可以一直执行着，不会每次都要花费时间去fork一次(这是CGI最为人诟病的fork-and-execute 模式)。

# 3.nginx cgi/fastcgi #

nginx 不能像apache那样直接执行外部可执行程序，但nginx可以作为代理服务器，将请求转发给后端服务器，这也是nginx的主要作用之一。其中nginx就支持FastCGI代理，接收客户端的请求，然后将请求转发给后端fastcgi进程。下面介绍如何使用C/C++编写cgi/fastcgi，并部署到nginx中。

## 3.1. nginx + fastcgi ##

通过前面的介绍知道，fastcgi进程由FastCGI进程管理器管理，而不是nginx。这样就需要一个FastCGI管理，管理我们编写fastcgi程序。本文使用spawn-fcgi作为FastCGI进程管理器。

### 3.1.1. spawn-fcgi ###

spawn-fcgi是一个通用的FastCGI进程管理器，简单小巧，原先是属于lighttpd的一部分，后来由于使用比较广泛，所以就迁移出来作为独立项目了。spawn-fcgi使用pre-fork 模型，功能主要是打开监听端口，绑定地址，然后fork-and-exec创建我们编写的fastcgi应用程序进程，退出完成工作。fastcgi应用程序初始化，然后进入死循环侦听socket的连接请求。

安装spawn-fcgi：

l  获取spawn-fcgi编译安装包，在[http://redmine.lighttpd.net/projects/spawn-fcgi/wiki][http_redmine.lighttpd.net_projects_spawn-fcgi_wiki]上可以获取当前最新的版本。

l  解压缩spawn-fcgi-x.x.x.tar.gz包。

l  进入解压缩目录，执行./configure。

l  make & make install

如果遇到以下错误：“ ./autogen.sh: x: autoreconf: not found”，因为没有安装automake 工具，ubuntu用下面的命令安装好就可以了：sudo apt-get install autoconf automake libtool 。

spawn-fcgi的帮助信息可以通过man spawn-fcgi或spawn-fcgi –h获得，下面是部分常用spawn-fcgi参数信息：

<table style="font-family:'microsoft yahei'; font-size:15px; line-height:35px; color:rgb(51,51,51)"> 
 <tbody> 
 <tr> 
 <td> -f &lt;fcgiapp&gt;&nbsp;指定调用FastCGI的进程的执行程序位置 -a &lt;addr&gt;&nbsp;绑定到地址addr。 -p &lt;port&gt;&nbsp;绑定到端口port。 -s &lt;path&gt;&nbsp;绑定到unix domain socket -C &lt;childs&gt;&nbsp;指定产生的FastCGI的进程数，默认为5。（仅用于<a href="http://lib.csdn.net/base/php" title="PHP知识库" style="text-decoration:none; color:rgb(223,52,52); font-weight:bold" rel="nofollow">PHP</a>） -P &lt;path&gt;&nbsp;指定产生的进程的PID文件路径。 -F &lt;childs&gt;&nbsp;指定产生的FastCGI的进程数（C的CGI用这个） -u和-g FastCGI使用什么身份（-u&nbsp;用户&nbsp;-g&nbsp;用户组）运行，CentOS下可以使用apache用户，其他的根据情况配置，如nobody、www-data等。 </td> 
 </tr> 
 </tbody> 
</table>

### 3.1.2. 编写fastcgi应用程序 ###

使用C/C++编写fastcgi应用程序，可以使用FastCGI软件开发套件或者其它开发框架，如fastcgi++。

本文使用FastCGI软件开发套件——fcgi（[http://www.fastcgi.com/drupal/node/6?q=node/21][http_www.fastcgi.com_drupal_node_6_q_node_21]），通过此套件可以轻松编写fastcgi应用程序，安装fcgi：

l  获取fcgi编译安装包，在[http://www.fastcgi.com/drupal/node/5][http_www.fastcgi.com_drupal_node_5]上可以获取当前最新的版本。

l  解压缩fcgi-x.x.x.tar.gz包。

l  进入解压缩目录，执行./configure。

l  make & make install

如果编译提示一下错误：

fcgio.cpp: In destructor 'virtual fcgi\_streambuf::~fcgi\_streambuf()':

fcgio.cpp:50: error: 'EOF' was not declared in this scope
    fcgio.cpp: In member function 'virtual int fcgi_streambuf::overflow(int)':
    fcgio.cpp:70: error: 'EOF' was not declared in this scope
    fcgio.cpp:75: error: 'EOF' was not declared in this scope
    fcgio.cpp: In member function 'virtual int fcgi_streambuf::sync()':
    fcgio.cpp:86: error: 'EOF' was not declared in this scope
    fcgio.cpp:87: error: 'EOF' was not declared in this scope
    fcgio.cpp: In member function 'virtual int fcgi_streambuf::underflow()':
    fcgio.cpp:113: error: 'EOF' was not declared in this scope
    make[2]: *** [fcgio.lo] Error 1
    make[2]: Leaving directory `/root/downloads/fcgi-2.4.1-SNAP-0910052249/libfcgi'
    make[1]: *** [all-recursive] Error 1
    make[1]: Leaving directory `/root/downloads/fcgi-2.4.1-SNAP-0910052249'

make: \*\*\* \[all\] Error 2

解决办法：在/include/fcgio.h文件中加上 \#include <cstdio>，然后再编译安装就通过了。

如果提示找不到动态库，请在LD\_LIBRARY\_PATH或/etc/ld.so.conf中添加fcgi的安装路径，如/usr/local/lib，并执行ldconfig更新一下。

\#include "fcgi\_stdio.h"

\#include <stdlib.h>

int main(void)

int count = 0;

while (FCGI\_Accept() >= 0)

printf("Content-type: text/html\\r\\n"

"\\r\\n"

"<title>FastCGI Hello!</title>"

"<h1>FastCGI Hello!</h1>"

"Request number %d running on host %s\\n",

\++count, getenv("SERVER\_NAME"));

return 0;

}

编译g++ main.cpp -o demo –lfcgi，并将demo部署到/opt/nginx-1.7.7/cgi-bin/目录

通过spawn-fcgi启动c/c++编写好的fastcgi程序：/opt/nginx-1.7.7/sbin/spawn-fcgi -a 127.0.0.1 -p 8081 -f /opt/nginx-1.7.7/cgi-bin/demo

### 3.1.3. nginx fastcgi配置 ###

关于nginx的几个配置文件解析，可以参阅《[Nginx安装与使用][Nginx]》[http://www.cnblogs.com/skynet/p/4146083.html][Nginx]，在上篇的nginx.conf基础上增加下面的fastcgi配置。

[![clip\_image007][clip_image007]][clip_image007_clip_image007]

这样nginx收到[http://localhost/demo.cgi][http_localhost_demo.cgi]请求时，会匹配到location = /demo.cgi块，将请求传到后端的fastcgi应用程序处理。如下如所示：（注意其中number为80，是因为我请求了80次）

[![clip\_image008][clip_image008]][clip_image008_clip_image008]

## 3.2. nginx + cgi ##

nginx 不能直接执行外部可执行程序，并且cgi是接收到请求时才会启动cgi进程，不像fastcgi会在一开就启动好，这样nginx天生是不支持 cgi 的。nginx 虽然不支持cgi，但它支持 fastCGI。所以，我们可以考虑使用fastcgi包装来支持 cgi。原理大致如下图所示：pre-fork几个通用的代理fastcgi程序——fastcgi-wrapper，fastcgi-wrapper启动执行cgi然后将cgi的执行结果返回给nginx（fork-and-exec）。

[![clip\_image010][clip_image010]][clip_image010_clip_image010]

明白原理之后，编写一个fastcgi-warpper也比较简单。网上流传比较多的一个解决方案是，来自nginx wiki（[http://wiki.nginx.org/SimpleCGI][http_wiki.nginx.org_SimpleCGI]）上的使用perl的fastcgi包装脚本cgiwrap-fcgi.pl。但我对perl不是很感冒，下面给出一个C/C++写的fastcgi-wrapper。

### 3.2.1. fastcgi-wrapper ###

其实编写C/C++的fastcgi-wrapper，就是写一个C/C++的fastcgi，步骤和原理跟前面的小节（nginx+fastcgi）一样。github上已经有人开源了，C写的fastcgi-wrapper：[https://github.com/gnosek/fcgiwrap][https_github.com_gnosek_fcgiwrap]。

安装fcgiwrap：

l  下载（[https://github.com/gnosek/fcgiwrap.git][https_github.com_gnosek_fcgiwrap.git]）

l  解压缩fcgiwrap，进入解压目录

l  autoreconf -i

l  ./configure

l  make && make install

启动fastcgi-wrapper：/opt/nginx-1.7.7/sbin/spawn-fcgi -f /usr/local/sbin/fcgiwrap -p 8081

### 3.2.2. nginx fcgiwrap配置 ###

在nginx.conf中增加下面的loaction配置块，这样所有的xxx.cgi请求都会走到fcgiwrap，然后fcgiwrap会执行cgi-bin目录下的cgi程序。

[![clip\_image011][clip_image011]][clip_image011_clip_image011]

### 3.2.3. 编写cgi应用程序 ###

\#include <stdio.h>

\#include <stdlib.h>

int main(void)

int count = 0;

printf("Content-type: text/html\\r\\n"

"\\r\\n"

"<title>CGI Hello!</title>"

"<h1>CGI Hello!</h1>"

"Request number %d running on host %s\\n",

\++count, getenv("SERVER\_NAME"));

return 0;

tyler@ubuntu:~/ClionProjects/HelloFastCGI$ g++ cgi.cpp -o cgidemo -lfcgi

tyler@ubuntu:~/ClionProjects/HelloFastCGI$ sudo cp cgidemo /opt/nginx-1.7.7/cgi-bin/

[![clip\_image012][clip_image012]][clip_image012_clip_image012]

注意图中的请求次数一直都是1，因为cgi的模式是fork-and-exec，每次都是一个新的进程。

# 参考链接 #

l  CGI, [http://www.dwz.cn/yFFgQ][http_www.dwz.cn_yFFgQ]

l  fastcgi, [http://www.dwz.cn/yFMap][http_www.dwz.cn_yFMap]

l  spawn-fcgi, [http://redmine.lighttpd.net/projects/spawn-fcgi/wiki][http_redmine.lighttpd.net_projects_spawn-fcgi_wiki]

l  fcgi, [http://www.fastcgi.com/drupal/node/6?q=node/21][http_www.fastcgi.com_drupal_node_6_q_node_21]

l  fcgiwrap, [https://github.com/gnosek/fcgiwrap.git][https_github.com_gnosek_fcgiwrap.git]

[Nginx]: http://www.cnblogs.com/skynet/p/4146083.html
[Link 1]: http://zh.wikipedia.org/wiki/%E8%84%9A%E6%9C%AC%E8%AF%AD%E8%A8%80
[Link 2]: http://zh.wikipedia.org/wiki/%E7%BC%96%E7%A8%8B%E8%AF%AD%E8%A8%80
[Unix shell]: http://zh.wikipedia.org/wiki/Unix_shell
[Python]: http://zh.wikipedia.org/wiki/Python
[Ruby]: http://zh.wikipedia.org/wiki/Ruby
[PHP]: http://zh.wikipedia.org/wiki/PHP
[Tcl]: http://zh.wikipedia.org/wiki/Tcl
[C]: http://zh.wikipedia.org/wiki/C%E8%AF%AD%E8%A8%80
[C 1]: http://zh.wikipedia.org/wiki/C%2B%2B
[Visual Basic]: http://zh.wikipedia.org/wiki/Visual_Basic
[http_www.dwz.cn_yFFgQ]: http://www.dwz.cn/yFFgQ
[Link 3]: http://zh.wikipedia.org/wiki/%E5%9B%BD%E5%AE%B6%E8%B6%85%E7%BA%A7%E7%94%B5%E8%84%91%E5%BA%94%E7%94%A8%E4%B8%AD%E5%BF%83
[shell]: http://zh.wikipedia.org/wiki/Shell
[Link 4]: http://zh.wikipedia.org/wiki/%E7%8E%AF%E5%A2%83%E5%8F%98%E9%87%8F
[Link 5]: http://zh.wikipedia.org/wiki/%E8%BF%9B%E7%A8%8B
[clip_image002]: http://images.cnitblog.com/blog/92071/201412/191104434855332.png
[clip_image002_clip_image002]: /images/20220710/fa80e3ce57a64a27a26cefe64830a6db.png
[Link 6]: http://lib.csdn.net/base/mysql
[Link 7]: http://lib.csdn.net/base/operatingsystem
[Link 8]: http://zh.wikipedia.org/wiki/%E9%80%9A%E7%94%A8%E7%BD%91%E5%85%B3%E6%8E%A5%E5%8F%A3
[Web]: http://zh.wikipedia.org/wiki/%E7%B6%B2%E9%A0%81%E4%BC%BA%E6%9C%8D%E5%99%A8
[CGI]: http://zh.wikipedia.org/wiki/CGI
[Link 9]: http://zh.wikipedia.org/wiki/%E7%A8%8B%E5%BC%8F
[Link 10]: http://zh.wikipedia.org/wiki/%E4%BC%BA%E6%9C%8D%E5%99%A8
[http_www.dwz.cn_yFMap]: http://www.dwz.cn/yFMap
[clip_image004]: http://images.cnitblog.com/blog/92071/201412/191104459072505.png
[clip_image004_clip_image004]: /images/20220710/e0b1ceb5f5054fa3a136ccbbcbc71027.png
[clip_image006]: http://images.cnitblog.com/blog/92071/201412/191104485636450.png
[clip_image006_clip_image006]: /images/20220710/3c577a990ff146248ce1bb6d893a54a6.png
[http_redmine.lighttpd.net_projects_spawn-fcgi_wiki]: http://redmine.lighttpd.net/projects/spawn-fcgi/wiki
[http_www.fastcgi.com_drupal_node_6_q_node_21]: http://www.fastcgi.com/drupal/node/6?q=node/21
[http_www.fastcgi.com_drupal_node_5]: http://www.fastcgi.com/drupal/node/5
[clip_image007]: http://images.cnitblog.com/blog/92071/201412/191104511574909.png
[clip_image007_clip_image007]: /images/20220710/844705f2872a40a5972a25885f13cdbe.png
[http_localhost_demo.cgi]: http://localhost/demo.cgi
[clip_image008]: http://images.cnitblog.com/blog/92071/201412/191104527668668.png
[clip_image008_clip_image008]: /images/20220710/07ec2f2f35c84fb9b6856313feb0c316.png
[clip_image010]: http://images.cnitblog.com/blog/92071/201412/191104553915370.png
[clip_image010_clip_image010]: /images/20220710/0ce4bab73e4b4b5baa75a2f425d4f861.png
[http_wiki.nginx.org_SimpleCGI]: http://wiki.nginx.org/SimpleCGI
[https_github.com_gnosek_fcgiwrap]: https://github.com/gnosek/fcgiwrap
[https_github.com_gnosek_fcgiwrap.git]: https://github.com/gnosek/fcgiwrap.git
[clip_image011]: http://images.cnitblog.com/blog/92071/201412/191104578914800.png
[clip_image011_clip_image011]: /images/20220710/38d69564ae224e318ffaf4fa21c57589.png
[clip_image012]: http://images.cnitblog.com/blog/92071/201412/191104599698402.png
[clip_image012_clip_image012]: /images/20220710/d1b03220d59c47f18aa02265144fa437.png