org.nhindirect.common.crypto.MutableKeyStoreProtectionManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of direct-common Show documentation
Direct Project common APIs. Includes instrumentation, auditing, and other utility APIs
There is a newer version: 8.0.0
/* 
Copyright (c) 2010, NHIN Direct Project
All rights reserved.

Authors:
   Greg Meyer      [email protected]
 
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
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.  Neither the name of the The NHIN Direct Project (nhindirect.org). 
nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS 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 COPYRIGHT HOLDER OR CONTRIBUTORS 
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 org.nhindirect.common.crypto;

import java.security.Key;
import java.security.KeyStore;
import java.security.KeyStore.Entry;

import org.nhindirect.common.crypto.exceptions.CryptoException;

/**
 * Interface for setting and clearing the secret keys for keystore and private key protection.  This
 * interface is implemented by stores that allow manipulation of the key material.
 * 
 * This interface assumes that key material is generated outside of the key store manager.
 * @author Greg Meyer
 * @since 1.3
 */
public interface MutableKeyStoreProtectionManager extends KeyStoreProtectionManager
{
	/**
	 * Sets key used to protect the private key as a Key object.
	 * @param key The key used to protect private keys.
	 * @throws CryptoException
	 */
	public void setPrivateKeyProtectionKey(Key key) throws CryptoException;
	
	/**
	 * Sets the key used to protect the private key as a byte array.
	 * @param key The key used to protect private keys.
	 * @throws CryptoException
	 */
	public void setPrivateKeyProtectionKeyAsBytes(byte[] key) throws CryptoException;
	
	/**
	 * Sets the key used to protect the private key as a string.  This is useful when pass phrases
	 * are generated by a plain text tool.
	 * @param key The key used to protect private keys.
	 * @throws CryptoException
	 */	
	public void setPrivateKeyProtectionKeyAsString(String key) throws CryptoException;
	
	/**
	 * Clears the key use to protect the private key.  Some implementations require that the
	 * key be cleared before a new value can be set.  For deterministic results, you should always
	 * clear the key before setting a new value.
	 * @throws CryptoException
	 */
	public void clearPrivateKeyProtectionKey() throws CryptoException;
	
	/**
	 * Sets key used to protect the key store as a Key object.
	 * @param key The key used to protect the key store.
	 * @throws CryptoException
	 */
	public void setKeyStoreProtectionKey(Key key) throws CryptoException;
	
	/**
	 * Sets key used to protect the key store as a byte array.
	 * @param key The key used to protect the key store.
	 * @throws CryptoException
	 */	
	public void setKeyStoreProtectionKeyAsBytes(byte[] key) throws CryptoException;	
	
	/**
	 * Sets key used to protect the key store as a string.  This is useful when pass phrases
	 * are generated by a plain text tool.
	 * @param key The key used to protect the key store.
	 * @throws CryptoException
	 */	
	public void setKeyStoreProtectionKeyAsString(String key) throws CryptoException;		

	/**
	 * Clears the key use to protect the key store.  Some implementations require that the
	 * key be cleared before a new value can be set.  For deterministic results, you should always
	 * clear the key before setting a new value.
	 * @throws CryptoException
	 */
	public void clearKeyStoreProtectionKey() throws CryptoException;
	
	/**
	 * Generic method to set an arbitrary key.
	 * @param alias Alias of the key that will be set.
	 * @param key The key that will be set.
	 * @throws CryptoException
	 */
	public void setKey(String alias, Key key) throws CryptoException;

	/**
	 * Generic method to clear an arbitrary key.
	 * @param alias Alias of the key that will be cleared.
	 * @throws CryptoException
	 */
	public void clearKey(String alias) throws CryptoException;
	
	/**
	 * Generic method to set an arbitrary entry.
	 * @param alias Alias of the entry that will be set.
	 * @param entry The entry that will be set.
	 * @throws CryptoException
	 */
	public void setEntry(String alias, Entry entry) throws CryptoException;

	/**
	 * Generic method to clear an arbitrary entry.
	 * @param alias Alias of the entry that will be cleared.
	 * @throws CryptoException
	 */
	public void clearEntry(String alias) throws CryptoException;
	
	
	/**
	 * Gets the underlying KeyStore object.
	 * @return The KeyStore object backing the protection manager.
	 */
	public KeyStore getKS();
}