Package de.adorsys.keymanagement.api.metadata

Interface KeyMetadataOper

All Known Subinterfaces:
KeyMetadataPersistence
All Known Implementing Classes:
NoOpMetadataPersistence
public interface KeyMetadataOper

  • Method Details

    • metadataPassword

      @Nullable default char[] metadataPassword(String forAlias)
      Password that will be used to store metadata as key entry in encrypted KeySource (i.e. java Keystore). By default password is null for keys of metadata type
      Parameters:
      forAlias - name used to find key
      Returns:
      password for specified alias as byte array

    • metadataAliasForKeyAlias

      String metadataAliasForKeyAlias(String forAlias)
      Generates metadata key entry alias from key alias
      Parameters:
      forAlias - key name used to find key in KeyStore
      Returns:
      metadata alias

    • isMetadataEntry

      boolean isMetadataEntry(String forAlias, KeyStore keyStore)
      Checks if key for provided entry alias is metadata-entry
      Parameters:
      forAlias - name used to find key
      keyStore - Keystore where search entry
      Returns:
      true if entry contains metadata

    • extract

      KeyMetadata extract(String forAlias, KeyStore keyStore)
      Reads metadata entry for key (by its alias) from KeyStore
      Parameters:
      forAlias - name used to find key
      keyStore - KeyStore where search key
      Returns:
      key metadata

    • persistMetadata

      void persistMetadata(String forAlias, KeyMetadata metadata, KeyStore keyStore)
      Saves metadata for existing key in KeyStore
      Parameters:
      forAlias - name used to find key
      metadata - new key metadata
      keyStore - which consists key to which metadata will be added

    • removeMetadata

      void removeMetadata(String forAlias, KeyStore keyStore)
      Removes key metadata from KeyStore
      Parameters:
      forAlias - name used to find key
      keyStore - key store to remove metadata from