BeS Playbook Info & Status

Version 0.1.0 (Jan 30, 2024)

Original authors:

Purpose

This document introduces a standardized data interchange format specifically designed for open source software playbooks within organizations. The OSSPloI captures crucial details related to these playbooks, including:

  • Playbook Name
  • Version Specifics
  • Type Information
  • Author Details
  • Last Execution Information
  • Detailed Report Path
  • List of Compatible Environments

These comprehensive details facilitate seamless sharing among peers within the organization and enable publication to the BeSLighthouse community dashboard. By leveraging the BLIman utility, organizations can effortlessly onboard their Open Source playbooks into BeSLab.

The adoption of this standardized format not only streamlines the sharing and publication process of open source software playbooks but also significantly reduces the time required for BeSLabs to assess projects of interest. These playbooks play a pivotal role in automating assessment activities and expediting the overall assessment timeline.

This format is stable, but further backwards compatible changes may still be made. Please feel free to create an issue in this repo.

Format Overview

The format is a JSON-based encoding format, using the following informal schema. The exact details of each field are elaborated in the next section. All ‘STRING’s contain UTF-8 text.

{
    "schema_version": "STRING",
    "playbooks":[
      {
      "name": "STRING",
      "version": "STRING",
      "type": "STRING",
      "author": {
        "name": "STRING",
          "type": "STRING"
      },
      "date_of_creation": "STRING",
      "last_update_date": "STRING",
      "last_execution": {
        "name": "STRING",
          "type": "STRING",
          "status": "STRING",
          "timestamp": "STRING"
      },
      "detailed_report_path": "STRING",
      "compatible_envs": ["STRING"]
    }
  ]
}

Field Details

playbooks.schema_version 

{
    "schema_version": "STRING"
}

The schema_version field is used to indicate which version of the schema a particular poi list was exported with. This can help consumer applications decide how to import the data for their own systems and offer some protection against future breaking changes. The value should be a string matching the schema version, which follows the SemVer 2.0.0 format, with no leading “v” prefix. If no value is specified, it should be assumed to be 1.0.0, matching version 1.0 of the schema. Clients can assume that new minor and patch versions of the schema only add new fields, without changing the meaning of old fields, so that a client that knows how to read version 1.2.0 can process data identifying as schema version 1.3.0 by ignoring any unexpected fields.

playbooks.name 

{
    "name": "STRING"
}

The name of the playbook.

playbooks.version 

{
    "version": "STRING"
}

Version of the playbook.

playbooks.type 

{
  "type": "STRING"
}

The type of the playbook - assessment or exploit.

playbooks.author 

"author": {
  "type": "STRING",
  "name": "STRING"
}

The details of the author of the playbook goes here.

Field Description
type User / Organization / Lab
name Name of the author

playbooks.date_of_creation 

{
  "date_of_creation": "STRING"
}

The date of the creation of playbook.

playbooks.last_updated_date 

{
  "last_updated_date": "STRING"
}

The date of last updation of the playbook.

playbooks.last_execution 

"last_execution": {
    "type": "STRING",
    "name": "STRING",
    "status": "STRING",
    "timestamp": "STRING"
}

Details of the last playbook execution is given here.

Field Description
type User / Organization / Lab
name Name of the entity who ran the playbook
status success / failure
timestamp Date and time of last execution

playbooks.detailed_report_path 

{
  "detailed_report_path": "STRING"
}

The path to the detailed report of the tools execution is given here.

playbooks.compatible_envs 

"compatible_envs": [
  "STRING"
]

A list of compatible BeSman environments.