Add SecureStringHelper.FromPlainTextString #14124

xtqqczze · 2020-11-18T16:42:29Z

PR Summary

Add unsafe helper method using SecureString(Char*, Int32) to construct a SecureString.

Replace the following pattern (which allocates on every loop iteration):

SecureString ss = new SecureString();
foreach (char t in password)
    ss.AppendChar(t);

PR Context

PR Checklist

PR has a meaningful title
- Use the present tense and imperative mood when describing your changes
Summarized changes
Make sure all .h, .cpp, .cs, .ps1 and .psm1 files have the correct copyright header
This PR is ready to merge and is not Work in Progress.
- If the PR is work in progress, please add the prefix WIP: or [ WIP ] to the beginning of the title (the WIP bot will keep its status check at Pending while the prefix is present) and remove the prefix when the PR is ready.
Breaking changes
- None
- OR
- [NA] Experimental feature(s) needed
  - [NA] Experimental feature name(s):
User-facing changes
- Not Applicable
- OR
- [NA] Documentation needed
  - [NA] Issue filed:
Testing - New and feature
- N/A or can only be tested interactively
- OR
- [NA] Make sure you've added a new test if existing tests do not effectively test the code changed
Tooling
- I have considered the user experience from a tooling perspective and don't believe tooling will be impacted.
- OR
- [NA] I have considered the user experience from a tooling perspective and enumerated concerns in the summary. This may include:
  - Impact on PowerShell Editor Services which is used in the PowerShell extension for VSCode (which runs in a different PS Host).
  - Impact on Completions (both in the console and in editors) - one of PowerShell's most powerful features.
  - Impact on PSScriptAnalyzer (which provides linting & formatting in the editor extensions).
  - Impact on EditorSyntax (which provides syntax highlighting with in VSCode, GitHub, and many other editors).

msftbot · 2020-12-06T20:00:06Z

This pull request has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 15 days. It will be closed if no further activity occurs within 10 days of this comment.

src/System.Management.Automation/security/SecureStringHelper.cs

msftbot · 2020-12-26T14:00:09Z

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

iSazonov · 2021-01-09T07:17:59Z

src/System.Management.Automation/security/SecureStringHelper.cs

+#nullable enable
+        internal static unsafe SecureString FromPlainTextString(string plainTextString)
+        {
+            if (plainTextString.Length == 0)
+            {
+                return new SecureString();
+            }


Nullable annotations do not still work in callsites and I'd add Assert to check null.

Nullable annotations do not still work in callsites and I'd add Assert to check null.

Apparently so, I was able to compile code with SecureStringHelper.FromPlainTextString(null). In that case I would prefer to use string.IsNullOrEmpty to avoid possible NRE.

I wasn't aware the compiler didn't check nullability at callsites, is this by design? If so that certainly reduces the value of #12631.

It checks if nullable annotations is enabled for callsites. So we get all benefits only after we finish annotations.
I agree with IsNullOrEmpty().

iSazonov · 2021-01-19T12:41:01Z

src/System.Management.Automation/security/SecureStringHelper.cs

+            Debug.Assert(plainTextString is not null);
+
+            if (string.IsNullOrEmpty(plainTextString))


If we use IsNullOrEmpty we can remove Debug.Assert

~~I think the current configuration makes sense; we shouldn't accept null, but if it's given to us in the product, we'll do the right thing.~~

Actually, no, I'd prefer that we either return null or throw a NullReferenceException

I've removed the null check and added documentation.

rjmholt · 2021-04-12T17:28:38Z

src/System.Management.Automation/security/SecureStringHelper.cs

+            Debug.Assert(plainTextString is not null);
+
+            if (string.IsNullOrEmpty(plainTextString))


~~I think the current configuration makes sense; we shouldn't accept null, but if it's given to us in the product, we'll do the right thing.~~

Actually, no, I'd prefer that we either return null or throw a NullReferenceException

If we are passed null, we throw a NRE.

msftbot · 2021-04-14T23:58:47Z

🎉v7.2.0-preview.5 has been released which incorporates this pull request.🎉

Handy links:

Release Notes

@davidBar-On

[7.2.0-preview.5] - 2021-04-14 * Breaking Changes - Make PowerShell Linux deb and RPM packages universal (#15109) - Enforce AppLocker Deny configuration before Execution Policy Bypass configuration (#15035) - Disallow mixed dash and slash in command line parameter prefix (#15142) (Thanks @davidBar-On!) * Experimental Features - `PSNativeCommandArgumentPassing`: Use `ArgumentList` for native executable invocation (breaking change) (#14692) * Engine Updates and Fixes - Add `IArgumentCompleterFactory` for parameterized `ArgumentCompleters` (#12605) (Thanks @powercode!) * General Cmdlet Updates and Fixes - Fix SSH remoting connection never finishing with misconfigured endpoint (#15175) - Respect `TERM` and `NO_COLOR` environment variables for `$PSStyle` rendering (#14969) - Use `ProgressView.Classic` when Virtual Terminal is not supported (#15048) - Fix `Get-Counter` issue with `-Computer` parameter (#15166) (Thanks @krishnayalavarthi!) - Fix redundant iteration while splitting lines (#14851) (Thanks @hez2010!) - Enhance `Remove-Item -Recurse` to work with OneDrive (#14902) (Thanks @iSazonov!) - Change minimum depth to 0 for `ConvertTo-Json` (#14830) (Thanks @kvprasoon!) - Allow `Set-Clipboard` to accept empty string (#14579) - Turn on and off `DECCKM` to modify keyboard mode for Unix native commands to work correctly (#14943) - Fall back to `CopyAndDelete()` when `MoveTo()` fails due to an `IOException` (#15077) * Code Cleanup <details> <summary> We thank the following contributors! @xtqqczze, @iSazonov, @ZhiZe-ZG </summary> <ul> <li>Update .NET to <code>6.0.0-preview.3</code> (#15221)</li> <li>Add space before comma to hosting test to fix error reported by <code>SA1001</code> (#15224)</li> <li>Add <code>SecureStringHelper.FromPlainTextString</code> helper method for efficient secure string creation (#14124) (Thanks @xtqqczze!)</li> <li>Use static lambda keyword (#15154) (Thanks @iSazonov!)</li> <li>Remove unnecessary <code>Array</code> -> <code>List</code> -> <code>Array</code> conversion in <code>ProcessBaseCommand.AllProcesses</code> (#15052) (Thanks @xtqqczze!)</li> <li>Standardize grammar comments in Parser.cs (#15114) (Thanks @ZhiZe-ZG!)</li> <li>Enable <code>SA1001</code>: Commas should be spaced correctly (#14171) (Thanks @xtqqczze!)</li> <li>Refactor <code>MultipleServiceCommandBase.AllServices</code> (#15053) (Thanks @xtqqczze!)</li> </ul> </details> * Tools - Use Unix line endings for shell scripts (#15180) (Thanks @xtqqczze!) * Tests - Add the missing tag in Host Utilities tests (#14983) - Update `copy-props` version in `package.json` (#15124) * Build and Packaging Improvements <details> <summary> We thank the following contributors! @JustinGrote </summary> <ul> <li>Fix <code>yarn-lock</code> for <code>copy-props</code> (#15225)</li> <li>Make package validation regex accept universal Linux packages (#15226)</li> <li>Bump NJsonSchema from 10.4.0 to 10.4.1 (#15190)</li> <li>Make MSI and EXE signing always copy to fix daily build (#15191)</li> <li>Sign internals of EXE package so that it works correctly when signed (#15132)</li> <li>Bump Microsoft.NET.Test.Sdk from 16.9.1 to 16.9.4 (#15141)</li> <li>Update daily release tag format to work with new Microsoft Update work (#15164)</li> <li>Feature: Add Ubuntu 20.04 Support to install-powershell.sh (#15095) (Thanks @JustinGrote!)</li> <li>Treat rebuild branches like release branches (#15099)</li> <li>Update WiX to 3.11.2 (#15097)</li> <li>Bump NJsonSchema from 10.3.11 to 10.4.0 (#15092)</li> <li>Allow patching of preview releases (#15074)</li> <li>Bump Newtonsoft.Json from 12.0.3 to 13.0.1 (#15084, #15085)</li> <li>Update the <code>minSize</code> build package filter to be explicit (#15055)</li> <li>Bump NJsonSchema from 10.3.10 to 10.3.11 (#14965)</li> </ul> </details> * Documentation and Help Content - Merge `7.2.0-preview.4` changes to master (#15056) - Update `README` and `metadata.json` (#15046) - Fix broken links for `dotnet` CLI (#14937) [7.2.0-preview.5]: v7.2.0-preview.4...v7.2.0-preview.5

Add SecureStringHelper.FromPlainTextString

95f6fb9

msftbot bot assigned rjmholt Nov 18, 2020

msftbot bot added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Nov 21, 2020

msftbot bot added the Stale label Dec 6, 2020

msftbot bot added Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept and removed Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept Stale labels Dec 6, 2020

Use C# 7.3 pattern-based fixed

3609f09

msftbot bot removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Dec 13, 2020

xtqqczze marked this pull request as ready for review Dec 14, 2020

xtqqczze requested review from SteveL-MSFT and TravisEz13 as code owners Dec 14, 2020

ColleenKeegan reviewed Dec 19, 2020

View changes

src/System.Management.Automation/security/SecureStringHelper.cs Outdated Show resolved Hide resolved

msftbot bot added the Review - Needed The PR is being reviewed label Dec 26, 2020

rjmholt approved these changes Dec 27, 2020

View changes

iSazonov reviewed Jan 9, 2021

View changes

iSazonov added the CL-CodeCleanup Indicates that a PR should be marked as a Code Cleanup change in the Change Log label Jan 9, 2021

Add null check and assert

503750e

iSazonov reviewed Jan 19, 2021

View changes

rjmholt approved these changes Apr 12, 2021

View changes

xtqqczze added 2 commits Apr 12, 2021

Remove null check

aabb031

If we are passed null, we throw a NRE.

Add documentation

7811240

rjmholt merged commit a6abf16 into PowerShell:master Apr 12, 2021
32 checks passed

msftbot bot removed the Review - Needed The PR is being reviewed label Apr 12, 2021

iSazonov added this to the 7.2.0-preview.6 milestone Apr 13, 2021

xtqqczze deleted the string-to-securestring branch Apr 13, 2021

iSazonov removed this from the 7.2.0-preview.6 milestone Apr 15, 2021

iSazonov added this to the 7.2.0-preview.5 milestone Apr 15, 2021

Sep	OCT	Nov
	11
2021	2022	2023

Add SecureStringHelper.FromPlainTextString #14124

Add SecureStringHelper.FromPlainTextString #14124

xtqqczze commented Nov 18, 2020 •

edited

msftbot bot commented Dec 6, 2020

msftbot bot commented Dec 26, 2020

iSazonov Jan 9, 2021

xtqqczze Jan 18, 2021

iSazonov Jan 19, 2021

iSazonov Jan 19, 2021 •

edited

rjmholt Apr 12, 2021 •

edited

xtqqczze Apr 12, 2021

rjmholt Apr 12, 2021 •

edited

msftbot bot commented Apr 14, 2021

		Debug.Assert(plainTextString is not null);

		if (string.IsNullOrEmpty(plainTextString))

Add SecureStringHelper.FromPlainTextString #14124

Add SecureStringHelper.FromPlainTextString #14124

Conversation

xtqqczze commented Nov 18, 2020 • edited

PR Summary

PR Context

PR Checklist

msftbot bot commented Dec 6, 2020

msftbot bot commented Dec 26, 2020

iSazonov Jan 9, 2021

Choose a reason for hiding this comment

xtqqczze Jan 18, 2021

Choose a reason for hiding this comment

iSazonov Jan 19, 2021

Choose a reason for hiding this comment

iSazonov Jan 19, 2021 • edited

Choose a reason for hiding this comment

rjmholt Apr 12, 2021 • edited

Choose a reason for hiding this comment

xtqqczze Apr 12, 2021

Choose a reason for hiding this comment

rjmholt Apr 12, 2021 • edited

Choose a reason for hiding this comment

msftbot bot commented Apr 14, 2021

xtqqczze commented Nov 18, 2020 •

edited

iSazonov Jan 19, 2021 •

edited

rjmholt Apr 12, 2021 •

edited

rjmholt Apr 12, 2021 •

edited