When the Perytons™ Traffic-Generator Add-On is enabled, messages' transmission can be initiated via a Script.
For transmitting messages the following functions can be used (depending on the field type that needs to be changed, i.e. HEX LIST or VALUE):
TransmitMessage(message)
Plugins<Protocol>.Plugin.SendTrafficGeneratedData(message)
Note: Triggering transmission of Messages from a Script is not supported by Perytons™ Protocol Analyzer versions older than Ver. 4.0. When sharing Scripts with users of older versions, the message transmission functions should be removed
Example I:
The following example This Script 'looks' for messages received from a specific device based on its Short Mac Source Address, changes one of the message's bytes to '0' (e.g. this can be used to changed the source or destination address) and transmits it over-the-air using the defined Traffic Generator Add-On settings (note that still ALL RECEIVED messages - no filtering - are recorded and kept in the data capture .ANL file).
public override void SetTrafficGeneratorMessages(List<InputMessage> messages)
{
txMessages = messages;
if (txMessages != null)
{
Loggers.EventsLogger.Error("Init message list"); // Mention initialtion of transmission messages list. done only one time
}
}
// This method called BEFORE input message is processed, giving the chance to modify how this
// message will be processed. For example modifying the decryption keys
public override void PreDoScript(InputMessage inputMessage)
{
//Perytons.Analyzer.Core.Encryption.NetworkKey key = Plugins<Protocol>.Plugin.GetKeysManager().MasterKey;
}
// This method will be called on each message received
// This part is refered in the Perytons Analyzer User Manual as 'Script Main' part
// Use packet.Field(FieldName).FieldProperties to get field value, meaning or any other property
// Use packet.Search(Parameters) to use predefined search utilities (search for value in message field(s) or subfields)
// Use packet.Action to set the needed action (e.g. add message to time view, etc.)
// Use Log.Sevirity(Message) to send alerts to the Event Log window
// Use Email.Sevirity(Message) to send e-mail alerts (need to set server info in the log4net.confog file
public override void DoScript(Packet packet) // don't remove this line
{
// Do your packet filtering logic here
try
{
string result = PreferencesHandler<UserPreferences>.Instance.ConnectionString;
if (string.IsNullOrEmpty(result) || (packet.Field("MacHeaderSourceAdd").Meaning.ToLower() == result.ToLower())) // Check if Connection String was left empty
{
Loggers.EventsLogger.Error("Trying to transmit the received message message, " + (txMessages == null)); // Message sent to log every time message transmission is triggered
InputMessage message = packet.GetInputMessage().Duplicate(false); // Duplicate the message in order to avoid modifying the original message that will be displayed in the time view
message.data[2]++; // increment sequence number
message.data[7] = 0; // change byte in the message data to 0 (might be source or dest. address)
TransmitMessage(message);
}
}
catch (Exception e) { Loggers.EventsLogger.Error("Error in Script " + e); }
packet.AddToTimeView();
base.DoScript(packet); // don't remove this line
}