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.

Sign up for GitHub

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

Jump to bottom

Add option to generate a config file template #984

Merged
merged 20 commits into from
Mar 28, 2024
Merged

Add option to generate a config file template #984

merged 20 commits into from
Mar 28, 2024

Conversation

amart241
Copy link
Collaborator

@amart241 amart241 commented Mar 11, 2024 •
edited
Loading

Add option to generate a config file template

🗣 Description

A separate tool to make generate configuration files based on user input.

💭 Motivation and context

This is an enhancement to make config files easier to make and understand.
This tool makes the tedious task of generating a config file easier by allowing the user to change
the template based on command line arguments. It will also just generate a default template if no arguments are passed.
This enhancement will resolve #647.

🧪 Testing

To test this import the Support module and run New-Config passing any parameters that you want to change

✅ 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.
  • Functional tests added/updated to cover PowerShell and Rego changes.
  • All relevant functional tests passed.
  • 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

✅ 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.

@amart241 amart241 self-assigned this Mar 11, 2024
@schrolla schrolla added this to the Glacier milestone Mar 11, 2024
@rgbrow1949 rgbrow1949 self-requested a review March 14, 2024 14:46
@rgbrow1949
Copy link
Collaborator

The GenerateConfig.ps1 works just as intended. Before merging, fix the linter errors for trailing whitespace. Also, the branch is out of date and needs rebasing.
image

@crutchfield
Copy link
Contributor

@amart241 This needs to be incorporated into the support module to support being delivered via PS Gallery. We should not longer us stand alone scripts and use exported functions instead.

@buidav buidav changed the title 647 add option to generate a config file template Add option to generate a config file template Mar 21, 2024
@schrolla schrolla added the enhancement This issue or pull request will add new or improve existing functionality label Mar 21, 2024
@amart241 amart241 force-pushed the 647-add-option-to-generate-a-config-file-template branch from 100b2d6 to 5017a10 Compare March 21, 2024 17:49
@rgbrow1949
Copy link
Collaborator

You have some trailing whitespace in a linter error, some pester errors and this branch needs rebasing
image

rgbrow1949
rgbrow1949 approved these changes Mar 28, 2024
View reviewed changes
Copy link
Collaborator

@rgbrow1949 rgbrow1949 left a comment

Choose a reason for hiding this comment

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

Works as intended. The only linter error is on the linter's side: it doesn't recognize converto-yaml as a real module, which it is and it works to generate the config file. This needs a rebase but after it's ready.

@nanda-katikaneni
Copy link
Collaborator

@amart241 , please ping me after the linter issue is fixed and branch is rebased. thanks.

@amart241 amart241 force-pushed the 647-add-option-to-generate-a-config-file-template branch from 3d0a240 to d93f58c Compare March 28, 2024 20:06
@amart241
Copy link
Collaborator Author

@amart241 , please ping me after the linter issue is fixed and branch is rebased. thanks.

Ready for review

@amart241
Copy link
Collaborator Author

@amart241 , please ping me after the linter issue is fixed and branch is rebased. thanks.

@nanda-katikaneni

nanda-katikaneni
nanda-katikaneni approved these changes Mar 28, 2024
View reviewed changes
Copy link
Collaborator

@nanda-katikaneni nanda-katikaneni left a comment

Choose a reason for hiding this comment

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

Looks good - README is updated to explain the new sample-config file generation.

@nanda-katikaneni nanda-katikaneni merged commit 9128a12 into main Mar 28, 2024
15 checks passed
@nanda-katikaneni nanda-katikaneni deleted the 647-add-option-to-generate-a-config-file-template branch March 28, 2024 21:31
ahuynhMITRE added a commit that referenced this pull request May 6, 2024
@ahuynhMITRE @dagarwal-mitre
@buidav @james-garriss @tkol2022 @schrolla @amart241 @github-actions @actions-user @ssatyapal123 @Sloane4
Discontinued Policy Markdown Creation (#1089)
0f353ee 
* (New) Add Licensing Information to AAD Report (#1011)

* Copied Changes form broken branch for new PR

* removed trailing whitespace

* Removed more trailing white space

* updated licensing table to have unique id and added case in smoke test for licensing table

* remove white space

* added check for licensing information to functional tests

* added smoke test for licensing

* Add a UTC timestamp to the Provider JSON (#1009)

* add a quick timestamp

* add milliseconds

* timestamp_zulu

* add timestampzulu to metadata in mergejson

* fix unit tests

* fix bug found in previous PR

* Add config file for GitHub Pages (#1001)

* add YML for theme

* add config for pages

* lint

* put regal yaml back

* Create a workflow for bumping the ScubaGear module version (#989)

* create workflow for automated version bumping

* clean up whitespace

* bump checkout version

* fix variable substitution and regex match output

* remove testing variable

* Fix the Handful of AAD unit tests that are broken (#1019)

* fixed unit tests :)

* Resolved Linter Warnings

---------

Co-authored-by: Devesh Agarwal <dagarwal@mitre.org>

* Remove default vars from test configs (#996)

* minor edits to aad.5.3v1 and aad5.4v1 instructions (#1028)

* uncenter the text (#1031)

* Add option to generate a config file template (#984)

* config file generation

* Adding defender

* Final generate config file

* Ready for pull request

* moved to support module

* added to manifest file

* pascal case and whitespace

* linter hacks

* linter test

* "unused" variables

* linter hacks part II

* linter hacks part III

* Unit Test added

* added default value for unit testing

various syntax fixes as well

* fixed unit test, mock converting to yaml

* fixed unit tests?

* fixed?

* more debugging

* debugging

* Update README.md for generating config

* Update ScubaGear version to 1.2.0 (#1029)

Co-authored-by: GitHub Action <action@github.com>

* Fix bug with msaad52v1 only admins consent to apps (#1043)

* uploading for Cassey debugging session

* modified Rego policy 5.2 and unit tests to account for Microsoft updates to tenant output data

* modified 5.2 functional tests based on Microsoft changes to JSON output

* Update sample reports to latest version output examples (#1058)

* Fix publish package errors (#1042)

* inject write-error

* comment out publish

* show manifest error

* remove fail silently

* debug path version

* fix id typo

* fixed list

* fix needs

* fix release prep again

* write prereleasetag

* get types

* fix typo

* fix typos

* set tags as array

* reset tags

* debug w string

* remove array

* gc manifest

* get childitem

* write module path

* Debug manifest

* debug more

* typecast to string

* debug string concat

* display hashtable

* more debug details

* tweak debugging

* update install w prerelease

* commenting

* install required version

* add debug

* add debug

* add version

* use 1 if

* hard code

* install only

* force it

* remove install

* add debug statements

* see params

* fix parameter set

* fix comment typo

* use binding

* add comments

* fix @

* remove cmdlet

* uncomm param set

* remove param sets

* split into 2

* fix push paths

* add env back

* clean debug statement

* fix pipeline issues

* add output test

* use write-output

* clean up minor

* back to previous version

* use output

* more output

* use debug

* more output

* fix ps lint

* test returning false

* return to old error

* hardcode params

* fix step name

* improve debug statements

* back to write host

* debug prerelease

* changed info to host

* switch tag version

* write manifest out

* update version

* fix temp print

* bump to 8

* add import back

* require version

* bump to 10

* bump vers

* without tag

* bump tag

* use find mod

* fix unit test

* bump tag

* trivial change to trigger tests

* hide error

* v 03

* fix pipeline

* return false

* add write error

* remove details

* be silent

* be false

* cleanup

* unhardcode

* Exclude Write-Host locally

* commented out push trigger

* comment out push trigger

* update description

* Add a Workflow to check for OPA version updates (#1004)

* add parseable language

* add OPA Update workflow

* remove white space

* grammar

* Update Pull Request Description

Co-authored-by: Addam Schroll <108814318+schrolla@users.noreply.github.com>

---------

Co-authored-by: Addam Schroll <108814318+schrolla@users.noreply.github.com>

* Defender functional test plan fixes (#1057)

* Remove IsNotChecked flag from G3 3.1 Non-compliant - No defender license test

* Move impersonation protection tests from standard to g5 variant

* Fix Markdown in readme (#1068)

* fix table

* fix links

* minor changes

* Add Policy Group Names to ScubaResults.json (#1041)

* package Report Results by control group

* finish comment

* upgrade the ScubaGear ScubaResults metadata with even more context

* make comment clearer

* make another comment clearer

* Bump OPA version from v0.61.0 to v0.63.0 (#1070)

* Bump OPA version from v0.61.0 to  v0.63.0

* also add support for 0.62.1

* add omit comments

* add back in the space

* add back in the link

---------

Co-authored-by: GitHub Action <action@github.com>
Co-authored-by: buidav <105074908+buidav@users.noreply.github.com>

* Add GitLeaks to CI/CD Pipeline (#1066)

* add if

* update pipeline

* remove push

* set permissions

* Enhance AAD Provider and Rego Code to automate checks for policy MS.AAD.3.3v1 (#1014)

* Update provider json for  auth method config

* Added new json for MS auth feature settings

* Combined authentication method calls into one json object

* Updates to JSON for aad 3.4 and 3.5

* updates to aad 3.3 rego

* Include all auth method configs in json export

* Updates to aad 3.3 to check msauth settings

* Updates to unit tests for aad 3.4

* Update AADConfig.rego 3.3v1 status check

* fix N/A criticality for 3.5 and adjust unit and functional tests for new JSON structure

* changed JSON structure for 3.4, 3.5 because it had redundant objects and updated all tests

* fix run unit test

* revised 3.3 unit tests

* update 3.3 code & added unit tests

* refactored names and added comments to 3.3 policy

* refactored 3.4 to reduce redundant code and bad variable naming

* streamlined code for 3.5 to reduce redundancy and returned ActualValue which was missing

* renamed MFAPolicies to PhishingResistantMFAPolicies for accuracy

* initial version 3.3 functional test wip

* added functional test cases

* removed NotCheckedDetails import since linter complained

* made AuthenticationPolicyMigrationIsComplete shorter due to linter complaints

* changed AuthenticationPolicyMigrationIsComplete from boolean assignment to if due to linter

* removed redundant call to Get-MgBetaPolicyAuthenticationMethodPolicy which was left by mistake

---------

Co-authored-by: Ted Kolovos <107076927+tkol2022@users.noreply.github.com>
Co-authored-by: Sloane4 <cdiaz@mitre.org>

* Bump OPA version from v0.63.0 to  v0.64.1 (#1079)

Co-authored-by: GitHub Action <action@github.com>

* fixed functional test for 5.3 so that it only produces a single EnableAdminConsentRequests field (#1081)

---------

Co-authored-by: Devesh Agarwal <147526644+dagarwal-mitre@users.noreply.github.com>
Co-authored-by: David Bui <105074908+buidav@users.noreply.github.com>
Co-authored-by: James Garriss <52328727+james-garriss@users.noreply.github.com>
Co-authored-by: Ted Kolovos <107076927+tkol2022@users.noreply.github.com>
Co-authored-by: Devesh Agarwal <dagarwal@mitre.org>
Co-authored-by: Addam Schroll <108814318+schrolla@users.noreply.github.com>
Co-authored-by: amart241 <106177534+amart241@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: GitHub Action <action@github.com>
Co-authored-by: Shanti Satyapal <78565245+ssatyapal123@users.noreply.github.com>
Co-authored-by: Sloane4 <cdiaz@mitre.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rgbrow1949 rgbrow1949 rgbrow1949 approved these changes

@nanda-katikaneni nanda-katikaneni nanda-katikaneni approved these changes

Assignees

@amart241 amart241

Labels
enhancement This issue or pull request will add new or improve existing functionality
Projects
None yet
Milestone
Glacier
Development

Successfully merging this pull request may close these issues.

Add option to generate a config file template
5 participants
@amart241 @rgbrow1949 @crutchfield @nanda-katikaneni @schrolla