iaik.pkcs.pkcs11.parameters.EcDH2KeyDerivationParameters Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sunpkcs11-wrapper Show documentation
Show all versions of sunpkcs11-wrapper Show documentation
PKCS#11 wrapper based on sunpkcs11
// 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.Util;
import iaik.pkcs.pkcs11.objects.PKCS11Object;
import sun.security.pkcs11.wrapper.CK_ECDH2_DERIVE_PARAMS;
import java.util.Arrays;
/**
* This abstract class encapsulates parameters for the DH mechanism
* Mechanism.ECMQV_DERIVE.
*
* @author Karl Scheibelhofer
* @version 1.0
*/
public class EcDH2KeyDerivationParameters extends DHKeyDerivationParameters {
/**
* The data shared between the two parties.
*/
protected byte[] sharedData;
/**
* The length in bytes of the second EC private key.
*/
protected long privateDataLength;
/**
* The key for the second EC private key value.
*/
protected PKCS11Object privateData;
/**
* The other party's second EC public key value.
*/
protected byte[] publicData2;
/**
* Create a new EcDH1KeyDerivationParameters object with the given
* attributes.
*
* @param kdf
* The key derivation function used on the shared secret value.
* One of the values defined in KeyDerivationFunctionType.
* @param sharedData
* The data shared between the two parties.
* @param publicData
* The other partie's public key value.
* @param privateDataLength
* The length in bytes of the second EC private key.
* @param privateData
* The key for the second EC private key value.
* @param publicData2
* The other party's second EC public key value.
*/
public EcDH2KeyDerivationParameters(long kdf, byte[] sharedData,
byte[] publicData, long privateDataLength, PKCS11Object privateData,
byte[] publicData2) {
super(kdf, publicData);
this.sharedData = sharedData;
this.privateDataLength = privateDataLength;
this.privateData = Util.requireNonNull("privateData", privateData);
this.publicData2 = Util.requireNonNull("publicData2", publicData2);
}
/**
* Get this parameters object as an object of the CK_ECDH2_DERIVE_PARAMS
* class.
*
* @return This object as a CK_ECDH2_DERIVE_PARAMS object.
*/
@Override
public CK_ECDH2_DERIVE_PARAMS getPKCS11ParamsObject() {
CK_ECDH2_DERIVE_PARAMS params = new CK_ECDH2_DERIVE_PARAMS();
params.kdf = kdf;
params.pSharedData = sharedData;
params.pPublicData = publicData;
params.ulPrivateDataLen = privateDataLength;
params.hPrivateData = privateData.getObjectHandle();
params.pPublicData2 = publicData2;
return params;
}
/**
* Get the data shared between the two parties.
*
* @return The data shared between the two parties.
*/
public byte[] getSharedData() {
return sharedData;
}
/**
* Set the data shared between the two parties.
*
* @param sharedData
* The data shared between the two parties.
*/
public void setSharedData(byte[] sharedData) {
this.sharedData = sharedData;
}
/**
* Get the key for the second EC private key value.
*
* @return The key for the second EC private key value.
*/
public PKCS11Object getPrivateData() {
return privateData;
}
/**
* Get the length in bytes of the second EC private key.
*
* @return The length in bytes of the second EC private key.
*/
public long getPrivateDataLength() {
return privateDataLength;
}
/**
* Get the other party's second EC public key value.
*
* @return The other party's second EC public key value.
*/
public byte[] getPublicData2() {
return publicData2;
}
/**
* Set the key for the second EC private key value.
*
* @param privateData
* The key for the second EC private key value.
*/
public void setPrivateData(PKCS11Object privateData) {
this.privateData = Util.requireNonNull("privateData", privateData);
}
/**
* Set the length in bytes of the second EC private key.
*
* @param privateDataLength
* The length in bytes of the second EC private key.
*/
public void setPrivateDataLength(long privateDataLength) {
this.privateDataLength = privateDataLength;
}
/**
* Set the other party's second EC public key value.
*
* @param publicData2
* The other party's second EC public key value.
*/
public void setPublicData2(byte[] publicData2) {
this.publicData2 = Util.requireNonNull("publicData2", publicData2);
}
/**
* 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() {
String upperStr = super.toString();
return Util.concatObjectsCap(upperStr.length() + 100, upperStr,
"\n Shared Data: ", Util.toHex(sharedData),
"\n Private Data Length (dec): ", privateDataLength,
"\n Private Data: ", privateData,
"\n Public Data 2: ", Util.toHex(publicData2));
}
/**
* 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.
*/
@Override
public boolean equals(Object otherObject) {
if (this == otherObject) {
return true;
} else if (!(otherObject instanceof EcDH2KeyDerivationParameters)) {
return false;
}
EcDH2KeyDerivationParameters other =
(EcDH2KeyDerivationParameters) otherObject;
return super.equals(other)
&& Arrays.equals(this.sharedData, other.sharedData)
&& (this.privateDataLength == other.privateDataLength)
&& this.privateData.equals(other.privateData)
&& Arrays.equals(this.publicData2, other.publicData2);
}
/**
* 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.
*/
@Override
public int hashCode() {
return super.hashCode() ^ Util.hashCode(sharedData)
^ ((int) privateDataLength) ^ privateData.hashCode()
^ Util.hashCode(publicData2);
}
}