Packages

t

com.digitalasset.canton.crypto

CryptoPrivateApi

trait CryptoPrivateApi extends EncryptionPrivateOps with SigningPrivateOps with HmacPrivateOps

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CryptoPrivateApi
  2. HmacPrivateOps
  3. HmacOps
  4. SigningPrivateOps
  5. EncryptionPrivateOps
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def decrypt[M](encrypted: 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
    EncryptionPrivateOps
  2. abstract def defaultEncryptionKeyScheme: EncryptionKeyScheme
    Definition Classes
    EncryptionPrivateOps
  3. abstract def defaultSigningKeyScheme: SigningKeyScheme
    Definition Classes
    SigningPrivateOps
  4. abstract 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
    EncryptionPrivateOps
  5. abstract def generateSigningKey(scheme: SigningKeyScheme = defaultSigningKeyScheme, name: Option[KeyName] = None)(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
    SigningPrivateOps
  6. abstract def hmacSecret(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, HmacError, Option[HmacSecret]]
    Attributes
    protected
    Definition Classes
    HmacPrivateOps
  7. abstract def initializeHmacSecret(length: Int = HmacSecret.defaultLength)(implicit executionContext: 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
    HmacPrivateOps
  8. abstract def rotateHmacSecret(length: Int = HmacSecret.defaultLength)(implicit executionContext: 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
    HmacPrivateOps
  9. abstract 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
    SigningPrivateOps

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 defaultHmacAlgorithm: HmacAlgorithm
    Definition Classes
    HmacOps
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. 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
  12. def hmacWithSecret(secret: HmacSecret, message: ByteString, algorithm: HmacAlgorithm = defaultHmacAlgorithm): Either[HmacError, Hmac]
    Definition Classes
    HmacOps
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. 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
  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  22. 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 HmacPrivateOps

Inherited from HmacOps

Inherited from SigningPrivateOps

Inherited from EncryptionPrivateOps

Inherited from AnyRef

Inherited from Any

Ungrouped