Package ch.admin.bit.jeap.crypto.api

Interface KeyIdCryptoService

All Known Implementing Classes:
NoopKeyIdCryptoService
public interface KeyIdCryptoService

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canDecrypt(byte[] ciphertext)
     
    Set<KeyId>
    configuredKeyIds()
     
    byte[]
    decrypt(byte[] ciphertextCryptoContainer)
    Decrypts a jEAP crypto container back to the plaintext bytes.
    byte[]
    encrypt(byte[] plaintext, KeyId keyId)
    Encrypts plaintext to a jEAP crypto container, using the wrapping key identified by the given key id for the encryption of the data.
    default boolean
    knows(KeyId keyId)
    Does this key id crypto service know the given key id and can link it to a wrapping key to be used for encryption?

  • Method Details

    • encrypt

      byte[] encrypt(byte[] plaintext, KeyId keyId)
      Encrypts plaintext to a jEAP crypto container, using the wrapping key identified by the given key id for the encryption of the data.
      Parameters:
      plaintext - Plaintext bytes to be encrypted
      keyId - Identifier for the wrapping key to be used for the encryption
      Returns:
      Encrypted data container, formatted according to a JeapCryptoDataFormat
      Throws:
      CryptoException - If encryption fails for any reason (empty plaintext, bad configuration, unknown key id, unable to get data key, ...)

    • decrypt

      byte[] decrypt(byte[] ciphertextCryptoContainer)
      Decrypts a jEAP crypto container back to the plaintext bytes.
      Parameters:
      ciphertextCryptoContainer - Encrypted data container, formatted according to a JeapCryptoDataFormat
      Returns:
      Decrypted plaintext bytes
      Throws:
      CryptoException - If decryption fails for any reason (bad configuration, unable to decrypt data key, ...)

    • knows

      default boolean knows(KeyId keyId)
      Does this key id crypto service know the given key id and can link it to a wrapping key to be used for encryption?
      Parameters:
      keyId - The key id
      Returns:
      true if this service knows the given key id and can link it to a wrapping key to be used for encryption, false otherwise.

    • configuredKeyIds

      Set<KeyId> configuredKeyIds()

    • canDecrypt

      boolean canDecrypt(byte[] ciphertext)