Net::F...Simple(3pm)

💖 Net::F...Simple(3pm) 💖

okay bestie, so this is the page for Net::F...Simple(3pm) — a User Contributed Perl Documentation page, and it's literally frame crafting made easy. yes the header truncates it, it's giving mysterious. iykyk.

---

✨ NAME ✨

Net::Frame::Simple — frame crafting made easy. periodt. 🎀

---

🌸 SYNOPSIS 🌸

# We build a TCP SYN
my $src    = '192.168.0.10';
my $target = '192.168.0.1';
my $port   = 22;

use Net::Frame::Simple qw($NoUnableToUnpackWarnings $NoModuleNotFoundWarnings);
use Net::Frame::Layer::IPv4;
use Net::Frame::Layer::TCP;

$NoUnableToUnpackWarnings = 1;
$NoModuleNotFoundWarnings = 1;

my $ip4 = Net::Frame::Layer::IPv4->new(
   src => $src,
   dst => $target,
);
my $tcp = Net::Frame::Layer::TCP->new(
   dst     => $port,
   options => "\x02\x04\x54\x0b",
   payload => 'test',
);

my $oSimple = Net::Frame::Simple->new(
   layers => [ $ip4, $tcp ],
);

# Now, the frame is ready to be send to the network
# We open a sender object, and a retriever object
use Net::Write::Layer3;
use Net::Frame::Dump::Online;

my $oWrite = Net::Write::Layer3->new(dst => $target);
my $oDump  = Net::Frame::Dump::Online->new(dev => $oDevice->dev);
$oDump->start;
$oWrite->open;

# We send the frame
$oSimple->send($oWrite);

# And finally, waiting for the response
until ($oDump->timeout) {
   if (my $recv = $oSimple->recv($oDump)) {
      print "RECV:\n".$recv->print."\n";
      last;
   }
}

$oWrite->close;
$oDump->stop;

---

🦋 DESCRIPTION 🦋

so this module is part of the Net::Frame frame crafting framework 💅 it's totally optional, but bestie, it can make playing with the network far easier 🌈

basically, it hides the complexity of frame forging, sending, and receiving, by handing you helper methods that internally figure out how to assemble frames and find responses to probes. it's giving main character energy while doing all the boring background work.

for example, it will take care of computing lengths and checksums, and matching a response frame to the requesting frame. no cap. 🔥

---

🎀 ATTRIBUTES 🎀

• raw — where the packed frame will be stored, or used to unpack a raw string taken from the network (or elsewhere).
• timestamp — the frame timestamp. ⏰
• firstLayer — we cannot know by which layer a frame begins, so this tells how to start unpacking raw data.
• padding — sometimes frames are padded to achieve 60 bytes in length. the padding gets stored here, or if you craft a frame, you can manually add your own padding.
• truncated — a binary flag stating when a raw frame has been truncated (or not).
• reply — when the recv method is called, and a corresponding reply has been found, it is stored here. 💌
• layers — this one is an arrayref. it stores all layers to use within the Net::Frame::Simple object.
• ref — this is a hashref that stores all layers. the key is the layer type (example: TCP: $oSimple->ref->{TCP}). if the frame contains multiple layers of the same type, only the one found at upper level will be kept (in fact, the latest analyzed one, aka LIFO).

---

✨ METHODS ✨

🫶 The constructor era

• new (hash) — object constructor. you can pass attributes in a hash as a parameter. also note that when you call it with the layers attribute set, it will automatically call computeLengths, computeChecksums and pack for you 👑 and when you pass the raw attribute, it will call unpack for you too, building layers and storing them in the layers attribute.
• newFromDump (hashref) — when Net::Frame::Dump's next method is called, and there is a frame waiting, it returns a hashref with specific values. you can directly use it as a parameter for this method, which will create a new Net::Frame::Simple object. convenient much? 💅

🌸 The math-and-pack girlies

• computeLengths — this one hides the manual hassle of calling the computeLengths method for each layer. it takes no parameter, it will know internally what to do. you may set the global variable $NoComputeLengths to 1 to avoid computing lengths.
• computeChecksums — same as above, but for checksums. you MUST call the previous one before this one. you may set the global variable $NoComputeChecksums to 1 to avoid computing checksums. 😤
• pack — will pack all layers to the raw attribute, ready to be sent to the network.
• unpack — will unpack a raw string from the raw attribute into respective layers. by default, a warning will be displayed if unable to unpack the next layer. you may disable this message by setting the global variable $NoUnableToUnpackWarnings to 1. furthermore, unpack() will try to load a module and print a warning in case it is not able to load it. you may disable this message by setting the global variable $NoModuleNotFoundWarnings to 1.

🦋 The speed + send + recv section

• getKey
• getKeyReverse

these two methods are basically used to increase the speed when using the recv method. ⚡

• recv (Net::Frame::Dump object) — when you want to search for the response of your probe, you call it by specifying from which Net::Frame::Dump object to search. it then returns a Net::Frame::Simple object if a match is found, or undef if not.
• send (Net::Write object) — will send to the Net::Write object the raw string describing the Net::Frame::Simple object.
• reSend (Net::Write object) — you can also reSend the frame, it will only rewrite it to the network if no reply has already been found. 🙈
• print — prints all layers in human readable format.
• dump — dumps the raw string in hexadecimal format.

---

🌈 SEE ALSO 🌈

Net::Write, Net::Frame::Dump

---

💜 AUTHOR 💜

Patrice <GomoR> Auffret

---

🎀 COPYRIGHT AND LICENSE 🎀

Copyright (c) 2006-2017, Patrice <GomoR> Auffret

You may distribute this module under the terms of the Artistic license. See LICENSE.Artistic file in the source distribution archive.

---

and that's the whole page bestie 🫶 this was perl v5.34.0, dated 2022-06-16, and it's the Net::F...Simple(3pm) manual — go forth and craft frames, you absolute icon ✨💖👑