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

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

Aperta Adatta ai principianti
#164 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Python
Stelle
2
Fork
4
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
aws, python
Ambito
cloud, documentation, security
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Tranquilla
Chiarezza
Abbastanza chiara
Idoneità per principianti
68/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.