javacard.security.KeyBuilder Maven / Gradle / Ivy
Show all versions of jcardsim Show documentation
/*
* Copyright 2011 Licel LLC.
*
* Licensed 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 javacard.security;
import com.licel.jcardsim.crypto.DSAPrivateKeyImpl;
import com.licel.jcardsim.crypto.DSAPublicKeyImpl;
import com.licel.jcardsim.crypto.ECPrivateKeyImpl;
import com.licel.jcardsim.crypto.ECPublicKeyImpl;
import com.licel.jcardsim.crypto.RSAKeyImpl;
import com.licel.jcardsim.crypto.RSAPrivateCrtKeyImpl;
import com.licel.jcardsim.crypto.SymmetricKeyImpl;
/**
*The KeyBuilder class is a key object factory.
*/
public class KeyBuilder {
/**
* Key object which implements interface type DESKey
* with CLEAR_ON_RESET transient key data.
* This Key object implicitly performs a clearKey() on
* power on or card reset.
*/
public static final byte TYPE_DES_TRANSIENT_RESET = 1;
/**
* Key object which implements interface type DESKey
* with CLEAR_ON_DESELECT transient key data.
*
This Key object implicitly performs a clearKey() on
* power on, card reset and applet deselection.
*/
public static final byte TYPE_DES_TRANSIENT_DESELECT = 2;
/**
* Key object which implements interface type DESKey with persistent key data.
*/
public static final byte TYPE_DES = 3;
/**
* Key object which implements interface type RSAPublicKey.
*/
public static final byte TYPE_RSA_PUBLIC = 4;
/**
* Key object which implements interface type RSAPrivateKey which
* uses modulus/exponent form.
*/
public static final byte TYPE_RSA_PRIVATE = 5;
/**
* Key object which implements interface type RSAPrivateCrtKey which
* uses Chinese Remainder Theorem.
*/
public static final byte TYPE_RSA_CRT_PRIVATE = 6;
/**
* Key object which implements the interface type DSAPublicKey
* for the DSA algorithm.
*/
public static final byte TYPE_DSA_PUBLIC = 7;
/**
* Key object which implements the interface type DSAPrivateKey
* for the DSA algorithm.
*/
public static final byte TYPE_DSA_PRIVATE = 8;
/**
* Key object which implements the interface type ECPublicKey
* for EC operations over fields of characteristic 2 with polynomial
* basis.
*/
public static final byte TYPE_EC_F2M_PUBLIC = 9;
/**
* Key object which implements the interface type ECPrivateKey
* for EC operations over fields of characteristic 2 with polynomial
* basis.
*/
public static final byte TYPE_EC_F2M_PRIVATE = 10;
/**
* Key object which implements the interface type ECPublicKey
* for EC operations over large prime fields.
*/
public static final byte TYPE_EC_FP_PUBLIC = 11;
/**
* Key object which implements the interface type ECPrivateKey
* for EC operations over large prime fields.
*/
public static final byte TYPE_EC_FP_PRIVATE = 12;
/**
* Key object which implements interface type AESKey
* with CLEAR_ON_RESET transient key data.
*
This Key object implicitly performs a clearKey() on
* power on or card reset.
*/
public static final byte TYPE_AES_TRANSIENT_RESET = 13;
/**
* Key object which implements interface type AESKey
* with CLEAR_ON_DESELECT transient key data.
*
This Key object implicitly performs a clearKey() on
* power on, card reset and applet deselection.
*/
public static final byte TYPE_AES_TRANSIENT_DESELECT = 14;
/**
* Key object which implements interface type AESKey with persistent key data.
*/
public static final byte TYPE_AES = 15;
/**
* DES Key Length LENGTH_DES = 64.
*/
public static final short LENGTH_DES = 64;
/**
* DES Key Length LENGTH_DES3_2KEY = 128.
*/
public static final short LENGTH_DES3_2KEY = 128;
/**
* DES Key Length LENGTH_DES3_3KEY = 192.
*/
public static final short LENGTH_DES3_3KEY = 192;
/**
* RSA Key Length LENGTH_RSA_512 = 512.
*/
public static final short LENGTH_RSA_512 = 512;
/**
* RSA Key Length LENGTH_RSA_736 = 736.
*/
public static final short LENGTH_RSA_736 = 736;
/**
* RSA Key Length LENGTH_RSA_768 = 768.
*/
public static final short LENGTH_RSA_768 = 768;
/**
* RSA Key Length LENGTH_RSA_896 = 896.
*/
public static final short LENGTH_RSA_896 = 896;
/**
* RSA Key Length LENGTH_RSA_1024 = 1024.
*/
public static final short LENGTH_RSA_1024 = 1024;
/**
* RSA Key Length LENGTH_RSA_1280 = 1280.
*/
public static final short LENGTH_RSA_1280 = 1280;
/**
* RSA Key Length LENGTH_RSA_1536 = 1536.
*/
public static final short LENGTH_RSA_1536 = 1536;
/**
* RSA Key Length LENGTH_RSA_1984 = 1984.
*/
public static final short LENGTH_RSA_1984 = 1984;
/**
* RSA Key Length LENGTH_RSA_2048 = 2048.
*/
public static final short LENGTH_RSA_2048 = 2048;
/**
* DSA Key Length LENGTH_DSA_512 = 512.
*/
public static final short LENGTH_DSA_512 = 512;
/**
* DSA Key Length LENGTH_DSA_768 = 768.
*/
public static final short LENGTH_DSA_768 = 768;
/**
* DSA Key Length LENGTH_DSA_1024 = 1024.
*/
public static final short LENGTH_DSA_1024 = 1024;
/**
* EC Key Length LENGTH_EC_FP_112 = 112.
*/
public static final short LENGTH_EC_FP_112 = 112;
/**
* EC Key Length LENGTH_EC_F2M_113 = 113.
*/
public static final short LENGTH_EC_F2M_113 = 113;
/**
* EC Key Length LENGTH_EC_FP_128 = 128.
*/
public static final short LENGTH_EC_FP_128 = 128;
/**
* EC Key Length LENGTH_EC_F2M_131 = 131.
*/
public static final short LENGTH_EC_F2M_131 = 131;
/**
* EC Key Length LENGTH_EC_FP_160 = 160.
*/
public static final short LENGTH_EC_FP_160 = 160;
/**
* EC Key Length LENGTH_EC_F2M_163 = 163.
*/
public static final short LENGTH_EC_F2M_163 = 163;
/**
* EC Key Length LENGTH_EC_FP_192 = 192.
*/
public static final short LENGTH_EC_FP_192 = 192;
/**
* EC Key Length LENGTH_EC_F2M_193 = 193.
*/
public static final short LENGTH_EC_F2M_193 = 193;
/**
* AES Key Length LENGTH_AES_128 = 128.
*/
public static final short LENGTH_AES_128 = 128;
/**
* AES Key Length LENGTH_AES_192 = 192.
*/
public static final short LENGTH_AES_192 = 192;
/**
* AES Key Length LENGTH_AES_256 = 256.
*/
public static final short LENGTH_AES_256 = 256;
/**
* Key object which implements interface type KoreanSEEDKey with
* CLEAR_ON_RESET transient key data. This Key object implicitly performs a
* clearKey() on power on or card reset.
*/
public static final byte TYPE_KOREAN_SEED_TRANSIENT_RESET=16;
/**
* Key object which implements interface type KoreanSEEDKey with
* CLEAR_ON_DESELECT transient key data. This Key object implicitly performs
* a clearKey() on power on or card reset.
*/
public static final byte TYPE_KOREAN_SEED_TRANSIENT_DESELECT = 17;
/**
* Key object which implements interface type KoreanSEEDKey with persistent
* key data.
*/
public static final byte TYPE_KOREAN_SEED = 18;
/**
* Key object which implements interface type HMACKey with CLEAR_ON_RESET
* transient key data. This Key object implicitly performs a clearKey() on
* power on or card reset. Note, there is no length constant associated with
* HMAC, since the specification states that the key can have any length.
*/
public static final byte TYPE_HMAC_TRANSIENT_RESET = 19;
/**
* Key object which implements interface type HMACKey with CLEAR_ON_DESELECT
* transient key data. This Key object implicitly performs a clearKey() on
* power on or card reset.
*/
public static final byte TYPE_HMAC_TRANSIENT_DESELECT = 20;
/**
* Key object which implements interface type HMACKey with persistent key
* data.
*/
public static final byte TYPE_HMAC = 21;
/**
* HMAC Key Length LENGTH_HMAC_SHA_1_BLOCK_64 = 64.
*/
public static final short LENGTH_HMAC_SHA_1_BLOCK_64 = 64;
/**
* HMAC Key Length LENGTH_HMAC_SHA_256_BLOCK_64 = 64.
*/
public static final short LENGTH_HMAC_SHA_256_BLOCK_64 = 64;
/**
* HMAC Key Length LENGTH_HMAC_SHA_384_BLOCK_128 = 64.
*/
public static final short LENGTH_HMAC_SHA_384_BLOCK_128 = 128;
/**
* HMAC Key Length LENGTH_HMAC_SHA_512_BLOCK_128 = 64.
*/
public static final short LENGTH_HMAC_SHA_512_BLOCK_128 = 128;
/**
* Korean Seed Key Length LENGTH_KOREAN_SEED_128 = 128.
*/
public static final short LENGTH_KOREAN_SEED_128 = 128;
/**
* Creates uninitialized cryptographic keys for signature and cipher algorithms. Only instances created
* by this method may be the key objects used to initialize instances of
* Signature, Cipher and KeyPair.
* Note that the object returned must be cast to their appropriate key type interface.
* @param keyType the type of key to be generated. Valid codes listed in TYPE.. constants.
* See {@link #TYPE_DES_TRANSIENT_RESET}.
* @param keyLength the key size in bits. The valid key bit lengths are key type dependent. Some common
* key lengths are listed above above in the LENGTH_.. constants.
* See {@link #LENGTH_DES}.
* @param keyEncryption if true this boolean requests a key implementation
* which implements the javacardx.crypto.KeyEncryption interface.
* The key implementation returned may implement the javacardx.crypto.KeyEncryption
* interface even when this parameter is false.
* @return the key object instance of the requested key type, length and encrypted access
* @throws CryptoException with the following reason codes:
* CryptoException.NO_SUCH_ALGORITHM if the requested algorithm
* associated with the specified type, size of key and key encryption interface is not supported.
*/
public static Key buildKey(byte keyType, short keyLength, boolean keyEncryption)
throws CryptoException {
Key key = null;
switch (keyType) {
// des
case TYPE_DES_TRANSIENT_RESET:
case TYPE_DES_TRANSIENT_DESELECT:
case TYPE_DES:
if (keyLength != 64 && keyLength != 128 && keyLength != 192) {
CryptoException.throwIt(CryptoException.ILLEGAL_VALUE);
}
key = new SymmetricKeyImpl(keyType, keyLength);
break;
// rsa
case TYPE_RSA_PUBLIC:
key = new RSAKeyImpl(false, keyLength);
break;
case TYPE_RSA_PRIVATE:
key = new RSAKeyImpl(true, keyLength);
break;
case TYPE_RSA_CRT_PRIVATE:
key = new RSAPrivateCrtKeyImpl(keyLength);
break;
// dsa
case TYPE_DSA_PUBLIC:
key = new DSAPublicKeyImpl(keyLength);
break;
case TYPE_DSA_PRIVATE:
key = new DSAPrivateKeyImpl(keyLength);
break;
// ecc
case TYPE_EC_F2M_PUBLIC:
if (keyLength != 113 && keyLength != 131 && keyLength != 163 && keyLength != 193) {
CryptoException.throwIt(CryptoException.ILLEGAL_VALUE);
}
key = new ECPublicKeyImpl(keyType, keyLength);
break;
case TYPE_EC_F2M_PRIVATE:
if (keyLength != 113 && keyLength != 131 && keyLength != 163 && keyLength != 193) {
CryptoException.throwIt(CryptoException.ILLEGAL_VALUE);
}
key = new ECPrivateKeyImpl(keyType, keyLength);
break;
case TYPE_EC_FP_PUBLIC:
if (keyLength != 112 && keyLength != 128 && keyLength != 160 && keyLength != 192) {
CryptoException.throwIt(CryptoException.ILLEGAL_VALUE);
}
key = new ECPublicKeyImpl(keyType, keyLength);
break;
case TYPE_EC_FP_PRIVATE:
if (keyLength != 112 && keyLength != 128 && keyLength != 160 && keyLength != 192) {
CryptoException.throwIt(CryptoException.ILLEGAL_VALUE);
}
key = new ECPrivateKeyImpl(keyType, keyLength);
break;
// aes
case TYPE_AES_TRANSIENT_RESET:
case TYPE_AES_TRANSIENT_DESELECT:
case TYPE_AES:
if (keyLength != 128 && keyLength != 192 && keyLength != 256) {
CryptoException.throwIt(CryptoException.ILLEGAL_VALUE);
}
key = new SymmetricKeyImpl(keyType, keyLength);
break;
// hmac
case TYPE_HMAC_TRANSIENT_RESET:
case TYPE_HMAC_TRANSIENT_DESELECT:
case TYPE_HMAC:
key = new SymmetricKeyImpl(keyType, keyLength);
break;
default:
CryptoException.throwIt(CryptoException.NO_SUCH_ALGORITHM);
break;
}
return key;
}
}