Skip to content

doc: clarify JceMasterKey supported algorithms #761

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

Merged
merged 2 commits into from
May 12, 2022
Merged

doc: clarify JceMasterKey supported algorithms #761

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2483ced
doc: clarify JceMasterKey supported algorithms
alex-chew May 11, 2022
4957d42
format
alex-chew May 12, 2022
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
13 changes: 7 additions & 6 deletions src/main/java/com/amazonaws/encryptionsdk/jce/JceMasterKey.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,9 @@ public class JceMasterKey extends MasterKey<JceMasterKey> {
private final JceKeyCipher jceKeyCipher_;

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

/**
* Returns a {@code JceMasterKey} backed by {@code unwrappingKey} and {@code wrappingKey} using
* {@code wrappingAlgorithm}. Currently only RSA algorithms are supported for {@code
* wrappingAlgorithm}. {@code wrappingAlgorithm}. If {@code unwrappingKey} is {@code null} then
* the returned {@link JceMasterKey} can only be used for encryption.
* Returns a {@code JceMasterKey} backed by the asymmetric key pair {@code unwrappingKey} and
* {@code wrappingKey} using {@code wrappingAlgorithm}. Currently only RSA algorithms are
* supported for asymmetric {@code wrappingAlgorithm}s. If {@code unwrappingKey} is {@code null}
* then the returned {@link JceMasterKey} can only be used for encryption.
*
* @param wrappingKey key used to wrap (encrypt) {@link DataKey}s
* @param unwrappingKey (Optional) key used to unwrap (decrypt) {@link DataKey}s.
Expand Down