aws / aws/aws-encryption-sdk-python

Document that non-Encryption SDK exceptions can be raised

Offen
#322 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
Python
Sterne
255
Forks
92
Ø Merge
2 T. 17 Std.
Gemergte PRs (30 T.)
2

Beschreibung

The API documentation for the Python Encryption SDK lists [custom exception types](https://aws-encryption-sdk-python.readthedocs.io/en/latest/generated/aws_encryption_sdk.exceptions.html), but the APIs may let through exceptions from underlying libraries (e.g. `InvalidTag` and `InvalidSignature`) from pyca/cryptography. We should add a note to the documentation stating this.

Alternatively (or additionally) we can try to wrap these kind of exceptions into Encryption SDK custom exceptions with additional context.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne mit der API-Dokumentation für das Python Encryption SDK und der im Issue verlinkten Seite zu den generierten Exceptions; prüfe, wie benutzerdefinierte Exception-Typen derzeit beschrieben werden. Als erledigt gilt die Aufgabe, wenn in der Dokumentation klar darauf hingewiesen wird, dass zugrunde liegende Kryptografie-Exceptions wie InvalidTag und InvalidSignature weitergegeben werden können, sofern das Projekt nicht die alternative Möglichkeit wählt, sie zu wrappen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

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

Neue Issues direkt in Ihr Postfach

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