Skip to content

Latest commit

 

History

History
111 lines (84 loc) · 2.29 KB

ConvertFrom-PKISecureString.md

File metadata and controls

111 lines (84 loc) · 2.29 KB
external help file Module Name online version schema
PSCredentialTools
2.0.0

ConvertFrom-PKISecureString

SYNOPSIS

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

SYNTAX

CertFile

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

Thumbprint

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

DESCRIPTION

{{Fill in the Description}}

EXAMPLES

EXAMPLE 1

ConvertFrom-PKISecureString -SecureString $MySecretValue -Thumbprint '87BB70A19A7671D389F49AF4C9608B2F381FDD80' | Out-File ./encryptedText.txt

Encrypts a SecureString object and saves it to disk.

PARAMETERS

-SecureString

The SecureString object that will returned as an encrypted string.

Type: SecureString
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Thumbprint

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

Type: String
Parameter Sets: Thumbprint
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CertificateFile

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

Type: String
Parameter Sets: CertFile
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CertificateStore

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

Type: String
Parameter Sets: Thumbprint
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

RELATED LINKS