You need to enable JavaScript to run this app.
导航

D 类型配置

最近更新时间2024.01.10 15:50:26

首次发布时间2023.08.16 16:38:19

本文档介绍火山引擎内容分发网络中 URL 鉴权模块的 D 类型配置。

alt

控制台中的配置

在内容分发网络控制台中,您需要做以下配置:

配置说明

生效对象

表示哪些文件的请求需要被鉴权。您至少需要添加一个对象,最多可以添加 50 个对象。您需要指定多个对象之间的条件关系。 这个条件关系表示匹配任何一个对象的请求就会被鉴权。 表示只有匹配所有对象的请求才会被鉴权。在设置对象时,您可以指定以下配置:

  • 文件后缀:表示满足指定后缀名匹配条件的文件请求需要被鉴权。匹配时区分大小写。指定的文件后缀可以包含英文字母和数字。多个文件后缀使用分号(;)分隔,长度不超过 1,024 个字符。例如 png;txt

  • 文件目录:表示满足指定目录匹配条件的文件请求需要被鉴权。匹配时区分大小写。您可以输入一个或者多个目录路径,总长度不能超过 1,024 个字符。多个目录路径使用分号分隔。目录路径的输入要求如下:

    • 目录路径必须以斜杠(/)开头和结尾。比如 /www/img/volc/;/www/doc/。如果要指定加速域名下的所有目录,输入 /

    • 目录路径只能包含可打印 ASCII 字符,以下字符除外:

      • 连续斜杠(//)、百分号(%)、空格、美元符号($)、问号(?)、Delete(ASCII code 127)。
  • 文件全路径:表示满足指定文件匹配条件的请求需要被鉴权。匹配时区分大小写。您可以输入一个或者多个文件路径,总长度不能超过 1,024 个字符。文件路径支持使用通配符(*)表示一个或者多个连续字符。多个文件路径使用分号分隔。文件路径的输入要求如下:

    • 文件路径必须以斜杠(/)开头。例如/www/img/image.png;/doc/study.docx

    • 文件路径只能包含可打印 ASCII 字符,以下字符除外:

      • 连续斜杠(//)、百分号(%)、空格、美元符号($)、问号(?)、Delete(ASCII code 127)。
主 KEY指定一个主密钥。密钥由 6-40 个字符组成,只能包含除了 Delete(ASCII code 127)的可打印 ASCII 字符。
备 KEY指定一个备密钥。密钥的输入要求与主 Key 相同。如果鉴权失败,内容分发网络会使用备密钥再计算一次签名并尝试与请求中的签名比对。

签名参数

指定请求的签名参数名称。参数名称的说明如下:

  • 不能超过 100 个字符。

  • 大小写敏感。

  • 可以包含字母、数字、下划线(_)、中划线(-)、句号(.)、逗号(,)、感叹号(!)。

  • 至少包含一个字母或者数字。

  • 不能与时间戳参数相同。

  • 控制台中默认的签名参数是 sign

有效时间指定签名的有效时间,单位是秒。该配置与客户端请求中的 timestamp 参数搭配使用,用来计算签名的过期时间。该参数的取值范围是 0-315,360,000。签名的过期时间 = timestamp + 有效时间。在内容分发网络收到某个请求时,如果请求中包含的签名的过期时间早于当前时间,内容分发网络判定签名已过期。此时,内容分发网络返回 403 响应状态码,表示鉴权失败。控制台中默认的有效时间是 1800

时间戳参数

指定请求的时间戳参数的名称。参数名称的说明如下:

  • 不能超过 100 个字符。

  • 大小写敏感。

  • 可以包含字母、数字、下划线(_)、中划线(-)、句号(.)、逗号(,)、感叹号(!)。

  • 不能与签名参数相同。

  • 控制台中默认的签名参数是 t

时间格式指定 Unix 时间戳的格式。

M3U8 改写

表示在响应一个 .m3u8 文件的请求时,内容分发网络是否对 .m3u8 文件中每个分片文件的 URL 添加签名参数。每个分片 URL 的签名是基于改写后分片 URL,使用签名规则计算的。

该配置还包含以下配置:

  • 分片 URL 原参数:表示在改写分片 URL 时是否保留 URL 中原有的参数。

  • 继承 M3U8 非签名参数:表示是否将来自该 M3U8 文件请求的不表示签名的查询参数添加到分片 URL 中。

需要留意的是,这两个配置会影响分片 URL 的签名计算。
例子:有一个分片 URL 是 /video.ts?version=1。您设置 分片 URL 原参数删除继承 M3U8 非签名参数开启,用户的 M3U8 请求中的查询参数是 q_m3u8=cool。那么改写后的分片 URL 是 /video.ts?q_m3u8=cool,该分片的签名是基于这个改写后的 URL 计算的。

在更新分片 URL 时,内容分发网络可以识别以下格式:

  • 绝对路径的 URL。例如 https://example.com/xxx/yyy/song.ts

  • 以根目录路径开头的 URL。例如 /xxx/yyy/song.ts

  • 以相对路径开头的 URL。例如 yyy/song.ts

对于其他不符合规范的 URL 格式,内容分发网络可能会无法识别,导致签名参数添加失败。

客户端请求格式

scheme://host/uri?sign=\<signature\>&t=timestamp(&...)

请求示例

https://www.example.com/product/cdn?sign=e954e253c33634b510443af72406600f&t=1620291453&query1=value1&query2=value2

签名计算公式

签名 <SIGNATURE> 的计算公式如下:

md5(key + uri + timestamp)

说明

  • 公式中的 + 表示参数值的拼接,并不是实际的字符。

  • MD5 的值是 32 位的。

签名计算公式中各参数的说明如下:

参数描述
key表示在内容分发网络控制台配置的密钥。
uri表示请求 URL 中的 uri 参数,以斜杠(/)开头,不包含域名。如果路径包含中文字符,您需要对路径编码。在请求示例中,该参数值是 /product/cdn
timestamp表示请求 URL 中的 timestamp 参数。该参数与控制台中的 有效时间 配置搭配使用,用来计算签名的过期时间。根据控制台中的 时间格式 配置,时间格式使用十进制或十六进制的 Unix 时间戳。在请求示例中,该参数值是 1620291453,是一个十进制 Unix 时间戳。

鉴权流程

在收到包含签名的客户端请求时,内容分发网络使用的鉴权流程如下:

  1. 基于请求中包含的鉴权参数以及您在内容分发网络控制台中配置的 key,使用签名计算公式计算签名。

  2. 判断内容分发网络计算得到的签名和客户端请求中包含的签名是否一致。如果不一致,内容分发网络判断请求不合法,拒绝该请求。

  3. 判断请求是否过期。如果存在以下情况,内容分发网络判断请求过期,拒绝该请求。

    • (客户端请求中的 timestamp 参数) + (您在内容分发网络控制台中配置的有效时间) < (内容分发网络收到该请求的时间)