Protect-Data ConfigurationThe cmdlet accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the cmdlet, access to these internal properties is provided through the Config method.
Protect-Data Configuration Settings
The size, in bits, of secret key for the symmetric algorithm.The legal key sizes vary depending on the algorithm. The KeySize and BlockSize
configuration settings may be set to specify the key and block size (in bits).
This setting is only applicable when KeyPassword is specified.
Note that when using the EzCrypt cmdlet, KeySize should be set after setting the Algorithm property.
The block size, in bits, of the cryptographic operation.The block size is a basic data unit in the operation of encrypt or decrypt. Messages longer than the block size are seen as successive blocks. If the message is shorter than the block size, the message will be padded with extra bits to reach the block size according to PaddingMode.
Different symmetric algorithm has different valid block sizes.
The following algorithms have a fixed block size: AES, CAST, DES, IDEA, RC2, TripleDES, Blowfish, and Twofish.
|IncludeIV: Whether to prepend the IV to the output data and read the IV from the input data.If this config is true, the IV will be automatically prepended to the output data when calling Encrypt. When calling Decrypt and this setting is True, the IV is automatically extracted form the ciphertext. The default value is False.|
The hash algorithm used to derive the Key and IV from the KeyPassword property.This configuration setting specifies which hash algorithm will be used when deriving the Key and InitializationVector from KeyPassword.
The default value is "MD5". Possible values are:
|KeyPasswordSalt: The salt value used in conjunction with the KeyPassword to derive the Key and IV.This configuration setting specifies the hex encoded salt value to be used along with the KeyPassword when calculating values for Key and InitializationVector.|
Base Configuration Settings
|UseBackgroundThread: Whether threads created by the cmdlet are background threads.If set to True, when the cmdlet creates a thread the thread's IsBackground property will be explicitly set to True. By default this setting is False.|
Tells the cmdlet whether or not to use the system security libraries or an internal implementation.
By default the cmdlet will use the system security libraries to perform cryptographic functions.
When set to False calls to unmanaged code will be made. In certain environments this is not desirable.
To use a completely managed security implementation set this setting to True.
Setting this to True tells the cmdlet to use the internal implementation
instead of using the system's security API.
Note: This setting is static. The value set is applicable to all cmdlets used in the application.
When this value is set the product's system DLL is no longer required as a reference, as all unmanaged code is stored in that file.