Add `Get-SecureRandom` cmdlet by SteveL-MSFT · Pull Request #19587 · PowerShell/PowerShell

SteveL-MSFT · 2023-04-28T00:49:19Z

PR Summary

Add a Get-SecureRandom cmdlet which does not expose a -SetSeed parameter ensuring results are always cryptographically secure. Get-Random is derived from this cmdlet and maintains the -SetSeed parameter. The only changes to the move of code from GetRandomCommand is changing some members to internal from private so that Get-Random can call them.

The tests are a copy of the Get-Random tests removing the -SetSeed tests and adding a specific test to ensure that parameter doesn't exist.

PR Context

Users of Get-Random who use -SetSeed may mistakenly think they are cryptographically secure but is not since a seed is used. This new cmdlet makes it easy to not make this mistake.

PR Checklist

src/Microsoft.PowerShell.Commands.Utility/commands/utility/GetSecureRandomCommand.cs

iSazonov · 2023-04-28T06:50:45Z

Is "Secure" right term if "strong crypto" is assumed? Maybe "Get-StrongRandom".

MartinGC94 · 2023-04-28T09:45:26Z

Why not just emit a warning if the SetSeed parameter is used? If a new Get-SecureRandom command is added people will probably assume that Get-Random is insecure, when in reality it's only insecure in specific circumstances.

SteveL-MSFT · 2023-04-28T13:32:04Z

@MartinGC94 I considered adding a warning when -SetSeed is used, but when used in automation, no one will likely see the warning. You're correct that the default usage of Get-Random is secure, but the intent here is to make it more clear. Get-Random will continue to work as it does today so this is really for newer users.

@iSazonov I chose Get-SecureRandom primarily to match the naming of the *-SecureString cmdlets even though there is no relation functionally between the two. Strong or Crypto would only be meaningful to someone who already understands the implications of -SetSeed and the name is really for those who may not.

test/powershell/Modules/Microsoft.PowerShell.Utility/Get-SecureRandom.Tests.ps1

PaulHigin

LGTM

src/Microsoft.PowerShell.Commands.Utility/commands/utility/GetSecureRandomCommand.cs

…eRandom.Tests.ps1 Co-authored-by: James Truher [MSFT] <jimtru@microsoft.com>

src/Microsoft.PowerShell.Commands.Utility/commands/utility/GetRandomCommandBase.cs

pull-request-quantifier-deprecated · 2023-05-02T16:26:44Z

This PR has 720 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

Quantification details

Label      : Extra Large
Size       : +434 -286
Percentile : 90.67%

Total files changed: 7

Change summary by file extension:
.cs : +295 -284
.psd1 : +2 -2
.ps1 : +137 -0

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

Fast and predictable releases to production:
- Optimal size changes are more likely to be reviewed faster with fewer
  iterations.
- Similarity in low PR complexity drives similar review times.
Review quality is likely higher as complexity is lower:
- Bugs are more likely to be detected.
- Code inconsistencies are more likely to be detected.
Knowledge sharing is improved within the participants:
- Small portions can be assimilated better.
Better engineering practices are exercised:
- Solving big problems by dividing them in well contained, smaller problems.
- Exercising separation of concerns within the code changes.

What can I do to optimize my changes

Use the PullRequestQuantifier to quantify your PR accurately
- Create a context profile for your repo using the context generator
- Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
- Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
- Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
Change your engineering behaviors
- For PRs that fall outside of the desired spectrum, review the details and check if:
  - Your PR could be split in smaller, self-contained PRs instead
  - Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

One line was added: +1 -0
One line was deleted: +0 -1
One line was modified: +1 -1 (git diff doesn't know about modified, it will
interpret that line like one addition plus one deletion)
Change percentiles: Change characteristics (addition, deletion, modification)
of this PR in relation to all other PRs within the repository.

Was this comment helpful? 👍 :ok_hand: :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

ghost · 2023-06-29T22:05:10Z

🎉v7.4.0-preview.4 has been released which incorporates this pull request.:tada:

Handy links:

Release Notes

Add Get-SecureRandom cmdlet

0517892

SteveL-MSFT requested a review from TravisEz13 April 28, 2023 00:49

SteveL-MSFT assigned TravisEz13 Apr 28, 2023

SteveL-MSFT requested a review from PaulHigin as a code owner April 28, 2023 00:49

iSazonov reviewed Apr 28, 2023

View reviewed changes

src/Microsoft.PowerShell.Commands.Utility/commands/utility/GetSecureRandomCommand.cs Outdated Show resolved Hide resolved

src/Microsoft.PowerShell.Commands.Utility/commands/utility/GetSecureRandomCommand.cs Outdated Show resolved Hide resolved

update comments

4cbb429

JamesWTruher reviewed May 1, 2023

View reviewed changes

test/powershell/Modules/Microsoft.PowerShell.Utility/Get-SecureRandom.Tests.ps1 Outdated Show resolved Hide resolved

PaulHigin approved these changes May 1, 2023

View reviewed changes

src/Microsoft.PowerShell.Commands.Utility/commands/utility/GetSecureRandomCommand.cs Outdated Show resolved Hide resolved

daxian-dbw added the WG-Cmdlets general cmdlet issues label May 1, 2023

TravisEz13 reviewed May 1, 2023

View reviewed changes

src/Microsoft.PowerShell.Commands.Utility/commands/utility/GetSecureRandomCommand.cs Outdated Show resolved Hide resolved

TravisEz13 reviewed May 1, 2023

View reviewed changes

src/Microsoft.PowerShell.Commands.Utility/commands/utility/GetSecureRandomCommand.cs Outdated Show resolved Hide resolved

daxian-dbw added the Needs-Triage The issue is new and needs to be triaged by a work group. label May 1, 2023

address Paul and Travis' comments

4aaeac5

pull-request-quantifier-deprecated bot added the Extra Large label May 1, 2023

SteveL-MSFT and others added 2 commits May 1, 2023 16:17

Update test/powershell/Modules/Microsoft.PowerShell.Utility/Get-Secur…

282431b

…eRandom.Tests.ps1 Co-authored-by: James Truher [MSFT] <jimtru@microsoft.com>

address codefactor

05589a1

TravisEz13 approved these changes May 2, 2023

View reviewed changes

SteveL-MSFT mentioned this pull request May 2, 2023

New Get-SecureRandom cmdlet MicrosoftDocs/PowerShell-Docs#10041

Closed

2 tasks

address Ilya's feedback creating a base class for both cmdlets

add59bb

iSazonov reviewed May 2, 2023

View reviewed changes

src/Microsoft.PowerShell.Commands.Utility/commands/utility/GetRandomCommandBase.cs Show resolved Hide resolved

remove unused using

5497891

iSazonov approved these changes May 2, 2023

View reviewed changes

TravisEz13 approved these changes May 2, 2023

View reviewed changes

TravisEz13 merged commit a153446 into PowerShell:master May 2, 2023

SteveL-MSFT deleted the get-securerandom branch May 2, 2023 18:01

crisman mentioned this pull request May 30, 2023

Get-SecureRandom missing in cmdlet history MicrosoftDocs/PowerShell-Docs#10105

Closed

3 tasks

sdwheeler added PowerShell-Docs needed The PR was reviewed and a PowerShell Docs update is needed and removed Needs-Triage The issue is new and needs to be triaged by a work group. labels Jun 1, 2023

adityapatwardhan added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Jun 28, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `Get-SecureRandom` cmdlet#19587

Add `Get-SecureRandom` cmdlet#19587
TravisEz13 merged 7 commits intoPowerShell:masterfrom
SteveL-MSFT:get-securerandom

SteveL-MSFT commented Apr 28, 2023 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

iSazonov commented Apr 28, 2023 •

edited

Loading

Uh oh!

MartinGC94 commented Apr 28, 2023

Uh oh!

SteveL-MSFT commented Apr 28, 2023

Uh oh!

Uh oh!

PaulHigin left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pull-request-quantifier-deprecated bot commented May 2, 2023

What can I do to optimize my changes

How to interpret the change counts in git diff output

Uh oh!

ghost commented Jun 29, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

Conversation

SteveL-MSFT commented Apr 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Context

PR Checklist

Uh oh!

Uh oh!

Uh oh!

iSazonov commented Apr 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MartinGC94 commented Apr 28, 2023

Uh oh!

SteveL-MSFT commented Apr 28, 2023

Uh oh!

Uh oh!

PaulHigin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pull-request-quantifier-deprecated bot commented May 2, 2023

What can I do to optimize my changes

How to interpret the change counts in git diff output

Uh oh!

ghost commented Jun 29, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

SteveL-MSFT commented Apr 28, 2023 •

edited

Loading

iSazonov commented Apr 28, 2023 •

edited

Loading