-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Duplicate README and LICENSE to the root
- Loading branch information
Showing
2 changed files
with
93 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2020 ZwCreatePhoton | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
<div align="center"> | ||
<h3>Packetator</h3> | ||
|
||
<p> | ||
Stateful packet replayer | ||
</p> | ||
</div> | ||
|
||
|
||
<!-- TABLE OF CONTENTS --> | ||
<details open="open"> | ||
<summary><h2 style="display: inline-block">Table of Contents</h2></summary> | ||
<ol> | ||
<li><a href="#about-the-project">About The Project</a></li> | ||
<li><a href="#getting-started">Getting Started</a></li> | ||
<li><a href="#license">License</a></li> | ||
<li><a href="#contact">Contact</a></li> | ||
</ol> | ||
</details> | ||
|
||
|
||
|
||
<!-- ABOUT THE PROJECT --> | ||
## About The Project | ||
|
||
The Packetator project is a stateful packet replayer that utilizes | ||
context from the network, transport, and application layers to | ||
determine the success of a packet replay. | ||
|
||
The Packetator project consists of two programs: | ||
_packetator_ and _packetatortots_. | ||
|
||
[_packetator_](https://github.com/ZwCreatePhoton/packetator) | ||
is a C++ program that implements the packet replayer for a single | ||
pcap. The replay of a pcap consists of 1 or more _packetator_ | ||
instances located across 1 or more machines. Each instance | ||
will replicate the traffic of a partition of the set of | ||
hosts from the pcap. _packetator_ can also be used to replay | ||
traffic from a single host to serve up content to a live client. | ||
This program is typically not used directly since it's CLI syntax | ||
is verbose. | ||
|
||
[_packetatortots_](https://github.com/ZwCreatePhoton/packetatortots) | ||
is a Python3 script that wraps around _packetator_ to replay | ||
collections of pcaps using a relatively simple CLI syntax. | ||
_packetatortots_ is located in a separate | ||
[repo](https://github.com/ZwCreatePhoton/packetatortots). | ||
|
||
## Getting Started | ||
|
||
To get a local instance up and running, see the [setup documentation](doc/setup.md). | ||
|
||
To learn about _packetator_'s configuration, see the [configuration documentation](doc/configuration.md). | ||
|
||
For usage, refer to the [usage documentation](doc/usage.md). | ||
|
||
<b>Note</b>: Usage of the _packetator_ program directly should be reserved for advanced usage. | ||
For typical usage, use [_packetatortots_](https://github.com/ZwCreatePhoton/packetatortots). | ||
|
||
|
||
<!-- LICENSE --> | ||
## License | ||
|
||
Distributed under the MIT License. See [`LICENSE`](LICENSE) for more information. | ||
|
||
Attributions for the software redistributed with packetator can be found in the [documentation](doc/notice). | ||
|
||
## Contact | ||
|
||
ZwCreatePhoton - [@ZwCreatePhoton](https://twitter.com/ZwCreatePhoton) | ||
|
||
Project Link: [https://github.com/ZwCreatePhoton/packetator](https://github.com/ZwCreatePhoton/packetator) |