From 8da2ee1c785713d606b387e7513d73f1a58dfdd8 Mon Sep 17 00:00:00 2001 From: Jared Ondricek Date: Tue, 26 Aug 2025 12:15:34 -0500 Subject: [PATCH] chore: rename master references to main --- .github/dependabot.yml | 2 +- README.md | 10 +- docs/RELEASE.md | 6 +- docs/additional_modules/attackToExcel.rst | 6 +- docs/additional_modules/collections.rst | 8 +- docs/additional_modules/diffStix.rst | 8 +- docs/additional_modules/navlayers.rst | 8 +- docs/contributing.rst | 2 +- docs/mitre_attack_data/examples.rst | 140 +++++++++++----------- mitreattack/collections/README.md | 16 +-- mitreattack/navlayers/README.md | 44 +++---- 11 files changed, 125 insertions(+), 125 deletions(-) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 02885bc2..f9260561 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -12,4 +12,4 @@ updates: day: "saturday" time: "09:00" timezone: "America/New_York" - target-branch: "master" + target-branch: "main" diff --git a/README.md b/README.md index 8b846342..af297307 100644 --- a/README.md +++ b/README.md @@ -25,10 +25,10 @@ More detailed information and examples about the specific usage of the additiona | module | description | documentation | |:------------|:------------|:--------------| -| [navlayers](https://github.com/mitre-attack/mitreattack-python/tree/master/mitreattack/navlayers) | A collection of utilities for working with [ATT&CK Navigator](https://github.com/mitre-attack/attack-navigator) layers. Provides the ability to import, export, and manipulate layers. Layers can be read in from the filesystem or python dictionaries, combined and edited, and then exported to excel or SVG images. | Further documentation can be found [here](https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/navlayers/README.md).| -| [attackToExcel](https://github.com/mitre-attack/mitreattack-python/tree/master/mitreattack/attackToExcel) | A collection of utilities for converting [ATT&CK STIX data](https://github.com/mitre/cti) to Excel spreadsheets. It also provides access to [Pandas](https://pandas.pydata.org/) DataFrames representing the dataset for use in data analysis. | Further documentation can be found [here](https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/attackToExcel/README.md).| -| [collections](https://github.com/mitre-attack/mitreattack-python/tree/master/mitreattack/collections) | A set of utilities for working with [ATT&CK Collections and Collection Indexes](https://github.com/center-for-threat-informed-defense/attack-workbench-frontend/blob/master/docs/collections.md). Provides functionalities for converting and summarizing data in collections and collection indexes, as well as generating a collection from a raw stix bundle input. | Further documentation can be found [here](https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/collections/README.md).| -| [diffStix](https://github.com/mitre-attack/mitreattack-python/tree/master/mitreattack/diffStix) | Create markdown, HTML, JSON and/or ATT&CK Navigator layers reporting on the changes between two versions of the STIX2 bundles representing the ATT&CK content. Run `diff_stix -h` for full usage instructions. | Further documentation can be found [here](https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/diffStix/README.md).| +| [navlayers](https://github.com/mitre-attack/mitreattack-python/tree/main/mitreattack/navlayers) | A collection of utilities for working with [ATT&CK Navigator](https://github.com/mitre-attack/attack-navigator) layers. Provides the ability to import, export, and manipulate layers. Layers can be read in from the filesystem or python dictionaries, combined and edited, and then exported to excel or SVG images. | Further documentation can be found [here](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/navlayers/README.md).| +| [attackToExcel](https://github.com/mitre-attack/mitreattack-python/tree/main/mitreattack/attackToExcel) | A collection of utilities for converting [ATT&CK STIX data](https://github.com/mitre/cti) to Excel spreadsheets. It also provides access to [Pandas](https://pandas.pydata.org/) DataFrames representing the dataset for use in data analysis. | Further documentation can be found [here](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/attackToExcel/README.md).| +| [collections](https://github.com/mitre-attack/mitreattack-python/tree/main/mitreattack/collections) | A set of utilities for working with [ATT&CK Collections and Collection Indexes](https://github.com/center-for-threat-informed-defense/attack-workbench-frontend/blob/main/docs/collections.md). Provides functionalities for converting and summarizing data in collections and collection indexes, as well as generating a collection from a raw stix bundle input. | Further documentation can be found [here](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/collections/README.md).| +| [diffStix](https://github.com/mitre-attack/mitreattack-python/tree/main/mitreattack/diffStix) | Create markdown, HTML, JSON and/or ATT&CK Navigator layers reporting on the changes between two versions of the STIX2 bundles representing the ATT&CK content. Run `diff_stix -h` for full usage instructions. | Further documentation can be found [here](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/diffStix/README.md).| ## Related MITRE Work @@ -70,7 +70,7 @@ One-off scripts and code examples you can use as inspiration for how to work wit ## Contributing To contribute to this project, either through a bug report, feature request, or merge request, -please see the [Contributors Guide](https://github.com/mitre-attack/mitreattack-python/blob/master/docs/CONTRIBUTING.md). +please see the [Contributors Guide](https://github.com/mitre-attack/mitreattack-python/blob/main/docs/CONTRIBUTING.md). ## Notice diff --git a/docs/RELEASE.md b/docs/RELEASE.md index 36b74967..5acbc50a 100644 --- a/docs/RELEASE.md +++ b/docs/RELEASE.md @@ -2,11 +2,11 @@ In order to release a new version of mitreattack-python, follow the process outlined here: -1. Verify that all changes desired in the next release are present in the `master` branch. +1. Verify that all changes desired in the next release are present in the `main` branch. - If this is for an ATT&CK release, make sure to update the `LATEST_VERSION` in `mitreattack/release_info.py`. -2. Verify that all changes are documented in the CHANGELOG staged in the `master` branch. +2. Verify that all changes are documented in the CHANGELOG staged in the `main` branch. 3. Build the _mitreattack-python_ package from source and install it locally: 1. [Optional] Activate a virtualenv. e.g., `source ./venv/bin/activate` 2. Uninstall any older/previously installed versions of mitreattack-python: `pip uninstall mitreattack-python` @@ -27,7 +27,7 @@ In order to release a new version of mitreattack-python, follow the process outl Update other fields in setup.py as necessary (used libraries, etc.) 6. Commit any uncommitted changes. 7. Tag the release: - 1. Tag the `master` branch with the version number - `git tag -a "vA.B.C" -m "mitreattack-python version A.B.C"` + 1. Tag the `main` branch with the version number - `git tag -a "vA.B.C" -m "mitreattack-python version A.B.C"` 2. Push both the commit and the tag - `git push`/`git push --tags` 8. Verify that the package uploaded correctly 1. Check that GitHub Actions succeeded: diff --git a/docs/additional_modules/attackToExcel.rst b/docs/additional_modules/attackToExcel.rst index 87261a14..e81519cb 100644 --- a/docs/additional_modules/attackToExcel.rst +++ b/docs/additional_modules/attackToExcel.rst @@ -1,11 +1,11 @@ attackToExcel ============================================== -A collection of utilities for converting `ATT&CK STIX data`_ to Excel spreadsheets. -It also provides access to `Pandas`_ DataFrames representing the dataset for use in data analysis. +A collection of utilities for converting `ATT&CK STIX data`_ to Excel spreadsheets. +It also provides access to `Pandas`_ DataFrames representing the dataset for use in data analysis. Further documentation can be found `here`_. .. _ATT&CK STIX data: https://github.com/mitre/cti .. _Pandas: https://pandas.pydata.org/ -.. _here: https://github.com/mitre-attack/mitreattack-python/tree/master/mitreattack/attackToExcel \ No newline at end of file +.. _here: https://github.com/mitre-attack/mitreattack-python/tree/main/mitreattack/attackToExcel \ No newline at end of file diff --git a/docs/additional_modules/collections.rst b/docs/additional_modules/collections.rst index 02cc4ff9..579c869b 100644 --- a/docs/additional_modules/collections.rst +++ b/docs/additional_modules/collections.rst @@ -1,11 +1,11 @@ collections ============================================== -A set of utilities for working with `ATT&CK Collections and Collection Indexes`_. -Provides functionalities for converting and summarizing data in collections and collection indexes, +A set of utilities for working with `ATT&CK Collections and Collection Indexes`_. +Provides functionalities for converting and summarizing data in collections and collection indexes, as well as generating a collection from a raw stix bundle input. Further documentation can be found `here`_. -.. _ATT&CK Collections and Collection Indexes: https://github.com/center-for-threat-informed-defense/attack-workbench-frontend/blob/master/docs/collections.md -.. _here: https://github.com/mitre-attack/mitreattack-python/tree/master/mitreattack/collections \ No newline at end of file +.. _ATT&CK Collections and Collection Indexes: https://github.com/center-for-threat-informed-defense/attack-workbench-frontend/blob/main/docs/collections.md +.. _here: https://github.com/mitre-attack/mitreattack-python/tree/main/mitreattack/collections \ No newline at end of file diff --git a/docs/additional_modules/diffStix.rst b/docs/additional_modules/diffStix.rst index 3e492d46..a5989464 100644 --- a/docs/additional_modules/diffStix.rst +++ b/docs/additional_modules/diffStix.rst @@ -1,10 +1,10 @@ diffStix ============================================== - -Create markdown, HTML, JSON and/or ATT&CK Navigator layers reporting on the changes between two -versions of the STIX2 bundles representing the ATT&CK content. Run 'diff_stix -h' for full usage + +Create markdown, HTML, JSON and/or ATT&CK Navigator layers reporting on the changes between two +versions of the STIX2 bundles representing the ATT&CK content. Run 'diff_stix -h' for full usage instructions. Further documentation can be found `here`_. -.. _here: https://github.com/mitre-attack/mitreattack-python/tree/master/mitreattack/diffStix \ No newline at end of file +.. _here: https://github.com/mitre-attack/mitreattack-python/tree/main/mitreattack/diffStix \ No newline at end of file diff --git a/docs/additional_modules/navlayers.rst b/docs/additional_modules/navlayers.rst index e7704a66..22863f10 100644 --- a/docs/additional_modules/navlayers.rst +++ b/docs/additional_modules/navlayers.rst @@ -1,12 +1,12 @@ navlayers ============================================== -A collection of utilities for working with `ATT&CK Navigator`_ layers. -Provides the ability to import, export, and manipulate layers. -Layers can be read in from the filesystem or python dictionaries, combined and edited, +A collection of utilities for working with `ATT&CK Navigator`_ layers. +Provides the ability to import, export, and manipulate layers. +Layers can be read in from the filesystem or python dictionaries, combined and edited, and then exported to excel or SVG images. Further documentation can be found `here`_. .. _ATT&CK Navigator: https://github.com/mitre-attack/attack-navigator -.. _here: https://github.com/mitre-attack/mitreattack-python/tree/master/mitreattack/navlayers \ No newline at end of file +.. _here: https://github.com/mitre-attack/mitreattack-python/tree/main/mitreattack/navlayers \ No newline at end of file diff --git a/docs/contributing.rst b/docs/contributing.rst index 08f84b2a..4fff7f38 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -3,4 +3,4 @@ Contributing To contribute to this project, either through a bug report, feature request, or merge request, please see the `Contributors Guide`_. -.. _Contributors Guide: https://github.com/mitre-attack/mitreattack-python/blob/master/docs/CONTRIBUTING.md \ No newline at end of file +.. _Contributors Guide: https://github.com/mitre-attack/mitreattack-python/blob/main/docs/CONTRIBUTING.md \ No newline at end of file diff --git a/docs/mitre_attack_data/examples.rst b/docs/mitre_attack_data/examples.rst index fabba876..9eaeed1d 100644 --- a/docs/mitre_attack_data/examples.rst +++ b/docs/mitre_attack_data/examples.rst @@ -3,122 +3,122 @@ Examples ============================================== -The following are links to scripts of examples on how to use the ``MitreAttackData`` +The following are links to scripts of examples on how to use the ``MitreAttackData`` library. See the examples_ directory in the repository for more details. -.. _examples: https://github.com/mitre-attack/mitreattack-python/tree/master/examples/ +.. _examples: https://github.com/mitre-attack/mitreattack-python/tree/main/examples/ Getting An ATT&CK Object ------------------------ -* `get_object_by_stix_id.py `_ -* `get_object_by_attack_id.py `_ -* `get_objects_by_name.py `_ -* `get_groups_by_alias.py `_ -* `get_software_by_alias.py `_ -* `get_campaigns_by_alias.py `_ -* `get_stix_type.py `_ -* `get_attack_id.py `_ -* `get_name.py `_ +* `get_object_by_stix_id.py `_ +* `get_object_by_attack_id.py `_ +* `get_objects_by_name.py `_ +* `get_groups_by_alias.py `_ +* `get_software_by_alias.py `_ +* `get_campaigns_by_alias.py `_ +* `get_stix_type.py `_ +* `get_attack_id.py `_ +* `get_name.py `_ Getting ATT&CK Objects by Type ------------------------------ -* `get_all_matrices.py `_ -* `get_all_tactics.py `_ -* `get_all_techniques.py `_ -* `get_all_mitigations.py `_ -* `get_all_groups.py `_ -* `get_all_software.py `_ -* `get_all_campaigns.py `_ -* `get_all_assets.py `_ -* `get_all_datasources.py `_ -* `get_all_datacomponents.py `_ +* `get_all_matrices.py `_ +* `get_all_tactics.py `_ +* `get_all_techniques.py `_ +* `get_all_mitigations.py `_ +* `get_all_groups.py `_ +* `get_all_software.py `_ +* `get_all_campaigns.py `_ +* `get_all_assets.py `_ +* `get_all_datasources.py `_ +* `get_all_datacomponents.py `_ Getting Multiple ATT&CK Objects ------------------------------- -* `get_tactics_by_matrix.py `_ -* `get_techniques_by_tactic.py `_ -* `get_tactics_by_technique.py `_ -* `get_techniques_by_platform.py `_ -* `get_objects_by_content.py `_ -* `get_objects_created_after.py `_ -* `get_objects_modified_after.py `_ +* `get_tactics_by_matrix.py `_ +* `get_techniques_by_tactic.py `_ +* `get_tactics_by_technique.py `_ +* `get_techniques_by_platform.py `_ +* `get_objects_by_content.py `_ +* `get_objects_created_after.py `_ +* `get_objects_modified_after.py `_ Related Objects ------------------- Technique:Procedure Examples -* `get_procedure_examples_by_technique.py `_ +* `get_procedure_examples_by_technique.py `_ Technique:Group Relationships -* `get_all_groups_using_all_techniques.py `_ -* `get_groups_using_technique.py `_ -* `get_all_techniques_used_by_all_groups.py `_ -* `get_techniques_used_by_group.py `_ -* `get_techniques_used_by_group_software.py `_ +* `get_all_groups_using_all_techniques.py `_ +* `get_groups_using_technique.py `_ +* `get_all_techniques_used_by_all_groups.py `_ +* `get_techniques_used_by_group.py `_ +* `get_techniques_used_by_group_software.py `_ Technique:Campaign Relationships -* `get_all_techniques_used_by_all_campaigns.py `_ -* `get_techniques_used_by_campaign.py `_ -* `get_all_campaigns_using_all_techniques.py `_ -* `get_campaigns_using_technique.py `_ +* `get_all_techniques_used_by_all_campaigns.py `_ +* `get_techniques_used_by_campaign.py `_ +* `get_all_campaigns_using_all_techniques.py `_ +* `get_campaigns_using_technique.py `_ Technique:Software Relationships -* `get_all_techniques_used_by_all_software.py `_ -* `get_techniques_used_by_software.py `_ -* `get_all_software_using_all_techniques.py `_ -* `get_software_using_technique.py `_ +* `get_all_techniques_used_by_all_software.py `_ +* `get_techniques_used_by_software.py `_ +* `get_all_software_using_all_techniques.py `_ +* `get_software_using_technique.py `_ Technique:Mitigation Relationships -* `get_all_techniques_mitigated_by_all_mitigations.py `_ -* `get_techniques_mitigated_by_mitigation.py `_ -* `get_all_mitigations_mitigating_all_techniques.py `_ -* `get_mitigations_mitigating_technique.py `_ +* `get_all_techniques_mitigated_by_all_mitigations.py `_ +* `get_techniques_mitigated_by_mitigation.py `_ +* `get_all_mitigations_mitigating_all_techniques.py `_ +* `get_mitigations_mitigating_technique.py `_ Technique:Sub-technique Relationships -* `get_all_parent_techniques_of_all_subtechniques.py `_ -* `get_parent_technique_of_subtechnique.py `_ -* `get_all_subtechniques_of_all_techniques.py `_ -* `get_subtechniques_of_technique.py `_ +* `get_all_parent_techniques_of_all_subtechniques.py `_ +* `get_parent_technique_of_subtechnique.py `_ +* `get_all_subtechniques_of_all_techniques.py `_ +* `get_subtechniques_of_technique.py `_ Technique:Data Component Relationships -* `get_all_datacomponents_detecting_all_techniques.py `_ -* `get_datacomponents_detecting_technique.py `_ -* `get_all_techniques_detected_by_all_datacomponents.py `_ -* `get_techniques_detected_by_datacomponent.py `_ +* `get_all_datacomponents_detecting_all_techniques.py `_ +* `get_datacomponents_detecting_technique.py `_ +* `get_all_techniques_detected_by_all_datacomponents.py `_ +* `get_techniques_detected_by_datacomponent.py `_ Software:Group Relationships -* `get_all_groups_using_all_software.py `_ -* `get_groups_using_software.py `_ -* `get_all_software_used_by_all_groups.py `_ -* `get_software_used_by_group.py `_ +* `get_all_groups_using_all_software.py `_ +* `get_groups_using_software.py `_ +* `get_all_software_used_by_all_groups.py `_ +* `get_software_used_by_group.py `_ Software:Campaign Relationships -* `get_all_campaigns_using_all_software.py `_ -* `get_campaigns_using_software.py `_ -* `get_all_software_used_by_all_campaigns.py `_ -* `get_software_used_by_campaign.py `_ +* `get_all_campaigns_using_all_software.py `_ +* `get_campaigns_using_software.py `_ +* `get_all_software_used_by_all_campaigns.py `_ +* `get_software_used_by_campaign.py `_ Campaign:Group Relationships -* `get_all_groups_attributing_to_all_campaigns.py `_ -* `get_groups_attributing_to_campaign.py `_ -* `get_all_campaigns_attributed_to_all_groups.py `_ -* `get_campaigns_attributed_to_group.py `_ +* `get_all_groups_attributing_to_all_campaigns.py `_ +* `get_groups_attributing_to_campaign.py `_ +* `get_all_campaigns_attributed_to_all_groups.py `_ +* `get_campaigns_attributed_to_group.py `_ Technique:Asset Relationships -* `get_all_assets_targeted_by_all_techniques.py `_ -* `get_assets_targeted_by_technique.py `_ -* `get_all_techniques_targeting_all_assets.py `_ -* `get_techniques_targeting_asset.py `_ +* `get_all_assets_targeted_by_all_techniques.py `_ +* `get_assets_targeted_by_technique.py `_ +* `get_all_techniques_targeting_all_assets.py `_ +* `get_techniques_targeting_asset.py `_ diff --git a/mitreattack/collections/README.md b/mitreattack/collections/README.md index 412aa48d..87329c9b 100644 --- a/mitreattack/collections/README.md +++ b/mitreattack/collections/README.md @@ -3,20 +3,20 @@ This folder contains modules and scripts for working with ATT&CK collections. Collections are sets of ATT&CK STIX objects, grouped for user convienence. For more information about ATT&CK collections, see the corresponding -[ATT&CK documentation](https://github.com/center-for-threat-informed-defense/attack-workbench-frontend/blob/master/docs/collections.md#collections). +[ATT&CK documentation](https://github.com/center-for-threat-informed-defense/attack-workbench-frontend/blob/main/docs/collections.md#collections). ## Collections Scripts | script | description | |:-------|:------------| -|[index_to_markdown](https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/collections/index_to_markdown.py)| Provides a means by which to convert a [collection index](https://github.com/center-for-threat-informed-defense/attack-workbench-frontend/blob/master/docs/collections.md#collection-indexes) into a human-readable markdown file. More information can be found in the corresponding [section](#index_to_markdown.py) below.| -|[collection_to_index](https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/collections/collection_to_index.py)| Provides a means by which to convert a [collection](https://github.com/center-for-threat-informed-defense/attack-workbench-frontend/blob/master/docs/collections.md#collections) into a easy-to-share [index file](https://github.com/center-for-threat-informed-defense/attack-workbench-frontend/blob/master/docs/collections.md#collection-indexes). More information can be found in the corresponding [section](#collection_to_index.py) below.| -|[stix_to_collection](https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/collections/stix_to_collection.py)| Provides a means by which to convert raw stix (in the form of [bundles](https://docs.oasis-open.org/cti/stix/v2.1/cs01/stix-v2.1-cs01.html#_gms872kuzdmg)) into a [collection](https://github.com/center-for-threat-informed-defense/attack-workbench-frontend/blob/master/docs/collections.md#collections). More information can be found in the corresponding [section](#stix_to_collection.py) below.| +|[index_to_markdown](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/collections/index_to_markdown.py)| Provides a means by which to convert a [collection index](https://github.com/center-for-threat-informed-defense/attack-workbench-frontend/blob/main/docs/collections.md#collection-indexes) into a human-readable markdown file. More information can be found in the corresponding [section](#index_to_markdown.py) below.| +|[collection_to_index](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/collections/collection_to_index.py)| Provides a means by which to convert a [collection](https://github.com/center-for-threat-informed-defense/attack-workbench-frontend/blob/main/docs/collections.md#collections) into a easy-to-share [index file](https://github.com/center-for-threat-informed-defense/attack-workbench-frontend/blob/main/docs/collections.md#collection-indexes). More information can be found in the corresponding [section](#collection_to_index.py) below.| +|[stix_to_collection](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/collections/stix_to_collection.py)| Provides a means by which to convert raw stix (in the form of [bundles](https://docs.oasis-open.org/cti/stix/v2.1/cs01/stix-v2.1-cs01.html#_gms872kuzdmg)) into a [collection](https://github.com/center-for-threat-informed-defense/attack-workbench-frontend/blob/main/docs/collections.md#collections). More information can be found in the corresponding [section](#stix_to_collection.py) below.| ### index_to_markdown.py `index_to_markdown.py` provides the `IndexToMarkdown` class, which provides a way to transform an existing -[collection index file](https://github.com/center-for-threat-informed-defense/attack-workbench-frontend/blob/master/docs/collections.md#collection-indexes) +[collection index file](https://github.com/center-for-threat-informed-defense/attack-workbench-frontend/blob/main/docs/collections.md#collection-indexes) into a markdown file for easy of use and reference. The `IndexToMarkdown` class is very simple, and provides a single method, `index_to_markdown`, which in turn only requires a single parameter - a dictionary representation of the desired index file to convert to markdown. @@ -39,8 +39,8 @@ print(generated_md) ### collection_to_index.py `collection_to_index.py` provides the `CollectionToIndex` class, which proves a means by which to summarize existing -[collections](https://github.com/center-for-threat-informed-defense/attack-workbench-frontend/blob/master/docs/collections.md#collections) -into a single [collection index](https://github.com/center-for-threat-informed-defense/attack-workbench-frontend/blob/master/docs/collections.md#collection-indexes) file. +[collections](https://github.com/center-for-threat-informed-defense/attack-workbench-frontend/blob/main/docs/collections.md#collections) +into a single [collection index](https://github.com/center-for-threat-informed-defense/attack-workbench-frontend/blob/main/docs/collections.md#collection-indexes) file. The `CollectionToIndex` class contains the `generate_index` function, which when provided with a name, description, root url (pointing to where the raw collections are stored), and a list of either files, folders, or already loaded bundles in the form of dictionaries, will create a summarizing index. @@ -71,7 +71,7 @@ print(output_indexC) `stix_to_collection.py` provides the `STIXToCollection` class, which proves a means by which to convert existing stix bundles into ones containing a -[collection](https://github.com/center-for-threat-informed-defense/attack-workbench-frontend/blob/master/docs/collections.md#collections) object. +[collection](https://github.com/center-for-threat-informed-defense/attack-workbench-frontend/blob/main/docs/collections.md#collections) object. The `STIXToCollection` class contains the `stix_to_collection` function, which when provided with a starter bundle, a name, a version, and an optional description, will output a modified bundle that contains a summary collection object. diff --git a/mitreattack/navlayers/README.md b/mitreattack/navlayers/README.md index a216fbc1..90f25a7c 100644 --- a/mitreattack/navlayers/README.md +++ b/mitreattack/navlayers/README.md @@ -14,51 +14,51 @@ and version 4.X layers, upgrading them to version 4.3. | script | description | |:-------|:------------| -| [filter](https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/navlayers/core/filter.py) | Implements a basic [filter object](https://github.com/mitre-attack/attack-navigator/blob/develop/layers/LAYERFORMATv4_1.md#filter-object-properties). | -| [gradient](https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/navlayers/core/gradient.py) | Implements a basic [gradient object](https://github.com/mitre-attack/attack-navigator/blob/develop/layers/LAYERFORMATv4_1.md#gradient-object-properties). | -| [layer](https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/navlayers/core/layer.py) | Provides an interface for interacting with core module's layer representation. A further breakdown can be found in the corresponding [section](#Layer) below. | -| [layout](https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/navlayers/core/layout.py) | Implements a basic [layout object](https://github.com/mitre-attack/attack-navigator/blob/develop/layers/LAYERFORMATv4_1.md#layout-object-properties). | -| [legenditem](https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/navlayers/core/legenditem.py) | Implements a basic [legenditem object](https://github.com/mitre-attack/attack-navigator/blob/develop/layers/LAYERFORMATv4_1.md#legenditem-object-properties). | -| [metadata](https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/navlayers/core/metadata.py) | Implements a basic [metadata object](https://github.com/mitre-attack/attack-navigator/blob/develop/layers/LAYERFORMATv4_1.md#metadata-object-properties). | -| [technique](https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/navlayers/core/technique.py) | Implements a basic [technique object](https://github.com/mitre-attack/attack-navigator/blob/develop/layers/LAYERFORMATv4_1.md#technique-object-properties). | -| [versions](https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/navlayers/core/versions.py) | Implements a basic [versions object](https://github.com/mitre-attack/attack-navigator/blob/develop/layers/LAYERFORMATv4_1.md#versions-object-properties).| +| [filter](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/navlayers/core/filter.py) | Implements a basic [filter object](https://github.com/mitre-attack/attack-navigator/blob/develop/layers/LAYERFORMATv4_1.md#filter-object-properties). | +| [gradient](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/navlayers/core/gradient.py) | Implements a basic [gradient object](https://github.com/mitre-attack/attack-navigator/blob/develop/layers/LAYERFORMATv4_1.md#gradient-object-properties). | +| [layer](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/navlayers/core/layer.py) | Provides an interface for interacting with core module's layer representation. A further breakdown can be found in the corresponding [section](#Layer) below. | +| [layout](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/navlayers/core/layout.py) | Implements a basic [layout object](https://github.com/mitre-attack/attack-navigator/blob/develop/layers/LAYERFORMATv4_1.md#layout-object-properties). | +| [legenditem](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/navlayers/core/legenditem.py) | Implements a basic [legenditem object](https://github.com/mitre-attack/attack-navigator/blob/develop/layers/LAYERFORMATv4_1.md#legenditem-object-properties). | +| [metadata](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/navlayers/core/metadata.py) | Implements a basic [metadata object](https://github.com/mitre-attack/attack-navigator/blob/develop/layers/LAYERFORMATv4_1.md#metadata-object-properties). | +| [technique](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/navlayers/core/technique.py) | Implements a basic [technique object](https://github.com/mitre-attack/attack-navigator/blob/develop/layers/LAYERFORMATv4_1.md#technique-object-properties). | +| [versions](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/navlayers/core/versions.py) | Implements a basic [versions object](https://github.com/mitre-attack/attack-navigator/blob/develop/layers/LAYERFORMATv4_1.md#versions-object-properties).| ### Manipulator Scripts | script | description | |:-------|:------------| -| [layerops](https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/navlayers/manipulators/layerops.py) | Provides a means by which to combine multiple ATT&CK layer objects in customized ways. A further breakdown can be found in the corresponding [section](#layerops.py) below. | +| [layerops](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/navlayers/manipulators/layerops.py) | Provides a means by which to combine multiple ATT&CK layer objects in customized ways. A further breakdown can be found in the corresponding [section](#layerops.py) below. | ### Exporter Scripts | script | description | |:-------|:------------| -| [to_excel](https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/navlayers/exporters/to_excel.py) | Provides a means by which to export an ATT&CK Layer to an excel file. A further breakdown can be found in the corresponding [section](#to_excel.py) below. | -| [to_svg](https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/navlayers/exporters/to_svg.py) | Provides a means by which to export an ATT&CK layer to an svg image file. A further breakdown can be found in the corresponding [section](#to_svg.py) below. This file also contains the `SVGConfig` object that can be used to configure the SVG export.| +| [to_excel](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/navlayers/exporters/to_excel.py) | Provides a means by which to export an ATT&CK Layer to an excel file. A further breakdown can be found in the corresponding [section](#to_excel.py) below. | +| [to_svg](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/navlayers/exporters/to_svg.py) | Provides a means by which to export an ATT&CK layer to an svg image file. A further breakdown can be found in the corresponding [section](#to_svg.py) below. This file also contains the `SVGConfig` object that can be used to configure the SVG export.| ### Generator Scripts | script | description | |:-------|:------------| -| [overview_generator](https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/navlayers/generators/overview_generator.py)| Provides a means by which to generate an ATT&CK Layer that summarizes, on a per technique basis, all instances of a given ATT&CK object type that reference/utilize each technique. A further explanation can be found in the corresponding [section](#overview_generator.py) below. | -| [usage_generator](https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/navlayers/generators/usage_generator.py)| Provides a means by which to generate an ATT&CK Layer that summarizes the techniques associated with a given ATT&CK object. A further explanation can be found in the corresponding [section](#usage_generator.py) below. | -| [sum_generator](https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/navlayers/generators/sum_generator.py)| Provides a means by which to generate a collection of ATT&CK Layers, one for each object in a given ATT&CK object class, that summarizes the coverage of that object. A further explanation can be found in the corresponding [section](#sum_generator.py) below. | +| [overview_generator](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/navlayers/generators/overview_generator.py)| Provides a means by which to generate an ATT&CK Layer that summarizes, on a per technique basis, all instances of a given ATT&CK object type that reference/utilize each technique. A further explanation can be found in the corresponding [section](#overview_generator.py) below. | +| [usage_generator](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/navlayers/generators/usage_generator.py)| Provides a means by which to generate an ATT&CK Layer that summarizes the techniques associated with a given ATT&CK object. A further explanation can be found in the corresponding [section](#usage_generator.py) below. | +| [sum_generator](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/navlayers/generators/sum_generator.py)| Provides a means by which to generate a collection of ATT&CK Layers, one for each object in a given ATT&CK object class, that summarizes the coverage of that object. A further explanation can be found in the corresponding [section](#sum_generator.py) below. | ### Utility Modules | script | description | |:-------|:------------| -| [excel_templates](https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/navlayers/exporters/excel_templates.py) | Provides a means by which to convert a matrix into a clean excel matrix template. | -| [matrix_gen](https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/navlayers/exporters/matrix_gen.py) | Provides a means by which to generate a matrix from raw data, either from a local STIX Bundle or from an ATT&CK Workbench instance (via url). | -| [svg_templates](https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/navlayers/exporters/svg_templates.py) | Provides a means by which to convert a layer file into a marked up svg file. | -| [svg_objects](https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/navlayers/exporters/svg_objects.py) | Provides raw templates and supporting functionality for generating svg objects. | +| [excel_templates](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/navlayers/exporters/excel_templates.py) | Provides a means by which to convert a matrix into a clean excel matrix template. | +| [matrix_gen](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/navlayers/exporters/matrix_gen.py) | Provides a means by which to generate a matrix from raw data, either from a local STIX Bundle or from an ATT&CK Workbench instance (via url). | +| [svg_templates](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/navlayers/exporters/svg_templates.py) | Provides a means by which to convert a layer file into a marked up svg file. | +| [svg_objects](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/navlayers/exporters/svg_objects.py) | Provides raw templates and supporting functionality for generating svg objects. | ### Command Line Tools | script | description | |:-------|:------------| -| [layerExporter_cli.py](https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/navlayers/layerExporter_cli.py) | A commandline utility to export Layer files to excel or svg formats using the exporter tools. Run with `-h` for usage. | -| [layerGenerator_cli.py](https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/navlayers/layerGenerator_cli.py) | A commandline utility to generate Layer files that correspond to various and collections of various stix objects. Run with `-h` for usage. | +| [layerExporter_cli.py](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/navlayers/layerExporter_cli.py) | A commandline utility to export Layer files to excel or svg formats using the exporter tools. Run with `-h` for usage. | +| [layerGenerator_cli.py](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/navlayers/layerGenerator_cli.py) | A commandline utility to generate Layer files that correspond to various and collections of various stix objects. Run with `-h` for usage. | ## Layer @@ -77,7 +77,7 @@ The class currently supports version 3 and 4 of the ATT&CK Layer spec, and will | `x.to_str()` | Returns a representation of the current ATT&CK layer object as a string representation of a dictionary. | Examples on how to create a layer programmatically, as opposed to loading it from an existing medium, can be found -[here](https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/navlayers/core/README.md). +[here](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/navlayers/core/README.md). ### Example Usage @@ -431,7 +431,7 @@ Valid types include `group`, `mitigation`, `software`, and `datasource`. This command line tool allows users to convert a [navigator](https://github.com/mitre-attack/attack-navigator) layer file to either an svg image or excel file using the functionality provided by the navlayers module. Details about the SVG configuration json mentioned below can be found in the -[SVGConfig](https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/navlayers/README.md#svgconfig) +[SVGConfig](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/navlayers/README.md#svgconfig) entry within the navlayers module documentation. ```commandline