ptolemy.actor.lib.security
Class SymmetricDecryption

java.lang.Object
  extended byptolemy.kernel.util.NamedObj
      extended byptolemy.kernel.InstantiableNamedObj
          extended byptolemy.kernel.Entity
              extended byptolemy.kernel.ComponentEntity
                  extended byptolemy.actor.AtomicActor
                      extended byptolemy.actor.TypedAtomicActor
                          extended byptolemy.actor.lib.security.CryptographyActor
                              extended byptolemy.actor.lib.security.CipherActor
                                  extended byptolemy.actor.lib.security.SymmetricDecryption
All Implemented Interfaces:
ptolemy.actor.Actor, ptolemy.kernel.util.Changeable, java.lang.Cloneable, ptolemy.kernel.util.Debuggable, ptolemy.kernel.util.DebugListener, ptolemy.kernel.util.Derivable, ptolemy.actor.Executable, ptolemy.kernel.util.Instantiable, ptolemy.kernel.util.ModelErrorHandler, ptolemy.kernel.util.MoMLExportable, ptolemy.kernel.util.Nameable, java.io.Serializable, ptolemy.actor.TypedActor

public class SymmetricDecryption
extends CipherActor

Decrypt an unsigned byte array using a symmetric algorithm.

See SymmetricEncryption for a description of symmetric vs. asymmetric algorithms.

This actor reads an unsigned byte array at the input port, decrypts the data using the data from the key port and then writes the unsigned byte array results to the output port.

The key should be the same for both the SymmetricEncryption actor and this actor. The algorithm parameter determines which algorithm is used. The algorithm specified must be symmetric. The mode and padding can also be specified in the mode and padding parameters. In case a provider specific instance of an algorithm is needed the provider may also be specified in the provider parameter.

Note that for simplicity, this actor does not support the notion of algorithm parameters, so the algorithm must not require that algorithm parameters be transmitted separately from the key. If the user selects an algorithm that uses algorithm parameters, then an exception will likely be thrown.

This actor relies on the Java Cryptography Architecture (JCA) and Java Cryptography Extension (JCE). See the CryptographyActor documentation for resources about JCA and JCE.

Since:
Ptolemy II 4.0
Version:
$Id: SymmetricDecryption.java,v 1.37 2004/04/13 05:12:38 cxh Exp $
Author:
Christopher Hylands Brooks, Contributor: Rakesh Reddy
See Also:
Serialized Form
Accepted Rating:
Yellow (cxh)
Proposed Rating:
Green (cxh)

Nested Class Summary
 
Nested classes inherited from class ptolemy.kernel.Entity
ptolemy.kernel.Entity.ContainedObjectsIterator
 
Field Summary
 ptolemy.actor.TypedIOPort key
          The key port.
 
Fields inherited from class ptolemy.actor.lib.security.CipherActor
_cipher, _mode, _padding, _updateCipherNeeded, mode, padding
 
Fields inherited from class ptolemy.actor.lib.security.CryptographyActor
_algorithm, _keySize, _provider, algorithm, input, keySize, output, provider
 
Fields inherited from class ptolemy.actor.AtomicActor
_stopRequested
 
Fields inherited from class ptolemy.kernel.util.NamedObj
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS
 
Fields inherited from interface ptolemy.actor.Executable
COMPLETED, NOT_READY, STOP_ITERATING
 
Constructor Summary
SymmetricDecryption(ptolemy.kernel.CompositeEntity container, java.lang.String name)
          Construct an actor with the given container and name.
 
Method Summary
protected  byte[] _process(byte[] dataBytes)
          Decrypt the data with the secret key by using javax.crypto.Cipher.
 void fire()
          Read the input and key, and send the decrypted data to the output port.
 
Methods inherited from class ptolemy.actor.lib.security.CipherActor
_updateCipher, attributeChanged, initialize
 
Methods inherited from class ptolemy.actor.TypedAtomicActor
_addPort, attributeTypeChanged, clone, newPort, typeConstraintList
 
Methods inherited from class ptolemy.actor.AtomicActor
_createReceivers, clone, connectionsChanged, getDirector, getExecutiveDirector, getFunctionDependency, getManager, inputPortList, iterate, newReceiver, outputPortList, postfire, prefire, preinitialize, pruneDependencies, removeDependency, setContainer, stop, stopFire, terminate, wrapup
 
Methods inherited from class ptolemy.kernel.ComponentEntity
_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, propagateExistence, setName
 
Methods inherited from class ptolemy.kernel.Entity
_description, _exportMoMLContents, _removePort, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName, validateSettables
 
Methods inherited from class ptolemy.kernel.InstantiableNamedObj
_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition
 
Methods inherited from class ptolemy.kernel.util.NamedObj
_addAttribute, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, attributeList, attributeList, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, getAttribute, getAttributes, getChangeListeners, getClassName, getDerivedLevel, getDerivedList, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, message, propagateValue, propagateValues, removeChangeListener, removeDebugListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setModelErrorHandler, setPersistent, setSource, toplevel, toString, workspace
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface ptolemy.actor.Actor
getDirector, getExecutiveDirector, getFunctionDependency, getManager, inputPortList, newReceiver, outputPortList
 
Methods inherited from interface ptolemy.actor.Executable
iterate, postfire, prefire, preinitialize, stop, stopFire, terminate, wrapup
 
Methods inherited from interface ptolemy.kernel.util.Derivable
getDerivedLevel, getDerivedList, propagateValue
 
Methods inherited from interface ptolemy.kernel.util.Nameable
description, getFullName, getName, getName
 

Field Detail

key

public ptolemy.actor.TypedIOPort key
The key port. This port contains the key that is used to decrypt data from the input port. The type is KeyToken that contains a java.security.key

Constructor Detail

SymmetricDecryption

public SymmetricDecryption(ptolemy.kernel.CompositeEntity container,
                           java.lang.String name)
                    throws ptolemy.kernel.util.NameDuplicationException,
                           ptolemy.kernel.util.IllegalActionException
Construct an actor with the given container and name.

Parameters:
container - The container.
name - The name of this actor.
Throws:
ptolemy.kernel.util.IllegalActionException - If the actor cannot be contained by the proposed container.
ptolemy.kernel.util.NameDuplicationException - If the container already has an actor with this name.
Method Detail

fire

public void fire()
          throws ptolemy.kernel.util.IllegalActionException
Read the input and key, and send the decrypted data to the output port. The algorithm is obtained from the key, and if it is different than the current value of the algorithm parameter, we reinitialize _cipher.

Specified by:
fire in interface ptolemy.actor.Executable
Overrides:
fire in class CipherActor
Throws:
ptolemy.kernel.util.IllegalActionException - If retrieving parameters fails, the algorithm does not exist or if the provider does not exist.

_process

protected byte[] _process(byte[] dataBytes)
                   throws ptolemy.kernel.util.IllegalActionException
Decrypt the data with the secret key by using javax.crypto.Cipher.

Specified by:
_process in class CryptographyActor
Parameters:
dataBytes - the data to be decrypted.
Returns:
byte[] the decrypted data.
Throws:
ptolemy.kernel.util.IllegalActionException - If an error occurs in ByteArrayOutputStream, a key is invalid, padding is bad, or if the block size is illegal.