ItsDangerous Documentation (1.1.x) Release 1.1.0

• 语言: 英语
• 格式: .pdf
• 来源: itsdangerous.palletsprojects.com

摘要

文档介绍了Python库itsdangerous的功能，包括签名接口、序列化接口和异常处理。1.1.0版本恢复了SHA-1作为默认签名算法，并添加了对SHA-512的回退支持。文档还详细说明了如何使用盐来命名不同的签名上下文，并介绍了对JSON Web Signature (JWS)的支持。此外，文档涵盖了不同版本的更新和功能改进，如支持不同的序列化工具和异常处理机制。

AI总结

### ItsDangerous 1.1.x 版本发布说明总结

#### 1. 版本更新概述
- **1.1.0 版本（2018-10-26）**
- 将默认签名算法从 SHA-512 重新改为 SHA-1，以修复因 1.0.0 版本更改默认算法引发的兼容性问题。
- 增加了对 SHA-512 的默认回退支持，以兼容使用 1.0.0 版本的用户。
- 支持在反序列化过程中使用回退算法，以避免未来版本更改默认算法时破坏现有签名。
- 将包名从驼峰式改为小写，修复了因命名变化导致的部分工具链问题。

- **1.0.0 版本（2018-10-18，已下架）**
- 默认签名算法改为 SHA-512，但因引发兼容性问题，该版本被从 PyPI 下架。
- 支持 Python 3.4 及以上版本，不再支持 Python 2.6 和 3.3。
- 将代码重构为包形式，部分 API 导入方式发生变化，未来版本将逐步移除兼容性导入。

#### 2. 核心功能
- **签名接口**
- 提供基于 HMAC 的签名功能，支持多种哈希算法（如 SHA-1、SHA-512 等）。
- 支持时间戳签名，用于验证签名的有效期。

- **序列化接口**
- 提供 URL 安全序列化功能，生成的签名字符串包含 URL 安全字符（如字母、数字、`-_` 等）。
- 支持 JSON Web 签名（JWS），符合 RFC 7515 标准，支持自定义头字段和序列化方式。

- **异常处理**
- 提供 `BadSignature` 和 `BadData` 等异常，帮助开发者快速定位签名或数据验证失败的问题。
- 在签名验证失败时，可通过异常对象获取原始签名数据，便于调试。

- **盐（Salt）的作用**
- 盐用于区分不同用途的签名，防止签名被滥用。
- 盐的值不会影响签名的安全性，但会影响签名的唯一性和兼容性。

#### 3. 其他功能
- **时间戳签名**
- 支持在签名中包含时间戳，用于验证签名的有效期。
- 时间戳签名适用于短期有效链接或令牌。

- **JSON Web 签名（JWS）**
- 支持生成和验证符合 JWS 标准的签名字符串。
- 默认使用 HMAC-SHA512 算法，可通过参数自定义算法和头字段。

#### 4. 兼容性与安全性
- **兼容性**
- 1.1.x 版本保持与之前版本的兼容性，用户无需修改代码即可升级。
- 未来版本将逐步移除部分兼容性接口，建议开发者及时更新代码。

- **安全性**
- 默认使用 SHA-1 算法，兼顾安全性和性能。
- 支持 SHA-512 回退机制，确保兼容性与安全性并存。

#### 5. 总结
ItsDangerous 1.1.x 版本在保持核心功能的同时，修复了 1.0.0 版本的兼容性问题，提供了更灵活的签名算法选择和更好的异常处理机制。开发者在使用时应关注盐的正确使用、签名算法的选择以及时间戳的有效期设置，以确保签名的安全性和可靠性。