Proposal: Make Collections Top Level Entities

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

Background Information

Because of their extensive use of nesting (e.g., Collections -> Behavior_Collections -> Behavior_Collection), Bundle Collections are cumbersome to use and perhaps unnecessarily complicated. And, as currently defined, Bundle Collections and top level container elements (e.g., Actions, Behaviors, Objects) serve similar functions - both store or reference a single type of MAEC entity (e.g., only Actions or only Objects).

Related Proposals

This proposal is related to the following proposed changes to the schema: https://github.com/MAECProject/schemas/wiki/Proposal:-Deprecate-MAEC-Bundle-(as-a-concept-and-output-format)

https://github.com/MAECProject/schemas/wiki/Proposal:-Make-Relationships-Top-Level-Entities

Proposal

We propose to deprecate entity-specific collections in favor of defining more general Collections as top-level entities in a MAEC Package. An "entity_type" field would optionally define the type of entity captured in the Collection. General, top level Collections would provide flexibility by permitting the capture of collections of any MAEC entity(ies), including Malware Subjects.

The following schema types would be deprecated: maecBundle:CollectionsType, maecBundle:BehaviorCollectionListType, maecBundle:BehaviorCollectionType, maecBundle:ActionCollectionListType, maecBundle:ActionCollectionType, maecBundle:ObjectCollectionListType, maecBundle:ObjectCollectionType, maecBundle:CandidateIndicatorCollectionListType, maecBundle:CandidateIndicatorCollectionType, maecBundle:BaseCollectionType.

A new CollectionType schema type would be defined in the MAEC Package schema with the following fields:

Field	Type	Multiplicity	Description
id	xs:anyURI	1	The id field specifies a unique identifier for the Collection.
entity_type	maecVocabs:CollectionEntityTypeEnum	0-1	The entity_type field specifies the type of MAEC entity that is captured in the Collection. Example types would be 'Object' or 'Various'.
Name	xs:string	0-1	The Name field specifies the name of the Collection.
Entity_Reference	maecCore:EntityReferenceType	0-*	The Entity_Reference field references an existing MAEC entity that is captured in the Collection, via its ID.

There may be cases where a Collection must be associated with a particular Malware Subject. To handle this requirement, we propose using a first-class relationship (see example).

Example

<MAEC_Package>
  <Collections>
    <Collection id="collection-1" entity_type="Action">
      <Name>Network Actions</Name>
      <Entity_Reference entity_id="action-1"/>
      <Entity_Reference entity_id="action-1"/>
      <Entity_Reference entity_id="action-1"/>
    </Collection>
  </Collections>

  <Malware_Subject id="malware-subject-1">
  ...
  </Malware_Subject>
 
  <Relationship source_id="malware-subject-1" target_id="collection-1">
    <Type>belongs to</Type>
  </Relationship>
</MAEC_Package>

Impact

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

Requested Feedback

1. Should Collections be top-level entities?
2. Should Collections be able to capture any set of related entities?
3. Is the CollectionType schema type reasonably defined?
4. Is the entity_type field useful and necessary?
5. Should Relationships be used to associate Collections with Malware Subjects?
6. Are there alternative solutions to making Collections more meaningful and easier to use?