Nginx官方文档(十二)【HTTP之ngx_http_access_module|ngx_http_addition_module|ngx_http_auth_basic_module】

骑猪看日落 2021-07-04 22:48 302阅读 0赞

# ngx\_http\_access\_module #

*  示例配置
 *  指令
    
     *  allow
     *  deny

`ngx_http_access_module` 模块允许限制对某些客户端地址的访问。

访问也可以通过密码、子请求结果或 JWT 限制。可用 satisfy 指令通过地址和密码同时限制访问。

## 示例配置 ##

location / {
        deny  192.168.1.1;
        allow 192.168.1.0/24;
        allow 10.1.1.0/16;
        allow 2001:0db8::/32;
        deny  all;
    }

按顺序检查规则，直到找到第一个匹配项。在本例中，仅允许 IPv4 网络 `10.1.1.0/16` 和 `192.168.1.0/24` 与 IPv6 网络 `2001:0db8::/ 32` 访问，不包括地址 `192.168.1.1`。在很多规则的情况下，最好使用 ngx\_http\_geo\_module 模块变量。

## 指令 ##

### allow ###

<table> 
 <thead> 
  <tr> 
   <th align="left">-</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left"><strong>语法</strong></td> 
   <td align="left"><strong>allow</strong> <code>address</code> | <code>CIDR</code> | <code>unix:</code> | <code>all</code>;</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>默认</strong></td> 
   <td align="left">——</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>上下文</strong></td> 
   <td align="left">http、server、location、limit_except</td> 
  </tr> 
 </tbody> 
</table>

允许访问指定的网络或地址。如果指定了特殊值 `unix:`（1.5.1），则允许访问所有 UNIX 域套接字。

### deny ###

<table> 
 <thead> 
  <tr> 
   <th align="left">-</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left"><strong>语法</strong></td> 
   <td align="left"><strong>deny</strong> <code>address</code> | <code>CIDR</code> | <code>unix:</code> | <code>all</code>;</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>默认</strong></td> 
   <td align="left">——</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>上下文</strong></td> 
   <td align="left">http、server、location、limit_except</td> 
  </tr> 
 </tbody> 
</table>

拒绝指定网络或地址的访问。如果指定了特殊值 `unix:`（1.5.1），则拒绝所有 UNIX 域套接字的访问。

## 原文档 ##

[http://nginx.org/en/docs/http/ngx\_http\_access\_module.html][http_nginx.org_en_docs_http_ngx_http_access_module.html]

--------------------

# ngx\_http\_addition\_module #

*  示例配置
 *  指令
    
     *  add\_before\_body
     *  add\_after\_body
     *  addition\_types

`ngx_http_addition_module` 是一个过滤器，用于在响应之前和之后添加文本。该模块不是默认构建，要启用应使用 `--with-http_addition_module` 配置参数构建。

## 示例配置 ##

location / {
        add_before_body /before_action;
        add_after_body  /after_action;
    }

## 指令 ##

### add\_before\_body ###

<table> 
 <thead> 
  <tr> 
   <th align="left">-</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left"><strong>语法</strong></td> 
   <td align="left"><strong>add_before_body</strong> <code>uri</code>;</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>默认</strong></td> 
   <td align="left">——</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>上下文</strong></td> 
   <td align="left">http、server、location</td> 
  </tr> 
 </tbody> 
</table>

在响应正文之前添加文本，作为给定子请求的一个处理结果返回。空字符串（`""`）作为参数时将取消从先前配置级别继承的额外文本。

### add\_after\_body ###

<table> 
 <thead> 
  <tr> 
   <th align="left">-</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left"><strong>语法</strong></td> 
   <td align="left"><strong>add_after_body</strong> <code>uri</code>;</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>默认</strong></td> 
   <td align="left">——</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>上下文</strong></td> 
   <td align="left">http、server、location</td> 
  </tr> 
 </tbody> 
</table>

在响应正文之后添加文本，作为给定子请求的一个处理结果返回。空字符串（`""`）作为参数时将取消从先前配置级别继承的额外文本。

### addition\_types ###

<table> 
 <thead> 
  <tr> 
   <th align="left">-</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left"><strong>语法</strong></td> 
   <td align="left"><strong>addition_types</strong> <code>mime-type ...</code>;</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>默认</strong></td> 
   <td align="left">addition_types text/html;</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>上下文</strong></td> 
   <td align="left">http、server、location</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>提示</strong></td> 
   <td align="left">该指令在 0.7.9 版本中出现</td> 
  </tr> 
 </tbody> 
</table>

除了 `text/html` 外，允许您在指定的 MIME 类型的响应中添加文本。特殊值 `*` 匹配所有 MIME类型（0.8.29）。

## 原文档 ##

[http://nginx.org/en/docs/http/ngx\_http\_addition\_module.html][http_nginx.org_en_docs_http_ngx_http_addition_module.html]

--------------------

# ngx\_http\_auth\_basic\_module #

*  示例配置
 *  指令
    
     *  auth\_basic
     *  auth\_basic\_user\_file

`ngx_http_auth_basic_module` 模块允许通过使用 **HTTP Basic Authentication** 协议验证用户名和密码来限制对资源的访问。

也可以通过地址、子请求结果或 JWT 来限制访问。可使用 satisfy 指令通过地址和密码同时限制访问。

## 示例配置 ##

location / {
        auth_basic           "closed site";
        auth_basic_user_file conf/htpasswd;
    }

## 指令 ##

### auth\_basic ###

<table> 
 <thead> 
  <tr> 
   <th align="left">-</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left"><strong>语法</strong></td> 
   <td align="left"><strong>auth_basic</strong> <code>string</code> | <code>off</code>;</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>默认</strong></td> 
   <td align="left">auth_basic off;</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>上下文</strong></td> 
   <td align="left">http、server、location、limit_except</td> 
  </tr> 
 </tbody> 
</table>

使用 **HTTP Basic Authentication** 协议，启用用户名和密码验证。指定的参数用作为一个 `realm`。参数值可以包含变量（1.3.10、1.2.7）。特殊值 `off` 可以取消从先前配置级别继承的 `auth_basic` 指令的影响。

### auth\_basic\_user\_file ###

<table> 
 <thead> 
  <tr> 
   <th align="left">-</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left"><strong>语法</strong></td> 
   <td align="left"><strong>auth_basic_user_file</strong> <code>file</code>;</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>默认</strong></td> 
   <td align="left">——</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>上下文</strong></td> 
   <td align="left">http、server、location、limit_except</td> 
  </tr> 
 </tbody> 
</table>

指定一个用于保存用户名和密码的文件，格式如下：

# comment
    name1:password1
    name2:password2:comment
    name3:password3

`file` 的名称可以包含变量。

支持以下密码类型：

*  用 `crypt()` 函数加密；可以使用 Apache HTTP Server 分发的或 `openssl passwd` 命令中的 `htpasswd` 工具生成；
 *  使用基于 MD5 密码算法（apr1）的 Apache 变体进行散列计算；可以用与上述相同的工具生成；
 *  [RFC 2307][] 中指定的 `{scheme}data` 语法（1.0.3+）；目前的实现方案包括 `PLAIN`（一个不应该使用的示例）、`SHA`（1.3.13）（简单 SHA-1 散列，不应该使用）和 `SSHA`（一些软件包使用了加盐的 SHA-1 散列，特别是 OpenLDAP 和 Dovecot）。

> 增加了对 SHA 模式的支持，仅用于帮助从其他 Web 服务器迁移。 它不应该用于新密码，因为它使用的未加盐的 SHA-1 散列容易受到[彩虹表][Link 1]的攻击。

## 原文档 ##

[http://nginx.org/en/docs/http/ngx\_http\_auth\_basic\_module.html][http_nginx.org_en_docs_http_ngx_http_auth_basic_module.html]

[http_nginx.org_en_docs_http_ngx_http_access_module.html]: http://nginx.org/en/docs/http/ngx_http_access_module.html
[http_nginx.org_en_docs_http_ngx_http_addition_module.html]: http://nginx.org/en/docs/http/ngx_http_addition_module.html
[RFC 2307]: https://tools.ietf.org/html/rfc2307#section-5.3
[Link 1]: http://en.wikipedia.org/wiki/Rainbow_attack
[http_nginx.org_en_docs_http_ngx_http_auth_basic_module.html]: http://nginx.org/en/docs/http/ngx_http_auth_basic_module.html