search

maddev-engenuity / AdversaryEmulation

MAD ATT&CK Defender: ATT&CK Adversary Emulation Repository
Apache License 2.0
106 stars 22 forks source link

Fill out project README's #4

Closed bluesentinelsec closed 3 years ago

bluesentinelsec commented 3 years ago

We would like project README's to guide external users through our content. The desired end state is for our README's to make the project to look professional while being easy-to-use for our external users.

At a minimum we should have README's for these folders:

  1. AdversaryEmulation
  2. vm_setup_scripts
  3. labs

Here are some general sections I would like to see; use your discretion to alter format/content if it makes sense for the particular section you're working on.

  1. An intro explaining the purpose of this project or folder.
  2. Instructions so external users know how to use our content.
  3. Malware warning on the root README (copy the language from lab 4.2 on Sharepoint)
  4. Instructions for people to submit git issues
  5. Instructions for people to submit changes / contributions

Add Remarks for recommended VM configuration under the vm_setup_scripts folder:

Malware Warning text - list this on the front page of our repo:

Fundamentally, this course entails executing publicly known adversary TTPs so that we can assess and improve cybersecurity. As a result, many of our tools and resources will likely be flagged malicious by security products. We make every effort to ensure that our adversary emulation content is trusted and safe for the purpose of offensive security testing.  
  
As a precaution, you should not perform these labs on any system that contains sensitive data. Additionally, you should never use capabilities and/or techniques taught in this course without first obtaining explicit written permission from the system/network owner(s). 
bluesentinelsec commented 3 years ago

Draft complete