Module org.apache.santuario.xmlsec
Package org.apache.xml.security.encryption

Interface KeyDerivationMethod

All Known Implementing Classes:
KeyDerivationMethodImpl
public interface KeyDerivationMethod
The key derivation is to generate new cryptographic key material from existing key material such as the shared secret and any other (private or public) information. The implementations of this interface provides XML serializing/deserializing of the: KeyDerivationParameters for various key derivation algorithms. The Schema for KeyDerivationMethod is as follows:

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAlgorithm()
    Returns the algorithm URI of this KeyDerivationMethod.
    KDFParams
    getKDFParams()
    Returns the KDF parameters used by the key derivation algorithm.

  • Method Details

    • getAlgorithm

      String getAlgorithm()
      Returns the algorithm URI of this KeyDerivationMethod.
      Returns:
      the algorithm URI string

    • getKDFParams

      KDFParams getKDFParams() throws XMLSecurityException
      Returns the KDF parameters used by the key derivation algorithm. Currently supported types are: ConcatKDFParams and HKDFParams.
      Returns:
      the KDFParams used by the key derivation algorithm
      Throws:
      XMLSecurityException - if the KDFParams cannot be created