mirror of
https://codeberg.org/PGPainless/sop-java.git
synced 2024-11-26 09:02:06 +01:00
Kotlin conversion: Encrypt
This commit is contained in:
parent
e681090757
commit
41db9d2ac7
GPG key ID:
62BEE9264BF17311
2 changed files with 166 additions and 193 deletions
|
|
@ -1,193 +0,0 @@
|
||||||
// SPDX-FileCopyrightText: 2021 Paul Schaub <vanitasvitae@fsfe.org>
|
|
||||||
//
|
|
||||||
// SPDX-License-Identifier: Apache-2.0
|
|
||||||
|
|
||||||
package sop.operation;
|
|
||||||
|
|
||||||
import sop.Profile;
|
|
||||||
import sop.Ready;
|
|
||||||
import sop.enums.EncryptAs;
|
|
||||||
import sop.exception.SOPGPException;
|
|
||||||
import sop.util.UTF8Util;
|
|
||||||
|
|
||||||
import java.io.ByteArrayInputStream;
|
|
||||||
import java.io.IOException;
|
|
||||||
import java.io.InputStream;
|
|
||||||
|
|
||||||
public interface Encrypt {
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Disable ASCII armor encoding.
|
|
||||||
*
|
|
||||||
* @return builder instance
|
|
||||||
*/
|
|
||||||
Encrypt noArmor();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Sets encryption mode.
|
|
||||||
*
|
|
||||||
* @param mode mode
|
|
||||||
* @return builder instance
|
|
||||||
*
|
|
||||||
* @throws sop.exception.SOPGPException.UnsupportedOption if this option is not supported
|
|
||||||
*/
|
|
||||||
Encrypt mode(EncryptAs mode)
|
|
||||||
throws SOPGPException.UnsupportedOption;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Adds the signer key.
|
|
||||||
*
|
|
||||||
* @param key input stream containing the encoded signer key
|
|
||||||
* @return builder instance
|
|
||||||
*
|
|
||||||
* @throws sop.exception.SOPGPException.KeyCannotSign if the key cannot be used for signing
|
|
||||||
* @throws sop.exception.SOPGPException.UnsupportedAsymmetricAlgo if the key uses an unsupported asymmetric algorithm
|
|
||||||
* @throws sop.exception.SOPGPException.BadData if the {@link InputStream} does not contain an OpenPGP key
|
|
||||||
* @throws IOException in case of an IO error
|
|
||||||
*/
|
|
||||||
Encrypt signWith(InputStream key)
|
|
||||||
throws SOPGPException.KeyCannotSign,
|
|
||||||
SOPGPException.UnsupportedAsymmetricAlgo,
|
|
||||||
SOPGPException.BadData,
|
|
||||||
IOException;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Adds the signer key.
|
|
||||||
*
|
|
||||||
* @param key byte array containing the encoded signer key
|
|
||||||
* @return builder instance
|
|
||||||
*
|
|
||||||
* @throws sop.exception.SOPGPException.KeyCannotSign if the key cannot be used for signing
|
|
||||||
* @throws sop.exception.SOPGPException.UnsupportedAsymmetricAlgo if the key uses an unsupported asymmetric algorithm
|
|
||||||
* @throws sop.exception.SOPGPException.BadData if the byte array does not contain an OpenPGP key
|
|
||||||
* @throws IOException in case of an IO error
|
|
||||||
*/
|
|
||||||
default Encrypt signWith(byte[] key)
|
|
||||||
throws SOPGPException.KeyCannotSign,
|
|
||||||
SOPGPException.UnsupportedAsymmetricAlgo,
|
|
||||||
SOPGPException.BadData,
|
|
||||||
IOException {
|
|
||||||
return signWith(new ByteArrayInputStream(key));
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Provide the password for the secret key used for signing.
|
|
||||||
*
|
|
||||||
* @param password password
|
|
||||||
* @return builder instance
|
|
||||||
*
|
|
||||||
* @throws sop.exception.SOPGPException.PasswordNotHumanReadable if the password is not human-readable
|
|
||||||
* @throws sop.exception.SOPGPException.UnsupportedOption if key password are not supported
|
|
||||||
*/
|
|
||||||
default Encrypt withKeyPassword(String password)
|
|
||||||
throws SOPGPException.PasswordNotHumanReadable,
|
|
||||||
SOPGPException.UnsupportedOption {
|
|
||||||
return withKeyPassword(password.getBytes(UTF8Util.UTF8));
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Provide the password for the secret key used for signing.
|
|
||||||
*
|
|
||||||
* @param password password
|
|
||||||
* @return builder instance
|
|
||||||
*
|
|
||||||
* @throws sop.exception.SOPGPException.PasswordNotHumanReadable if the password is not human-readable
|
|
||||||
* @throws sop.exception.SOPGPException.UnsupportedOption if key password are not supported
|
|
||||||
*/
|
|
||||||
Encrypt withKeyPassword(byte[] password)
|
|
||||||
throws SOPGPException.PasswordNotHumanReadable,
|
|
||||||
SOPGPException.UnsupportedOption;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Encrypt with the given password.
|
|
||||||
*
|
|
||||||
* @param password password
|
|
||||||
* @return builder instance
|
|
||||||
*
|
|
||||||
* @throws sop.exception.SOPGPException.PasswordNotHumanReadable if the password is not human-readable
|
|
||||||
* @throws sop.exception.SOPGPException.UnsupportedOption if this option is not supported
|
|
||||||
*/
|
|
||||||
Encrypt withPassword(String password)
|
|
||||||
throws SOPGPException.PasswordNotHumanReadable,
|
|
||||||
SOPGPException.UnsupportedOption;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Encrypt with the given cert.
|
|
||||||
*
|
|
||||||
* @param cert input stream containing the encoded cert.
|
|
||||||
* @return builder instance
|
|
||||||
*
|
|
||||||
* @throws sop.exception.SOPGPException.CertCannotEncrypt if the certificate is not encryption capable
|
|
||||||
* @throws sop.exception.SOPGPException.UnsupportedAsymmetricAlgo if the certificate uses an unsupported asymmetric algorithm
|
|
||||||
* @throws sop.exception.SOPGPException.BadData if the {@link InputStream} does not contain an OpenPGP certificate
|
|
||||||
* @throws IOException in case of an IO error
|
|
||||||
*/
|
|
||||||
Encrypt withCert(InputStream cert)
|
|
||||||
throws SOPGPException.CertCannotEncrypt,
|
|
||||||
SOPGPException.UnsupportedAsymmetricAlgo,
|
|
||||||
SOPGPException.BadData,
|
|
||||||
IOException;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Encrypt with the given cert.
|
|
||||||
*
|
|
||||||
* @param cert byte array containing the encoded cert.
|
|
||||||
* @return builder instance
|
|
||||||
*
|
|
||||||
* @throws sop.exception.SOPGPException.CertCannotEncrypt if the certificate is not encryption capable
|
|
||||||
* @throws sop.exception.SOPGPException.UnsupportedAsymmetricAlgo if the certificate uses an unsupported asymmetric algorithm
|
|
||||||
* @throws sop.exception.SOPGPException.BadData if the byte array does not contain an OpenPGP certificate
|
|
||||||
* @throws IOException in case of an IO error
|
|
||||||
*/
|
|
||||||
default Encrypt withCert(byte[] cert)
|
|
||||||
throws SOPGPException.CertCannotEncrypt,
|
|
||||||
SOPGPException.UnsupportedAsymmetricAlgo,
|
|
||||||
SOPGPException.BadData,
|
|
||||||
IOException {
|
|
||||||
return withCert(new ByteArrayInputStream(cert));
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Pass in a profile.
|
|
||||||
*
|
|
||||||
* @param profile profile
|
|
||||||
* @return builder instance
|
|
||||||
*/
|
|
||||||
default Encrypt profile(Profile profile) {
|
|
||||||
return profile(profile.getName());
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Pass in a profile identifier.
|
|
||||||
*
|
|
||||||
* @param profileName profile identifier
|
|
||||||
* @return builder instance
|
|
||||||
*/
|
|
||||||
Encrypt profile(String profileName);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Encrypt the given data yielding the ciphertext.
|
|
||||||
* @param plaintext plaintext
|
|
||||||
* @return input stream containing the ciphertext
|
|
||||||
*
|
|
||||||
* @throws IOException in case of an IO error
|
|
||||||
* @throws sop.exception.SOPGPException.KeyIsProtected if at least one signing key cannot be unlocked
|
|
||||||
*/
|
|
||||||
Ready plaintext(InputStream plaintext)
|
|
||||||
throws IOException,
|
|
||||||
SOPGPException.KeyIsProtected;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Encrypt the given data yielding the ciphertext.
|
|
||||||
* @param plaintext plaintext
|
|
||||||
* @return input stream containing the ciphertext
|
|
||||||
*
|
|
||||||
* @throws IOException in case of an IO error
|
|
||||||
* @throws sop.exception.SOPGPException.KeyIsProtected if at least one signing key cannot be unlocked
|
|
||||||
*/
|
|
||||||
default Ready plaintext(byte[] plaintext)
|
|
||||||
throws IOException,
|
|
||||||
SOPGPException.KeyIsProtected {
|
|
||||||
return plaintext(new ByteArrayInputStream(plaintext));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
166
sop-java/src/main/kotlin/sop/operation/Encrypt.kt
Normal file
166
sop-java/src/main/kotlin/sop/operation/Encrypt.kt
Normal file
|
|
@ -0,0 +1,166 @@
|
||||||
|
// SPDX-FileCopyrightText: 2023 Paul Schaub <vanitasvitae@fsfe.org>
|
||||||
|
//
|
||||||
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
package sop.operation
|
||||||
|
|
||||||
|
import java.io.ByteArrayInputStream
|
||||||
|
import java.io.IOException
|
||||||
|
import java.io.InputStream
|
||||||
|
import sop.Profile
|
||||||
|
import sop.Ready
|
||||||
|
import sop.enums.EncryptAs
|
||||||
|
import sop.exception.SOPGPException.*
|
||||||
|
import sop.util.UTF8Util
|
||||||
|
|
||||||
|
interface Encrypt {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Disable ASCII armor encoding.
|
||||||
|
*
|
||||||
|
* @return builder instance
|
||||||
|
*/
|
||||||
|
fun noArmor(): Encrypt
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets encryption mode.
|
||||||
|
*
|
||||||
|
* @param mode mode
|
||||||
|
* @return builder instance
|
||||||
|
* @throws UnsupportedOption if this option is not supported
|
||||||
|
*/
|
||||||
|
@Throws(UnsupportedOption::class) fun mode(mode: EncryptAs): Encrypt
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Adds the signer key.
|
||||||
|
*
|
||||||
|
* @param key input stream containing the encoded signer key
|
||||||
|
* @return builder instance
|
||||||
|
* @throws KeyCannotSign if the key cannot be used for signing
|
||||||
|
* @throws UnsupportedAsymmetricAlgo if the key uses an unsupported asymmetric algorithm
|
||||||
|
* @throws BadData if the [InputStream] does not contain an OpenPGP key
|
||||||
|
* @throws IOException in case of an IO error
|
||||||
|
*/
|
||||||
|
@Throws(
|
||||||
|
KeyCannotSign::class, UnsupportedAsymmetricAlgo::class, BadData::class, IOException::class)
|
||||||
|
fun signWith(key: InputStream): Encrypt
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Adds the signer key.
|
||||||
|
*
|
||||||
|
* @param key byte array containing the encoded signer key
|
||||||
|
* @return builder instance
|
||||||
|
* @throws KeyCannotSign if the key cannot be used for signing
|
||||||
|
* @throws UnsupportedAsymmetricAlgo if the key uses an unsupported asymmetric algorithm
|
||||||
|
* @throws BadData if the byte array does not contain an OpenPGP key
|
||||||
|
* @throws IOException in case of an IO error
|
||||||
|
*/
|
||||||
|
@Throws(
|
||||||
|
KeyCannotSign::class, UnsupportedAsymmetricAlgo::class, BadData::class, IOException::class)
|
||||||
|
fun signWith(key: ByteArray): Encrypt = signWith(ByteArrayInputStream(key))
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Provide the password for the secret key used for signing.
|
||||||
|
*
|
||||||
|
* @param password password
|
||||||
|
* @return builder instance
|
||||||
|
* @throws PasswordNotHumanReadable if the password is not human-readable
|
||||||
|
* @throws UnsupportedOption if key password are not supported
|
||||||
|
*/
|
||||||
|
@Throws(PasswordNotHumanReadable::class, UnsupportedOption::class)
|
||||||
|
fun withKeyPassword(password: String): Encrypt =
|
||||||
|
withKeyPassword(password.toByteArray(UTF8Util.UTF8))
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Provide the password for the secret key used for signing.
|
||||||
|
*
|
||||||
|
* @param password password
|
||||||
|
* @return builder instance
|
||||||
|
* @throws PasswordNotHumanReadable if the password is not human-readable
|
||||||
|
* @throws UnsupportedOption if key password are not supported
|
||||||
|
*/
|
||||||
|
@Throws(PasswordNotHumanReadable::class, UnsupportedOption::class)
|
||||||
|
fun withKeyPassword(password: ByteArray): Encrypt
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Encrypt with the given password.
|
||||||
|
*
|
||||||
|
* @param password password
|
||||||
|
* @return builder instance
|
||||||
|
* @throws PasswordNotHumanReadable if the password is not human-readable
|
||||||
|
* @throws UnsupportedOption if this option is not supported
|
||||||
|
*/
|
||||||
|
@Throws(PasswordNotHumanReadable::class, UnsupportedOption::class)
|
||||||
|
fun withPassword(password: String): Encrypt
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Encrypt with the given cert.
|
||||||
|
*
|
||||||
|
* @param cert input stream containing the encoded cert.
|
||||||
|
* @return builder instance
|
||||||
|
* @throws CertCannotEncrypt if the certificate is not encryption capable
|
||||||
|
* @throws UnsupportedAsymmetricAlgo if the certificate uses an unsupported asymmetric algorithm
|
||||||
|
* @throws BadData if the [InputStream] does not contain an OpenPGP certificate
|
||||||
|
* @throws IOException in case of an IO error
|
||||||
|
*/
|
||||||
|
@Throws(
|
||||||
|
CertCannotEncrypt::class,
|
||||||
|
UnsupportedAsymmetricAlgo::class,
|
||||||
|
BadData::class,
|
||||||
|
IOException::class)
|
||||||
|
fun withCert(cert: InputStream): Encrypt
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Encrypt with the given cert.
|
||||||
|
*
|
||||||
|
* @param cert byte array containing the encoded cert.
|
||||||
|
* @return builder instance
|
||||||
|
* @throws CertCannotEncrypt if the certificate is not encryption capable
|
||||||
|
* @throws UnsupportedAsymmetricAlgo if the certificate uses an unsupported asymmetric algorithm
|
||||||
|
* @throws BadData if the byte array does not contain an OpenPGP certificate
|
||||||
|
* @throws IOException in case of an IO error
|
||||||
|
*/
|
||||||
|
@Throws(
|
||||||
|
CertCannotEncrypt::class,
|
||||||
|
UnsupportedAsymmetricAlgo::class,
|
||||||
|
BadData::class,
|
||||||
|
IOException::class)
|
||||||
|
fun withCert(cert: ByteArray): Encrypt = withCert(ByteArrayInputStream(cert))
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Pass in a profile.
|
||||||
|
*
|
||||||
|
* @param profile profile
|
||||||
|
* @return builder instance
|
||||||
|
*/
|
||||||
|
fun profile(profile: Profile): Encrypt = profile(profile.name)
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Pass in a profile identifier.
|
||||||
|
*
|
||||||
|
* @param profileName profile identifier
|
||||||
|
* @return builder instance
|
||||||
|
*/
|
||||||
|
fun profile(profileName: String): Encrypt
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Encrypt the given data yielding the ciphertext.
|
||||||
|
*
|
||||||
|
* @param plaintext plaintext
|
||||||
|
* @return input stream containing the ciphertext
|
||||||
|
* @throws IOException in case of an IO error
|
||||||
|
* @throws KeyIsProtected if at least one signing key cannot be unlocked
|
||||||
|
*/
|
||||||
|
@Throws(IOException::class, KeyIsProtected::class) fun plaintext(plaintext: InputStream): Ready
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Encrypt the given data yielding the ciphertext.
|
||||||
|
*
|
||||||
|
* @param plaintext plaintext
|
||||||
|
* @return input stream containing the ciphertext
|
||||||
|
* @throws IOException in case of an IO error
|
||||||
|
* @throws KeyIsProtected if at least one signing key cannot be unlocked
|
||||||
|
*/
|
||||||
|
@Throws(IOException::class, KeyIsProtected::class)
|
||||||
|
fun plaintext(plaintext: ByteArray): Ready = plaintext(ByteArrayInputStream(plaintext))
|
||||||
|
}
|
||||||
Loading…
Reference in a new issue