one.block.eosiojava.utilities

Class PEMProcessor

java.lang.Object

one.block.eosiojava.utilities.PEMProcessor

public class PEMProcessor
extends java.lang.Object

This is a wrapper class for PEMObjects that throws a PEMProcessorError if an invalid PEMObject is passed into the constructor. Once initialized the PEMProcessor can be used to return the type, DER format, or algorithm used to create the PEMObject.

Constructor Summary

Constructors

Constructor and Description
PEMProcessor(java.lang.String pemObject) Initialize PEMProcessor with PEM content in String format.

Method Summary

Modifier and Type	Method and Description
java.lang.String	extractEOSPublicKeyFromPrivateKey(boolean isLegacy) Extract EOS public key
java.lang.String	extractPEMPublicKeyFromPrivateKey(boolean isLegacy) Extract PEM public key
@NotNull AlgorithmEmployed	getAlgorithm() Gets the algorithm used to generate the key from its PEM format.
static org.bouncycastle.crypto.params.ECDomainParameters	getCurveDomainParameters(AlgorithmEmployed curve) Gets EC Curve's domain parameter by curve type
@NotNull java.lang.String	getDERFormat() Gets the DER encoded format of the key from its PEM format.
@NotNull byte[]	getKeyData() Gets the key as a byte array from its PEM format.
@NotNull java.lang.String	getType() Gets the PEM Object key type (i.e.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PEMProcessor

public PEMProcessor(java.lang.String pemObject)
             throws PEMProcessorError

Initialize PEMProcessor with PEM content in String format.

Parameters:

pemObject - - input PEM content in String format.

Throws:

PEMProcessorError - When failing to read pem data from the input.

Method Detail

getType

@NotNull
public @NotNull java.lang.String getType()

Gets the PEM Object key type (i.e. PRIVATE KEY, PUBLIC KEY).

Returns:

key type as string

getDERFormat

@NotNull
public @NotNull java.lang.String getDERFormat()

Gets the DER encoded format of the key from its PEM format.

Returns:

DER format of key as string

getAlgorithm

@NotNull
public @NotNull AlgorithmEmployed getAlgorithm()
                                                 throws PEMProcessorError

Gets the algorithm used to generate the key from its PEM format.

Returns:

The algorithm used to generate the key.

Throws:

PEMProcessorError - if the algorithm fetch leads to an exception.

getKeyData

@NotNull
public @NotNull byte[] getKeyData()
                                    throws PEMProcessorError

Gets the key as a byte array from its PEM format.

Returns:

key as byte[]

Throws:

PEMProcessorError - when key data is unobtainable.

extractEOSPublicKeyFromPrivateKey

public java.lang.String extractEOSPublicKeyFromPrivateKey(boolean isLegacy)
                                                   throws PEMProcessorError

Extract EOS public key

Parameters:

isLegacy - - Set to true if the legacy format of the key is desired. This uses "EOS" to prefix the key data and only applies to keys generated with the secp256k1 algorithm. The new format prefixes the key data with "PUB_K1_".

Returns:

EOS format public key of the current private key

Throws:

PEMProcessorError - when the public key extraction fails.

extractPEMPublicKeyFromPrivateKey

public java.lang.String extractPEMPublicKeyFromPrivateKey(boolean isLegacy)
                                                   throws PEMProcessorError

Extract PEM public key

Parameters:

isLegacy - Whether to return the legacy format of the key. This uses "EOS" to prefix the key data and only applies to keys generated with the secp256k1 algorithm. The new format prefixes the key data with "PUB_K1_".

Returns:

EOS format public key of the current private key

Throws:

PEMProcessorError - when public key extraction fails.

getCurveDomainParameters

public static org.bouncycastle.crypto.params.ECDomainParameters getCurveDomainParameters(AlgorithmEmployed curve)
                                                                                  throws PEMProcessorError

Gets EC Curve's domain parameter by curve type

Parameters:

curve - - type

Returns:

ECDomainParameters of input curve

Throws:

PEMProcessorError - would be throw if input curve is not supported.