You need to enable JavaScript to run this app.
导航
视频点播
  • 文档首页
    • /视频点播/控制台指南/分发加速设置/配置域名/访问控制/配置 URL 鉴权/A 类型说明
A 类型说明
最近更新时间：2024.08.01 16:27:19首次发布时间：2023.08.23 19:50:16
我的收藏

本文为您详细介绍 A 类型鉴权方式的工作原理并提供鉴权示例。

适用范围

本文仅适用于自定义源站加速域名。

工作原理

A 类型鉴权方式的工作原理说明如下：

  • 鉴权 URL 构成：

    scheme://host/uri?sign=timestamp-rand-uid-md5(uri-timestamp-rand-uid-key)(&...)

  • 鉴权 URL 示例：

    https://www.example.com/img/volcano.png?sign=1644406401-2e1ca42a1bb248408fc9cf435e5af744-0-54959c1ec3448bf8e992554476248fab

  • 鉴权参数说明如下：

    参数

    描述

    uri

    请求的文件路径。路径以斜杠 / 开头，不包含域名。比如请求的完整路径为 https://www.example.com/image.png，则 uri 的值为 /image.png。如果路径包含中文字符，您需要对路径编码。

    timestamp

    鉴权 URL 的生成时间，为十进制的 Unix 时间戳。该参数与您在视频点播控制台中配置的有效时长搭配使用，用来计算签名的失效时间。签名的失效时间 = timestamp + 有效时长。示例：1644406401。

    rand

    随机字符串。长度为 1-100 位。可以包含字母和数字。示例：2e1ca42a1bb248408****f435e5af744。

    uid

    用户 ID。预留参数，暂未使用。设置成 0 即可。

    key

    您在视频点播控制台配置的密钥。可以使用主密钥或者备密钥。

  • 鉴权流程：

    1. CDN 节点收到客户端的带签名请求后，使用 MD5 算法，基于 md5(uri-timestamp-rand-uid-key) 公式计算签名值。MD5 值在鉴权时会转化成小写进行比较。

      说明

      MD5 值为 32 位。

    2. CDN 节点进行以下校验：
      1. 判断服务端计算出的签名值和客户端请求 URL 中的签名值是否一致。
      2. 判断签名是否过期。CDN 节点会将“timestamp+ 您在视频点播控制台配置的有效时长”跟当前时间进行对比。如果签名的过期时间早于当前时间，视频点播判定签名已过期；反之，则判定签名有效。
    3. 根据检验结果，返回资源请求或 HTTP 403 错误。

控制台配置说明

对于 A 类型鉴权方式，您可以在视频点播控制台中配置以下参数：
图片

参数

说明

生效对象

表示对哪些文件的请求需要被鉴权。您至少需要添加一个规则，最多可以添加 10 个。
您可以指定多个规则之间的关系：

  • 默认是任一，表示匹配任何一个规则的请求就会被鉴权。
  • 所有表示只有匹配所有规则的请求才会被鉴权。

每条规则包含以下配置：

  • 条件类型：支持以下选项：
    • 文件目录：规则应用于特定目录下的所有文件。
    • 文件后缀：规则应用于特定后缀名的所有文件。
    • 文件全路径匹配：规则应用于特定文件。
  • 是否匹配：可设为匹配或不匹配。
  • 规则：根据规则类型，输入规则的内容。长度不能超过 1,024 个字符。不能包含以下字符：连续斜杠 //、空格、美元符号 $ 、问号 ?、Delete（ASCII code 127）。不同规则类型的具体要求如下：
    • 如果规则类型是文件后缀，规则内容必须是一个或者多个以分号 ; 分隔的文件后缀。文件后缀无需以句点 . 开头。示例：png;txt。
    • 如果规则类型是文件目录，规则内容必须是一个或者多个以分号 ; 分隔的目录路径。目录路径必须以斜杠 / 开头和结尾。示例：/chs/foods/;/us/birds/。
    • 如果规则类型是文件全路径，规则内容必须是一个或者多个以分号 ; 分隔的文件路径。文件路径必须以斜杠 / 开头，可以包含星号 * 用来表示一个或者多个字符。示例：/chs/foods/local*sets;/us/birds/chickadee。

主 Key

主密钥。长度限制为 6-40 个字符，只能包含可打印 ASCII 字符，Delete（ASCII code 127）除外。不支持纯空白字符。

备 Key

备密钥。长度限制为 6-40 个字符，只能包含可打印 ASCII 字符，Delete（ASCII code 127）除外。不支持纯空白字符。

说明

对线上业务域名变更 URL 鉴权时，建议在过渡期使用备 Key，避免业务中断。

签名参数

请求的签名参数名称。不能超过 100 个字符。大小写敏感。可以包含字母、数字、下划线 _、中划线 -、句号 .、逗号 ,、感叹号 !。至少包含一个字母或者数字。签名参数与时间戳参数不能同名。

说明

  • 对于自定义源站加速域名，默认的签名参数名称是 sign。
  • 对于点播加速域名，默认的签名参数是 auth_key。

有效时间

签名的有效时长。该参数与客户端请求中的 timestamp 参数搭配使用，用来计算签名的失效时间。签名的失效时间 = timestamp + 有效时长。您可指定一个时间单位并输入时间。默认的有效时长是 30 分。您可以指定的最长时间是 10 年，也就是 315,360,000 秒。具体说明如下：

  • 如果您指定的时间单位是秒，您可以输入的最大值是 315360000。
  • 如果您指定的时间单位是分，您可以输入的最大值是 5256000。
  • 如果您指定的时间单位是小时，您可以输入的最大值是 87600。
  • 如果您指定的时间单位是天，您可以输入的最大值是 3650。

时间格式

固定为十进制（Unix 时间戳）。

m3u8 改写

表示在响应 .m3u8 文件的请求时，是否对 .m3u8 文件中每个分片文件的 URL 添加签名参数。每个分片 URL 的签名是基于改写后分片 URL，使用签名规则计算的。开启该配置后，您还可进行以下配置：

  • 分片 URL 原参数：在改写分片 URL 时是否保留 URL 中原有的参数。默认保留。
  • m3u8 非签名参数：是否将来自该 M3U8 文件请求的不表示签名的查询参数添加到分片 URL 中。默认不继承。

说明

  • 对于点播加速域名，m3u8 改写默认开启。
  • 对于自定义源站加速域名，m3u8 改写默认关闭。

鉴权示例

以下示例可以帮助您准确理解鉴权方式 A 的实现方式。

示例条件

本示例中，假设带签名的请求 URL 为：

https://www.example.com/img/volcano.png?auth_key=1644406401-2e1ca42a1bb248408fc9cf435e5af744-0-54959c1ec3448bf8e992554476248fab

根据以上 URL，各鉴权参数的取值具体如下：

  • uri 的值为 /img/volcano.png。
  • timestamp 的值为 1644406401，表示鉴权 URL 的生成时间为 2022-02-09 11:33:21 GMT。
  • rand 的值为 2e1ca42a1bb248408fc9cf435e5af744。
  • uid 的值为 0。

再假设您在视频点播控制台设置的密钥为 abc123def456，有效时长为 1800 秒。

鉴权流程

本示例中的鉴权流程如下：

  1. 视频点播 CDN 节点收到客户端的带签名请求后，使用 MD5 算法，基于 md5(uri-timestamp-rand-uid-key) 公式计算签名值。在本示例中，签名计算公式为：md5(/img/volcano.png-1644406401-2e1ca42a1bb248408fc9cf435e5af744-0-abc123def456)

  2. CDN 节点将签名值加入原始请求。得到的请求如下：

    https://www.example.com/img/volcano.png?sign=1644406401-2e1ca42a1bb248408fc9cf435e5af744-0-54959c1ec3448bf8e992554476248fab

  3. CDN 节点验证请求合法性：

    1. 判断该请求和客户端请求是否一致。本示例中两者一致。
    2. 判断请求是否过期。假设本示例中，CDN 节点收到请求的时间是 2022-02-09 11:40:21 GMT，该时间早于 “2022-02-09 11:33:21 + 1800 秒”，因此判定请求未过期。

签名工具

视频点播为 A 类型鉴权方式提供签名工具。您可前往视频点播控制台签名工具页面查看。详细使用步骤请见签名工具。