ptolemy.actor.lib.security
Class SecretKey
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.Source
ptolemy.actor.lib.security.SecretKey
- All Implemented Interfaces:
- Actor, Changeable, java.lang.Cloneable, Debuggable, DebugListener, Derivable, Executable, Instantiable, ModelErrorHandler, MoMLExportable, Nameable, java.io.Serializable, TypedActor
- public class SecretKey
- extends Source
Create a secret key and send it on the output.
The secret key is a symmetric key can be used by the SymmetricEncryption and SymmetricDecryption actors.
See SymmetricEncryption for a
description of symmetric vs. asymmetric algorithms.
This key should be not be visible to users as the security of
the encrypted message relies on the secrecy of this key.
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: SecretKey.java,v 1.13 2004/04/13 05:12:38 cxh Exp $
- Author:
- Christopher Hylands Brooks, Contributor: Rakesh Reddy
- See Also:
KeyWriter,
SecretKeyReader,
Serialized Form
- Accepted Rating:
- Proposed Rating:
|
Field Summary |
protected java.lang.String |
_algorithm
The name of the algorithm to be used. |
protected int |
_keySize
The key size to be used when processing information. |
protected java.lang.String |
_provider
The provider to be used for a provider specific implementation. |
StringParameter |
algorithm
Specify the algorithm to be used to process data. |
Parameter |
keySize
Specify the size of the key to be created.
|
StringParameter |
provider
Specify a provider for the given algorithm. |
| Fields inherited from class ptolemy.kernel.util.NamedObj |
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS |
|
Constructor Summary |
SecretKey(CompositeEntity container,
java.lang.String name)
Construct an actor with the given container and name.
|
|
Method Summary |
void |
attributeChanged(Attribute attribute)
Override the base class to reinitialize the state if
the algorithm, provider, or keysize
parameter is changed. |
void |
fire()
Send the key that was generated in initialize() on the output port. |
void |
initialize()
Initialize the key by using the cached values of the parameters. |
| 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.Entity |
_description, _exportMoMLContents, _removePort, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName, validateSettables |
| 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 |
algorithm
public StringParameter algorithm
- Specify the algorithm to be used to process data. The algorithm is
specified as a string. The algorithms are limited to those
implemented by providers using the Java JCE which are found on the
system.
The initial default is "DES".
provider
public StringParameter provider
- Specify a provider for the given algorithm. Takes the algorithm name
as a string. The default value is "SystemDefault" which allows the
system chooses the provider based on the JCE architecture.
keySize
public Parameter keySize
- Specify the size of the key to be created.
The key size is an integer value representing the number of
bits in the key. The initial default depends on the algorithm
that is selected, not all algorithms use keySize.
DSA is the most common algorithm that uses keySize,
the Sun documentation says:
"The length, in bits, of the modulus p. This must range from
512 to 1024, and must be a multiple of 64. The default keysize
is 1024."
Refer to
http://java.sun.com/j2se/1.4.2/docs/guide/security/CryptoSpec.html#AppB
for a list of possible key sizes for certain algorithms.
The initial default is 1024.
_algorithm
protected java.lang.String _algorithm
- The name of the algorithm to be used.
_keySize
protected int _keySize
- The key size to be used when processing information.
_provider
protected java.lang.String _provider
- The provider to be used for a provider specific implementation.
SecretKey
public SecretKey(CompositeEntity container,
java.lang.String name)
throws NameDuplicationException,
IllegalActionException
- Construct an actor with the given container and name.
The Java virtual machine is queried for algorithm and provider
choices and these choices are added to the appropriate parameters.
- 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.
attributeChanged
public void attributeChanged(Attribute attribute)
throws IllegalActionException
- Override the base class to reinitialize the state if
the algorithm, provider, or keysize
parameter is changed.
- Overrides:
attributeChanged in class NamedObj
- Parameters:
attribute - The attribute that changed.
- Throws:
IllegalActionException - Not thrown in this base class.
fire
public void fire()
throws IllegalActionException
- Send the key that was generated in initialize() on the output port.
- Specified by:
fire in interface Executable- Overrides:
fire in class Source
- Throws:
IllegalActionException - If thrown by base class.
initialize
public void initialize()
throws IllegalActionException
- Initialize the key by using the cached values of the parameters.
- Specified by:
initialize in interface Executable- Overrides:
initialize in class AtomicActor
- Throws:
IllegalActionException - If thrown by base class or
if the algorithm is not found, or if the padding scheme is illegal,
or if the specified provider does not exist.