Skip to content

8350147: Replace example in KEM class with the one from JEP 452 #23652

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
bradfordwetmore wants to merge 3 commits into from
Closed

8350147: Replace example in KEM class with the one from JEP 452 #23652

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d0a9900
8350147: Replace example in KEM class with the one from JEP 452
bradfordwetmore Feb 15, 2025
70a3ae8
Codereview Comments from Weijun
bradfordwetmore Feb 15, 2025
fa3d293
Further codereview Comments from Weijun
bradfordwetmore Feb 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 30 additions & 14 deletions src/java.base/share/classes/javax/crypto/KEM.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,24 +65,40 @@
* new shared secret and key encapsulation message.
* <p>
*
* Example:
* Example operation using a ficticious {@code KEM} algorithm {@code ABC}:
Copy link
Member

@seanjmullan seanjmullan Feb 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo: s/ficticious/fictitious/

Copy link
Contributor Author

@bradfordwetmore bradfordwetmore Feb 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will fix in JDK-8350476

* {@snippet lang = java:
* // Receiver side
* var kpg = KeyPairGenerator.getInstance("X25519");
* var kp = kpg.generateKeyPair();
* // Receiver side
* KeyPairGenerator g = KeyPairGenerator.getInstance("ABC");
* KeyPair kp = g.generateKeyPair();
* publishKey(kp.getPublic());
*
* // Sender side
* var kem1 = KEM.getInstance("DHKEM");
* var sender = kem1.newEncapsulator(kp.getPublic());
* var encapsulated = sender.encapsulate();
* var k1 = encapsulated.key();
* // Sender side
* KEM senderKEM = KEM.getInstance("ABC");
* PublicKey receiverPublicKey = retrieveKey();
* ABCKEMParameterSpec senderSpec = new ABCKEMParameterSpec(args);
* KEM.Encapsulator e = senderKEM.newEncapsulator(
* receiverPublicKey, senderSpec, null);
* KEM.Encapsulated enc = e.encapsulate();
* SecretKey senderSecret = enc.key();
*
* // Receiver side
* var kem2 = KEM.getInstance("DHKEM");
* var receiver = kem2.newDecapsulator(kp.getPrivate());
* var k2 = receiver.decapsulate(encapsulated.encapsulation());
* sendBytes(enc.encapsulation());
* sendBytes(enc.params());
*
* assert Arrays.equals(k1.getEncoded(), k2.getEncoded());
* // Receiver side
* byte[] ciphertext = receiveBytes();
* byte[] params = receiveBytes();
*
* KEM receiverKEM = KEM.getInstance("ABC");
* AlgorithmParameters algParams =
* AlgorithmParameters.getInstance("ABC");
* algParams.init(params);
* ABCKEMParameterSpec receiverSpec =
* algParams.getParameterSpec(ABCKEMParameterSpec.class);
* KEM.Decapsulator d =
* receiverKEM.newDecapsulator(kp.getPrivate(), receiverSpec);
* SecretKey receiverSecret = d.decapsulate(ciphertext);
*
* // senderSecret and receiverSecret should now be equal.
* }
*
* @since 21
Expand Down