Nginx Secure Token Module 使用教程

Nginx Secure Token Module 使用教程

1. 项目目录结构及介绍

nginx-secure-token-module/
├── ngx_http_secure_token_m3u8
│   ├── ngx_http_secure_token_processor_base.c
│   ├── ngx_http_secure_token_processor_base.h
│   ├── ngx_http_secure_token_utils.c
│   ├── ngx_http_secure_token_utils.h
│   ├── ngx_http_secure_token_xml.c
│   └── ngx_http_secure_token_xml.h
├── travis_build.sh
├── README
└── AGPL-3.0

目录结构说明

• ngx_http_secure_token_m3u8/: 包含与安全令牌处理相关的源文件和头文件。
  • ngx_http_secure_token_processor_base.c: 处理安全令牌的基础逻辑。
  • ngx_http_secure_token_processor_base.h: 处理安全令牌的基础头文件。
  • ngx_http_secure_token_utils.c: 安全令牌的工具函数。
  • ngx_http_secure_token_utils.h: 安全令牌的工具头文件。
  • ngx_http_secure_token_xml.c: 处理XML格式的安全令牌。
  • ngx_http_secure_token_xml.h: 处理XML格式的安全令牌头文件。
• travis_build.sh: Travis CI 构建脚本。
• README: 项目说明文档。
• AGPL-3.0: 项目许可证文件。

2. 项目启动文件介绍

项目的主要启动文件是 ngx_http_secure_token_processor_base.c，它包含了安全令牌处理的核心逻辑。该文件负责生成和验证CDN令牌，支持Akamai v2令牌和Amazon CloudFront令牌。

启动文件功能

• 令牌生成: 根据配置生成CDN令牌，可以作为cookie或查询字符串参数。
• 令牌验证: 验证请求中的令牌是否有效。
• URI加密: 支持对URI进行加密。

3. 项目配置文件介绍

项目的配置主要通过Nginx的配置文件进行。以下是一些关键的配置指令：

配置指令

• secure_token_avoid_cookies: 控制是否使用查询字符串令牌而不是cookie令牌。

  • 默认值: on
  • 上下文: http, server, location

• secure_token_types: 定义应返回令牌的MIME类型。

  • 默认值: none
  • 上下文: http, server, location

• secure_token_uri_filename_prefix: 定义URI文件名前缀，只有匹配前缀的URI才会返回令牌。

  • 默认值: none
  • 上下文: http, server, location

示例配置

http {
    server {
        location / {
            secure_token_avoid_cookies off;
            secure_token_types application/vnd.apple.mpegurl;
            secure_token_uri_filename_prefix /secure/;
        }
    }
}

配置说明

• secure_token_avoid_cookies: 设置为off，表示使用cookie令牌。
• secure_token_types: 设置为application/vnd.apple.mpegurl，表示只对M3U8格式的文件返回令牌。
• secure_token_uri_filename_prefix: 设置为/secure/，表示只有URI以/secure/开头的文件才会返回令牌。

通过以上配置，可以灵活控制安全令牌的生成和验证逻辑，确保资源的安全访问。