org.apache.xml.security.encryption.KeyDerivationMethod Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xmlsec Show documentation

Apache XML Security for Java supports XML-Signature Syntax and Processing, W3C Recommendation 12 February 2002, and XML Encryption Syntax and Processing, W3C Recommendation 10 December 2002. As of version 1.4, the library supports the standard Java API JSR-105: XML Digital Signature APIs.

The newest version!

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.xml.security.encryption;

import org.apache.xml.security.encryption.keys.content.derivedKey.KDFParams;
import org.apache.xml.security.exceptions.XMLSecurityException;

/**
 * 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: {@link org.apache.xml.security.encryption.params.KeyDerivationParameters} for
 * various key derivation algorithms.
 *
 * The Schema for KeyDerivationMethod is as follows:
 *  * 
 * 
 *   
 *     
 *   
 *   
 * 
 * 
 */
public interface KeyDerivationMethod {

    /**
     * Returns the algorithm URI of this KeyDerivationMethod.
     *
     * @return the algorithm URI string
     */
    String getAlgorithm();

    /**
     * Returns the KDF parameters used by the key derivation algorithm.
     * Currently supported types are:
     * {@link org.apache.xml.security.encryption.params.ConcatKDFParams} and
     * {@link org.apache.xml.security.encryption.params.HKDFParams}.
     *
     * @return the KDFParams used by the key derivation algorithm
     * @throws XMLSecurityException if the KDFParams cannot be created
     */
    KDFParams getKDFParams() throws XMLSecurityException;

}