org.dihedron.crypto.providers.smartcard.SmartCardTraits Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of crypto Show documentation
Set of classes to support cryptography, including smart card detection, encryption, decription and signing.
The newest version!
/**
 * Copyright (c) 2012-2014, Andrea Funto'. All rights reserved.
 * 
 * This file is part of the Crypto library ("Crypto").
 *
 * Crypto is free software: you can redistribute it and/or modify it under 
 * the terms of the GNU Lesser General Public License as published by the Free 
 * Software Foundation, either version 3 of the License, or (at your option) 
 * any later version.
 *
 * Crypto is distributed in the hope that it will be useful, but WITHOUT ANY 
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR 
 * A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more 
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License 
 * along with Crypto. If not, see .
 */
package org.dihedron.crypto.providers.smartcard;

import org.dihedron.crypto.providers.ProviderTraits;
import org.dihedron.crypto.providers.smartcard.discovery.Reader;
import org.dihedron.crypto.providers.smartcard.discovery.SmartCard;

/**
 * The set of characteristics of a smart card based PKCS#11 security provider.
 * 
 * @author Andrea Funto'
 */
public class SmartCardTraits implements ProviderTraits {

	/**
	 * The name of the underlying Sun PKCS#11 provider class; the class gets
	 * loaded at run-time to avoid errors when running on an unsupported JVM
	 * (such as IBM's).
	 */		
	// TODO: may want to transform this into an array in order to be able to
	// handle IBM's PKCS#11 provider too (reflectively).
	final static String SUN_PKCS11_PROVIDER_CLASS = "sun.security.pkcs11.SunPKCS11";
	
	/**
	 * Whether by default the hashing should be executed on card; by default (due
	 * to performance and reliability) the digest is produced in Java code.
	 */
	private static final boolean DEFAULT_HASH_ON_CARD = false;
	
	/**
	 * The reader holding the smart card.
	 */
	private Reader reader;
	
	/**
	 * The database entry for the smart card in the reader.
	 */
	private SmartCard smartcard;
	
	/**
	 * Whether the new provider will hash data in code or on the smart card.
	 */
	private boolean hashOnCard;
	
	/**
	 * Constructor.
	 * 
	 * @param reader
	 *   the reader holding the smart card.
	 * @param smartcard
	 *   the database entry for the smart card in the reader.
	 */
	public SmartCardTraits(Reader reader, SmartCard smartcard) {
		this(reader, smartcard, DEFAULT_HASH_ON_CARD);
	}

	/**
	 * Constructor.
	 * 
	 * @param reader
	 *   the reader holding the smart card.
	 * @param smartcard
	 *   the database entry for the smart card in the reader.
	 * @param hashOnCard
	 *   whether the new provider will hash data in code or on the smart card.
	 */
	public SmartCardTraits(Reader reader, SmartCard smartcard, boolean hashOnCard) {
		this.reader = reader;
		this.smartcard = smartcard;
		this.hashOnCard = hashOnCard;
	}	
	
	/**
	 * Returns the reader holding the smart card.
	 * 
	 * @return
	 *   the reader holding the smart card.
	 */
	public Reader getReader() {
		return reader;
	}

	/**
	 * Returns the database entry for the smart card in the reader.
	 * 
	 * @return
	 *   the database entry for the smart card in the reader.
	 */
	public SmartCard getSmartCard() {
		return smartcard;
	}
	
	/**
	 * Returns whether the new provider will hash data in code or on the smart card.
	 * 
	 * @return
	 *   whether the new provider will hash data in code or on the smart card.
	 */
	public boolean isHashOnCard() {
		return this.hashOnCard;
	}
}