PGPainless/pgpainless
PGPainless/pgpainless
1
0
Fork 0
mirror of https://github.com/pgpainless/pgpainless.git synced 2024-11-23 04:42:06 +01:00
Code Issues Releases Wiki Activity

Add documentation to SessionKey

Browse source
This commit is contained in:
Paul Schaub 2021-12-28 01:40:30 +01:00
parent f3b7286eaf
commit 6eac50c5b5
1 changed files with 27 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
pgpainless-core/src/main/java/org/pgpainless/util/SessionKey.java
View file

@ -9,24 +9,49 @@ import javax.annotation.Nonnull;
import org.bouncycastle.openpgp.PGPSessionKey;
import org.pgpainless.algorithm.SymmetricKeyAlgorithm;
/**
* A {@link SessionKey} is the symmetric key that is used to encrypt/decrypt an OpenPGP message.
* The OpenPGP message header contains a copy of the session key, encrypted for the public key of each recipient.
*/
public class SessionKey {
private SymmetricKeyAlgorithm algorithm;
private byte[] key;
private final SymmetricKeyAlgorithm algorithm;
private final byte[] key;
/**
* Constructor to create a session key from a BC {@link PGPSessionKey} object.
*
* @param sessionKey BC session key
*/
public SessionKey(@Nonnull PGPSessionKey sessionKey) {
this(SymmetricKeyAlgorithm.fromId(sessionKey.getAlgorithm()), sessionKey.getKey());
}
/**
* Create a session key object from an algorithm and a key.
*
* @param algorithm algorithm
* @param key key
*/
public SessionKey(@Nonnull SymmetricKeyAlgorithm algorithm, @Nonnull byte[] key) {
this.algorithm = algorithm;
this.key = key;
}
/**
* Return the symmetric key algorithm.
*
* @return algorithm
*/
public SymmetricKeyAlgorithm getAlgorithm() {
return algorithm;
}
/**
* Return the bytes of the key.
*
* @return key
*/
public byte[] getKey() {
byte[] copy = new byte[key.length];
System.arraycopy(key, 0, copy, 0, copy.length);