org.apache.xml.security.encryption.AgreementMethod 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 java.security.PublicKey;
import java.util.Iterator;

import org.apache.xml.security.exceptions.XMLSecurityException;
import org.apache.xml.security.encryption.keys.OriginatorKeyInfo;
import org.apache.xml.security.encryption.keys.RecipientKeyInfo;
import org.w3c.dom.Element;

/**
 * A Key Agreement algorithm provides for the derivation of a shared secret key
 * based on a shared secret computed from certain types of compatible public
 * keys from both the sender and the recipient. Information from the originator
 * to determine the secret is indicated by an optional OriginatorKeyInfo
 * parameter child of an AgreementMethod element while that
 * associated with the recipient is indicated by an optional RecipientKeyInfo. A
 * shared key is derived from this shared secret by a method determined by the
 * Key Agreement algorithm.
 * 
 * Note: XML Encryption does not provide an on-line key agreement
 * negotiation protocol. The AgreementMethod element can be used by
 * the originator to identify the keys and computational procedure that were
 * used to obtain a shared encryption key. The method used to obtain or select
 * the keys or algorithm used for the agreement computation is beyond the scope
 * of this specification.
 * 

 * The AgreementMethod element appears as the content of a
 * ds:KeyInfo since, like other ds:KeyInfo children,
 * it yields a key. This ds:KeyInfo is in turn a child of an
 * EncryptedData or EncryptedKey element. The
 * Algorithm attribute and KeySize child of the EncryptionMethod
 * element under this EncryptedData or EncryptedKey
 * element are implicit parameters to the key agreement computation. In cases
 * where this EncryptionMethod algorithm URI is
 * insufficient to determine the key length, a KeySize MUST have been included.
 * In addition, the sender may place a KA-Nonce element under
 * AgreementMethod to assure that different keying material is
 * generated even for repeated agreements using the same sender and recipient
 * public keys.
 * 

 * If the agreed key is being used to wrap a key, then
 * AgreementMethod would appear inside a ds:KeyInfo
 * inside an EncryptedKey element.
 * 

 * The Schema for AgreementMethod is as follows:
 * 
 * 
 * 
 *     
 *         
 *         
 *         
 *         
 *         
 *     
 *     
 * 
 * 
 *
 */
public interface AgreementMethod {

    /**
     * Returns a byte array.
     * @return a byte array.
     */
    byte[] getKANonce();

    /**
     * Sets the KANonce.jj
     * @param kanonce
     */
    void setKANonce(byte[] kanonce);

    /**
     * Returns KeyDerivationMethod information used in the AgreementMethod.
     * @return The KeyDerivationMethod information regarding the AgreementMethod.
     */
    KeyDerivationMethod getKeyDerivationMethod() throws XMLSecurityException;

    /**
     * This method is used to set the KeyDerivationMethod when the AgreementMethod is being
     * used to derive a key. The KeyDerivationMethod is declared as  
     * but is used in ECDH_ES
     *
     * @param keyDerivationMethod
     */
    void setKeyDerivationMethod(KeyDerivationMethod keyDerivationMethod);

    /**
     * Returns additional information regarding the AgreementMethod.
     * @return additional information regarding the AgreementMethod.
     */
    Iterator getAgreementMethodInformation();

    /**
     * Adds additional AgreementMethod information.
     *
     * @param info a Element that represents additional information
     * specified by
     *        *     
     *   
     */
    void addAgreementMethodInformation(Element info);

    /**
     * Removes additional AgreementMethod information.
     *
     * @param info a Element that represents additional information
     * specified by
     *        *     
     *   
     */
    void removeAgreementMethodInformation(Element info);

    /**
     * Returns information relating to the originator's shared secret.
     *
     * @return information relating to the originator's shared secret.
     */
    OriginatorKeyInfo getOriginatorKeyInfo() throws XMLSecurityException;

    /**
     * Sets the information relating to the originator's shared secret.
     *
     * @param keyInfo information relating to the originator's shared secret.
     */
    void setOriginatorKeyInfo(OriginatorKeyInfo keyInfo);

    /**
     * Sets the originator's PublicKey to generate the secret
     *
     * @param publicKey originator's PublicKey
     */
    void setOriginatorPublicKey(PublicKey publicKey);

    /**
     * Returns information relating to the recipient's shared secret.
     *
     * @return information relating to the recipient's shared secret.
     */
    RecipientKeyInfo getRecipientKeyInfo() throws XMLSecurityException;

    /**
     * Sets the information relating to the recipient's shared secret.
     *
     * @param keyInfo information relating to the recipient's shared secret.
     */
    void setRecipientKeyInfo(RecipientKeyInfo keyInfo);

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