mirror of
https://github.com/pgpainless/pgpainless.git
synced 2024-12-23 03:17:58 +01:00
Kotlin conversion: PublicKeyAlgorithm
This commit is contained in:
parent
eb07b94bcb
commit
608edc2378
GPG key ID:
62BEE9264BF17311
2 changed files with 96 additions and 163 deletions
|
|
@ -1,163 +0,0 @@
|
||||||
// SPDX-FileCopyrightText: 2018 Paul Schaub <vanitasvitae@fsfe.org>
|
|
||||||
//
|
|
||||||
// SPDX-License-Identifier: Apache-2.0
|
|
||||||
|
|
||||||
package org.pgpainless.algorithm;
|
|
||||||
|
|
||||||
import java.util.Map;
|
|
||||||
import java.util.NoSuchElementException;
|
|
||||||
import java.util.concurrent.ConcurrentHashMap;
|
|
||||||
|
|
||||||
import org.bouncycastle.bcpg.PublicKeyAlgorithmTags;
|
|
||||||
|
|
||||||
import javax.annotation.Nonnull;
|
|
||||||
import javax.annotation.Nullable;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Enumeration of public key algorithms as defined in RFC4880.
|
|
||||||
*
|
|
||||||
* @see <a href="https://tools.ietf.org/html/rfc4880#section-9.1">RFC4880: Public-Key Algorithms</a>
|
|
||||||
*/
|
|
||||||
public enum PublicKeyAlgorithm {
|
|
||||||
|
|
||||||
/**
|
|
||||||
* RSA capable of encryption and signatures.
|
|
||||||
*/
|
|
||||||
RSA_GENERAL (PublicKeyAlgorithmTags.RSA_GENERAL, true, true),
|
|
||||||
|
|
||||||
/**
|
|
||||||
* RSA with usage encryption.
|
|
||||||
*
|
|
||||||
* @deprecated see <a href="https://tools.ietf.org/html/rfc4880#section-13.5">Deprecation notice</a>
|
|
||||||
*/
|
|
||||||
@Deprecated
|
|
||||||
RSA_ENCRYPT (PublicKeyAlgorithmTags.RSA_ENCRYPT, false, true),
|
|
||||||
|
|
||||||
/**
|
|
||||||
* RSA with usage of creating signatures.
|
|
||||||
*
|
|
||||||
* @deprecated see <a href="https://tools.ietf.org/html/rfc4880#section-13.5">Deprecation notice</a>
|
|
||||||
*/
|
|
||||||
@Deprecated
|
|
||||||
RSA_SIGN (PublicKeyAlgorithmTags.RSA_SIGN, true, false),
|
|
||||||
|
|
||||||
/**
|
|
||||||
* ElGamal with usage encryption.
|
|
||||||
*/
|
|
||||||
ELGAMAL_ENCRYPT (PublicKeyAlgorithmTags.ELGAMAL_ENCRYPT, false, true),
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Digital Signature Algorithm.
|
|
||||||
*/
|
|
||||||
DSA (PublicKeyAlgorithmTags.DSA, true, false),
|
|
||||||
|
|
||||||
/**
|
|
||||||
* EC is deprecated.
|
|
||||||
* @deprecated use {@link #ECDH} instead.
|
|
||||||
*/
|
|
||||||
@Deprecated
|
|
||||||
EC (PublicKeyAlgorithmTags.EC, false, true),
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Elliptic Curve Diffie-Hellman.
|
|
||||||
*/
|
|
||||||
ECDH (PublicKeyAlgorithmTags.ECDH, false, true),
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Elliptic Curve Digital Signature Algorithm.
|
|
||||||
*/
|
|
||||||
ECDSA (PublicKeyAlgorithmTags.ECDSA, true, false),
|
|
||||||
|
|
||||||
/**
|
|
||||||
* ElGamal General.
|
|
||||||
*
|
|
||||||
* @deprecated see <a href="https://tools.ietf.org/html/rfc4880#section-13.8">Deprecation notice</a>
|
|
||||||
*/
|
|
||||||
@Deprecated
|
|
||||||
ELGAMAL_GENERAL (PublicKeyAlgorithmTags.ELGAMAL_GENERAL, true, true),
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Diffie-Hellman key exchange algorithm.
|
|
||||||
*/
|
|
||||||
DIFFIE_HELLMAN (PublicKeyAlgorithmTags.DIFFIE_HELLMAN, false, true),
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Digital Signature Algorithm based on twisted Edwards Curves.
|
|
||||||
*/
|
|
||||||
EDDSA (PublicKeyAlgorithmTags.EDDSA, true, false),
|
|
||||||
;
|
|
||||||
|
|
||||||
private static final Map<Integer, PublicKeyAlgorithm> MAP = new ConcurrentHashMap<>();
|
|
||||||
|
|
||||||
static {
|
|
||||||
for (PublicKeyAlgorithm p : PublicKeyAlgorithm.values()) {
|
|
||||||
MAP.put(p.algorithmId, p);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Return the {@link PublicKeyAlgorithm} that corresponds to the provided algorithm id.
|
|
||||||
* If an invalid id is provided, null is returned.
|
|
||||||
*
|
|
||||||
* @param id numeric algorithm id
|
|
||||||
* @return algorithm or null
|
|
||||||
*/
|
|
||||||
@Nullable
|
|
||||||
public static PublicKeyAlgorithm fromId(int id) {
|
|
||||||
return MAP.get(id);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Return the {@link PublicKeyAlgorithm} that corresponds to the provided algorithm id.
|
|
||||||
* If an invalid id is provided, throw a {@link NoSuchElementException}.
|
|
||||||
*
|
|
||||||
* @param id numeric algorithm id
|
|
||||||
* @return algorithm
|
|
||||||
* @throws NoSuchElementException in case of an unmatched algorithm id
|
|
||||||
*/
|
|
||||||
@Nonnull
|
|
||||||
public static PublicKeyAlgorithm requireFromId(int id) {
|
|
||||||
PublicKeyAlgorithm algorithm = fromId(id);
|
|
||||||
if (algorithm == null) {
|
|
||||||
throw new NoSuchElementException("No PublicKeyAlgorithm found for id " + id);
|
|
||||||
}
|
|
||||||
return algorithm;
|
|
||||||
}
|
|
||||||
|
|
||||||
private final int algorithmId;
|
|
||||||
private final boolean signingCapable;
|
|
||||||
private final boolean encryptionCapable;
|
|
||||||
|
|
||||||
PublicKeyAlgorithm(int algorithmId, boolean signingCapable, boolean encryptionCapable) {
|
|
||||||
this.algorithmId = algorithmId;
|
|
||||||
this.signingCapable = signingCapable;
|
|
||||||
this.encryptionCapable = encryptionCapable;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Return the numeric identifier of the public key algorithm.
|
|
||||||
*
|
|
||||||
* @return id
|
|
||||||
*/
|
|
||||||
public int getAlgorithmId() {
|
|
||||||
return algorithmId;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Return true if this public key algorithm is able to create signatures.
|
|
||||||
*
|
|
||||||
* @return true if the algorithm can sign
|
|
||||||
*/
|
|
||||||
public boolean isSigningCapable() {
|
|
||||||
return signingCapable;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Return true if this public key algorithm can be used as an encryption algorithm.
|
|
||||||
*
|
|
||||||
* @return true if the algorithm can encrypt
|
|
||||||
*/
|
|
||||||
public boolean isEncryptionCapable() {
|
|
||||||
return encryptionCapable;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -0,0 +1,96 @@
|
||||||
|
// SPDX-FileCopyrightText: 2023 Paul Schaub <vanitasvitae@fsfe.org>
|
||||||
|
//
|
||||||
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
package org.pgpainless.algorithm
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Enumeration of public key algorithms as defined in RFC4880.
|
||||||
|
*
|
||||||
|
* See [RFC4880: Public-Key Algorithms](https://tools.ietf.org/html/rfc4880#section-9.1)
|
||||||
|
*/
|
||||||
|
enum class PublicKeyAlgorithm(
|
||||||
|
val algorithmId: Int,
|
||||||
|
val signingCapable: Boolean,
|
||||||
|
val encryptionCapable: Boolean) {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* RSA capable of encryption and signatures.
|
||||||
|
*/
|
||||||
|
RSA_GENERAL (1, true, true),
|
||||||
|
|
||||||
|
/**
|
||||||
|
* RSA with usage encryption.
|
||||||
|
*
|
||||||
|
* @deprecated see <a href="https://tools.ietf.org/html/rfc4880#section-13.5">Deprecation notice</a>
|
||||||
|
*/
|
||||||
|
@Deprecated("RSA_ENCRYPT is deprecated in favor of RSA_GENERAL",
|
||||||
|
ReplaceWith("RSA_GENERAL"))
|
||||||
|
RSA_ENCRYPT (2, false, true),
|
||||||
|
|
||||||
|
/**
|
||||||
|
* RSA with usage of creating signatures.
|
||||||
|
*
|
||||||
|
* @deprecated see <a href="https://tools.ietf.org/html/rfc4880#section-13.5">Deprecation notice</a>
|
||||||
|
*/
|
||||||
|
@Deprecated("RSA_SIGN is deprecated in favor of RSA_GENERAL",
|
||||||
|
ReplaceWith("RSA_GENERAL"))
|
||||||
|
RSA_SIGN (3, true, false),
|
||||||
|
|
||||||
|
/**
|
||||||
|
* ElGamal with usage encryption.
|
||||||
|
*/
|
||||||
|
ELGAMAL_ENCRYPT (16, false, true),
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Digital Signature Algorithm.
|
||||||
|
*/
|
||||||
|
DSA (17, true, false),
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Elliptic Curve Diffie-Hellman.
|
||||||
|
*/
|
||||||
|
ECDH (18, false, true),
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Elliptic Curve Digital Signature Algorithm.
|
||||||
|
*/
|
||||||
|
ECDSA (19, true, false),
|
||||||
|
|
||||||
|
/**
|
||||||
|
* ElGamal General.
|
||||||
|
*
|
||||||
|
* @deprecated see <a href="https://tools.ietf.org/html/rfc4880#section-13.8">Deprecation notice</a>
|
||||||
|
*/
|
||||||
|
@Deprecated("ElGamal is deprecated")
|
||||||
|
ELGAMAL_GENERAL (20, true, true),
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Diffie-Hellman key exchange algorithm.
|
||||||
|
*/
|
||||||
|
DIFFIE_HELLMAN (21, false, true),
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Digital Signature Algorithm based on twisted Edwards Curves.
|
||||||
|
*/
|
||||||
|
EDDSA (22, true, false),
|
||||||
|
;
|
||||||
|
|
||||||
|
fun isSigningCapable(): Boolean = signingCapable
|
||||||
|
fun isEncryptionCapable(): Boolean = encryptionCapable
|
||||||
|
|
||||||
|
companion object {
|
||||||
|
@JvmStatic
|
||||||
|
fun fromId(id: Int): PublicKeyAlgorithm? {
|
||||||
|
return values().firstOrNull {
|
||||||
|
it.algorithmId == id
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@JvmStatic
|
||||||
|
fun requireFromId(id: Int): PublicKeyAlgorithm {
|
||||||
|
return fromId(id) ?:
|
||||||
|
throw NoSuchElementException("No PublicKeyAlgorithm found for id $id")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
Loading…
Reference in a new issue