aws / aws/amazon-s3-encryption-client-python
Make sure that the Docs clarify stream length is not always plaintext length
- Lenguaje dominante
- Python
- Estrellas
- 2
- Forks
- 4
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
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.
Guía de contribución
Línea de trabajo
Start with the documentation for S3EC GetObject streams and contentLength, then verify how authenticated encryption and CBC padding affect the bytes customers must read. Done means the docs clearly distinguish stream length from original plaintext length and explain that the complete stream must be read.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- aws, python
- Área
- cloud, documentation, security
- Tipo de issue
- Documentación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Estado de actividad
- Tranquilo
- Claridad
- Bastante claro
- Aptitud para principiantes
- 68/100