aws / aws/aws-encryption-sdk-python

Document that non-Encryption SDK exceptions can be raised

Aperta
#322 1 commento 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Python
Stelle
255
Fork
92
Merge medio
2g 17h
PR unite (30g)
2

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia dalla documentazione dell’API del Python Encryption SDK e dalla pagina delle eccezioni generate collegata nell’issue; verifica come vengono attualmente descritti i tipi di eccezioni personalizzate. Il lavoro è completato quando la documentazione indica chiaramente che le eccezioni crittografiche sottostanti, come InvalidTag e InvalidSignature, possono propagarsi, a meno che il progetto non scelga l’alternativa di racchiuderle.

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

Valutazione

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

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.