Skip to content

Commit

Permalink
Tweak documentation for AvoidUsingBrokenHashAlgorithms (#1829)
Browse files Browse the repository at this point in the history
Prior to this change, the documentation for the new rule,
**AvoidUsingBrokenHashAlgorithms**, was not reflowed and had the same
metadata description as **UseCmdletCorrectly**.

To keep this document in sync with the one in the published docset, this
change reflows the document to 100 characters and corrects the metadata.

This is related to the work in MicrosoftDocs/PowerShell-Docs-Modules#90.
  • Loading branch information
michaeltlombardi authored Aug 15, 2022
1 parent a154270 commit 987c169
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/Rules/AvoidUsingBrokenHashAlgorithms.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Cmdlet Verbs
description: Avoid using broken hash algorithms
ms.custom: PSSA v1.21.0
ms.date: 05/31/2022
ms.topic: reference
Expand All @@ -15,7 +15,9 @@ Avoid using the broken algorithms MD5 or SHA-1.

## How

Replace broken algorithms with secure alternatives. MD5 and SHA-1 should be replaced with SHA256, SHA384, SHA512, or other safer algorithms when possible, with MD5 and SHA-1 only being utilized by necessity for backwards compatibility.
Replace broken algorithms with secure alternatives. MD5 and SHA-1 should be replaced with SHA256,
SHA384, SHA512, or other safer algorithms when possible, with MD5 and SHA-1 only being utilized by
necessity for backwards compatibility.

## Example 1

Expand Down

0 comments on commit 987c169

Please sign in to comment.