mirror of
https://github.com/pgpainless/pgpainless.git
synced 2024-12-23 03:17:58 +01:00
Kotlin conversion: EncryptionBuilder + Interface
This commit is contained in:
parent
bbd956dbb7
commit
e9caa4af1f
GPG key ID:
62BEE9264BF17311
4 changed files with 95 additions and 115 deletions
|
|
@ -1,77 +0,0 @@
|
||||||
// SPDX-FileCopyrightText: 2018 Paul Schaub <vanitasvitae@fsfe.org>
|
|
||||||
//
|
|
||||||
// SPDX-License-Identifier: Apache-2.0
|
|
||||||
|
|
||||||
package org.pgpainless.encryption_signing;
|
|
||||||
|
|
||||||
import java.io.IOException;
|
|
||||||
import java.io.OutputStream;
|
|
||||||
import java.util.ArrayList;
|
|
||||||
import java.util.List;
|
|
||||||
import java.util.Set;
|
|
||||||
import javax.annotation.Nonnull;
|
|
||||||
|
|
||||||
import org.bouncycastle.openpgp.PGPException;
|
|
||||||
import org.pgpainless.PGPainless;
|
|
||||||
import org.pgpainless.algorithm.CompressionAlgorithm;
|
|
||||||
import org.pgpainless.algorithm.SymmetricKeyAlgorithm;
|
|
||||||
import org.pgpainless.algorithm.negotiation.SymmetricKeyAlgorithmNegotiator;
|
|
||||||
import org.pgpainless.key.SubkeyIdentifier;
|
|
||||||
import org.slf4j.Logger;
|
|
||||||
import org.slf4j.LoggerFactory;
|
|
||||||
|
|
||||||
public class EncryptionBuilder implements EncryptionBuilderInterface {
|
|
||||||
|
|
||||||
private static final Logger LOGGER = LoggerFactory.getLogger(EncryptionBuilder.class);
|
|
||||||
|
|
||||||
private OutputStream outputStream;
|
|
||||||
|
|
||||||
@Override
|
|
||||||
public WithOptions onOutputStream(@Nonnull OutputStream outputStream) {
|
|
||||||
this.outputStream = outputStream;
|
|
||||||
return new WithOptionsImpl();
|
|
||||||
}
|
|
||||||
|
|
||||||
class WithOptionsImpl implements WithOptions {
|
|
||||||
@Override
|
|
||||||
public EncryptionStream withOptions(ProducerOptions options) throws PGPException, IOException {
|
|
||||||
if (options == null) {
|
|
||||||
throw new NullPointerException("ProducerOptions cannot be null.");
|
|
||||||
}
|
|
||||||
return new EncryptionStream(outputStream, options);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Negotiate the {@link SymmetricKeyAlgorithm} used for message encryption.
|
|
||||||
*
|
|
||||||
* @param encryptionOptions encryption options
|
|
||||||
* @return negotiated symmetric key algorithm
|
|
||||||
*/
|
|
||||||
public static SymmetricKeyAlgorithm negotiateSymmetricEncryptionAlgorithm(EncryptionOptions encryptionOptions) {
|
|
||||||
List<Set<SymmetricKeyAlgorithm>> preferences = new ArrayList<>();
|
|
||||||
for (SubkeyIdentifier key : encryptionOptions.getKeyViews().keySet()) {
|
|
||||||
preferences.add(encryptionOptions.getKeyViews().get(key).getPreferredSymmetricKeyAlgorithms());
|
|
||||||
}
|
|
||||||
|
|
||||||
SymmetricKeyAlgorithm algorithm = SymmetricKeyAlgorithmNegotiator
|
|
||||||
.byPopularity()
|
|
||||||
.negotiate(
|
|
||||||
PGPainless.getPolicy().getSymmetricKeyEncryptionAlgorithmPolicy(),
|
|
||||||
encryptionOptions.getEncryptionAlgorithmOverride(),
|
|
||||||
preferences);
|
|
||||||
LOGGER.debug("Negotiation resulted in {} being the symmetric encryption algorithm of choice.", algorithm);
|
|
||||||
return algorithm;
|
|
||||||
}
|
|
||||||
|
|
||||||
public static CompressionAlgorithm negotiateCompressionAlgorithm(ProducerOptions producerOptions) {
|
|
||||||
CompressionAlgorithm compressionAlgorithmOverride = producerOptions.getCompressionAlgorithmOverride();
|
|
||||||
if (compressionAlgorithmOverride != null) {
|
|
||||||
return compressionAlgorithmOverride;
|
|
||||||
}
|
|
||||||
|
|
||||||
// TODO: Negotiation
|
|
||||||
|
|
||||||
return PGPainless.getPolicy().getCompressionAlgorithmPolicy().defaultCompressionAlgorithm();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -1,38 +0,0 @@
|
||||||
// SPDX-FileCopyrightText: 2018 Paul Schaub <vanitasvitae@fsfe.org>
|
|
||||||
//
|
|
||||||
// SPDX-License-Identifier: Apache-2.0
|
|
||||||
|
|
||||||
package org.pgpainless.encryption_signing;
|
|
||||||
|
|
||||||
import java.io.IOException;
|
|
||||||
import java.io.OutputStream;
|
|
||||||
import javax.annotation.Nonnull;
|
|
||||||
|
|
||||||
import org.bouncycastle.openpgp.PGPException;
|
|
||||||
|
|
||||||
public interface EncryptionBuilderInterface {
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create a {@link EncryptionStream} on an {@link OutputStream} that contains the plain data that
|
|
||||||
* shall be encrypted and or signed.
|
|
||||||
*
|
|
||||||
* @param outputStream output stream of the plain data.
|
|
||||||
* @return api handle
|
|
||||||
*/
|
|
||||||
WithOptions onOutputStream(@Nonnull OutputStream outputStream);
|
|
||||||
|
|
||||||
interface WithOptions {
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create an {@link EncryptionStream} with the given options (recipients, signers, algorithms...).
|
|
||||||
*
|
|
||||||
* @param options options
|
|
||||||
* @return encryption stream
|
|
||||||
*
|
|
||||||
* @throws PGPException if something goes wrong during encryption stream preparation
|
|
||||||
* @throws IOException if something goes wrong during encryption stream preparation (writing headers)
|
|
||||||
*/
|
|
||||||
EncryptionStream withOptions(ProducerOptions options) throws PGPException, IOException;
|
|
||||||
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -0,0 +1,59 @@
|
||||||
|
// SPDX-FileCopyrightText: 2023 Paul Schaub <vanitasvitae@fsfe.org>
|
||||||
|
//
|
||||||
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
package org.pgpainless.encryption_signing
|
||||||
|
|
||||||
|
import org.pgpainless.PGPainless.Companion.getPolicy
|
||||||
|
import org.pgpainless.algorithm.CompressionAlgorithm
|
||||||
|
import org.pgpainless.algorithm.SymmetricKeyAlgorithm
|
||||||
|
import org.pgpainless.algorithm.negotiation.SymmetricKeyAlgorithmNegotiator.Companion.byPopularity
|
||||||
|
import org.slf4j.Logger
|
||||||
|
import org.slf4j.LoggerFactory
|
||||||
|
import java.io.OutputStream
|
||||||
|
|
||||||
|
class EncryptionBuilder : EncryptionBuilderInterface {
|
||||||
|
override fun onOutputStream(outputStream: OutputStream): EncryptionBuilderInterface.WithOptions {
|
||||||
|
return WithOptionsImpl(outputStream)
|
||||||
|
}
|
||||||
|
|
||||||
|
class WithOptionsImpl(val outputStream: OutputStream) : EncryptionBuilderInterface.WithOptions {
|
||||||
|
|
||||||
|
override fun withOptions(options: ProducerOptions): EncryptionStream {
|
||||||
|
return EncryptionStream(outputStream, options)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
companion object {
|
||||||
|
|
||||||
|
@JvmStatic
|
||||||
|
val LOGGER: Logger = LoggerFactory.getLogger(EncryptionBuilder::class.java)
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Negotiate the [SymmetricKeyAlgorithm] used for message encryption.
|
||||||
|
*
|
||||||
|
* @param encryptionOptions encryption options
|
||||||
|
* @return negotiated symmetric key algorithm
|
||||||
|
*/
|
||||||
|
@JvmStatic
|
||||||
|
fun negotiateSymmetricEncryptionAlgorithm(encryptionOptions: EncryptionOptions): SymmetricKeyAlgorithm {
|
||||||
|
val preferences = encryptionOptions.keyViews.values
|
||||||
|
.map { it.preferredSymmetricKeyAlgorithms }
|
||||||
|
.toList()
|
||||||
|
val algorithm = byPopularity().negotiate(
|
||||||
|
getPolicy().symmetricKeyEncryptionAlgorithmPolicy,
|
||||||
|
encryptionOptions.encryptionAlgorithmOverride,
|
||||||
|
preferences)
|
||||||
|
LOGGER.debug("Negotiation resulted in {} being the symmetric encryption algorithm of choice.", algorithm)
|
||||||
|
return algorithm
|
||||||
|
}
|
||||||
|
|
||||||
|
@JvmStatic
|
||||||
|
fun negotiateCompressionAlgorithm(producerOptions: ProducerOptions): CompressionAlgorithm {
|
||||||
|
val compressionAlgorithmOverride = producerOptions.compressionAlgorithmOverride
|
||||||
|
return compressionAlgorithmOverride ?: getPolicy().compressionAlgorithmPolicy.defaultCompressionAlgorithm()
|
||||||
|
|
||||||
|
// TODO: Negotiation
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,36 @@
|
||||||
|
// SPDX-FileCopyrightText: 2023 Paul Schaub <vanitasvitae@fsfe.org>
|
||||||
|
//
|
||||||
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
package org.pgpainless.encryption_signing
|
||||||
|
|
||||||
|
import org.bouncycastle.openpgp.PGPException
|
||||||
|
import java.io.IOException
|
||||||
|
import java.io.OutputStream
|
||||||
|
|
||||||
|
fun interface EncryptionBuilderInterface {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a [EncryptionStream] wrapping an [OutputStream]. Data that is piped through the
|
||||||
|
* [EncryptionStream] will be encrypted and/or signed.
|
||||||
|
*
|
||||||
|
* @param outputStream output stream which receives the encrypted / signed data.
|
||||||
|
* @return api handle
|
||||||
|
*/
|
||||||
|
fun onOutputStream(outputStream: OutputStream): WithOptions
|
||||||
|
|
||||||
|
fun interface WithOptions {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create an [EncryptionStream] with the given options (recipients, signers, algorithms...).
|
||||||
|
*
|
||||||
|
* @param options options
|
||||||
|
* @return encryption stream
|
||||||
|
*
|
||||||
|
* @throws PGPException if something goes wrong during encryption stream preparation
|
||||||
|
* @throws IOException if something goes wrong during encryption stream preparation (writing headers)
|
||||||
|
*/
|
||||||
|
@Throws(PGPException::class, IOException::class)
|
||||||
|
fun withOptions(options: ProducerOptions): EncryptionStream
|
||||||
|
}
|
||||||
|
}
|
||||||
Loading…
Reference in a new issue