Packages

final case class StoredPrivateKey(id: Fingerprint, data: ByteString, purpose: KeyPurpose, name: Option[KeyName], wrapperKeyId: Option[String300]) extends Product with Serializable

Represents the data to be stored in the crypto_private_keys table. If wrapperKeyId is set (Some(wrapperKeyId)) then the data field is encrypted otherwise (None), then the data field is in plaintext.

id

canton identifier for a private key

data

a ByteString that stores either: (1) the serialized private key case class, which contains the private key plus metadata, or (2) the above proto serialization but encrypted with the wrapper key if present.

purpose

to identify if the key is for signing or encryption

name

an alias name for the private key

wrapperKeyId

identifies what is the key being used to encrypt the data field. If empty, data is unencrypted.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StoredPrivateKey
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new StoredPrivateKey(id: Fingerprint, data: ByteString, purpose: KeyPurpose, name: Option[KeyName], wrapperKeyId: Option[String300])

    id

    canton identifier for a private key

    data

    a ByteString that stores either: (1) the serialized private key case class, which contains the private key plus metadata, or (2) the above proto serialization but encrypted with the wrapper key if present.

    purpose

    to identify if the key is for signing or encryption

    name

    an alias name for the private key

    wrapperKeyId

    identifies what is the key being used to encrypt the data field. If empty, data is unencrypted.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. val data: ByteString
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. val id: Fingerprint
  10. def isEncrypted: Boolean
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. val name: Option[KeyName]
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  16. def productElementNames: Iterator[String]
    Definition Classes
    Product
  17. val purpose: KeyPurpose
  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. val wrapperKeyId: Option[String300]

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped