Skip to content

Removed value from SecureString/PSCredential string conversion exception message #19977

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
Merged
daxian-dbw merged 4 commits into from
Jul 17, 2023
Merged

Removed value from SecureString/PSCredential string conversion exception message #19977

daxian-dbw merged 4 commits into from
Jul 17, 2023

Conversation

@ArmaanMcleod
Copy link
Contributor

@ArmaanMcleod ArmaanMcleod commented Jul 15, 2023 •
edited
Loading

PR Summary

Fixes #19375

Removed value from exception message when [securestring] or ConvertFrom-SecureString fails to convert string to secure string.

Also removed value when string is casted to PSCredential.

PR Context

Current behaviour

Below shows string to convert in exception message which should not be shown in-case it is sensitive data like tokens, passwords etc.

PS C:\> [securestring]"p@ssword"
InvalidArgument: Cannot convert the "p@ssword" value of type "System.String" to type "System.Security.SecureString".

PS C:\> ConvertFrom-SecureString "p@assword"
ConvertFrom-SecureString: Cannot bind parameter 'SecureString'. Cannot convert the "p@assword" value of type "System.String" to type "System.Security.SecureString".

PS C>\> [pscredential]"p@assword"
InvalidArgument: Cannot convert the "p@assword" value of type "System.String" to type "System.Management.Automation.PSCredential".

New behaviour

Removes string entirely from exception message.

PS C:\> [securestring]"p@ssword"
InvalidArgument: Cannot convert the value of type "System.String" to type "System.Security.SecureString".

PS C:\> ConvertFrom-SecureString "p@assword"
ConvertFrom-SecureString: Cannot bind parameter 'SecureString'. Cannot convert the value of type "System.String" to type "System.Security.SecureString".

[pscredential]"p@assword"
InvalidArgument: Cannot convert the value of type "System.String" to type "System.Management.Automation.PSCredential".

PR Checklist

@ArmaanMcleod ArmaanMcleod marked this pull request as ready for review July 15, 2023 13:24
@iSazonov
Copy link
Collaborator

iSazonov commented Jul 15, 2023

WG said about PSCredential too.

@ArmaanMcleod ArmaanMcleod changed the title Removed value from secure string conversion exception message Removed value from SecureString/PSCredential string conversion exception message Jul 16, 2023
@ArmaanMcleod
Copy link
Contributor Author

ArmaanMcleod commented Jul 16, 2023

WG said about PSCredential too.

@iSazonov Thanks for picking up on that. I've made some changes to also not expose the string in message when casting string to PSCredential.

@pull-request-quantifier-deprecated
Copy link

pull-request-quantifier-deprecated bot commented Jul 17, 2023

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

Quantification details 

Label      : Extra Small
Size       : +26 -2
Percentile : 11.2%

Total files changed: 4

Change summary by file extension:
.cs : +14 -2
.resx : +3 -0
.ps1 : +9 -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.

@ArmaanMcleod ArmaanMcleod requested a review from iSazonov July 17, 2023 10:24
@iSazonov iSazonov added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Jul 17, 2023
SeeminglyScience
SeeminglyScience approved these changes Jul 17, 2023
View reviewed changes
Copy link
Collaborator

@SeeminglyScience SeeminglyScience left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks for the contribution @ArmaanMcleod! ❤️

@StevenBucher98 StevenBucher98 added the PowerShell-Docs not needed The PR was reviewed and doesn't appear to require a PowerShell Docs update label Jul 17, 2023
@daxian-dbw daxian-dbw merged commit d24285f into PowerShell:master Jul 17, 2023
@daxian-dbw daxian-dbw assigned daxian-dbw and unassigned TravisEz13 Jul 17, 2023
@ArmaanMcleod ArmaanMcleod deleted the fix-secure-string-value-cast branch July 17, 2023 20:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@iSazonov iSazonov iSazonov approved these changes

@SeeminglyScience SeeminglyScience SeeminglyScience approved these changes

Assignees

@daxian-dbw daxian-dbw

Labels

CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log Extra Small PowerShell-Docs not needed The PR was reviewed and doesn't appear to require a PowerShell Docs update

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

PSInvalidCastException should not display the value to be cast when target type is a secure string

6 participants

@ArmaanMcleod @iSazonov @SeeminglyScience @daxian-dbw @TravisEz13 @StevenBucher98