Skip to content

Commit 12a1dc9

Browse files
authored
doc: clarify JceMasterKey supported algorithms (#761)
1 parent ec38abe commit 12a1dc9

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

src/main/java/com/amazonaws/encryptionsdk/jce/JceMasterKey.java

+7-6
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,9 @@ public class JceMasterKey extends MasterKey<JceMasterKey> {
4444
private final JceKeyCipher jceKeyCipher_;
4545

4646
/**
47-
* Returns a {@code JceMasterKey} backed by {@code key} using {@code wrappingAlgorithm}. Currently
48-
* "{@code AES/GCM/NoPadding}" is the only supported value for {@code wrappingAlgorithm}.
47+
* Returns a {@code JceMasterKey} backed by the symmetric key {@code key} using {@code
48+
* wrappingAlgorithm}. Currently "{@code AES/GCM/NoPadding}" is the only supported value for
49+
* symmetric {@code wrappingAlgorithm}s.
4950
*
5051
* @param key key used to wrap/unwrap (encrypt/decrypt) {@link DataKey}s
5152
* @param provider
@@ -67,10 +68,10 @@ public static JceMasterKey getInstance(
6768
}
6869

6970
/**
70-
* Returns a {@code JceMasterKey} backed by {@code unwrappingKey} and {@code wrappingKey} using
71-
* {@code wrappingAlgorithm}. Currently only RSA algorithms are supported for {@code
72-
* wrappingAlgorithm}. {@code wrappingAlgorithm}. If {@code unwrappingKey} is {@code null} then
73-
* the returned {@link JceMasterKey} can only be used for encryption.
71+
* Returns a {@code JceMasterKey} backed by the asymmetric key pair {@code unwrappingKey} and
72+
* {@code wrappingKey} using {@code wrappingAlgorithm}. Currently only RSA algorithms are
73+
* supported for asymmetric {@code wrappingAlgorithm}s. If {@code unwrappingKey} is {@code null}
74+
* then the returned {@link JceMasterKey} can only be used for encryption.
7475
*
7576
* @param wrappingKey key used to wrap (encrypt) {@link DataKey}s
7677
* @param unwrappingKey (Optional) key used to unwrap (decrypt) {@link DataKey}s.

0 commit comments

Comments
 (0)