Proposal: Make Tools Top Level Entities

Status: Open
Comment Period Closes:
Affects Backwards Compatibility: Yes
Relevant Issue: https://github.com/MAECProject/schemas/issues/107

Background Information

It is awkward to define and use Tools in the current version of the schema, especially where multiple Analyses make use of the same tool. In such cases, the Tool must be defined in one Analysis, and when it is used in another Analysis, a reference must be made to its definition in the first Analysis.

Proposal

We propose to make Tools top-level entities in the MAEC Package. Tools would then only be referenced (but not defined) from inside Analyses. This would make referencing Tools much more straightforward.

Example

<Package>
  <Tools>
    <Tool id="tool-1">
      <Name>Some analysis tool</Name>
      <Version>2.3.1</Version>
    </Tool>
  </Tools>
  <Malware_Subjects>
    <Malware_Subject>
      <Analyses>
        <Analysis id="analysis-1">
          <Tools>
            <Tool_Reference tool_id="tool-1"/>
          </Tools>
        </Analysis>
      </Analysis>
    </Malware_Subject>
  </Malware_Subjects>
</Package>

Impact

This change will not be backward compatible and is one of several revisions planned in new major version.

Requested Feedback

1. Does it make sense to make Tools top-level entities?
2. Are there preferable alternatives for making Tools easier to use?