puppetlabs / Puppet.Dsc

Convert DSC resources into Puppet Resource API types and providers
https://www.powershellgallery.com/packages/Puppet.Dsc
Apache License 2.0
9 stars 12 forks source link

(maint) - Add disclaimer for script block logging #295

Closed jordanbreen28 closed 2 months ago

jordanbreen28 commented 2 months ago

Summary

This PR adds a warning to each generated modules readme about the use of sensitive data with script block logging enabled. As per microsoft's own recommendation, protected event logging should also be enabled to encyrpt this data.

Additional Context

https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_logging_windows?view=powershell-7.4#protected-event-logging:~:text=It%27s%20recommended%20to%20enable%20Protected%20Event%20Logging%2C%20as%20described%20below%2C%20when%20using%20Script%20Block%20Logging%20for%20anything%20other%20than%20diagnostics%20purposes. https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_logging_windows?view=powershell-7.4#protected-event-logging

Related Issues (if any)

Mention any related issues or pull requests.

Checklist

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 19.70%. Comparing base (d424f92) to head (6b0acab). Report is 2 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #295 +/- ## ======================================= Coverage 19.70% 19.70% ======================================= Files 47 47 Lines 868 868 ======================================= Hits 171 171 Misses 697 697 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.