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

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

Ouverte Adaptée aux débutants
#164 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
Python
Étoiles
2
Forks
4
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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.

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par la documentation des streams S3EC GetObject et de contentLength, puis vérifiez comment le chiffrement authentifié et le padding CBC affectent les octets que les clients doivent lire. Le travail est terminé lorsque la documentation distingue clairement la longueur du stream de la longueur du texte en clair d’origine et explique que le stream complet doit être lu.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
aws, python
Domaine
cloud, documentation, security
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
Calme
Clarté
Plutôt claire
Accessibilité débutants
68/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.