docs/net.corda.core.crypto.internal/AliasPrivateKey

AliasPrivateKey

data class AliasPrivateKey(val alias: String) : PrivateKey

PrivateKey wrapper to just store the alias of a private key. Usually, HSM (hardware secure module) key entries are accessed via unique aliases and the private key material never leaves the box. This class wraps a String key alias into a PrivateKey object, which helps on transferring KeyPair objects without exposing the private key material. Then, whenever we need to sign with the actual private key, we provide the alias from this AliasPrivateKey to the underlying HSM implementation.

Constructors

AliasPrivateKey

constructor(alias: String)

Types

Companion

object Companion

Properties

alias

val alias: String

Functions

destroy

open fun destroy()

getAlgorithm

open override fun getAlgorithm(): String

getEncoded

open override fun getEncoded(): ByteArray

getFormat

open override fun getFormat(): String

isDestroyed

open fun isDestroyed(): Boolean

sign

fun PrivateKey.sign(bytesToSign: ByteArray): DigitalSignature

Utility to simplify the act of signing a byte array.

fun PrivateKey.sign(bytesToSign: ByteArray, publicKey: PublicKey): DigitalSignature.WithKey

Utility to simplify the act of signing a byte array and return a DigitalSignature.WithKey object. Note that there is no check if the public key matches with the signing private key.