Add AvoidUsingBrokenHashAlgorithms - #1787
Conversation
Sorry, something went wrong.
|
|
Sorry, something went wrong.
Christoph Bergmeister (bergmeister)
left a comment
There was a problem hiding this comment.
Thanks for the contribution and very good idea. I'll be giving it a test run but from a high level looks good otherwise. I might suggest something minor around the parameter parsin
Sorry, something went wrong.
Cool, thanks! I'll fix anything as needed when you get a chance to review. |
Sorry, something went wrong.
| Context "When there are violations" { | ||
| It "detects broken hash algorithms violations" { | ||
| (Invoke-ScriptAnalyzer -ScriptDefinition 'Get-FileHash foo -Algorithm MD5' -Settings $settings).Count | Should -Be 1 | ||
| (Invoke-ScriptAnalyzer -ScriptDefinition 'Get-FileHash foo -Algorithm SHA1' -Settings $settings).Count | Should -Be 1 |
There was a problem hiding this comment.
An optional improvement would be to make it also work when no named parameters are used: Invoke-ScriptAnalyzer -ScriptDefinition 'Get-FileHash foo SHA1'
Sorry, something went wrong.
There was a problem hiding this comment.
Good idea. Can you see of any cases where this might false flag? Ie, someone opening a file that's named the same as a flagged hashing algorithm?
Sorry, something went wrong.
There was a problem hiding this comment.
No, because what you would do is check whether the first and second item in the array are not named parameters, i.e. do not start with dash and therefore you know for sure that the first one has to be the file name and the second one the algorithm
Sorry, something went wrong.
Christoph Bergmeister (bergmeister)
left a comment
There was a problem hiding this comment.
Looks good, I would just change severity from Warning. An optional suggestion on improving parsing but this could also just be a follow up PR as I'd rather want to wrap this up and ship it quickly in the next version of PSSA.
Docs question to Sean Wheeler (@sdwheeler) What do we do with the docs/Rules folder in this repo now? Do we have to replicate the same change here: https://github.com/MicrosoftDocs/PowerShell-Docs-Modules/tree/main/reference/docs-conceptual/PSScriptAnalyzer/Rules
Sorry, something went wrong.
Co-authored-by: Christoph Bergmeister [MVP] <c.bergmeister@gmail.com>
Thanks for the input! Fixed severities and unit tests based on your review comments. I lack the bandwidth at the moment to improve the parsing, but it's something I could look into in the future. I think we should leave that as a follow-up PR like you said to get this to ship faster. |
Sorry, something went wrong.
Yes. I just need to know when you are going to release and then I will copy the updated docs from the source repository to the docs repository. Eventually we want a CI job to do that automatically at release time. But for now, I can do it manually. |
Sorry, something went wrong.
PR Summary
This adds a new rule: AvoidUsingBrokenHashAlgorithms.
This rule searches for use of SHA-1 or MD5 within -Algorithm parameters. This mainly serves to flag use with Get-FileHash, but also works for other cmdlets which may use the same parameter scheme. Should other algorithms in the future be deemed insecure, it would be trivial to add them.
At this point both of these algorithms are broken (Microsoft SDL has labeled them as such since 2009), so I think it would be worthwhile to flag these, such that new code doesn't use these algorithms except when needed for backwards compatability.
PR Checklist