search

cisagov / ScubaGear

Automation to assess the state of your M365 tenant against CISA's baselines
https://www.cisa.gov/resources-tools/services/secure-cloud-business-applications-scuba-project
Creative Commons Zero v1.0 Universal
1.76k stars 226 forks source link

Link in the sample-report broken #1434

Open elysiumsecurityltd opened 3 days ago

elysiumsecurityltd commented 3 days ago

🐛 Summary

If you navigate through the sample report the links to the controls details are broken

To reproduce

Steps to reproduce the behavior:

  1. Go to PowerShell -> ScubaGear -> Sample-Reports -> BaselineReports.html
  2. Then click on one of the Baseline Conformance Report, i.e.: [Azure Active Directory]
  3. Then click on any of the "headers", i.e.: [Legacy Authentication]

Expected behavior

You should see an explanation of what that control is. Instead you get a 404 Not found error:

404 - page not found Cannot find a valid ref in v1.4.0-old/PowerShell/ScubaGear/baselines/aad.md

It could be that the sample report was created using an older version of the repo. Do you need to reference the online repo? isn't it possible to use a local/relative reference? (../baselines/aad.md)

Cheers, B.

buidav commented 3 days ago

From what you've posted you are looking at the sample report in our prerelease or main branch? If so, then the broken links are because you've looked at the sample report links of a prelease version of ScubaGear.

The sample report and version bump for ScubaGear v1.4.0 were created ahead of time this version sprint. Once ScubaGear v1.4.0 of ScubaGear releases, the links in the sample reports will correct themselves.

Previous sample-reports of released versions will work normally. for example ScubaGear v1.3.0 https://github.com/cisagov/ScubaGear/tree/v1.3.0/PowerShell/ScubaGear/Sample-Reports

We've gone back and forth between linking locally to markdown vs linking to the online copies because of this issue. Will queue another discussion with the team to see if we can better address this.

elysiumsecurityltd commented 3 days ago

Hi, yes I believe that's from there... I just did a git clone on the main url with what should be the default branch. git clone https://github.com/cisagov/ScubaGear

Sorry to re-open another discussion on the topic, if that's only a problem on a pre-release then maybe it is not a bug! :)

buidav commented 2 days ago

Sorry to re-open another discussion on the topic, if that's only a problem on a pre-release then maybe it is not a bug! :)

Oh no worries. Thanks for opening an issue on this! Opening issues lets us know, people are using the tool and interacting with all aspects of it. ;)