Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Unprotect-CmsMessage

Unprotect-CmsMessage

microsoft.powershell.security.dll

Synopsis

Decrypts content that has been encrypted by using the Cryptographic Message Syntax format.

Syntax

Unprotect-CmsMessage [-EventLogRecord] [-To] [-IncludeContext] [<CommonParameters>]

Unprotect-CmsMessage [-Content] [-To] [-IncludeContext] [<CommonParameters>]

Unprotect-CmsMessage [-LiteralPath] [-To] [-IncludeContext] [<CommonParameters>]

Unprotect-CmsMessage [-Path] [-To] [-IncludeContext] [<CommonParameters>]

Detailed Description

The Cryptographic Message Syntax cmdlets support encryption and decryption of content using the IETF standard format for cryptographically protecting messages, as documented by RFC5652.

The CMS encryption standard uses public key cryptography, where the keys used to encrypt content (the public key) and the keys used to decrypt content (the private key) are separate. Your public key can be shared widely, and is not sensitive data. If any content is encrypted with this public key, only your private key can decrypt it. For more information about Public Key Cryptography, see http://en.wikipedia.org/wiki/Public-key_cryptography.

Unprotect-CmsMessage decrypts content that has been encrypted in CMS format. You can run this cmdlet to decrypt content that you have encrypted by running the Protect-CmsMessage cmdlet. You can specify content that you want to decrypt as a string, by the encryption event log record ID number, or by path to the encrypted content. The Unprotect-CmsMessage cmdlet returns the decrypted content.

Parameters

-Content <String>

Specifies an encrypted string, or a variable containing an encrypted string.

Aliases

None

Required?

true

Position

1

Default value

Accept pipeline input?

True (ByValue, ByPropertyName)

Accept wildcard characters?

false

-EventLogRecord <PSObject>

Specifies an event log record ID that represents a CMS encryption operation.

Aliases

None

Required?

true

Position

1

Default value

Accept pipeline input?

True (ByValue)

Accept wildcard characters?

false

-IncludeContext <SwitchParameter>

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-LiteralPath <String>

Specifies the path to encrypted content that you want to decrypt. Unlike Path, the value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcard characters. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell Windows PowerShell not to interpret any characters as escape sequences.

Aliases

None

Required?

true

Position

1

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-Path <String>

Specifies the path to encrypted content that you want to decrypt.

Aliases

None

Required?

true

Position

1

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-To <CmsMessageRecipient[]>

Specifies one or more CMS message recipients, identified in any of the following formats.

-- An actual certificate (as retrieved from the certificate provider)

-- Path to the a file containing the certificate

-- Path to a directory containing the certificate

-- Thumbprint of the certificate (used to look in the certificate store)

-- Subject name of the certificate (used to look in the certificate store)

Aliases

none

Required?

false

Position

2

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type


Notes

None

Examples

Example 1: Decrypt a message

In the following example, you decrypt content that is located at the literal path C:\Users\Test\Documents\PowerShell ISE. For the value of the required To parameter, this example uses the thumbprint of the certificate that was used to perform the encryption. The decrypted message, "Try the new Break All command," is the result.

PS C:\>C:\Users\gabyk\Documents\PowerShell_ISEUnprotect-CmsMessage –LiteralPath 'C:\Users\Test\Documents\PowerShell ISE\Future_Plans.txt' –To '‎0f 8j b1 ab e0 ce 35 1d 67 d2 f2 6f a2 d2 00 cl 22 z9 m9 85'
Try the new Break All command

Online Version
about_Providers
Get-CmsMessage
Protect-CmsMessage