python-flirt 0.9.9__cp314-cp314-win_amd64.whl

flirt/__init__.py

@@ -0,0 +1,5 @@
+from .flirt import *
+
+__doc__ = flirt.__doc__
+if hasattr(flirt, "__all__"):
+    __all__ = flirt.__all__

python_flirt-0.9.9.dist-info/METADATA

@@ -0,0 +1,142 @@
+Metadata-Version: 2.4
+Name: python-flirt
+Version: 0.9.9
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Disassemblers
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Rust
+Requires-Dist: maturin>=1.7.4 ; extra == 'dev'
+Requires-Dist: pytest>=7.1.3 ; extra == 'dev'
+Requires-Dist: pytest-sugar>=0.9.4 ; extra == 'dev'
+Requires-Dist: pytest-instafail>=0.4.2 ; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0 ; extra == 'dev'
+Requires-Dist: pycodestyle>=2.9.1 ; extra == 'dev'
+Requires-Dist: black>=22.10.0 ; extra == 'dev'
+Requires-Dist: isort>=5.10.1 ; extra == 'dev'
+Requires-Dist: mypy>=0.982 ; extra == 'dev'
+Provides-Extra: dev
+License-File: LICENSE.txt
+Summary: A Python library for parsing, compiling, and matching Fast Library Identification and Recognition Technology (FLIRT) signatures.
+Keywords: flirt
+Home-Page: https://github.com/williballenthin/lancelot/tree/master/pyflirt
+Author-email: Willi Ballenthin <william.ballenthin@mandiant.com>
+Maintainer-email: Willi Ballenthin <william.ballenthin@mandiant.com>
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: repository, https://github.com/williballenthin/lancelot/tree/master/pyflirt
+
+# python-flirt
+
+A Python library for parsing, compiling, and matching [Fast Library Identification and Recognition Technology (FLIRT)](https://hex-rays.com/products/ida/tech/flirt/in_depth/) signatures. These signatures are typically used by the Hex-Rays IDA Pro tool; this library is the result of reverse engineering the matching engine and reimplementing parsers and matchers. You can use this library to match FLIRT signatures against byte sequences to recognize statically-linked code without IDA Pro.
+
+These are the [Python bindings](https://github.com/williballenthin/lancelot/tree/master/pyflirt) to
+[lancelot-flirt](https://github.com/williballenthin/lancelot/tree/master/flirt) generated via
+[PyO3](https://github.com/PyO3/pyo3) for Python 3.x that are available on PyPI as
+[python-flirt](https://pypi.org/project/python-flirt/).
+
+## Usage
+
+Add `python-flirt` to your Python project dependencies (such as via `setup.py`); for example, like this:
+
+```py
+setuptools.setup(
+  ...
+  install_requires=[
+    "python-flirt~=0.6.3",
+  ]
+  ...
+)
+```
+
+Here's a sample example that parses a FLIRT signature from a string and matches against a byte sequence:
+
+```python
+import flirt
+
+BUF = bytes([
+    # utcutil.dll
+    #  MD5 abc9ea116498feb8f1de45f60d595af6
+    #  SHA-1 2f1ba350237b74c454caf816b7410490f5994c59
+    #  SHA-256 7607897638e9dae406f0840dbae68e879c3bb2f08da350c6734e4e2ef8d61ac2
+    # __EH_prolog3_catch_align
+
+    0x51,0x8b,0x4c,0x24,0x0c,0x89,0x5c,0x24,0x0c,0x8d,0x5c,0x24,0x0c,0x50,0x8d,0x44,
+    0x24,0x08,0xf7,0xd9,0x23,0xc1,0x8d,0x60,0xf8,0x8b,0x43,0xf0,0x89,0x04,0x24,0x8b,
+    0x43,0xf8,0x50,0x8b,0x43,0xfc,0x8b,0x4b,0xf4,0x89,0x6c,0x24,0x0c,0x8d,0x6c,0x24,
+    0x0c,0xc7,0x44,0x24,0x08,0xff,0xff,0xff,0xff,0x51,0x53,0x2b,0xe0,0x56,0x57,0xa1,
+    0x70,0x14,0x01,0x10,0x33,0xc5,0x50,0x89,0x65,0xf0,0x8b,0x43,0x04,0x89,0x45,0x04,
+    0xff,0x75,0xf4,0x64,0xa1,0x00,0x00,0x00,0x00,0x89,0x45,0xf4,0x8d,0x45,0xf4,0x64,
+    0xa3,0x00,0x00,0x00,0x00,0xf2,0xc3
+])
+
+PAT = """\
+518B4C240C895C240C8D5C240C508D442408F7D923C18D60F88B43F08904248B 21 B4FE 006E :0000 __EH_prolog3_GS_align ^0041 ___security_cookie ........33C5508941FC8B4DF0895DF08B4304894504FF75F464A1000000008945F48D45F464A300000000F2C3
+518B4C240C895C240C8D5C240C508D442408F7D923C18D60F88B43F08904248B 1F E4CF 0063 :0000 __EH_prolog3_align ^003F ___security_cookie ........33C5508B4304894504FF75F464A1000000008945F48D45F464A300000000F2C3
+518B4C240C895C240C8D5C240C508D442408F7D923C18D60F88B43F08904248B 22 E4CE 006F :0000 __EH_prolog3_catch_GS_align ^0042 ___security_cookie ........33C5508941FC8B4DF08965F08B4304894504FF75F464A1000000008945F48D45F464A300000000F2C3
+518B4C240C895C240C8D5C240C508D442408F7D923C18D60F88B43F08904248B 20 6562 0067 :0000 __EH_prolog3_catch_align ^0040 ___security_cookie ........33C5508965F08B4304894504FF75F464A1000000008945F48D45F464A300000000F2C3
+---
+"""
+
+# parse signature file content into a list of signatures.
+sigs = flirt.parse_pat(PAT)
+
+# compile signatures into a matching engine instance.
+# separate from above so that you can load multiple files.
+matcher = flirt.compile(sigs)
+
+# match the signatures against the given buffer, starting at offset 0.
+# results in a list of rule instances with a field `name` tuple like:
+#
+#     ("__EH_prolog3_catch_align", "public", 0)
+for m in matcher.match(BUF):
+    print(f"match: {m.names[0][0]}")
+```
+
+expected output:
+
+```
+match: __EH_prolog3_catch_align
+```
+
+Note, the above logic does not handle "references" that are describe below;
+however, it does give a sense for the required setup to parse and compile rules.
+
+### Usage: signature file formats
+
+This library supports loading signatures from both the .sig and .pat file formats:
+
+  - .sig files are the compiled signatures usually fed into IDA Pro for matching. They are structurally compressed (and uncommonly compressed with a zlib-like algorithm, not supported here) and have a raw binary representation.
+
+  - .pat files are the ASCII-encoded text files generated by `sigmake.exe`. These are typically compiled into .sig files for use in IDA Pro; however, since `lancelot-flirt` compiles the rules into its own intermediate representation, you can use them directly. Notably, this library supports a slight extension to enable a file header with lines prefixed with `#`, which enables you to embed a acknowledgement/copyright/license.
+
+With knowledge of the above, you may consider also supporting `.pat.gz` signature files in your client application, as this enables a great compression ratio while preserving the file license header and human-inspectability.
+
+### Usage: matching references
+
+To differentiate functions with a shared byte-wise representation, such as wrapper functions that dispatch other addresses, a FLIRT engine matches recursively using "references".
+This feature is used heavily to match common routines provided by modern C/C++ runtime libraries.
+
+Unfortunately, client code must coordinate the recursive invocation of FLIRT matching.
+
+Therefore, when integrating this library into a client application, you should review the matching logic of `lancelot::core::analysis::flirt` [here](https://github.com/williballenthin/lancelot/blob/master/core/src/analysis/flirt.rs).
+Essentially, you'll need to inspect the "references" found within a function and recursively FLIRT match those routines to resolve the best matching signature.
+There's also a matching implementation in Python for vivisect [here](https://github.com/williballenthin/viv-utils/blob/master/viv_utils/flirt.py) that relies on more thorough code flow recovery.
+
+
+### Usage: example tool
+
+The tool [capa](https://github.com/fireeye/capa) uses `python-flirt` to recognize statically-linked functions within PE files.
+You can use this code as an example for how to integrate this library with your client code.
+
+## License
+
+This project is licensed under the Apache License, Version 2.0 (https://www.apache.org/licenses/LICENSE-2.0).
+You should not redistribute FLIRT signatures distributed by Hex-Rays; however, there are open source signatures available here:
+
+  - https://github.com/fireeye/siglib/
+  - https://github.com/Maktm/FLIRTDB
+  - https://github.com/rizinorg/sigdb
+

python_flirt-0.9.9.dist-info/RECORD

@@ -0,0 +1,6 @@
+flirt/__init__.py,sha256=9TxxyU4VTmqwqqXa_cN1EAzFMeX4OG6N-V5mO-SUdbQ,103
+flirt/flirt.cp314-win_amd64.pyd,sha256=l2ci5WLN8wCA6PtVIhQhQqqu9d-Idaszrl8Ecp_X7TM,421376
+python_flirt-0.9.9.dist-info/METADATA,sha256=2LKf_Gri9ziq10XMwDG5olhkV6XCgLmtdh3hWAn1YvQ,7697
+python_flirt-0.9.9.dist-info/WHEEL,sha256=ZrAiv7lKoKZh206bhSq4g-n3q3ySUOJQmQ4WXAA7TE8,97
+python_flirt-0.9.9.dist-info/licenses/LICENSE.txt,sha256=r8ITulvkflA7NBADr4iaroceghiTL9_1Xvd48ud8yqw,11551
+python_flirt-0.9.9.dist-info/RECORD,,

python_flirt-0.9.9.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.10.2)
+Root-Is-Purelib: false
+Tag: cp314-cp314-win_amd64

python_flirt-0.9.9.dist-info/licenses/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 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.
+
+   Copyright (C) 2020 Mandiant, Inc.
+
+   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.