aws / aws/aws-encryption-sdk-python

Document that non-Encryption SDK exceptions can be raised

Đang mở
#322 1 bình luận 0 reaction 0 người được giao Xem trên GitHub
Ngôn ngữ chính
Python
Star
255
Fork
92
Merge trung bình
2 ngày 17 giờ
Pull request đã merge (30 ngày)
2

Mô tả

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.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
cryptography, python
Lĩnh vực
documentation, security
Loại issue
Tài liệu
Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
45/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.