traffic-taffy 0.5.8__tar.gz → 0.6.1__tar.gz

traffic_taffy-0.6.1/LICENSE.txt

@@ -0,0 +1,204 @@
+Copyright 2023-2024 USC/ISI
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+
+The Apache 2.0 LICENSE:
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.

{traffic_taffy-0.5.8 → traffic_taffy-0.6.1}/PKG-INFO

@@ -1,9 +1,10 @@
 Metadata-Version: 2.1
 Name: traffic-taffy
-Version: 0.5.8
+Version: 0.6.1
 Summary: A tool for doing differential analysis of pcap files
-Project-URL: Homepage, https://github.com/hardaker/traffic-taffy
+Project-URL: Homepage, https://traffic-taffy.github.io/
 Author-email: Wes Hardaker <opensource@hardakers.net>
+License-File: LICENSE.txt
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.7
@@ -40,6 +41,14 @@ This tool is designed to do just that.
 See the online [readthedocs
 documentation](https://traffic-taffy.readthedocs.io/).
 
+## Development
+
+Traffic-taffy is under very rapid development with a fair amount of
+refactoring as time goes on into better class architectures.  If you
+are considering looking at portions of the code and submitting pull
+requests, please reach out to Wes ahead of time to check what changes
+might be coming that will cause merge conflicts.
+
 # Copyright and License
 
 This project is copyrighted by the University of Southern California,

{traffic_taffy-0.5.8 → traffic_taffy-0.6.1}/README.md

@@ -18,6 +18,14 @@ This tool is designed to do just that.
 See the online [readthedocs
 documentation](https://traffic-taffy.readthedocs.io/).
 
+## Development
+
+Traffic-taffy is under very rapid development with a fair amount of
+refactoring as time goes on into better class architectures.  If you
+are considering looking at portions of the code and submitting pull
+requests, please reach out to Wes ahead of time to check what changes
+might be coming that will cause merge conflicts.
+
 # Copyright and License
 
 This project is copyrighted by the University of Southern California,

{traffic_taffy-0.5.8 → traffic_taffy-0.6.1}/pyproject.toml

@@ -39,7 +39,7 @@ taffy-graph = "traffic_taffy.tools.graph:main"
 taffy-export = "traffic_taffy.tools.export:main"
 
 [project.urls]
-Homepage = "https://github.com/hardaker/traffic-taffy"
+Homepage = "https://traffic-taffy.github.io/"
 
 [tool.hatch.version]
 path = "traffic_taffy/__init__.py"
@@ -65,7 +65,9 @@ ignore = ["E501", "I001", "PLR0913", "ANN101", "ANN204",
 # complaining about simple if/else
 "SIM108",
 # allow blind exceptions
-"BLE001"
+"BLE001",
+# allow for loop variable overrides
+"PLW2901",
 ]
 fixable = ["ALL"]  # gulp
 # select = ["ALL"]

traffic_taffy-0.6.1/traffic_taffy/__init__.py

@@ -0,0 +1 @@
+__VERSION__ = "0.6.1"

{traffic_taffy-0.5.8 → traffic_taffy-0.6.1}/traffic_taffy/compare.py

@@ -1,16 +1,35 @@
+"""The primary statistical packet comparison engine."""
+
+from __future__ import annotations
 from logging import debug, error
-from typing import List
+from typing import List, TYPE_CHECKING
 import datetime as dt
 from datetime import datetime
 
+if TYPE_CHECKING:
+    from argparse import ArgumentParser, Namespace
+
 from traffic_taffy.comparison import Comparison
 from traffic_taffy.dissectmany import PCAPDissectMany
 from traffic_taffy.dissector import PCAPDissectorLevel
 from traffic_taffy.dissection import Dissection
 
+from dataclasses import dataclass
+
+
+@dataclass
+class Report:
+    delta_percentage: float
+    delta_absolute: int
+    total: int
+    left_count: int
+    right_count: int
+    left_percentage: float
+    right_percentage: float
+
 
 class PcapCompare:
-    "Takes a set of PCAPs to then perform various comparisons upon"
+    """Take a set of PCAPs to then perform various comparisons upon."""
 
     REPORT_VERSION: int = 2
 
@@ -25,11 +44,12 @@ class PcapCompare:
         bin_size: int | None = None,
         dissection_level: PCAPDissectorLevel = PCAPDissectorLevel.COUNT_ONLY,
         between_times: List[int] | None = None,
-        ignore_list: List[str] = [],
+        ignore_list: List[str] | None = None,
         layers: List[str] | None = None,
         force_load: bool = False,
         force_overwrite: bool = False,
     ) -> None:
+        """Create a compare object."""
         self.pcap_files = pcap_files
         self.deep = deep
         self.maximum_count = maximum_count
@@ -39,30 +59,31 @@ class PcapCompare:
         self.between_times = between_times
         self.bin_size = bin_size
         self.cache_file_suffix = cache_file_suffix
-        self.ignore_list = ignore_list
+        self.ignore_list = ignore_list or []
         self.layers = layers
         self.force_overwrite = force_overwrite
         self.force_load = force_load
 
     @property
-    def pcap_files(self):
+    def pcap_files(self) -> List[str]:
+        """List of pcap files being compared."""
         return self._pcap_files
 
     @pcap_files.setter
-    def pcap_files(self, new_pcap_files):
+    def pcap_files(self, new_pcap_files: List[str]) -> None:
         self._pcap_files = new_pcap_files
 
     @property
-    def reports(self):
+    def reports(self) -> List[dict]:
+        """List of reports generated by the comparison."""
         return self._reports
 
     @reports.setter
-    def reports(self, newvalue):
+    def reports(self, newvalue: List[dict]) -> None:
         self._reports = newvalue
 
     def compare_dissections(self, left_side: dict, right_side: dict) -> dict:
-        "compares the results from two reports"
-
+        """Compare two dissections."""
         report = {}
 
         keys = set(left_side.keys())
@@ -79,7 +100,7 @@ class PcapCompare:
             right_side_total = sum(right_side[key].values())
 
             new_left_count = 0
-            for subkey in left_side[key].keys():
+            for subkey in left_side[key]:
                 delta_percentage = 0.0
                 total = 0
                 if subkey in right_side[key]:
@@ -99,18 +120,18 @@ class PcapCompare:
                     new_left_count += 1
 
                 delta_absolute = right_count - left_count
-                report[key][subkey] = {
-                    "delta_percentage": delta_percentage,
-                    "delta_absolute": delta_absolute,
-                    "total": total,
-                    "left_count": left_count,
-                    "right_count": right_count,
-                    "left_percentage": left_percentage,
-                    "right_percentage": right_percentage,
-                }
+                report[key][subkey] = Report(
+                    delta_percentage=delta_percentage,
+                    delta_absolute=delta_absolute,
+                    total=total,
+                    left_count=left_count,
+                    right_count=right_count,
+                    left_percentage=left_percentage,
+                    right_percentage=right_percentage,
+                )
 
             new_right_count = 0
-            for subkey in right_side[key].keys():
+            for subkey in right_side[key]:
                 if subkey not in report[key]:
                     delta_percentage = 1.0
                     total = right_side[key][subkey]
@@ -120,15 +141,15 @@ class PcapCompare:
                     right_percentage = right_side[key][subkey] / right_side_total
                     new_right_count += 1  # this value wasn't in the left
 
-                    report[key][subkey] = {
-                        "delta_percentage": delta_percentage,
-                        "delta_absolute": right_count,
-                        "total": total,
-                        "left_count": left_count,
-                        "right_count": right_count,
-                        "left_percentage": left_percentage,
-                        "right_percentage": right_percentage,
-                    }
+                    report[key][subkey] = Report(
+                        delta_percentage=delta_percentage,
+                        delta_absolute=right_count,
+                        total=total,
+                        left_count=left_count,
+                        right_count=right_count,
+                        left_percentage=left_percentage,
+                        right_percentage=right_percentage,
+                    )
 
             if right_side_total == 0:
                 right_percent = 100
@@ -140,19 +161,20 @@ class PcapCompare:
             else:
                 left_percent = new_left_count / left_side_total
 
-            report[key][Dissection.NEW_RIGHT_SUBKEY] = {
-                "delta_absolute": new_right_count - new_left_count,
-                "total": new_left_count + new_right_count,
-                "left_count": new_left_count,
-                "right_count": new_right_count,
-                "left_percentage": left_percent,
-                "right_percentage": right_percent,
-                "delta_percentage": right_percent - left_percent,
-            }
+            report[key][Dissection.NEW_RIGHT_SUBKEY] = Report(
+                delta_absolute=new_right_count - new_left_count,
+                total=new_left_count + new_right_count,
+                left_count=new_left_count,
+                right_count=new_right_count,
+                left_percentage=left_percent,
+                right_percentage=right_percent,
+                delta_percentage=right_percent - left_percent,
+            )
 
         return Comparison(report)
 
     def load_pcaps(self) -> None:
+        """Load all pcaps into memory and dissect them."""
         # load the first as a reference pcap
         pdm = PCAPDissectMany(
             self.pcap_files,
@@ -167,17 +189,16 @@ class PcapCompare:
             force_load=self.force_load,
             force_overwrite=self.force_overwrite,
         )
-        results = pdm.load_all()
-        return results
+        return pdm.load_all()
 
     def compare(self) -> List[Comparison]:
-        "Compares each pcap against the original source"
-
+        """Compare each pcap as requested."""
         dissections = self.load_pcaps()
         self.compare_all(dissections)
         return self.reports
 
-    def compare_all(self, dissections) -> List[Comparison]:
+    def compare_all(self, dissections: List[Dissection]) -> List[Comparison]:
+        """Compare all loaded pcaps."""
         reports = []
         if len(self.pcap_files) > 1:
             # multiple file comparison
@@ -197,9 +218,8 @@ class PcapCompare:
                 error(
                     "the requested pcap data was not long enough to compare against itself"
                 )
-                raise ValueError(
-                    "not enough of a single capture file to time-bin the results"
-                )
+                errorstr: str = "not large enough pcap file"
+                raise ValueError(errorstr)
             debug(
                 f"found {len(timestamps)} timestamps from {timestamps[2]} to {timestamps[-1]}"
             )
@@ -249,7 +269,10 @@ class PcapCompare:
         return reports
 
 
-def compare_add_parseargs(compare_parser, add_subgroup: bool = True):
+def compare_add_parseargs(
+    compare_parser: ArgumentParser, add_subgroup: bool = True
+) -> ArgumentParser:
+    """Add common comparison arguments."""
     if add_subgroup:
         compare_parser = compare_parser.add_argument_group("Comparison result options")
 
@@ -285,17 +308,26 @@ def compare_add_parseargs(compare_parser, add_subgroup: bool = True):
     )
 
     compare_parser.add_argument(
-        "-T",
-        "--between-times",
-        nargs=2,
-        type=int,
-        help="For single files, only display results between these timestamps",
+        "-s",
+        "--sort-by",
+        default="delta%",
+        type=str,
+        help="Sort report entries by this column",
     )
 
+    # compare_parser.add_argument(
+    #     "-T",
+    #     "--between-times",
+    #     nargs=2,
+    #     type=int,
+    #     help="For single files, only display results between these timestamps",
+    # )
+
     return compare_parser
 
 
-def get_comparison_args(args):
+def get_comparison_args(args: Namespace) -> dict:
+    """Return a dict of comparison parameters from arguments."""
     return {
         "maximum_count": args.packet_count or 0,
         "print_threshold": float(args.print_threshold) / 100.0,

traffic_taffy-0.6.1/traffic_taffy/comparison.py

@@ -0,0 +1,34 @@
+"""A simple data storage module to hold comparison data."""
+
+from __future__ import annotations
+from typing import Dict, Any
+
+
+class Comparison:
+    """A simple data storage class to hold comparison data."""
+
+    def __init__(self, contents: list, title: str = ""):
+        """Create a Comparison class from contents."""
+        self.contents = contents
+        self.title: str = title
+        self.printing_arguments: Dict[str, Any] = {}
+
+    # title
+    @property
+    def title(self) -> str:
+        """The title of this comparison."""
+        return self._title
+
+    @title.setter
+    def title(self, new_title: str) -> None:
+        self._title = new_title
+
+    # report contents -- actual data
+    @property
+    def contents(self) -> None:
+        """The contents of this comparison."""
+        return self._contents
+
+    @contents.setter
+    def contents(self, new_contents: str) -> None:
+        self._contents = new_contents