DecryptFile
Task for decrypting a file with Pgp
Task version: 1.3.0
Required Frends version: 5.7+
Required .NET version: 8.0
Compatible Agents: Crossplatform
Task Parameters
SourceFilePath : String
Path to the file containing the data to be decrypted.
Default: -
Example: C:\secrets\message.gpg
OutputFilePath : String
Path where the decrypted file will be saved to.
Default: -
Example: C:\messages\result.txt
DecryptBufferSize : Int32
Buffer size in KB that will be used when decrypting the file.
Default: 64
Example: 64
PrivateKeySource : PrivateKeySource
Source of the private key - file path or string.
Possible values:
File: Source of the private key - file path or string.String: Source of the private key - file path or string.
Default: -
Example: PrivateKeySource.File
PrivateKeyPath : String
Path to the private key file.
Default: -
Example: C:\keys\my_key.asc
🗝PrivateKeyString : String
Private key as a string, including the BEGIN/END PGP PRIVATE KEY BLOCK lines.
Default: -
Example: -----BEGIN PGP PRIVATE KEY BLOCK----- ... -----END PGP PRIVATE KEY BLOCK-----
PassphraseEncoding : PassphraseEncoding
Encoding used for the private key passphrase. Defaults to Utf8.
Use Legacy if the passphrase contains non-ASCII characters and the key was created with an older PGP tool.
Possible values:
Utf8: Encoding used for the private key passphrase. Defaults to Utf8.
Use Legacy if the passphrase contains non-ASCII characters and the key was created with an older PGP tool.
Legacy: Encoding used for the private key passphrase. Defaults to Utf8.
Use Legacy if the passphrase contains non-ASCII characters and the key was created with an older PGP tool.
Default: -
Example: PassphraseEncoding.Utf8
🗝PrivateKeyPassphrase : String
Passphrase for the private key.
Default: -
Example: P@ssw0rd
ThrowErrorOnFailure : Boolean
Whether to throw an error on failure.
Default: True
Example: true
ErrorMessageOnFailure : String
Overrides the error message on failure.
Default: -
Example: Custom error message
Task Result
Success : Boolean
Indicates if the task completed successfully.
Example: true
Error : Error
Error that occurred during task execution.
Example: object { string Message, Exception AdditionalInfo }
Task Changelog
Changelog for Task Frends.Pgp.DecryptFile.
[1.3.0] - 2026-06-23
Fixed
Decryption failing with non-ASCII passphrases
Output directory not created automatically
Added
Input.PrivateKeyString � option to provide the private key directly as a string instead of a file path
Input.PassphraseEncoding � option to choose between Utf8 (default) and Legacy passphrase encoding
[1.2.0] - 2026-05-11
Fixed
Support decryption of signed messages
[1.1.0] - 2026-02-23
Fixed
Ensure FrendsTaskMetadata.json is included in NuGet package
[1.0.0] - 2026-01-09
Added
Initial implementation
Last updated
Was this helpful?