ConvertFrom-PKISecureString

NAME ConvertFrom-PKISecureString



SYNOPSIS

Converts a SecureString object into encrypted text with the public key of a PKI certificate.





SYNTAX

ConvertFrom-PKISecureString [-SecureString] <SecureString> -CertificateFile <String> [<CommonParameters>]



ConvertFrom-PKISecureString [-SecureString] <SecureString> -Thumbprint <String> [-CertificateStore <String>]

[<CommonParameters>]





DESCRIPTION





PARAMETERS

-SecureString <SecureString>

The SecureString object that will returned as an encrypted string.



Required? true

Position? 2

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Thumbprint <String>

The ThumbPrint of a certificate on the local computer that will be used to encrypt the string.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-CertificateFile <String>

Path to a .CER certificate public key file that will be used to encrypt the string.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-CertificateStore <String>

Specifies the certifcate store of the specified certificate thumbprint. Either LocalMachine or CurrentUser.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>ConvertFrom-PKISecureString -SecureString $MySecretValue -Thumbprint

'87BB70A19A7671D389F49AF4C9608B2F381FDD80' | Out-File ./encryptedText.txt



Encrypts a SecureString object and saves it to disk.











RELATED LINKS