aws / aws/amazon-s3-encryption-client-python

Make sure that the Docs clarify stream length is not always plaintext length

未关闭 适合新手
#164 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
Python
星标
2
派生
4
PR 合并指标
30 天内没有已合并 PR

描述

The S3EC attempts to be as "transparent" as possible when applying client-side encryption. For example, PutObject/GetObject "just works". A deeper example is ranged gets - in Java, a ranged get request will apply to the plaintext range, the customer does not need to manually adjust the range to account for encrypted blocks.

However, there is one aspect that is seemingly not possible, which is contentLength of the GetObject stream. It includes the auth tag. Customers need to read the entire thing, which is their original message length + auth tag (or padding in the case of CBC).

This needs to be well-documented.

贡献指南

打开贡献指南

调研方向

先从 S3EC GetObject streams 和 contentLength 的文档开始,然后验证 authenticated encryption 和 CBC padding 如何影响客户必须读取的字节数。完成的标准是,文档清楚地区分 stream 长度和原始 plaintext 长度,并说明必须读取完整的 stream。

由索引模型根据 Issue 内容生成。

评估

技术栈
aws, python
领域
cloud, documentation, security
Issue 类型
文档
难度
2/5
预计耗时
1-3 小时
活跃度
冷清
描述清晰度
基本清楚
新手友好度
68/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。