├── .gitignore ├── LICENSE ├── README.md ├── config.py ├── entity.py ├── example.png ├── flow.py ├── memory.py └── pcap-grapher.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | env/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | 28 | # PyInstaller 29 | # Usually these files are written by a python script from a template 30 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 31 | *.manifest 32 | *.spec 33 | 34 | # Installer logs 35 | pip-log.txt 36 | pip-delete-this-directory.txt 37 | 38 | # Unit test / coverage reports 39 | htmlcov/ 40 | .tox/ 41 | .coverage 42 | .coverage.* 43 | .cache 44 | nosetests.xml 45 | coverage.xml 46 | *.cover 47 | .hypothesis/ 48 | 49 | # Translations 50 | *.mo 51 | *.pot 52 | 53 | # Django stuff: 54 | *.log 55 | local_settings.py 56 | 57 | # Flask stuff: 58 | instance/ 59 | .webassets-cache 60 | 61 | # Scrapy stuff: 62 | .scrapy 63 | 64 | # Sphinx documentation 65 | docs/_build/ 66 | 67 | # PyBuilder 68 | target/ 69 | 70 | # Jupyter Notebook 71 | .ipynb_checkpoints 72 | 73 | # pyenv 74 | .python-version 75 | 76 | # celery beat schedule file 77 | celerybeat-schedule 78 | 79 | # SageMath parsed files 80 | *.sage.py 81 | 82 | # dotenv 83 | .env 84 | 85 | # virtualenv 86 | .venv 87 | venv/ 88 | ENV/ 89 | 90 | # Spyder project settings 91 | .spyderproject 92 | .spyproject 93 | 94 | # Rope project settings 95 | .ropeproject 96 | 97 | # mkdocs documentation 98 | /site 99 | 100 | # .idea folder 101 | .idea/ 102 | 103 | # mypy 104 | .mypy_cache/ 105 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # pcap-grapher 2 | ### Create an intuitive and interactive graph of a client's IP traffic. ### 3 | 4 | Usage: 5 | `pcap-grapher.py [-h] [-f display-filter] ` 6 | ![Alt text](example.png?raw=true "example-graph") 7 | 8 | #### Additional features: #### 9 | * Filter the traffic to get an even-more concise graph 10 | * Click a packet (circle) to get details about the flow on stdout (incl. protocols) 11 | 12 | #### Prerequisites: #### 13 | * pyshark 14 | * numpy 15 | * matplotlib 16 | 17 | #### TODOs: #### 18 | * Restructure project 19 | -------------------------------------------------------------------------------- /config.py: -------------------------------------------------------------------------------- 1 | import argparse 2 | 3 | parser = argparse.ArgumentParser(description="Create an intuitive and interactive graph of a client's IP traffic") 4 | parser.add_argument("pcap_path", metavar="", help="path to the pcap file") 5 | parser.add_argument("client_ip", metavar="", 6 | help="client's ip allow filtering and focusing on a specific IP") 7 | parser.add_argument("-f", dest="display_filter", metavar="display-filter", 8 | help="Wireshark display filter, additional to the client filter.") 9 | 10 | args = parser.parse_args() 11 | pcap_path = args.pcap_path 12 | display_filter = args.display_filter 13 | client_ip = args.client_ip 14 | -------------------------------------------------------------------------------- /entity.py: -------------------------------------------------------------------------------- 1 | class Entity: 2 | def __init__(self, pkt, is_upstream): 3 | if is_upstream: 4 | self.ip = pkt.ip.src 5 | self.port = getattr(pkt, pkt.transport_layer.lower()).srcport 6 | else: 7 | self.ip = pkt.ip.dst 8 | self.port = getattr(pkt, pkt.transport_layer.lower()).dstport 9 | 10 | def __str__(self): 11 | return self.ip + ":" + str(self.port) 12 | -------------------------------------------------------------------------------- /example.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Yotamho/pcap-grapher/218957c3773ef228b7d8382dd76a2492531581bc/example.png -------------------------------------------------------------------------------- /flow.py: -------------------------------------------------------------------------------- 1 | import time 2 | import pyshark.packet.packet 3 | import config 4 | from logging import Logger 5 | from collections import Counter 6 | 7 | from entity import Entity 8 | 9 | 10 | class Flow: 11 | def __init__(self, pkt: pyshark.packet.packet.Packet): 12 | self.packets = [] 13 | self.protocols = Counter() 14 | self.logger = Logger(self.__class__.__name__) 15 | 16 | is_packet_upstream = check_if_packet_is_upstream(pkt) 17 | if is_packet_upstream is not None: 18 | self.start_time = float(pkt.sniff_timestamp) 19 | self.end_time = float(pkt.sniff_timestamp) 20 | self.ingest(pkt) 21 | 22 | self.client = Entity(pkt, is_packet_upstream) 23 | self.server = Entity(pkt, not is_packet_upstream) 24 | else: 25 | self.logger.error("Packet does not include client configured IP. Packet number: " + pkt.number) 26 | 27 | def ingest(self, pkt): 28 | self.end_time = float(pkt.sniff_timestamp) 29 | self.packets.append(pkt) 30 | self.count_protocol(pkt) 31 | 32 | def count_protocol(self, pkt: pyshark.packet.packet.Packet): 33 | if len(pkt.layers) > 3: 34 | self.protocols[pkt.layers[3].layer_name] += 1 35 | else: 36 | self.protocols[pkt.layers[2].layer_name] += 1 37 | 38 | def __len__(self): 39 | return len(self.packets) 40 | 41 | def __str__(self): 42 | return "\nFlow: " + str(self.client) + " -> " + str(self.server) + "\n\t" \ 43 | + "Protocols: " + str(self.protocols) + "\n\t" \ 44 | + "No. of packets: " + str(len(self)) + "\n\t" \ 45 | + "Start Time: " + time.strftime('%Y-%d-%m %H:%M:%S', time.gmtime(float(self.start_time))) + "\n\t" \ 46 | + "End Time: " + time.strftime('%Y-%d-%m %H:%M:%S', time.gmtime(float(self.end_time))) 47 | 48 | def __iter__(self): 49 | for pkt in self.packets: 50 | yield pkt 51 | 52 | 53 | def check_if_packet_is_upstream(pkt: pyshark.packet.packet.Packet): 54 | addresses = (pkt.ip.src, pkt.ip.dst) 55 | client_configured_ip = config.client_ip 56 | if client_configured_ip in addresses: 57 | return client_configured_ip == addresses[0] 58 | else: 59 | return None 60 | -------------------------------------------------------------------------------- /memory.py: -------------------------------------------------------------------------------- 1 | from logging import Logger 2 | 3 | from flow import Flow 4 | 5 | 6 | class Memory: 7 | def __init__(self): 8 | self.inner = {} 9 | self.logger = Logger(self.__class__.__name__) 10 | 11 | def upsert(self, pkt): 12 | four_tuple = packet_to_four_tuple(pkt) 13 | if four_tuple: 14 | if four_tuple in self.inner: 15 | self.update(four_tuple, pkt) 16 | else: 17 | self.insert(four_tuple, pkt) 18 | else: 19 | self.logger.warn("Non TCP/UDP Packet: " + pkt.number) 20 | 21 | def update(self, four_tuple, pkt): 22 | self.inner[four_tuple].ingest(pkt) 23 | 24 | def insert(self, four_tuple, pkt): 25 | self.inner[four_tuple] = Flow(pkt) 26 | 27 | def items(self): 28 | for four_tuple, flow in self.inner.items(): 29 | yield four_tuple, flow 30 | 31 | def get_minimal_timestamp(self): 32 | return min([flow.start_time for flow in self.inner.values()]) 33 | 34 | 35 | def packet_to_four_tuple(pkt): 36 | if pkt.transport_layer: 37 | transport_layer = getattr(pkt, pkt.transport_layer.lower()) 38 | return frozenset({(pkt.ip.src, transport_layer.srcport), (pkt.ip.dst, transport_layer.dstport)}) 39 | else: 40 | return None 41 | -------------------------------------------------------------------------------- /pcap-grapher.py: -------------------------------------------------------------------------------- 1 | import pyshark 2 | import numpy as np 3 | from matplotlib import pyplot as plt 4 | import matplotlib.patches as mpatches 5 | 6 | import config 7 | from memory import Memory 8 | 9 | 10 | class PcapSchema: 11 | NUMBER_OF_COLORS = 255 12 | 13 | def __init__(self): 14 | self.pcap_path = config.pcap_path 15 | self.client_ip = config.client_ip 16 | self.display_filter = "ip.addr==" + self.client_ip 17 | if config.display_filter: 18 | self.display_filter = self.display_filter + " and " + config.display_filter 19 | self.memory = Memory() 20 | self.colors = {} 21 | self.cmap = plt.cm.get_cmap('hsv') 22 | 23 | def build_flows(self): 24 | pcap = pyshark.FileCapture(self.pcap_path, display_filter=self.display_filter) 25 | for pkt in pcap: 26 | self.memory.upsert(pkt) 27 | 28 | def get_color(self, src_port): 29 | 30 | if src_port not in self.colors: 31 | self.colors[src_port] = self.cmap(int(src_port) % PcapSchema.NUMBER_OF_COLORS) 32 | return self.colors[src_port] 33 | 34 | def draw_flows(self): 35 | minimal_timestamp = float(self.memory.get_minimal_timestamp()) 36 | ytick_labels = [] 37 | yticks = [] 38 | fig = plt.figure() 39 | fig.suptitle( 40 | self.client_ip + " on " + self.pcap_path[self.pcap_path.rfind("\\\\") + 2:]) 41 | ax = fig.add_subplot(111) 42 | for i, (four_tuple, flow) in enumerate(self.memory.items()): 43 | ax.plot(np.array([float(t) - minimal_timestamp for t in (flow.start_time, flow.end_time)]), 44 | np.array([i * 3] * 2), 'k') 45 | ax.plot(np.array([float(pkt.sniff_timestamp) - minimal_timestamp for pkt in flow]), 46 | np.array([i * 3] * len(flow)), 'bo', color=self.get_color(flow.client.port), picker=True)[ 47 | 0].set_gid( 48 | flow) 49 | ytick_labels.append(str(flow.server)) 50 | yticks.append(i * 3) 51 | ax.set_yticks(yticks) 52 | ax.set_yticklabels(ytick_labels) 53 | ax.set_xlabel("Seconds since beginning of capture") 54 | ax.set_ylabel("External IP:Port") 55 | plt.legend(title='Internal Port', 56 | handles=[mpatches.Patch(color=color, label=src_port) for src_port, color in self.colors.items()]) 57 | 58 | def onpick(event): 59 | print(event.artist.get_gid()) 60 | 61 | fig.canvas.mpl_connect("pick_event", onpick) 62 | plt.show() 63 | 64 | 65 | if __name__ == "__main__": 66 | pcap_schema = PcapSchema() 67 | pcap_schema.build_flows() 68 | pcap_schema.draw_flows() 69 | --------------------------------------------------------------------------------