From aff2e4135485d074c56853ee3ac4c8486371cfb3 Mon Sep 17 00:00:00 2001 From: Kevin Jahaziel Leon Morales Date: Fri, 27 Dec 2024 13:51:16 -0600 Subject: [PATCH] fix: Docs --- changelog.md | 25 ++++++++++++++++++++ pycatsniffer_bv3/cat_sniffer.py | 4 ++-- pycatsniffer_bv3/docs/CatSniffer - Thread.md | 17 +++++++------ 3 files changed, 35 insertions(+), 11 deletions(-) create mode 100644 changelog.md diff --git a/changelog.md b/changelog.md new file mode 100644 index 0000000..7d014b9 --- /dev/null +++ b/changelog.md @@ -0,0 +1,25 @@ +# Change Log + +## V2.0 - Catnip +### Added +- Automatic catsniffer serial path location +- Setup for local pip package +### Changed +- Change the firmware argument to named input insted of index input +### Fixed +- Fix python validation + +## V2.0 - Pycatsniffer +### Added +- Automatic catsniffer serial path location +- Setup for local pip package +- Protocol filters for Thread and Zigbee +### Changed +- Change the firmware argument to named input insted of index input +- Change the .lua dissector for compiled dissectors + +> Note: Our compiled dissectores are for **Wireshark 4.4** version, are no compatible with under version, we are not supporting more in a production use the **.lua** (this are for testing or development) + +## V1.0 - Cativity +### Added +- Cativity - Adding a new tool for Zigbee Networks activity detection diff --git a/pycatsniffer_bv3/cat_sniffer.py b/pycatsniffer_bv3/cat_sniffer.py index 879ad9c..db74c79 100644 --- a/pycatsniffer_bv3/cat_sniffer.py +++ b/pycatsniffer_bv3/cat_sniffer.py @@ -128,8 +128,8 @@ def start( if channel not in self.sniffer_collector.get_protocol_phy().list_channel_range: control_ble = Protocols.PROTOCOLSLIST.get_protocol_by_name("ble") if get_protocol != control_ble: - control_channel = get_protocol.get_channel_range()[0][0] - channel = control_channel + print(f"\x1b[31;1m[!] Channel out of the range: {channel}\x1b[0m") + sys.exit(1) self.sniffer_collector.set_protocol_channel(channel) self.sniffer_collector.set_verbose_mode(verbose) diff --git a/pycatsniffer_bv3/docs/CatSniffer - Thread.md b/pycatsniffer_bv3/docs/CatSniffer - Thread.md index ed8f475..eabad0d 100644 --- a/pycatsniffer_bv3/docs/CatSniffer - Thread.md +++ b/pycatsniffer_bv3/docs/CatSniffer - Thread.md @@ -67,12 +67,12 @@ Then reboot your board. - `Import` -> `From Zip File` -> Locate the zip file in the folder `filter_profiles` from the repo - Then `Ok` -> If the **filters profiles** are not imported, with the latest version of pycatsniffer with the *Thread* command support, wireshark will not open an error will be displayed: `󰄛 - PycatSniffer CLI> wireshark: Configuration Profile "Threat" does not exist` or `󰄛 - PycatSniffer CLI> wireshark: Configuration Profile "Zigbee" does not exist` +> If the **filters profiles** are not imported, with the latest version of pycatsniffer with the *Thread* command support, wireshark will not open an error will be displayed: `󰄛 - PycatSniffer CLI> wireshark: Configuration Profile "Thread" does not exist` or `󰄛 - PycatSniffer CLI> wireshark: Configuration Profile "Zigbee" does not exist` ### Adding our dissectors - Open Wireshark - * `About Wireshark` -> `Folders` -- Locate `Global Plugins` and doble click in the `Location` column +- Locate `Personal Plugins` in the *name* column and doble click in the `Location` column - Once the folder are open, copy the `catsniffer.` from the `dissectors` folder > * About wireshark in macos are in the `Wireshark` menu and Windows and Linux are in `Help` menu @@ -199,7 +199,7 @@ Done # Catsniffer - Sniffing the network ## Starting the sniffing ```shell -python cat_sniffer.py sniff -phy threat -ff -ws -c 13 +python cat_sniffer.py sniff -phy Thread -ff -ws -c 13 :-: :-- | ++++=. .=++++ | @@ -218,7 +218,7 @@ python cat_sniffer.py sniff -phy threat -ff -ws -c 13 ┃ Information ┃ Value ┃ ┡━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━┩ │ COM Port │ /dev/cu.usbmodem13201 │ -│ PHY │ Threat │ +│ PHY │ Thread │ │ Channel │ 13 │ └─────────────┴───────────────────────┘ PyCat-Sniffer CLI - For sniffing the TI CC1352 device communication inferfaces. @@ -228,8 +228,7 @@ Type help or ? to list commands. ``` Wireshark open with listening in the channel 13 - -![[wireshark_thread_example.png]] +![wireshark_thread_example](wireshark_thread_example.png "wireshark_thread_example") ## Setting up the network key - `Preferences` -> `Protocols` @@ -238,10 +237,10 @@ Wireshark open with listening in the channel 13 - `Decryption key index`: 1 - `Key Hash`: Thread hash -![[wireshar_thread_key_info.png]] +![wireshar_thread_key_info](wireshar_thread_key_info.png "wireshar_thread_key_info") Once you save, Wireshark will show something like: -![[wireshark_thread_decrypted.png]] +![wireshark_thread_decrypted](wireshark_thread_decrypted.png "wireshark_thread_decrypted") ## View UDP Packets In the OT Border Router: @@ -272,4 +271,4 @@ The Border Router recived: > 9 bytes from fd96:26d8:408f:b50e:bca0:8fb6:ed5a:4a27 49154 CatsRules ``` -![[wireshark_thread_udp.png]] +![wireshar_thread_udp](wireshark_thread_udp.png "wireshar_thread_udp")