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

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

Offen Anfängerfreundlich
#164 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
Python
Sterne
2
Forks
4
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne mit der Dokumentation zu S3EC GetObject-Streams und contentLength und überprüfe anschließend, wie sich authentifizierte Verschlüsselung und CBC-Padding auf die Anzahl der Bytes auswirken, die Kunden lesen müssen. Als abgeschlossen gilt die Aufgabe, wenn die Dokumentation Stream-Länge und ursprüngliche Klartextlänge klar unterscheidet und erklärt, dass der vollständige Stream gelesen werden muss.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
aws, python
Bereich
cloud, documentation, security
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Ruhig
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
68/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.