Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update sample reports for 1.5.0 #1566

Merged
merged 3 commits into from
Feb 12, 2025

Conversation

schrolla
Copy link
Collaborator

@schrolla schrolla commented Feb 12, 2025

🗣 Description

Replaces the old sample reports with newly generated versions that incorporate changes and updates made up to v1.5.0, including:

  • Addition of privileged service principals and risky applications in results JSON
  • Addition of privileged service principals table in Entra HTML report
  • Addition of non-default sandbox PowerPlatform environment as example

💭 Motivation and context

Sample reports can be referenced by users to better understand what sort of output the tool can generate. This version includes additional result and report information from assessment updates.

Closes #1558

🧪 Testing

Sample reports were generated against a test tenant and an automated redaction script followed by manually editing the JSON to sanitize any user and tenant details. Then, Invoke-ScubaCached -Login:$false -ExportProvider:$false -M365Environment gcc -ProductNames * -OutPath <sample_outfolder> is run which will use the existing out folder's JSON file as input and replace the other output files in that directory with those from the cached run. The same command was run again with the -KeepIndividualJSON option to generate the full range of possible output files possible depending on parameters.

Test the changes by checking out a local copy of the branch and manually reviewing the JSON, CSV, and HTML output files with local editor/browser. Do note that the links to SCBs in the HTML report will generate a 404 Not Found until the actual release is published since the tag doesn't yet exist. To check the links, just be sure that they are well-formed and include the v1.5.0 tag as the correct version.

✅ Pre-approval checklist

  • This PR has an informative and human-readable title.
  • PR targets the correct parent branch (e.g., main or release-name) for merge.
  • Changes are limited to a single goal - eschew scope creep!
  • Changes are sized such that they do not touch excessive number of files.
  • All future TODOs are captured in issues, which are referenced in code comments.
  • These code changes follow the ScubaGear content style guide.
  • Related issues these changes resolve are linked preferably via closing keywords.
  • All relevant type-of-change labels added.
  • All relevant project fields are set.
  • All relevant repo and/or project documentation updated to reflect these changes.
  • Unit tests added/updated to cover PowerShell and Rego changes. N/A
  • Functional tests added/updated to cover PowerShell and Rego changes. N/A
  • All relevant functional tests passed. N/A
  • All automated checks (e.g., linting, static analysis, unit/smoke tests) passed.

✅ Pre-merge checklist

  • PR passed smoke test check.

  • Feature branch has been rebased against changes from parent branch, as needed

    Use Rebase branch button below or use this reference to rebase from the command line.

  • Resolved all merge conflicts on branch

  • Notified merge coordinator that PR is ready for merge via comment mention

  • Demonstrate changes to the team for questions and comments.
    (Note: Only required for issues of size Medium or larger)

✅ Post-merge checklist

  • Feature branch deleted after merge to clean up repository.
  • Verified that all checks pass on parent branch (e.g., main or release-name) after merge.

@schrolla schrolla added the documentation This issue or pull request improves or adds to documentation label Feb 12, 2025
@schrolla schrolla added this to the Lionfish milestone Feb 12, 2025
@schrolla schrolla self-assigned this Feb 12, 2025
@schrolla schrolla linked an issue Feb 12, 2025 that may be closed by this pull request
2 tasks
@schrolla schrolla force-pushed the 1558-create-sample-report-for-lionfish branch from 33d2609 to 970a635 Compare February 12, 2025 16:51
@schrolla schrolla marked this pull request as ready for review February 12, 2025 16:51
Copy link
Collaborator

@dagarwal-mitre dagarwal-mitre left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just 2 quick questions besides that I didn't see any issues

Copy link
Collaborator

@mitchelbaker-cisa mitchelbaker-cisa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Checked conditional access policies, privileged users/roles and found no outliers.

Checked for application/service principal object/application IDs and found no outliers across privileged_service_principals, risky_applications, or risky_third_party_service_principals properties.

@schrolla
Copy link
Collaborator Author

@nanda-katikaneni Updated sample reports are ready for merge.

@nanda-katikaneni nanda-katikaneni merged commit 7f904b3 into main Feb 12, 2025
26 checks passed
@nanda-katikaneni nanda-katikaneni deleted the 1558-create-sample-report-for-lionfish branch February 12, 2025 22:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This issue or pull request improves or adds to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create sample report for Lionfish
4 participants