Packages

trait VaultService extends AbstractService

* Vault service providing programmatic access to locally stored keys and certificates

We have two key-stores: a private key store where we are storing our pairs of public and private keys and a public key store where we are storing other public keys that we learned.

We learn public key stores in different ways: either by importing them or by picking them up from internal sources (such as identity management updates).

The only purpose of the public key store (where we import foreign keys) is convenience for identity management such that when we add identity management transactions, we can refer to fingerprints in commands while building them rather than having to attach public-key files.

In addition, we also provide access to the locally stored certificates which are used either by the HTTP/1.1 sequencer client or for legal identity claims.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. VaultService
  2. AbstractService
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def generateCertificate(request: GenerateCertificateRequest): Future[GenerateCertificateResponse]

    * Create a new, self-signed certificate with CN=unique_identifier

  2. abstract def generateEncryptionKey(request: GenerateEncryptionKeyRequest): Future[GenerateEncryptionKeyResponse]

    * Generates a new public / private key pair for hybrid encryption.

    * Generates a new public / private key pair for hybrid encryption.

    Stores the private key in the vault, and returns the public key

  3. abstract def generateSigningKey(request: GenerateSigningKeyRequest): Future[GenerateSigningKeyResponse]

    * Generates a new public / private key pair for signing.

    * Generates a new public / private key pair for signing.

    Stores the private key in the vault, and returns the public key

  4. abstract def importCertificate(request: ImportCertificateRequest): Future[ImportCertificateResponse]

    * Import a X509 certificate into the local vault.

  5. abstract def importPublicKey(request: ImportPublicKeyRequest): Future[ImportPublicKeyResponse]

    * Import a public key into the registry in order to provide that Fingerprint -> PublicKey lookups

    * Import a public key into the registry in order to provide that Fingerprint -> PublicKey lookups

    @param: ImportPublicKeyRequest serialized public key to be imported @return: fingerprint and serialized public key of imported public key

  6. abstract def listCertificates(request: ListCertificateRequest): Future[ListCertificateResponse]

    * List certificates stored in the local vault

  7. abstract def listMyKeys(request: ListKeysRequest): Future[ListKeysResponse]

    * List public keys according to request filter for which we have a private key in our key vault.

    * List public keys according to request filter for which we have a private key in our key vault.

    The request includes a filter for fingerprints which can be used for lookups.

    @param ListMyKeysRequest: request with optional fingerprint filter @return: all serialized keys and their fingerprints that have the fingerprint filter as a substring in their fingerprint

  8. abstract def listPublicKeys(request: ListKeysRequest): Future[ListKeysResponse]

    * Lists all public keys matching the supplied filter which are internally cached

    * Lists all public keys matching the supplied filter which are internally cached

    Any public key returned here can be referenced in topology transaction building by fingerprint.

  9. abstract def rotateHmacSecret(request: RotateHmacSecretRequest): Future[RotateHmacSecretResponse]

    * Rotate the stored HMAC secret.

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. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. def serviceCompanion: VaultService
    Definition Classes
    VaultService → AbstractService
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  19. 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 AbstractService

Inherited from AnyRef

Inherited from Any

Ungrouped