Package org.xrpl.xrpl4j.crypto.signing.bc

Class BcSignatureService

java.lang.Object

org.xrpl.xrpl4j.crypto.signing.AbstractSignatureService<PrivateKey>

org.xrpl.xrpl4j.crypto.signing.bc.BcSignatureService

All Implemented Interfaces:

SignatureService<PrivateKey>, TransactionSigner<PrivateKey>, TransactionVerifier

public class BcSignatureService
extends AbstractSignatureService<PrivateKey>
implements SignatureService<PrivateKey>

A SignatureService that uses BouncyCastle internally to sign with an in-memory instance of PrivateKey.

WARNING: This implementation utilizes in-memory private-key material. Consider instead using a SignatureService that uses instance of PrivateKeyReference for improved security.

See Also:

• "https://www.bouncycastle.org/java.html"
• "https://www.bouncycastle.org/fips-java/BCFipsIn100.pdf"

Constructor Summary

Constructors

Constructor	Description
BcSignatureService()	Required-args Constructor for use in development mode.
BcSignatureService(SignatureUtils signatureUtils, org.bouncycastle.crypto.signers.Ed25519Signer ed25519Signer, org.bouncycastle.crypto.signers.ECDSASigner ecdsaSigner)	Required-args Constructor.

Method Summary

Modifier and Type	Method	Description
PublicKey	derivePublicKey(PrivateKey privateKey)	Helper method to derive a public key from a private key.
protected Signature	ecDsaSign(PrivateKey privateKey, UnsignedByteArray transactionBytes)	Does the actual work of computing a signature using a secp256k1 private-key, as locatable using privateKey.
protected boolean	ecDsaVerify(PublicKey publicKey, UnsignedByteArray transactionBytes, Signature signature)	Verify a signature.
protected Signature	edDsaSign(PrivateKey privateKey, UnsignedByteArray signableTransactionBytes)	Does the actual work of computing a signature using a ed25519 private-key, as locatable using privateKey.
protected boolean	edDsaVerify(PublicKey publicKey, UnsignedByteArray transactionBytes, Signature signature)	Verify a signature.

Methods inherited from class org.xrpl.xrpl4j.crypto.signing.AbstractSignatureService

multiSign, multiSignInner, sign, sign, sign, signInner, verify, verifyMultiSigned

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xrpl.xrpl4j.crypto.signing.TransactionSigner

multiSign, multiSignInner, multiSignToSigner, sign, sign, sign, signInner

Methods inherited from interface org.xrpl.xrpl4j.crypto.signing.TransactionVerifier

verify, verifyMultiSigned, verifyMultiSigned

Constructor Details

BcSignatureService

public BcSignatureService()

Required-args Constructor for use in development mode.

BcSignatureService

public BcSignatureService(SignatureUtils signatureUtils,
 org.bouncycastle.crypto.signers.Ed25519Signer ed25519Signer,
 org.bouncycastle.crypto.signers.ECDSASigner ecdsaSigner)

Required-args Constructor.

Parameters:

signatureUtils - An SignatureUtils.

ed25519Signer - An Ed25519Signer.

ecdsaSigner - An ECDSASigner.

Method Details

edDsaSign

protected Signature edDsaSign(PrivateKey privateKey,
 UnsignedByteArray signableTransactionBytes)

Description copied from class: AbstractSignatureService

Does the actual work of computing a signature using a ed25519 private-key, as locatable using privateKey.

Specified by:

edDsaSign in class AbstractSignatureService<PrivateKey>

Parameters:

privateKey - A AbstractSignatureService used for signing.

signableTransactionBytes - A UnsignedByteArray to sign.

Returns:

A Signature with data that can be used to submit a transaction to the XRP Ledger.

ecDsaSign

protected Signature ecDsaSign(PrivateKey privateKey,
 UnsignedByteArray transactionBytes)

Description copied from class: AbstractSignatureService

Does the actual work of computing a signature using a secp256k1 private-key, as locatable using privateKey.

Specified by:

ecDsaSign in class AbstractSignatureService<PrivateKey>

Parameters:

privateKey - A AbstractSignatureService used for signing.

transactionBytes - A UnsignedByteArray to sign.

Returns:

A Signature with data that can be used to submit a transaction to the XRP Ledger.

edDsaVerify

protected boolean edDsaVerify(PublicKey publicKey,
 UnsignedByteArray transactionBytes,
 Signature signature)

Description copied from class: AbstractSignatureService

Verify a signature.

Specified by:

edDsaVerify in class AbstractSignatureService<PrivateKey>

Parameters:

publicKey - The PublicKey used to verify the signed transaction.

transactionBytes - An UnsignedByteArray containing the bytes of the transaction that was signed.

signature - A Signature over the transaction.

Returns:

true if the signature is valid; false otherwise.

ecDsaVerify

protected boolean ecDsaVerify(PublicKey publicKey,
 UnsignedByteArray transactionBytes,
 Signature signature)

Description copied from class: AbstractSignatureService

Verify a signature.

Specified by:

ecDsaVerify in class AbstractSignatureService<PrivateKey>

Parameters:

publicKey - A PublicKey.

transactionBytes - An UnsignedByteArray containing the bytes of the transaction that was signed.

signature - A Signature over the transaction.

Returns:

true if the signature is valid; false otherwise.

derivePublicKey

public PublicKey derivePublicKey(PrivateKey privateKey)

Description copied from class: AbstractSignatureService

Helper method to derive a public key from a private key.

Specified by:

derivePublicKey in interface TransactionSigner<PrivateKey>

Specified by:

derivePublicKey in class AbstractSignatureService<PrivateKey>

Parameters:

privateKey - An instance of PrivateKey.

Returns:

A corresponding PublicKey.