iaik.pkcs.pkcs11.parameters.DHPkcsDeriveParameters Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sunpkcs11-wrapper
PKCS#11 wrapper based on sunpkcs11
There is a newer version: 1.4.3
// Copyright (c) 2002 Graz University of Technology. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice,
//    this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
//
// 3. The end-user documentation included with the redistribution, if any, must
//    include the following acknowledgment:
//
//    "This product includes software developed by IAIK of Graz University of
//     Technology."
//
//    Alternately, this acknowledgment may appear in the software itself, if and
//    wherever such third-party acknowledgments normally appear.
//
// 4. The names "Graz University of Technology" and "IAIK of Graz University of
//    Technology" must not be used to endorse or promote products derived from
//    this software without prior written permission.
//
// 5. Products derived from this software may not be called "IAIK PKCS Wrapper",
//    nor may "IAIK" appear in their name, without prior written permission of
//    Graz University of Technology.
//
// THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE LICENSOR BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
// OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
// OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
// ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
// OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.

package iaik.pkcs.pkcs11.parameters;

import iaik.pkcs.pkcs11.TokenRuntimeException;
import iaik.pkcs.pkcs11.Util;
import iaik.pkcs.pkcs11.wrapper.Constants;
import iaik.pkcs.pkcs11.wrapper.Functions;

/**
 * This class encapsulates parameters for the algorithms
 * Mechanism.DH_PKCS_DERIVE.
 *
 * @author Karl Scheibelhofer
 * @version 1.0
 * @invariants (publicValue_ <> null)
 */
public class DHPkcsDeriveParameters implements Parameters {

    /**
     * The initialization vector.
     */
    protected byte[] publicValue_;

    /**
     * Create a new DHPkcsDeriveParameters object with the given public value.
     *
     * @param publicValue
     *          The public value of the other party in the key agreement
     *          protocol.
     * @preconditions (publicValue <> null)
     * @postconditions
     */
    public DHPkcsDeriveParameters(byte[] publicValue) {
        publicValue_ = publicValue;
    }

    /**
     * Create a (deep) clone of this object.
     *
     * @return A clone of this object.
     * @preconditions
     * @postconditions (result <> null)
     *                 and (result instanceof DHPkcsDeriveParameters)
     *                 and (result.equals(this))
     */
    @Override
    public java.lang.Object clone() {
        DHPkcsDeriveParameters clone;

        try {
            clone = (DHPkcsDeriveParameters) super.clone();

            clone.publicValue_ = (byte[]) this.publicValue_.clone();
        } catch (CloneNotSupportedException ex) {
            // this must not happen, because this class is cloneable
            throw new TokenRuntimeException(
                    "An unexpected clone exception occurred.", ex);
        }

        return clone;
    }

    /**
     * Get this parameters object as a byte array.
     *
     * @return This object as a byte array.
     * @preconditions
     * @postconditions (result <> null)
     */
    @Override
    public Object getPKCS11ParamsObject() {
        return publicValue_;
    }

    /**
     * Get the public value of the other party in the key agreement protocol.
     *
     * @return The public value of the other party in the key agreement
     *         protocol.
     * @preconditions
     * @postconditions (result <> null)
     */
    public byte[] getPublicValue() {
        return publicValue_;
    }

    /**
     * Set the public value of the other party in the key agreement protocol.
     *
     * @param publicValue
     *          The public value of the other party in the key agreement
     *          protocol.
     * @preconditions (publicValue <> null)
     * @postconditions
     */
    public void setPublicValue(byte[] publicValue) {
        publicValue_ = Util.requireNonNull("publicValue", publicValue);
    }

    /**
     * Returns the string representation of this object. Do not parse data from
     * this string, it is for debugging only.
     *
     * @return A string representation of this object.
     */
    @Override
    public String toString() {
        StringBuilder buffer = new StringBuilder();

        buffer.append(Constants.INDENT);
        buffer.append("Public Value (hex): ");
        buffer.append(Functions.toHexString(publicValue_));

        return buffer.toString();
    }

    /**
     * Compares all member variables of this object with the other object.
     * Returns only true, if all are equal in both objects.
     *
     * @param otherObject
     *          The other object to compare to.
     * @return True, if other is an instance of this class and all member
     *         variables of both objects are equal. False, otherwise.
     * @preconditions
     * @postconditions
     */
    @Override
    public boolean equals(java.lang.Object otherObject) {
        if (this == otherObject) {
            return true;
        }

        if (!(otherObject instanceof DHPkcsDeriveParameters)) {
            return false;
        }

        DHPkcsDeriveParameters other = (DHPkcsDeriveParameters) otherObject;
        return Functions.equals(this.publicValue_, other.publicValue_);
    }

    /**
     * The overriding of this method should ensure that the objects of this
     * class work correctly in a hashtable.
     *
     * @return The hash code of this object.
     * @preconditions
     * @postconditions
     */
    @Override
    public int hashCode() {
        return Functions.hashCode(publicValue_);
    }

}