save PSCredential in the file

by

Update on non-Windows Platforms

A lot has changed since this answer was first written. Modern versions of PowerShell are based on .net core, and run cross-platform. The underlying type that enables this whole answer is called [securestring] and the security and encryption that backs it comes from the Data Protection API (DPAPI) on Windows, which is not open source and not available cross-platform.

As such, while you can possibly use the same code here on non-Windows platforms, do note that there will be absolutely no encryption backing it.

tl;dr: don’t use this on non-Windows platforms!

More information available in this excellent answer on a related question.

To store and retrieve encrypted credentials easily, use PowerShell’s built-in XML serialization (Clixml):

$credential = Get-Credential

$credential | Export-CliXml -Path 'C:\My\Path\cred.xml'

To re-import:

$credential = Import-CliXml -Path 'C:\My\Path\cred.xml'

The important thing to remember is that by default this uses the Windows data protection API, and the key used to encrypt the password is specific to both the user and the machine that the code is running under.

As a result, the encrypted credential cannot be imported by a different user nor the same user on a different computer.

By encrypting several versions of the same credential with different running users and on different computers, you can have the same secret available to multiple users.

By putting the user and computer name in the file name, you can store all of the encrypted secrets in a way that allows for the same code to use them without hard coding anything:

Encrypter

# run as each user, and on each computer

$credential = Get-Credential

$credential | Export-CliXml -Path "C:\My\Secrets\myCred_${env:USERNAME}_${env:COMPUTERNAME}.xml"

The code that uses the stored credentials:

$credential = Import-CliXml -Path "C:\My\Secrets\myCred_${env:USERNAME}_${env:COMPUTERNAME}.xml"

The correct version of the file for the running user will be loaded automatically (or it will fail because the file doesn’t exist).

More Related Contents:

  1. Saving credentials for reuse by powershell and error ConvertTo-SecureString : Key not valid for use in specified state
  2. Get current user’s credentials object in Powershell without prompting
  3. Powershell script to delete 15 days old .txt files [duplicate]
  4. How to run an EXE file in PowerShell with parameters with spaces and quotes
  5. Use PowerShell to run virus scan on multiple servers
  6. Unable to access UNC Paths in Powershell remote session
  7. Fastest Way to get a uniquely index item from the property of an array
  8. PowerShell IE9 ComObject has all null properties after navigating to webpage
  9. PowerShell script runs when pasted into the PowerShell window, but not when run from shortcut
  10. Obtaining ExitCode using Start-Process and WaitForExit instead of -Wait
  11. Maximize window and bring it in front with powershell
  12. How do I run a PowerShell script when the computer starts?
  13. ConvertTo-Csv Output without quotes
  14. PowerShell – get process ID of called application
  15. Can the following Nested foreach loop be simplified in PowerShell?
  16. Add Write-Progress to Get-Job/Wait-Job
  17. Powershell with exchange– How do I append all verbose output to a file
  18. How to handle command-line arguments in PowerShell
  19. How to send email with PowerShell
  20. Powershell: Colon in commandlet parameters
  21. Passing PowerShell variables into a script block
  22. powershell function switch param with string array
  23. Can’t install nuget package because of “Failed to initialize the PowerShell host”
  24. What security setting is preventing Remote PowerShell 2.0 from accessing UNC paths
  25. PowerShell Capture Write-Host output
  26. start remote process within the context
  27. How to run powershell command in batch file
  28. How can I elevate Powershell while keeping the current working directory AND maintain all parameters passed to the script?
  29. Are you able to use PtrToStringAuto to decrypt a secure string in Powershell 7 on macOS?
  30. Prevent trailing newline in PowerShell Out-File command

Leave a Comment