com.ohadr.crypto.interfaces.CryptoProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of common-crypto Show documentation

parent POM for authentication projects.

The newest version!

package com.ohadr.crypto.interfaces;

import java.security.InvalidKeyException;
import java.security.Key;

import javax.crypto.Cipher;

import org.apache.commons.lang3.tuple.ImmutablePair;

public interface CryptoProvider
{
	/**
	 * Returns a seeded key based on the given key parameters. Given the same key parameters, the method will always
	 * return the same key.
	 * 
	 * @param keyParams
	 *            Specifies the hive and the seed for generating the seeded key.
	 * @return A key that can be used with the getCipher() method.
	 */
	Key getKey(ImmutablePair keyParams);

	/**
	 * Returns a cipher object for symmetric data encrpytion.
	 * 
	 * @param key
	 *            The encryption key returned from getSeededKey(). Other keys may not be accepted.
	 * @param cryptMode
	 *            One of Cipher.ENCRYPT_MODE, Cipher.DECRYPT_MODE.
	 * @return A Cipher object that can be used for encrpytion/description, depending on the value of cryptMode.
	 */
	Cipher getCipher(Key key, int cryptMode) throws InvalidKeyException;

	/**
	 * Returns the server's private key used for digitally signing data.
	 * /
	PrivateKey loadPrivateKey();

	/**
	 * Returns the server's certificate used for digitally validating signatures.
	 * /
	Certificate loadCertificate();

	/**
	 * Returns the signature algorithm (RSA/DSA)
	 * /
	Signature getSignatureAlgorithm();*/
}