This GitHub public repository ( https://github.com/oasis-open/cti-pattern-matcher ) was created at the request of the OASIS Cyber Threat Intelligence (CTI) TC as an OASIS Open Repository to support development of open source resources related to Technical Committee work.
While this Open Repository remains associated with the sponsor TC, its development priorities, leadership, intellectual property terms, participation rules, and other matters of governance are separate and distinct from the OASIS TC Process and related policies.
All contributions made to this Open Repository are subject to open source license terms expressed in the BSD-3-Clause License. That license was selected as the declared "Applicable License" when the Open Repository was created.
As documented in "Public Participation Invited", contributions to this OASIS Open Repository are invited from all parties, whether affiliated with OASIS or not. Participants must have a GitHub account, but no fees or OASIS membership obligations are required. Participation is expected to be consistent with the OASIS Open Repository Guidelines and Procedures, the open source LICENSE designated for this particular repository, and the requirement for an Individual Contributor License Agreement that governs intellectual property.
Statement of Purpose for this OASIS Open Repository (cti-pattern-matcher) as proposed and approved [bis] by the TC:
The pattern-matcher is a prototype software tool for matching STIX Observed Data content against patterns used in STIX Indicators. The matcher accepts a pattern and one or more timestamped observations, and determines whether the observations match the criteria specified by the pattern. The purpose of this tool is to evaluate examples and test cases which implement the patterning specification, as a form of executable documentation and to verify patterns express the desired criteria.
- Python 2.7.6+
- ANTLR Python Runtime (4.5.3+)
- python-dateutil (https://dateutil.readthedocs.io/en/stable/)
- six (https://six.readthedocs.io/)
- (For running tests) - pytest (http://pytest.org/latest/getting-started.html)
To install pattern-matcher, first install all required dependencies, then run python setup.py install in the root of this repository.
Run the pattern_matcher.py script in this repository, and follow directions. For example:
$ python pattern_matcher.py
Enter a CybOX pattern:
file-object:hashes.sha-256 = 'aec070645fe53ee3b3763059376134f058cc337247c978add178b6ccdfb0019f'
Enter the name of json file containing a CybOX object or container:
test\0pass.json
PASS: file-object:hashes.sha-256 = 'aec070645fe53ee3b3763059376134f058cc337247c978add178b6ccdfb0019f'To run the automated tests, execute py.test from inside the test directory.
Open Repository Maintainers are responsible for oversight of this project's community development activities, including evaluation of GitHub pull requests and preserving open source principles of openness and fairness. Maintainers are recognized and trusted experts who serve to implement community goals and consensus design preferences.
Initially, the associated TC members have designated one or more persons to serve as Maintainer(s); subsequently, participating community members may select additional or substitute Maintainers, per consensus agreements.
Current Maintainers of this Open Repository
- Greg Back; GitHub ID: https://github.com/gtback/; WWW: MITRE
- Ivan Kirillov; GitHub ID: https://github.com/ikiril01/; WWW: MITRE
Questions or comments about this Open Repository's activities should be composed as GitHub issues or comments. If use of an issue/comment is not possible or appropriate, questions may be directed by email to the Maintainer(s) listed above. Please send general questions about Open Repository participation to OASIS Staff at repository-admin@oasis-open.org and any specific CLA-related questions to repository-cla@oasis-open.org.