aws / aws/aws-encryption-sdk-python
Document that non-Encryption SDK exceptions can be raised
- 主要言語
- Python
- スター
- 255
- フォーク
- 92
- 平均マージ
- 2日 17時間
- マージ済み PR(30日)
- 2
説明
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.
コントリビューションガイド
調査の方向性
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.
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- cryptography, python
- 領域
- documentation, security
- issue の種類
- ドキュメント
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 45/100