Packages

t

com.digitalasset.canton.crypto

CryptoPrivateStoreApi

trait CryptoPrivateStoreApi extends CryptoPrivateApi with EncryptionPrivateStoreOps with SigningPrivateStoreOps with HmacPrivateStoreOps

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CryptoPrivateStoreApi
  2. HmacPrivateStoreOps
  3. SigningPrivateStoreOps
  4. EncryptionPrivateStoreOps
  5. CryptoPrivateApi
  6. HmacPrivateOps
  7. HmacOps
  8. SigningPrivateOps
  9. EncryptionPrivateOps
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def defaultEncryptionKeyScheme: EncryptionKeyScheme
    Definition Classes
    EncryptionPrivateOps
  2. abstract def defaultSigningKeyScheme: SigningKeyScheme
    Definition Classes
    SigningPrivateOps
  3. implicit abstract val ec: ExecutionContext
    Definition Classes
    SigningPrivateStoreOps
  4. abstract val encryptionOps: EncryptionOps
    Attributes
    protected
    Definition Classes
    EncryptionPrivateStoreOps
  5. abstract def generateEncryptionKeypair(scheme: EncryptionKeyScheme)(implicit traceContext: TraceContext): EitherT[Future, EncryptionKeyGenerationError, EncryptionKeyPair]

    Internal method to generate and return the entire encryption key pair

    Internal method to generate and return the entire encryption key pair

    Attributes
    protected
    Definition Classes
    EncryptionPrivateStoreOps
  6. abstract def generateSigningKeypair(scheme: SigningKeyScheme)(implicit traceContext: TraceContext): EitherT[Future, SigningKeyGenerationError, SigningKeyPair]

    Internal method to generate and return the entire signing key pair

    Internal method to generate and return the entire signing key pair

    Attributes
    protected
    Definition Classes
    SigningPrivateStoreOps
  7. abstract val signingOps: SigningOps
    Attributes
    protected
    Definition Classes
    SigningPrivateStoreOps
  8. abstract val store: CryptoPrivateStore
    Attributes
    protected
    Definition Classes
    HmacPrivateStoreOps

Concrete 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() @HotSpotIntrinsicCandidate()
  6. def decrypt[M](encryptedMessage: Encrypted[M], encryptionKeyId: Fingerprint)(deserialize: (ByteString) => Either[DeserializationError, M]): EitherT[Future, DecryptionError, M]

    Decrypts an encrypted message using the referenced private encryption key

    Decrypts an encrypted message using the referenced private encryption key

    Definition Classes
    EncryptionPrivateStoreOpsEncryptionPrivateOps
  7. def defaultHmacAlgorithm: HmacAlgorithm
    Definition Classes
    HmacOps
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. def generateEncryptionKey(scheme: EncryptionKeyScheme = defaultEncryptionKeyScheme, name: Option[KeyName] = None)(implicit traceContext: TraceContext): EitherT[Future, EncryptionKeyGenerationError, EncryptionPublicKey]

    Generates a new encryption key pair with the given scheme and optional name, stores the private key and returns the public key.

    Generates a new encryption key pair with the given scheme and optional name, stores the private key and returns the public key.

    Definition Classes
    EncryptionPrivateStoreOpsEncryptionPrivateOps
  11. def generateSigningKey(scheme: SigningKeyScheme, name: Option[KeyName])(implicit traceContext: TraceContext): EitherT[Future, SigningKeyGenerationError, SigningPublicKey]

    Generates a new signing key pair with the given scheme and optional name, stores the private key and returns the public key.

    Generates a new signing key pair with the given scheme and optional name, stores the private key and returns the public key.

    Attributes
    protected[crypto]
    Definition Classes
    SigningPrivateStoreOpsSigningPrivateOps
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. def hmac(message: ByteString, algorithm: HmacAlgorithm = defaultHmacAlgorithm)(implicit executionContext: ExecutionContext): EitherT[Future, HmacError, Hmac]

    Calculates the HMAC of the given message using the stored private key

    Calculates the HMAC of the given message using the stored private key

    Definition Classes
    HmacPrivateOps
  15. def hmacSecret(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, HmacError, Option[HmacSecret]]
    Definition Classes
    HmacPrivateStoreOpsHmacPrivateOps
  16. def hmacWithSecret(secret: HmacSecret, message: ByteString, algorithm: HmacAlgorithm = defaultHmacAlgorithm): Either[HmacError, Hmac]
    Definition Classes
    HmacOps
  17. def initializeHmacSecret(length: Int = HmacSecret.defaultLength)(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, HmacError, Unit]

    Initializes the private HMAC secret if not present

    Initializes the private HMAC secret if not present

    Definition Classes
    HmacPrivateStoreOpsHmacPrivateOps
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. def rotateHmacSecret(length: Int = HmacSecret.defaultLength)(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, HmacError, Unit]

    Rotates the private HMAC secret by replacing the existing one with a newly generated secret.

    Rotates the private HMAC secret by replacing the existing one with a newly generated secret.

    Definition Classes
    HmacPrivateStoreOpsHmacPrivateOps
  23. def sign(bytes: ByteString, signingKeyId: Fingerprint): EitherT[Future, SigningError, Signature]

    Signs the byte string directly, however it is encouraged to sign a hash.

    Signs the byte string directly, however it is encouraged to sign a hash.

    Attributes
    protected[crypto]
    Definition Classes
    SigningPrivateStoreOpsSigningPrivateOps
  24. def sign(hash: Hash, signingKeyId: Fingerprint): EitherT[Future, SigningError, Signature]

    Signs the given hash using the referenced private signing key.

    Signs the given hash using the referenced private signing key.

    Definition Classes
    SigningPrivateOps
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

Inherited from HmacPrivateStoreOps

Inherited from SigningPrivateStoreOps

Inherited from CryptoPrivateApi

Inherited from HmacPrivateOps

Inherited from HmacOps

Inherited from SigningPrivateOps

Inherited from EncryptionPrivateOps

Inherited from AnyRef

Inherited from Any

Ungrouped