aws / aws/aws-encryption-sdk-java

JavaDocs: Document replacement methods for MKP methods

Offen
#2,040 1 Kommentar 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
Java
Sterne
240
Forks
125
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

### 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

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Finde die JavaDocs für die veralteten MasterKeyProvider-Methoden und die Methoden des Caching Cryptographic Materials Manager. Lies anschließend die verwandten Issues 2035 und 2033 und vergleiche dann die veralteten APIs mit den Keyring-Methoden, auf die sie verweisen. Als abgeschlossen gilt die Aufgabe, wenn der Ersatz für jede veraltete Methode dokumentiert ist und die Frage zum Caching CMM geklärt oder eindeutig dokumentiert wurde.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
java
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
42/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.