aws / aws/aws-encryption-sdk-python
Document that non-Encryption SDK exceptions can be raised
- Langage dominant
- Python
- Étoiles
- 255
- Forks
- 92
- Merge moyen
- 2 j 17 h
- PR mergées (30 j)
- 2
Description
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.
Guide de contribution
Ouvrir le guide de contribution
Piste de recherche
Start with the API documentation for the Python Encryption SDK and the generated exceptions page linked in the issue; check how custom exception types are currently described. Done means the documentation clearly notes that underlying cryptography exceptions such as InvalidTag and InvalidSignature may propagate, unless the project chooses the alternative of wrapping them.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- cryptography, python
- Domaine
- documentation, security
- Type d'issue
- Documentation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 45/100