Package org.mycore.crypt

Class MCRCipher

java.lang.Object

org.mycore.crypt.MCRCipher

Direct Known Subclasses:

MCRAESCipher

public abstract class MCRCipher
extends Object

Abstract class of a concrete cipherimplementation After checking the permission call the encrypt an decrypt functionality. The permission is set by acl. Example for chipher with id abstract: crypt:abstract {encrypt:decrypt} "administrators only"

Author:

Paul Borchert

Field Summary

Fields

Modifier and Type	Field	Description
protected String	cipherID

Constructor Summary

Constructors

Constructor	Description
MCRCipher()

Method Summary

Modifier and Type	Method	Description
byte[]	decrypt(byte[] bytes)
String	decrypt(String text)
protected abstract byte[]	decryptImpl(byte[] bytes)
protected abstract String	decryptImpl(String text)
byte[]	encrypt(byte[] bytes)
String	encrypt(String text)
protected abstract byte[]	encryptImpl(byte[] bytes)
protected abstract String	encryptImpl(String text)
abstract void	generateKeyFile()	If no keyfile exsits, generate the secret key an write it to the keyfile.
boolean	getAclEnabled()
abstract void	init(String id)	Initialize the chipher by reading the key from file.
abstract boolean	isInitialized()	Return whether cipher has been initialized.
abstract void	overwriteKeyFile()	Generate the secret key an write it to the keyfile.
abstract void	reset()	Revert init process.
void	setAclEnabled(String enabled)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

cipherID

protected String cipherID

Constructor Details

MCRCipher

public MCRCipher()

Method Details

init

public abstract void init(String id)
                   throws MCRCryptKeyFileNotFoundException,
InvalidKeyException

Initialize the chipher by reading the key from file. If the cipher can't initialized an exception will thrown. Common issue is an missing key. In this case the methods throws a MCRCryptKeyFileNotFoundException. Needs the id of cipher as parameter, because the id can't be set during instanciating by getSingleInstanceOf.

Parameters:

id - ID of cipher as configured

Throws:

MCRCryptKeyFileNotFoundException

InvalidKeyException

isInitialized

public abstract boolean isInitialized()

Return whether cipher has been initialized.

reset

public abstract void reset()

Revert init process.

generateKeyFile

public abstract void generateKeyFile()
                              throws FileAlreadyExistsException

If no keyfile exsits, generate the secret key an write it to the keyfile.

Throws:

FileAlreadyExistsException

overwriteKeyFile

public abstract void overwriteKeyFile()

Generate the secret key an write it to the keyfile. Overwrites exsisting keyfile.

getAclEnabled

public boolean getAclEnabled()

setAclEnabled

public void setAclEnabled(String enabled)

encrypt

public String encrypt(String text)
               throws MCRCryptKeyNoPermissionException

Throws:

MCRCryptKeyNoPermissionException

encrypt

public byte[] encrypt(byte[] bytes)
               throws MCRCryptKeyNoPermissionException

Throws:

MCRCryptKeyNoPermissionException

decrypt

public String decrypt(String text)
               throws MCRCryptKeyNoPermissionException

Throws:

MCRCryptKeyNoPermissionException

decrypt

public byte[] decrypt(byte[] bytes)
               throws MCRCryptKeyNoPermissionException

Throws:

MCRCryptKeyNoPermissionException

encryptImpl

protected abstract String encryptImpl(String text)

decryptImpl

protected abstract String decryptImpl(String text)

encryptImpl

protected abstract byte[] encryptImpl(byte[] bytes)

decryptImpl

protected abstract byte[] decryptImpl(byte[] bytes)