Package org.gridgain.internal.encryption.storage

Interface DataEncryptionKeyManager

All Known Implementing Classes:
DataEncryptionKeyManagerImpl
public interface DataEncryptionKeyManager
Data encryption key manager with chain mechanism. Each data encryption key stores in some key chain and all keys in one chain has one.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.gridgain.internal.encryption.provider.DataEncryptionKey
    activeKey(String chainId)
    Returns active key for provided chain identifier.
    void
    addKey(String chainId, org.gridgain.internal.encryption.provider.DataEncryptionKey newKey)
    Adds new data encryption key to chain with provided identifier.
    void
    changeActiveKey(String chainId, int keyId)
    Changes active data encryption key to key with provided identifier in key chain.
    boolean
    createKeyChain(String chainId, org.gridgain.internal.encryption.provider.DataEncryptionKey key, @Nullable String providerName)
    Creates new key chain with provided identifier and store key as active.
    org.gridgain.internal.encryption.provider.DataEncryptionKey
    getKey(String chainId, int keyId)
    Returns key with provided key identifier from chain with provided identifier.
    boolean
    keyChainExists(String chainId)
    Returns true if chain with provided identifier exists or false if not.
    void
    remove(String chainId)
    Removes key chain.

  • Method Details

    • createKeyChain

      boolean createKeyChain(String chainId, org.gridgain.internal.encryption.provider.DataEncryptionKey key, @Nullable @Nullable String providerName)
      Creates new key chain with provided identifier and store key as active. Provider name using to encrypt.
      Parameters:
      chainId - Key chain identifier.
      key - Data encryption key.
      providerName - Encryption provider name.
      Returns:
      true if key chain is created and false in case when chain with chainId already exists.

    • activeKey

      org.gridgain.internal.encryption.provider.DataEncryptionKey activeKey(String chainId)
      Returns active key for provided chain identifier.
      Parameters:
      chainId - Chain identifier.

    • getKey

      org.gridgain.internal.encryption.provider.DataEncryptionKey getKey(String chainId, int keyId)
      Returns key with provided key identifier from chain with provided identifier.
      Parameters:
      chainId - Chain identifier.
      keyId - Key identifier.

    • keyChainExists

      boolean keyChainExists(String chainId)
      Returns true if chain with provided identifier exists or false if not.
      Parameters:
      chainId - Chain identifier.

    • addKey

      void addKey(String chainId, org.gridgain.internal.encryption.provider.DataEncryptionKey newKey)
      Adds new data encryption key to chain with provided identifier.
      Parameters:
      chainId - Chain identifier.
      newKey - Data encryption key.

    • changeActiveKey

      void changeActiveKey(String chainId, int keyId)
      Changes active data encryption key to key with provided identifier in key chain.
      Parameters:
      chainId - Chain identifier.
      keyId - Key identifier.

    • remove

      void remove(String chainId)
      Removes key chain.
      Parameters:
      chainId - Chain identifier.