README

OASIS TC Open Repository: openc2-oif-orchestrator

This GitHub public repository openc2-oif-orchestrator was created at the request of the OASIS OpenC2 Technical Committee as an OASIS TC Open Repository to support development of open source resources related to Technical Committee work.

While this TC 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 TC Open Repository are subject to open source license terms expressed in Apache License v 2.0. That license was selected as the declared Applicable License when the TC voted to create this Open Repository.

As documented in Public Participation Invited, contributions to this TC 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 TC Open Repository Guidelines and Procedures, the open source LICENSE.md designated for this particular repository, and the requirement for an Individual Contributor License Agreement that governs intellectual property.

Statement of Purpose

OpenC2 Integration Framework (OIF) is a project to enable developers to create and test OpenC2 specifications and implementations without having to recreate an entire OpenC2 ecosystem. The OIF consists of two major parts:

• The "OIF Orchestrator" (this repository), which functions as an OpenC2 producer, and
• The "OIF Device", which functions as an OpenC2 consumer.

When used together the OIF Orchestrator and Device implement both sides of the OpenC2 Producer / Consumer model. The following diagram provides a high-level overview of the OIF:

Motivation: The OIF Orchestrator was created with the intent of being an easy-to-configure OpenC2 producer that can be used in the creation of reference implementations to control multiple devices. To that end it allows for the addition of multiple serializations and message transfer solutions. The intent is to reduce the time and effort needed to produce an OpenC2 reference implementation. The OpenC2 specification does not limit the types of data serialization or transport protocols that can be utilized to deliver the message content. OIF was built with the capability to easily add serialization and transport functionality in order to be able to represent a wide range of use cases. Additionally, OIF allows newcomers a lower barrier to entry by providing a framework to work within, allowing a developer to focus their product's functionality without having to build out the rest of the supporting architecture.

Short term, OIF is being used to work through interoperability use cases in order to mature the OpenC2 specification. Long term, OIF plans to help guide the community towards conformance by providing a validation/test capability that will determine if the vendor implementation meets the requirements set forth in OpenC2 specifications.

To get started please reference README.md in the /docs folder

Maintainers

TC 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.

Current Maintainers of this TC Open Repository

• Danny Martinez, [email protected], Huntington Ingalls Industries

About OASIS TC Open Repositories

• TC Open Repositories: Overview and Resources
• Frequently Asked Questions
• Open Source Licenses
• Contributor License Agreements (CLAs)
• Maintainers' Guidelines and Agreement

Feedback

Questions or comments about this TC 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 TC Open Repository participation to OASIS Staff at [email protected] and any specific CLA-related questions to [email protected].