ptolemy.actor.lib.security
Class SymmetricEncryption
java.lang.Object
ptolemy.kernel.util.NamedObj
ptolemy.kernel.InstantiableNamedObj
ptolemy.kernel.Entity
ptolemy.kernel.ComponentEntity
ptolemy.actor.AtomicActor
ptolemy.actor.TypedAtomicActor
ptolemy.actor.lib.security.CryptographyActor
ptolemy.actor.lib.security.CipherActor
ptolemy.actor.lib.security.SymmetricEncryption
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Cloneable, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable
public class SymmetricEncryption
- extends CipherActor
Encrypt an unsigned byte array using a symmetric algorithm.
In cryptography, a symmetric algorithm is an algorithm that uses
the same key for encryption and decryption. An asymmetric algorithm uses
two different keys: a public key and a private key. Sun's documentation
says that asymmetric algorithms are usually much slower than
symmetric algorithms. The initial default set of algorithms that
comes with the Sun JDK does not include an asymmetric encryption algorithm,
though other algorithms may be installed by the system administrator.
This actor reads an unsigned byte array at the input port,
encrypts 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
SymmetricDecryption actor and this actor. The key should not
be visible to users as the security of the encrypted message relies on
the secrecy of this key.
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 the JCE.
- Since:
- Ptolemy II 4.0
- Version:
- $Id: SymmetricEncryption.java 57040 2010-01-27 20:52:32Z cxh $
- Author:
- Christopher Hylands Brooks, Contributor: Rakesh Reddy
- See Also:
- Serialized Form
- Accepted Rating:
- Proposed Rating:
|
Field Summary |
TypedIOPort |
key
The key to be used by this actor to encrypt the data. |
| Fields inherited from class ptolemy.kernel.util.NamedObj |
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS |
|
Method Summary |
protected byte[] |
_process(byte[] dataBytes)
Encrypt the data using the javax.crypto.Cipher. |
void |
fire()
If there is a token on the input port, this method takes the
data from the input and encrypts the data based on the
algorithm, provider, mode and padding
using the key read in from the key port. |
| Methods inherited from class ptolemy.actor.AtomicActor |
_actorFiring, _actorFiring, addActorFiringListener, addInitializable, clone, connectionsChanged, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, postfire, prefire, preinitialize, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, setContainer, stop, stopFire, terminate, wrapup |
| Methods inherited from class ptolemy.kernel.ComponentEntity |
_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, propagateExistence, setName |
| Methods inherited from class ptolemy.kernel.Entity |
_description, _exportMoMLContents, _removePort, _validateSettables, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName |
| Methods inherited from class ptolemy.kernel.util.NamedObj |
_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _recordDecoratedAttributes, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, attributeList, attributeList, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, propagateValue, propagateValues, removeChangeListener, removeDebugListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, validateSettables, workspace |
| Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
key
public TypedIOPort key
- The key to be used by this actor to encrypt the data.
The type is an KeyToken containing a java.security.Key.
Usually the output of the
SecretKey
actor is connected to this port
SymmetricEncryption
public SymmetricEncryption(CompositeEntity container,
java.lang.String name)
throws NameDuplicationException,
IllegalActionException
- Construct an actor with the given container and name.
- Parameters:
container - The container.name - The name of this actor.
- Throws:
IllegalActionException - If the actor cannot be contained
by the proposed container.
NameDuplicationException - If the container already has an
actor with this name.
fire
public void fire()
throws IllegalActionException
- If there is a token on the input port, this method takes the
data from the input and encrypts the data based on the
algorithm, provider, mode and padding
using the key read in from the key port.
This processed data is then sent on the output port.
All parameters should be the same as the corresponding
decryption actor. This method calls javax.crypto.Cipher.init()
with the value of the key.
- Specified by:
fire in interface Executable- Overrides:
fire in class CipherActor
- Throws:
IllegalActionException - If thrown by base class.
_process
protected byte[] _process(byte[] dataBytes)
throws IllegalActionException
- Encrypt the data using the javax.crypto.Cipher.
- Specified by:
_process in class CryptographyActor
- Parameters:
dataBytes - the data to be encrypted.
- Returns:
- byte[] the encrypted data.
- Throws:
IllegalActionException - If error occurs in
ByteArrayOutputStream, if the key is invalid, if the padding is bad
or if the block size is illegal.