mirror of
https://codeberg.org/PGPainless/sop-java.git
synced 2024-11-29 10:32:08 +01:00
Kotlin conversion: AbstractSign
This commit is contained in:
parent
31409b7949
commit
e68d6df57f
GPG key ID:
62BEE9264BF17311
2 changed files with 79 additions and 85 deletions
|
|
@ -1,85 +0,0 @@
|
||||||
// SPDX-FileCopyrightText: 2022 Paul Schaub <vanitasvitae@fsfe.org>
|
|
||||||
//
|
|
||||||
// SPDX-License-Identifier: Apache-2.0
|
|
||||||
|
|
||||||
package sop.operation;
|
|
||||||
|
|
||||||
import sop.exception.SOPGPException;
|
|
||||||
import sop.util.UTF8Util;
|
|
||||||
|
|
||||||
import java.io.ByteArrayInputStream;
|
|
||||||
import java.io.IOException;
|
|
||||||
import java.io.InputStream;
|
|
||||||
|
|
||||||
public interface AbstractSign<T> {
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Disable ASCII armor encoding.
|
|
||||||
*
|
|
||||||
* @return builder instance
|
|
||||||
*/
|
|
||||||
T noArmor();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Add one or more signing keys.
|
|
||||||
*
|
|
||||||
* @param key input stream containing encoded keys
|
|
||||||
* @return builder instance
|
|
||||||
*
|
|
||||||
* @throws sop.exception.SOPGPException.KeyCannotSign if the key cannot be used for signing
|
|
||||||
* @throws sop.exception.SOPGPException.BadData if the {@link InputStream} does not contain an OpenPGP key
|
|
||||||
* @throws sop.exception.SOPGPException.UnsupportedAsymmetricAlgo if the key uses an unsupported asymmetric algorithm
|
|
||||||
* @throws IOException in case of an IO error
|
|
||||||
*/
|
|
||||||
T key(InputStream key)
|
|
||||||
throws SOPGPException.KeyCannotSign,
|
|
||||||
SOPGPException.BadData,
|
|
||||||
SOPGPException.UnsupportedAsymmetricAlgo,
|
|
||||||
IOException;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Add one or more signing keys.
|
|
||||||
*
|
|
||||||
* @param key byte array containing encoded keys
|
|
||||||
* @return builder instance
|
|
||||||
*
|
|
||||||
* @throws sop.exception.SOPGPException.KeyCannotSign if the key cannot be used for signing
|
|
||||||
* @throws sop.exception.SOPGPException.BadData if the byte array does not contain an OpenPGP key
|
|
||||||
* @throws sop.exception.SOPGPException.UnsupportedAsymmetricAlgo if the key uses an unsupported asymmetric algorithm
|
|
||||||
* @throws IOException in case of an IO error
|
|
||||||
*/
|
|
||||||
default T key(byte[] key)
|
|
||||||
throws SOPGPException.KeyCannotSign,
|
|
||||||
SOPGPException.BadData,
|
|
||||||
SOPGPException.UnsupportedAsymmetricAlgo,
|
|
||||||
IOException {
|
|
||||||
return key(new ByteArrayInputStream(key));
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Provide the password for the secret key used for signing.
|
|
||||||
*
|
|
||||||
* @param password password
|
|
||||||
* @return builder instance
|
|
||||||
* @throws sop.exception.SOPGPException.UnsupportedOption if key passwords are not supported
|
|
||||||
* @throws sop.exception.SOPGPException.PasswordNotHumanReadable if the provided passphrase is not human-readable
|
|
||||||
*/
|
|
||||||
default T withKeyPassword(String password)
|
|
||||||
throws SOPGPException.UnsupportedOption,
|
|
||||||
SOPGPException.PasswordNotHumanReadable {
|
|
||||||
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.UnsupportedOption if key passwords are not supported
|
|
||||||
* @throws sop.exception.SOPGPException.PasswordNotHumanReadable if the provided passphrase is not human-readable
|
|
||||||
*/
|
|
||||||
T withKeyPassword(byte[] password)
|
|
||||||
throws SOPGPException.UnsupportedOption,
|
|
||||||
SOPGPException.PasswordNotHumanReadable;
|
|
||||||
|
|
||||||
}
|
|
||||||
79
sop-java/src/main/kotlin/sop/operation/AbstractSign.kt
Normal file
79
sop-java/src/main/kotlin/sop/operation/AbstractSign.kt
Normal file
|
|
@ -0,0 +1,79 @@
|
||||||
|
// SPDX-FileCopyrightText: 2023 Paul Schaub <vanitasvitae@fsfe.org>
|
||||||
|
//
|
||||||
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
package sop.operation
|
||||||
|
|
||||||
|
import java.io.IOException
|
||||||
|
import java.io.InputStream
|
||||||
|
import sop.exception.SOPGPException.BadData
|
||||||
|
import sop.exception.SOPGPException.KeyCannotSign
|
||||||
|
import sop.exception.SOPGPException.PasswordNotHumanReadable
|
||||||
|
import sop.exception.SOPGPException.UnsupportedAsymmetricAlgo
|
||||||
|
import sop.exception.SOPGPException.UnsupportedOption
|
||||||
|
import sop.util.UTF8Util
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Interface for signing operations.
|
||||||
|
*
|
||||||
|
* @param <T> builder subclass
|
||||||
|
*/
|
||||||
|
interface AbstractSign<T> {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Disable ASCII armor encoding.
|
||||||
|
*
|
||||||
|
* @return builder instance
|
||||||
|
*/
|
||||||
|
fun noArmor(): T
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add one or more signing keys.
|
||||||
|
*
|
||||||
|
* @param key input stream containing encoded keys
|
||||||
|
* @return builder instance
|
||||||
|
* @throws KeyCannotSign if the key cannot be used for signing
|
||||||
|
* @throws BadData if the [InputStream] does not contain an OpenPGP key
|
||||||
|
* @throws UnsupportedAsymmetricAlgo if the key uses an unsupported asymmetric algorithm
|
||||||
|
* @throws IOException in case of an IO error
|
||||||
|
*/
|
||||||
|
@Throws(
|
||||||
|
KeyCannotSign::class, BadData::class, UnsupportedAsymmetricAlgo::class, IOException::class)
|
||||||
|
fun key(key: InputStream): T
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add one or more signing keys.
|
||||||
|
*
|
||||||
|
* @param key byte array containing encoded keys
|
||||||
|
* @return builder instance
|
||||||
|
* @throws KeyCannotSign if the key cannot be used for signing
|
||||||
|
* @throws BadData if the byte array does not contain an OpenPGP key
|
||||||
|
* @throws UnsupportedAsymmetricAlgo if the key uses an unsupported asymmetric algorithm
|
||||||
|
* @throws IOException in case of an IO error
|
||||||
|
*/
|
||||||
|
@Throws(
|
||||||
|
KeyCannotSign::class, BadData::class, UnsupportedAsymmetricAlgo::class, IOException::class)
|
||||||
|
fun key(key: ByteArray): T = key(key.inputStream())
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Provide the password for the secret key used for signing.
|
||||||
|
*
|
||||||
|
* @param password password
|
||||||
|
* @return builder instance
|
||||||
|
* @throws UnsupportedOption if key passwords are not supported
|
||||||
|
* @throws PasswordNotHumanReadable if the provided passphrase is not human-readable
|
||||||
|
*/
|
||||||
|
@Throws(UnsupportedOption::class, PasswordNotHumanReadable::class)
|
||||||
|
fun withKeyPassword(password: String): T = withKeyPassword(password.toByteArray(UTF8Util.UTF8))
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Provide the password for the secret key used for signing.
|
||||||
|
*
|
||||||
|
* @param password password
|
||||||
|
* @return builder instance
|
||||||
|
* @throws UnsupportedOption if key passwords are not supported
|
||||||
|
* @throws PasswordNotHumanReadable if the provided passphrase is not human-readable
|
||||||
|
*/
|
||||||
|
@Throws(UnsupportedOption::class, PasswordNotHumanReadable::class)
|
||||||
|
fun withKeyPassword(password: ByteArray): T
|
||||||
|
}
|
||||||
Loading…
Reference in a new issue