search

aws / aws-encryption-sdk-java

AWS Encryption SDK
https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/introduction.html
Apache License 2.0
218 stars 121 forks source link

JavaDocs: Document replacement methods for MKP methods #2040

Open texastony opened 1 week ago

texastony commented 1 week ago

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.

Related Issues

jumarko commented 1 week ago

Awesome, thanks for the quick action.