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

Document PSAvoidUsingBrokenHashAlgorithms #90

Closed
2 tasks done
michaeltlombardi opened this issue Aug 11, 2022 · 0 comments · Fixed by #91
Closed
2 tasks done

Document PSAvoidUsingBrokenHashAlgorithms #90

michaeltlombardi opened this issue Aug 11, 2022 · 0 comments · Fixed by #91
Assignees
@michaeltlombardi
Labels
area-conceptual Area - Conceptual articles area-scriptanalyzer Area - ScriptAnalyzer module issue-doc-idea Issue - request for new content

Comments

@michaeltlombardi
Copy link
Contributor

Prerequisites

  • Existing Issue: Search the existing issues for this repository. If there is an issue that fits your needs do not file a new one. Subscribe, react, or comment on that issue instead.
  • Descriptive Title: Write the title for this issue as a short synopsis. If possible, provide context. For example, "Document new Get-Foo cmdlet" instead of "New cmdlet."

Module

PSScriptAnalyzer

Summary

PSScriptAnalyzer added a new rule, PSAvoidUsingBrokenHashAlgorithms. The documentation for this rule should be added to the official docset. This rule warns a developer when they use a broken algorithm.

Details

The rule warns when a code statement uses either the MD5 or SHA1 hash algorithm, as those algorithms have been broken.

For example, this code violates the new rule:

Get-FileHash ./foo.txt -Algorithm SHA1

Content Type

Concept

Articles

  • reference\docs-conceptual\PSScriptAnalyzer\Rules\AvoidUsingBrokenHashAlgorithms.md
  • reference\docs-conceptual\PSScriptAnalyzer\Rules\README.md

Related Source Pull Requests

Related Source Issues

None.
@michaeltlombardi michaeltlombardi added issue-doc-idea Issue - request for new content needs-triage Waiting - Needs triage labels Aug 11, 2022
@michaeltlombardi michaeltlombardi self-assigned this Aug 11, 2022
@michaeltlombardi michaeltlombardi added area-conceptual Area - Conceptual articles area-scriptanalyzer Area - ScriptAnalyzer module and removed needs-triage Waiting - Needs triage labels Aug 11, 2022
michaeltlombardi added a commit to michaeltlombardi/PowerShell-Docs-Modules that referenced this issue Aug 11, 2022
@michaeltlombardi
(MicrosoftDocsGH-90) Document PSAvoidUsingBrokenHashAlgorithms
ebba499 
This change:

- documents the new `PSAvoidUsingBrokenHashAlgorithms` rule for
  **PSScriptAnalyzer** by updating the rule table and adding a document
  for the rule.
- Resolves MicrosoftDocs#90
- Fixes AB#4996
@michaeltlombardi michaeltlombardi mentioned this issue Aug 11, 2022
Merged
4 tasks
michaeltlombardi added a commit to michaeltlombardi/PowerShell-Docs-Modules that referenced this issue Aug 11, 2022
@michaeltlombardi
(MicrosoftDocsGH-90) Document PSAvoidUsingBrokenHashAlgorithms
6329ad4 
This change:

- documents the new `PSAvoidUsingBrokenHashAlgorithms` rule for
  **PSScriptAnalyzer** by updating the rule table and adding a document
  for the rule.
- Resolves MicrosoftDocs#90
- Fixes AB#4996
michaeltlombardi added a commit to michaeltlombardi/PowerShell-Docs-Modules that referenced this issue Aug 11, 2022
@michaeltlombardi
(MicrosoftDocsGH-90) Document PSAvoidUsingBrokenHashAlgorithms
72dd411 
This change:

- documents the new `PSAvoidUsingBrokenHashAlgorithms` rule for
  **PSScriptAnalyzer** by updating the rule table and adding a document
  for the rule.
- Resolves MicrosoftDocs#90
- Fixes AB#4996
michaeltlombardi added a commit to michaeltlombardi/PSScriptAnalyzer that referenced this issue Aug 11, 2022
@michaeltlombardi
(MAINT) Update documentation for AvoidUsingBrokenHashAlgorithms
5a30bc8 
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.
@michaeltlombardi michaeltlombardi mentioned this issue Aug 11, 2022
Merged
6 tasks
bergmeister pushed a commit to PowerShell/PSScriptAnalyzer that referenced this issue Aug 15, 2022
@michaeltlombardi
Tweak documentation for AvoidUsingBrokenHashAlgorithms (#1829)
987c169 
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.
michaeltlombardi added a commit to michaeltlombardi/PowerShell-Docs-Modules that referenced this issue Aug 17, 2022
@michaeltlombardi
(MicrosoftDocsGH-90) Document PSAvoidUsingBrokenHashAlgorithms (Micro…
03065d1 
…softDocs#91)

This change:

- documents the new `PSAvoidUsingBrokenHashAlgorithms` rule for
  **PSScriptAnalyzer** by updating the rule table and adding a document
  for the rule.
- Resolves MicrosoftDocs#90
- Fixes AB#4996
sdwheeler added a commit that referenced this issue Sep 22, 2022
@sdwheeler @michaeltlombardi
Publish to live (#94)
e4dd62a 
* (AB-4960) Run expectations workflow every 30m (#89)

This change reduces the frequency the expectations GHA runs from
once every 10 minutes to once every 30 minutes to help reduce the
frequency of rate limiting.

* (GH-90) Document PSAvoidUsingBrokenHashAlgorithms (#91)

This change:

- documents the new `PSAvoidUsingBrokenHashAlgorithms` rule for
  **PSScriptAnalyzer** by updating the rule table and adding a document
  for the rule.
- Resolves #90
- Fixes AB#4996

* (AB-4196) Codify markdownlint (#92)

Prior to this change, the repository had no markdownlint configuration.
This change adds configuration based on the rules defined in the
MicrosoftDocs/PowerShell-Docs project.

The root-folder `.markdownlint.json` file specifies the enforced syntax
for Markdown files in this project.

The root-folder `.markdownlint-cli2.yaml` file governs the behavior of
the linter overall. The settings included are minimal and do not effect
the editing experience. This file may require iteration for advanced
usage later.

In every `About` folder for reference content, this change adds a
`.markdownlint.json` file. When editing Markdown in VS Code, the editor
uses the closest configuration file to the edited document. That allows
us to override and specify alternate rules on a per-folder basis.

In this change, the configuration files in the `About` folders:

- Extend the root configuration. Any settings not specified in these
  configurations is inherited from the configuration at the project
  root.
- Overrides the `line-length` rule, setting the maximum line length for
  code blocks to 74 characters and for other text to 79 characters.This
  is to accomodate the PowerShell Help System's line length
  requirements.

In the `rules` folder for PSScriptAnalyzer's conceptual content, this
change adds a `.markdownlint.json` file which ignores the markdownlint
rule `no-emphasis-as-heading`. PSSA rules indicate their severity level
by a single line of emphasized text.

This change is related to AB#4196 and AB#4197.

* Add CrescendoBuilt to docs (#93)

* Fix typos (#95)

Co-authored-by: Mikey Lombardi (He/Him) <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@michaeltlombardi michaeltlombardi

Labels
area-conceptual Area - Conceptual articles area-scriptanalyzer Area - ScriptAnalyzer module issue-doc-idea Issue - request for new content
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

(GH-90) Document PSAvoidUsingBrokenHashAlgorithms michaeltlombardi/PowerShell-Docs-Modules
1 participant
@michaeltlombardi