远程鉴权

规则类型

选择一个规则的类型。支持以下配置：

• 文件后缀：根据请求文件的后缀判断请求是否需要被鉴权。
• 目录匹配：根据请求文件所在的目录判断请求是否需要被鉴权。
• 文件全路径：根据请求文件的 URL 判断请求是否需要被鉴权。

是否匹配

指定匹配的方式。支持以下配置：

• 匹配：表示匹配规则内容的请求需要被鉴权。
• 不匹配：表示不匹配规则内容的请求需要被鉴权。

规则

输入一个或者多个配置项，多个配置项以英文分号（;）分隔。 配置项的要求如下：

• 如果规则类型是文件后缀，您需要输入一个或者多个文件扩展名，总长度不能超过 1,024 个字符。文件扩展名大小写敏感，可包含字母和数字。多个扩展名以以英文分号（;）分隔，例如jpg;png。
• 如果规则类型是目录匹配，您需要输入一个或者多个目录路径，总长度不能超过 1,024 个字符。多个目录路径使用英文分号（;）分隔。目录路径大小写敏感。需要遵循的规则如下：
  • 目录路径需以 / 开头和结尾，例如 /test/a/;/test/b/。如果要指定所有目录，输入 /。
  • 目录路径可以包含可打印 ASCII 字符。但不支持以下字符：连续的斜杠（//）、空格、美元符号（$）、问号（?）、Delete（ASCII code 127）。
• 如果规则类型是文件全路径，您需要输入一个或者多个文件路径，总长度不能超过 1,024 个字符。多个文件路径使用英文分号（;）分隔。文件路径大小写敏感。需要遵循的规则如下：
  • 支持通配符*，填写为/*。
  • 文件路径必须以反斜杠（/）开头。例如 /www/img/picture.png;/doc/study.docx。
  • 文件路径可以包含可打印 ASCII 字符。但不支持以下字符：连续的斜杠（//）、空格、美元符号（$）、问号（?）、Delete（ASCII code 127）。

远程鉴权地址（主）

鉴权服务器的主地址，长度不能超过 100 个字符，需要填写合法的域名或 IP。主地址必须采用以下格式之一：

• <scheme>://<domain>：例如 https://example.com
• <scheme>://<ip> ：例如 http://192.168.0.1

请求路径

鉴权 URL 中的路径。鉴权服务器的地址和该路径组成了鉴权 URL。veImageX 会把用户请求转发到该鉴权 URL。支持以下配置：

• 遵循用户请求路径：鉴权 URL 中的路径与用户请求 URL 中的路径相同。
• 指定具体请求路径：一个指定的路径。您需要在鉴权路径中指定该路径。

鉴权路径

如果请求路径是指定具体请求路径，该配置才会出现。在该配置中，您指定一个鉴权路径。需要遵循的规则如下：

• 鉴权路径必须以斜杠（/）开头。
• 长度不能超过 100 个字符。
• 可以包含可打印 ASCII 字符。但不支持以下字符：连续的斜杠（//）、空格、美元符号（$）、问号（?）、Delete（ASCII code 127）。

请求方法

在发送鉴权请求时 veImageX 所使用的请求方法。支持以下配置：

• 跟随用户请求的方法：表示鉴权请求使用的方法与用户请求相同。
• GET：表示鉴权请求使用 GET 方法。
• POST：表示鉴权请求使用 POST 方法。
• HEAD：表示鉴权请求使用 HEAD 方法。

用户请求参数

表示哪些用户请求 URL 中的查询参数包含在鉴权请求中。支持以下配置：

• 保留全部参数：鉴权请求包括用户请求 URL 中的所有查询参数。
• 删除全部参数：鉴权请求不包括用户请求 URL 中的任何查询参数。
• 保留部分参数：鉴权请求包括用户请求 URL 中的指定的查询参数。

参数清单

如果用户请求参数是保留部分参数，该配置才会出现。该配置表示用户请求 URL 中的哪些查询参数需要包括在鉴权请求中。需要遵循的规则如下：

• 多个参数使用英文分号 (;) 分隔。
• 总长度不能超过 1,024 个字符。
• 参数名称是大小写敏感的，可以包含可打印 ASCII 字符。但不支持以下字符： 空格、双引号（"）、Delete（ASCII code 127）

添加鉴权请求参数

该配置表示您需要额外添加的查询参数。最多支持添加 50 个规则。

• 请求参数名称：您需要添加的一个查询参数的名称。参数名称不能超过 1,024 个字符，可以包含可打印 ASCII 字符。但不支持以下字符：双引号（"）、空格、Delete（ASCII code 127）
• 取值方式：该查询参数的值是如何定义的。支持以下配置：
  • 常量：该参数值是一个固定值，类型是字符串。
  • 变量：该参数的值来自一个变量。参见变量字段说明。
• 参数取值：该查询参数的值。该配置的说明如下：
  • 如果取值方式是常量，您指定一个固定值作为该参数的值，长度不能超过 1,024 个字符。该参数值不能以美元符号（$）开头，可以包含除了以下字符的可打印 ASCII 字符：双引号（"）、Delete（ASCII code 127）
  • 如果取值方式是变量，您需要从列表中选择一个变量。您选择的变量的值会作为该参数的值。

HOST 请求头

鉴权请求中 HOST 头部的值。支持以下配置：

• 加速域名：表示 HOST 头部的值与加速域名相同。
• 自定义：表示一个指定的 HOST 头部值。

自定义请求 HOST

如果HOST 请求头是自定义，该配置才会出现。在该配置中，您需要输入一个 HOST 头部的值。需要遵循的规则如下：

• 长度不能超过 1,024 个字符。
• 符合请求头名称格式。
• 头部清单不能重复。

用户其他请求头

表示哪些用户请求中的请求头包含在鉴权请求中。支持以下配置：

• 保留全部头部：鉴权请求包含用户请求中的所有请求头。
• 删除全部头部：鉴权请求不包含任何用户请求中请求头。
• 保留部分头部：鉴权请求包含用户请求中的指定请求头。

头部清单

如果用户请求头是保留部分头部，该配置才会出现。该配置指定需要包含在鉴权请求中的请求头。多个请求头用分号 (;) 分隔。请求头大小写不敏感，不能是 Host，。需要遵循的规则如下：

• 长度不能超过 1,024 个字符。
• 符合请求头名称格式。
• 头部清单不能重复。

取值方式

表示该请求头的值是如何定义的。支持以下配置：

• 常量：表示该请求头的值是一个固定值，类型是字符串。
• 变量：表示该请求头的值来自一个变量。参见变量字段说明。

参数取值

表示该请求头的值。该配置的说明如下：

• 如果取值方式是常量，您指定一个固定值作为该请求头的值。该值的长度不能超过 1,024 个字符，不能以美元符号（$）开头，可以包含可打印 ASCII 字符，但不支持以下字符：双引号（"）、Delete（ASCII code 127）。
• 如果取值方式是变量，您需要从列表中选择一个变量。您选择的变量的值会作为该请求头的值。

鉴权成功状态码

从鉴权服务器返回的状态码中，哪些被认为是鉴权成功。默认值是 200。

• 您可以输入范围在 200-299 中的一个或者多个状态码。
• 多个状态码使用分号（;）分隔。您也可以输入 2xx 表示 200-299 范围中的任意一个状态码。

鉴权失败状态码

表示从鉴权服务器返回的状态码中，哪些被认为是鉴权失败。默认值是 401。

• 您可以输入范围在 400-499 中的一个或者多个状态码。多个状态码使用分号（;）分隔。
• 您也可以输入 4xx 表示 400-499 范围中的任意一个状态码。

其他状态码

该配置表示在满足以下所有条件时，veImageX 对用户请求的处理方式。

• 鉴权服务器返回的状态码不是您指定的表示鉴权成功的状态码。
• 鉴权服务器返回的状态码不是您指定的表示鉴权失败的状态码。

支持以下配置：

• 默认放行：表示 veImageX 认为用户请求鉴权成功，并将请求的文件返回给用户。
• 默认拦截：表示 veImageX 认为用户请求鉴权失败，拒绝该用户请求。

鉴权结果缓存

表示 veImageX 是否缓存鉴权结果，也就是鉴权服务器返回的鉴权状态码。您可以设置该配置为 开启 或者 关闭。默认是 关闭。

在开启该配置后，对于收到的用户请求，veImageX 会检测该请求的鉴权状态码是否已被缓存。如果鉴权状态码已被缓存，veImageX 则使用该鉴权状态码来确定是否将请求的文件发送给用户。

缓存key

表示缓存的鉴权状态码中所包含的字段。这些字段是您在该配置中定义的。每个鉴权状态码都有一个唯一的缓存key。该配置仅在 鉴权结果缓存 为 开启 的情况下才出现。

同时，veImageX 通过缓存 key 来判断用户请求是否命中了鉴权状态码的缓存。 当收到一个请求时，veImageX 尝试使用请求中的字段来匹配缓存 key。如果找到了匹配，veImageX 就会使用该缓存的鉴权状态码。

异常执行策略

该配置表示鉴权异常发生时，veImageX处理用户请求的方式。支持以下配置：

• 默认放行：表示 veImageX 认为用户请求鉴权成功，并将请求的文件返回给用户。
• 默认拦截：表示 veImageX 认为用户请求鉴权失败，拒绝该用户请求。

鉴权异常包括但不限于以下情况：

• 鉴权请求超时。
• 鉴权服务器拒绝了鉴权请求。
• veImageX 无法与鉴权服务器建立连接。