Package i5.las2peer.security

Class AgentImpl

java.lang.Object

i5.las2peer.security.AgentImpl

All Implemented Interfaces:

Agent, MessageReceiver, XmlAble, Cloneable

Direct Known Subclasses:

AnonymousAgentImpl, GroupAgentImpl, PassphraseAgentImpl, TestAgent

public abstract class AgentImpl
extends Object
implements Agent, XmlAble, Cloneable, MessageReceiver

An Agent is the basic acting entity in the las2peer network. At the moment, an agent can represent a simple user, a group, a service or a monitoring agent.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AgentImpl()	Creates an empty agent.
protected	AgentImpl(KeyPair pair, SecretKey key)	Creates a new agent.
protected	AgentImpl(PublicKey publicKey, byte[] encryptedPrivate)	Creates a new agent.

Method Summary

Modifier and Type	Method	Description
final AgentImpl	cloneLocked()	Gets a locked copy of this agent.
static AgentImpl	createFromXml(File xmlFile)	Factory: Create an agent from its XML file representation.
static AgentImpl	createFromXml(InputStream is)	Factory: Create an agent from its XML input stream representation.
static AgentImpl	createFromXml(String xml)	Factory: Create an agent from its XML string representation.
static AgentImpl	createFromXml(Element rootElement)	Factory: Create an agent from its XML representation.
Signature	createSignature()	Uses the CryptoTools to create a java.security.Signature and initializes the object for signing with the agent's private key.
SecretKey	decryptSymmetricKey(byte[] crypted)	Uses the CryptoTools to decrypt the passed crypted content with the agent's private key.
void	encryptPrivateKey(SecretKey key)	Encrypts the private key into a byte array with strong encryption based on a passphrase.
boolean	equals(Object other)
protected String	getEncodedPrivate()	Gets the private key encrypted and encoded in base64.
String	getIdentifier()	The agent id
PublicKey	getPublicKey()
String	getResponsibleForAgentSafeId()	Returns the id of this agent.
Node	getRunningAtNode()	Gets the node, this agent is running at.
boolean	isLocked()	Returns whether the agent is locked or not.
void	lockPrivateKey()	(Re-)Lock the private key.
void	notifyRegistrationTo(Node n)	Notifies this agent that it has been registered at a node.
void	notifyUnregister()	Notifies this agent of unregistering from a node.
abstract void	receiveMessage(Message message, AgentContext c)	Hook to be called by the node where this agent is registered to, when the node receives a message destined to this agent.
byte[]	signContent(byte[] plainData)	Uses the CryptoTools to sign the passed data with the agent's private key.
void	unlockPrivateKey(SecretKey key)	Unlocks the private key.

Methods inherited from class java.lang.Object

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

Methods inherited from interface i5.las2peer.serialization.XmlAble

toXmlString

Constructor Details

AgentImpl

protected AgentImpl()

Creates an empty agent.

AgentImpl

protected AgentImpl(KeyPair pair,
 SecretKey key)
             throws AgentOperationFailedException

Creates a new agent.

Parameters:

pair - The private public keypair to use for this agent

key - The secret key to encrypt the private key

Throws:

AgentOperationFailedException - If the private key can not be encrypted

AgentImpl

protected AgentImpl(PublicKey publicKey,
 byte[] encryptedPrivate)

Creates a new agent.

Parameters:

publicKey - The public key to use for this agent

encryptedPrivate - The encrypted private key to use for this agent

Method Details

lockPrivateKey

public void lockPrivateKey()

(Re-)Lock the private key.

unlockPrivateKey

public void unlockPrivateKey(SecretKey key)
                      throws AgentOperationFailedException,
AgentAccessDeniedException

Unlocks the private key.

Parameters:

key - A key that is used to unlock the agents private key.

Throws:

AgentOperationFailedException - If the agent's private key can not be deserialized.

AgentAccessDeniedException

encryptPrivateKey

public void encryptPrivateKey(SecretKey key)
                       throws AgentOperationFailedException,
AgentLockedException

Encrypts the private key into a byte array with strong encryption based on a passphrase. to unlock the key

Parameters:

key - A key that is used to encrypt the agents private key.

Throws:

AgentOperationFailedException - If an issue with the given key occurs.

AgentLockedException - If the given agent is not unlocked

isLocked

public boolean isLocked()

Description copied from interface: Agent

Returns whether the agent is locked or not.

Specified by:

isLocked in interface Agent

Returns:

true, if the private key of this agent is still locked

getIdentifier

public String getIdentifier()

Description copied from interface: Agent

The agent id

Specified by:

getIdentifier in interface Agent

Returns:

The agent id.

getResponsibleForAgentSafeId

public String getResponsibleForAgentSafeId()

Returns the id of this agent. This method is only implemented, since an Agent is also a MessageReceiver, thus has to implement this method. It was written for the Mediator class.

Specified by:

getResponsibleForAgentSafeId in interface MessageReceiver

Returns:

id of the agent

getPublicKey

public PublicKey getPublicKey()

Returns:

the cryptographic public key of this agent

decryptSymmetricKey

public SecretKey decryptSymmetricKey(byte[] crypted)
                              throws AgentLockedException,
SerializationException,
CryptoException

Uses the CryptoTools to decrypt the passed crypted content with the agent's private key.

Parameters:

crypted - The encrypted content that is decrypted using the agents private key.

Returns:

Returns a SecretKey decrypted from the crypted input and the agent's private key

Throws:

AgentLockedException - the private key has not been unlocked yet

CryptoException - If an issue occurs with decryption.

SerializationException - If an issue occurs with deserializing the given and decrypted data.

createSignature

public Signature createSignature()
                          throws InvalidKeyException,
AgentLockedException,
NoSuchAlgorithmException

Uses the CryptoTools to create a java.security.Signature and initializes the object for signing with the agent's private key.

Returns:

a java.security.Signature

Throws:

AgentLockedException - the private key has not been unlocked yet

InvalidKeyException

NoSuchAlgorithmException

signContent

public byte[] signContent(byte[] plainData)
                   throws CryptoException,
AgentLockedException

Uses the CryptoTools to sign the passed data with the agent's private key.

Parameters:

plainData - The plain data to sign

Returns:

Returns a signed version of the input

Throws:

AgentLockedException - the private key has not been unlocked yet

CryptoException

getEncodedPrivate

protected String getEncodedPrivate()

Gets the private key encrypted and encoded in base64. mainly for toXmlString() methods of subclasses

Returns:

encoded version or the private key

receiveMessage

public abstract void receiveMessage(Message message,
 AgentContext c)
                             throws MessageException

Hook to be called by the node where this agent is registered to, when the node receives a message destined to this agent.

Specified by:

receiveMessage in interface MessageReceiver

Parameters:

message -

c -

Throws:

MessageException

cloneLocked

public final AgentImpl cloneLocked()
                            throws CloneNotSupportedException

Gets a locked copy of this agent.

Returns:

a locked clone of this agent

Throws:

CloneNotSupportedException

notifyUnregister

public void notifyUnregister()

Notifies this agent of unregistering from a node.

Specified by:

notifyUnregister in interface MessageReceiver

notifyRegistrationTo

public void notifyRegistrationTo(Node n)
                          throws AgentException

Notifies this agent that it has been registered at a node. May be overridden in implementing classes. Make sure, overriding methods do a call of this method!

Specified by:

notifyRegistrationTo in interface MessageReceiver

Parameters:

n -

Throws:

AgentException

getRunningAtNode

public Node getRunningAtNode()

Gets the node, this agent is running at.

Returns:

the node, this agent is running at

createFromXml

public static AgentImpl createFromXml(File xmlFile)
                               throws MalformedXMLException

Factory: Create an agent from its XML file representation. Depending on the type attribute of the root node, the type will be a UserAgentImpl, GroupAgentImpl, ServiceAgentImpl. Creation of MonitoringAgents is not supported.

Parameters:

xmlFile -

Returns:

an agent

Throws:

MalformedXMLException

createFromXml

public static AgentImpl createFromXml(String xml)
                               throws MalformedXMLException

Factory: Create an agent from its XML string representation. Depending on the type attribute of the root node, the type will be a UserAgentImpl, GroupAgentImpl, ServiceAgentImpl. Creation of MonitoringAgents is not supported.

Parameters:

xml -

Returns:

an agent

Throws:

MalformedXMLException

createFromXml

public static AgentImpl createFromXml(InputStream is)
                               throws MalformedXMLException

Factory: Create an agent from its XML input stream representation. Depending on the type attribute of the root node, the type will be a UserAgentImpl, GroupAgentImpl, ServiceAgentImpl. Creation of MonitoringAgents is not supported.

Parameters:

is -

Returns:

an agent

Throws:

MalformedXMLException

createFromXml

public static AgentImpl createFromXml(Element rootElement)
                               throws MalformedXMLException

Factory: Create an agent from its XML representation. Depending on the type attribute of the root node, the type will be a UserAgentImpl, GroupAgentImpl, ServiceAgentImpl. Creation of MonitoringAgents is not supported.

Parameters:

rootElement -

Returns:

an agent

Throws:

MalformedXMLException

equals

public boolean equals(Object other)

Overrides:

equals in class Object