Package com.couchbase.client.encryption

Interface KeyStoreProvider

public interface KeyStoreProvider
Key provider interface for key store implementation.
Since:
0.1.0
Author:
Subhashni Balakrishnan

  • Method Details

    • getKey

      byte[] getKey​(String keyName) throws Exception
      Internally used by crypto providers to retrieve the key for encryption/decryption.
      Parameters:
      keyName - The key to be retrieved for secret keys. Add suffix _public/_private to retrieve public/private key
      Returns:
      key Key as raw bytes
      Throws:
      Exception - on failure

    • storeKey

      void storeKey​(String keyName, byte[] key) throws Exception
      Add a key
      Parameters:
      keyName - Name of the key
      key - Secret key as byes
      Throws:
      Exception - on failure

    • publicKeyName

      String publicKeyName()
      Get the name of the encryption key
      Returns:
      encryption key name

    • publicKeyName

      void publicKeyName​(String name)
      Set the name of the encryption key
      Parameters:
      name - encryption key

    • privateKeyName

      String privateKeyName()
      Get the private key name set
      Returns:
      private key name

    • privateKeyName

      void privateKeyName​(String name)
      Set the private key name required for an asymmetic cryptographic algorithm
      Parameters:
      name - private key name

    • signingKeyName

      String signingKeyName()
      Get the signing key name/password set
      Returns:
      name

    • signingKeyName

      void signingKeyName​(String name)
      Set signing key name/password
      Parameters:
      name - Signing key name