Join us on Slack!
Click here and fill out the form to receive an invite to the Open Cybersecurity Alliance slack instance, then join the #stix-shifter channel, to meet and discuss usage with the team.
Introduction Webinar!
Click here to view an introduction webinar on STIX Shifter and the use cases it solves for.
Introduction
STIX-shifter is an open source python library allowing software to connect to products that house data repositories by using STIX Patterning, and return results as STIX Observations.
For more information about this project, see the STIX-shifter Overview
Dependencies
This stix-shifter has the following dependencies:
- stix2-patterns>=1.1.0
- stix2-validator>=0.5.0
- stix2-matcher: There is no python package publish in pypi for stix2-matcher. The bellow command can be used to install this package:
pip install git+git://github.com/oasis-open/cti-pattern-matcher.git@b265862971eb63c04a8a054a2adb13860edf7846#egg=stix2-matcher - antlr4-python3-runtime>=4.7
- python-dateutil>=2.7.3
Your development environment must use Python 3.6.x
Installation
The recommended method for installing the STIX-shifter is via pip.
pip install stix-shifter
Usage
As A Script
The STIX-Shifter comes with a bundled script which you can use to translate STIX Pattern to a native datasource query. It can also be used to translate a JSON data source query result to a STIX bundle of observable objects. You can also send query to a datasource by using a transmission option.
More details of the command line option can be found here
$ stix-shifter translate <MODULE NAME> query "<STIX IDENTITY OBJECT>" "<STIX PATTERN>" "<OPTIONS>"
Example:
$ stix-shifter translate qradar query {} "[ipv4-addr:value = '127.0.0.1']" {}
Note: In order to create python executable stix-shifter from source run the following command from stix-shifter parent directory in your python 3 environment: python setup.py install
As A Library
You can also use this library to integrate STIX Shifter into your own tools. You can translate a STIX Pattern:
from stix_shifter.stix_translation import stix_translation
translation = stix_translation.StixTranslation()
response = translation.translate('<MODULE NAME>', 'query', '{}', '<STIX PATTERN>', '<OPTIONS>')
print(response)
Contributing
We are thrilled you are considering contributing! We welcome all contributors.
Please read our guidelines for contributing.
Guide for creating new connectors
If you want to create a new connector for STIX-shifter, see the developer guide
Licensing
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.