Skip to content

Add -AsPlainText to ConvertFrom-SecureString #11142

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

Merged
adityapatwardhan merged 3 commits into from
Dec 11, 2019
Merged

Add -AsPlainText to ConvertFrom-SecureString #11142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8f8d005
Add `-AsPlainText` to `ConvertFrom-SecureString`
SteveL-MSFT Nov 21, 2019
e62148a
address CodeFactor
SteveL-MSFT Nov 21, 2019
5da97ca
make `-Force` not required for `ConvertTo-SecureString`
SteveL-MSFT Dec 5, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 21 additions & 16 deletions src/Microsoft.PowerShell.Security/security/SecureStringCommands.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,12 @@ public SecureString SecureString
}
}

/// <summary>
/// Gets or sets a switch to get the secure string as plain text.
/// </summary>
[Parameter(ParameterSetName = "AsPlainText")]
public SwitchParameter AsPlainText { get; set; }

/// <summary>
/// Processes records from the input pipeline.
/// For each input object, the command encrypts
Expand All @@ -165,6 +171,19 @@ protected override void ProcessRecord()
{
encryptionResult = SecureStringHelper.Encrypt(SecureString, Key);
}
else if (AsPlainText)
{
IntPtr valuePtr = IntPtr.Zero;
try
{
valuePtr = Marshal.SecureStringToGlobalAllocUnicode(SecureString);
exportedString = Marshal.PtrToStringUni(valuePtr);
}
finally
{
Marshal.ZeroFreeGlobalAllocUnicode(valuePtr);
}
}
else
{
exportedString = SecureStringHelper.Protect(SecureString);
Expand Down Expand Up @@ -342,22 +361,8 @@ protected override void ProcessRecord()
}
else
{
if (!Force)
{
string error =
SecureStringCommands.ForceRequired;
Exception e = new ArgumentException(error);
WriteError(new ErrorRecord(e, "ImportSecureString_ForceRequired", ErrorCategory.InvalidArgument, null));
}
else
{
// The entire purpose of the SecureString is to prevent a secret from being
// permanently stored in memory as a .Net string. If they use the
// -AsPlainText and -Force flags, they consciously have made the decision to be OK
// with that.
importedString = new SecureString();
foreach (char currentChar in String) { importedString.AppendChar(currentChar); }
}
importedString = new SecureString();
foreach (char currentChar in String) { importedString.AppendChar(currentChar); }
}
}
catch (ArgumentException e)
Expand Down
5 changes: 3 additions & 2 deletions test/powershell/Modules/Microsoft.PowerShell.Security/SecureString.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,11 @@ Describe "SecureString conversion tests" -Tags "CI" {
$ss = ConvertTo-SecureString -AsPlainText -Force abcd
$ss | Should -BeOfType SecureString
}

It "can convert back from a secure string" {
$secret = "abcd"
$ss1 = ConvertTo-SecureString -AsPlainText -Force $secret
$ss2 = convertfrom-securestring $ss1 | convertto-securestring
[pscredential]::New("user",$ss2).GetNetworkCredential().Password | Should -Be $secret
$ss2 = ConvertFrom-SecureString $ss1 | ConvertTo-SecureString
$ss2 | ConvertFrom-SecureString -AsPlainText | Should -Be $secret
}
}