aws / aws/aws-encryption-sdk-java

JavaDocs: Document replacement methods for MKP methods

Đang mở
#2,040 1 bình luận 1 reaction 0 người được giao Xem trên GitHub
Ngôn ngữ chính
Java
Star
240
Fork
125
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

### Issue
Crypto Tools marked all MasterKeyProvider methods as deprecated, but did not revise their JavaDocs to state which methods should be used instead.

This is a source of customer confusion, as it is not clear that customers should use the Keyring methods instead.

_As originally posted by @jumarko in https://github.com/aws/aws-encryption-sdk-java/pull/1864#discussion_r1665561054_

Are these deprecations documented anywhere?
The javadoc doesn't say anything about what should be used instead.

### Suggested Fix
Revise the Java Docs for the Master Key Providers so that they details which methods replace the marked as deprecated methods.

Either remove the deprecation notice from the Caching Cryptographic Materials Manager methods or [implement support for the CachingCMM with Keyrings](https://github.com/aws/aws-cryptographic-material-providers-library/issues/480).

#### Related Issues
- https://github.com/aws/aws-encryption-sdk-java/issues/2035
- https://github.com/aws/aws-encryption-sdk-java/issues/2033

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

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

Hướng nghiên cứu

Tìm JavaDocs cho các phương thức đã lỗi thời của MasterKeyProvider và các phương thức của Caching Cryptographic Materials Manager. Đọc các issue liên quan 2035 và 2033, sau đó so sánh các API đã lỗi thời với các phương thức Keyring mà chúng tham chiếu. Công việc được xem là hoàn tất khi phần thay thế cho từng phương thức đã lỗi thời được ghi lại và câu hỏi về Caching CMM đã được giải quyết hoặc ghi lại một cách rõ ràng.

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

Đánh giá

Công nghệ
java
Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
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
42/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.