ptolemy.actor.lib.security
Class SignatureVerifier

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.SignatureActor
                              extended byptolemy.actor.lib.security.SignatureVerifier
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 SignatureVerifier
extends SignatureActor

Verify the signature of the input data.

In cryptography, digital signatures can be used to verify that the data was not modified in transit. However, the data itself is passed in clear text.

The provider and signatureAlgorithm parameters should be set to the values used to generate the publicKey. See PublicKeyReader and SignatureActor for possible values.

The provider and signatureAlgorithm parameters should be set to the same value as the corresponding parameter in the SignatureSigner actor.

This actor reads a KeyToken public key from the publicKey port and then reads unsigned byte arrays from the signature port and verifies the signature of each unsigned byte array that appears on the input port. If the signature is valid, then the unsigned byte array data on the input port is passed to the output port. If the signature is not valid, then an exception is 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: SignatureVerifier.java,v 1.39 2004/04/13 05:12:38 cxh Exp $
Author:
Christopher Hylands Brooks, Contributor: Rakesh Reddy
See Also:
PublicKeyReader, Serialized Form
Accepted Rating:
Red (cxh)
Proposed Rating:
Yellow (cxh)

Nested Class Summary
 
Nested classes inherited from class ptolemy.kernel.Entity
ptolemy.kernel.Entity.ContainedObjectsIterator
 
Field Summary
 ptolemy.actor.TypedIOPort publicKey
          The public key that is used to verify the signature.
 ptolemy.actor.TypedIOPort signature
          The signature of the data.
 
Fields inherited from class ptolemy.actor.lib.security.SignatureActor
_provider, _signature, _signatureAlgorithm, input, output, provider, signatureAlgorithm
 
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
SignatureVerifier(ptolemy.kernel.CompositeEntity container, java.lang.String name)
          Construct an actor with the given container and name.
 
Method Summary
 void fire()
          Read in the publicKey, input and signature tokens, verify the signature and write the input data on the output port.
 
Methods inherited from class ptolemy.actor.lib.security.SignatureActor
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

signature

public ptolemy.actor.TypedIOPort signature
The signature of the data. The type of this input port is unsigned byte array.


publicKey

public ptolemy.actor.TypedIOPort publicKey
The public key that is used to verify the signature. This port receives the public key to be used from the The type of this input port is an KeyToken containing a java.security.PublicKey.

Constructor Detail

SignatureVerifier

public SignatureVerifier(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 in the publicKey, input and signature tokens, verify the signature and write the input data on the output port.

Specified by:
fire in interface ptolemy.actor.Executable
Overrides:
fire in class SignatureActor
Throws:
ptolemy.kernel.util.IllegalActionException - If thrown by a base class, if there is a problem with the cryptographic configuration or if the signature does not properly verify.