Unprotect-KFData

Syntax

Unprotect-KFData 
  [-EncryptedData] <string> 
  [-ThrowErrors[:$true]]

Support

>= kenaflow 2.0.19

Return

Depending on the data encrypted with Protect-KFData it will return:

  • a string
  • an object
  • an array of byte values

Please read the description below.

Description

This cmdlet can be used to decrypt data that was encrypted using Protect-KFData

The encryptionPassphrase from the global configuration is used for decryption.

If the encrypted data contains an object, that it is stored as CliXML serialized string and will be deserialzed after decryption.

Parameters

[-EncryptedData] <string>

<string> contains the encrypted data.

[-ThrowErrors[:$true]]

This is a default parameter for all kenaflow cmdlets. If set to $true (default!) the engine will pass exception within the cmdlet to the script for further handling.

Example

$encryptedData = Protect-KFData -Object @{Hello="kenaflow"}
Write-KFLogOutput (Unprotect-KFData $encryptedData)

Discussion