Skip to content
bworrell edited this page Jan 30, 2013 · 11 revisions

CybOX Tool Development

  • Q: What languages do you support?
  • A: Currently all of our tools/APIs/bindings are written for Python 2.6/2.7. Other languages are being considered for support, but this decision ultimately lies with the CybOX community

  • Q: I found a bug. How do I report it?
  • A: Submit a bug to the repository issue tracker. Mark the bug with the appropriate labels (e.g., "email to cybox" and "bug") and fill out the details. We will handle the rest!

  • Q: Is there documentation for the APIs and bindings?
  • A: Not yet. We are currently working on improving the (poor) state of our documentation across the entirety of the CybOX project, which includes the tools/bindings/APIs. We plan on providing extensive sets of coding examples alongside prose documentation to aid developers in their journey with CybOX.

  • Q: How can I contribute back to the CybOX Tools repository?
  • A: Issue a pull request and we will review the submission!

  • Q: Are there plans for "easy" distribution of CybOX tools/APIs/bindings?
  • A: Our python-cybox package can be installed via the setup.py script and we are currently looking into other methods for the distribution of our bindings and APIs (e.g., pip, distribute, etc.)

CybOX GitHub Repository and General

  • Q: What are the concepts behind the branches in the tool repository?
  • A: Our master branch contains the most recent, stable code for our repository. Non-master branches will be created on a per-feature basis and should be quickly merged back into the master branch. Branches will be named to be easily associated with a particular feature/issue tracker id.

  • Q: How do I find the most recent release of a script?
  • A: Releases of scripts will be tagged, e.g., "email_to_cybox-v0.2". Because all of our scripts are developed within the Tools repository, each tag will point to a particular revision of the entire repository. As such, users will need to navigate to the appropriate tool directory for a given tag.

  • Q: Will the python-cybox repository be used to exclusively store the Python CybOX Bindings?
  • A: Yes. The python-cybox repository is home to the development of our python bindings and APIs.

  • Q: Do we support pull requests?
  • A: Absolutely! We strongly encourage developers to tinker with our code. If a developer wishes to contribute back to the repository, they just need to issue a pull request and we will review the submission.

  • Q: Where can I find more information about CybOX?
  • A: The CybOX homepage is located at http://cybox.mitre.org