SignFile

PGP Task for signing files.

Task version: 1.2.0

Required Frends version: 5.7+

Required .NET version: 8.0

Compatible Agents: Crossplatform

Source code: https://github.com/FrendsPlatform/Frends.Pgp/tree/main/Frends.Pgp.SignFile

Task Parameters

Input

Name	Description
SourceFilePath : String	Full path to the file for signing. Default: - Example: C:\temp\message.txt
OutputFilePath : String	Full path for the signing file. Default: - Example: C:\temp\message.pgp
OutputFileExistsAction : OutputFileExistsAction	Action for if the output file exists. Possible values: Overwrite: Action for if the output file exists. Error: Action for if the output file exists. Default: - Example: OutputFileExistsAction.Overwrite

Options

Name	Description
DetachedSignature : Boolean	Create a detached signature (true) or attached signature (false). Detached signature creates a separate .sig file, attached signature embeds the signature with the data. Default: True Example: true
UseArmor : Boolean	Use ascii armor or not. Default: True Example: true
SignatureHashAlgorithm : PgpSignatureHashAlgorithm	Hash algorithm to use with signature Possible values: Md2: Hash algorithm to use with signature Md5: Hash algorithm to use with signature RipeMd160: Hash algorithm to use with signature Sha1: Hash algorithm to use with signature Sha224: Hash algorithm to use with signature Sha256: Hash algorithm to use with signature Sha384: Hash algorithm to use with signature Sha512: Hash algorithm to use with signature Default: 5 Example: PgpSignatureHashAlgorithm.Sha256
UseFileKey : Boolean	If true, PrivateKey is treated as a file path. If false, treated as raw key string. Default: True Example: true
PrivateKey : String	Private key file path or ASCII-armored private key content Default: - Example: C:\temp\privatekey.asc
🗝PrivateKeyPassword : String	Password/passphrase for the private key Default: - Example: MySecurePassphrase123
UseCompression : Boolean	Whether to compress the signed data (only applies to attached signatures) Default: False Example: false
SignatureBufferSize : Int32	Buffer size in KB for reading the file during signature generation Default: 16 Example: 16
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

Name	Description
Success : Boolean	Indicates if the task completed successfully. Example: true
FilePath : String	File path to the signed file. Example: C:\temp\message.pgp
Error : Error	Error that occurred during task execution. Example: object { string Message, Exception AdditionalInfo }

Task Changelog

Changelog for Task Frends.Pgp.SignFile.

[1.2.0] - 2026-02-23

Fixed

• Ensure FrendsTaskMetadata.json is included in NuGet package

[1.1.0] - 2026-01-21

Added

• Add UseCompression option for compressing attached signature data. Default is false.

[1.0.0] - 2026-01-05

Added

• Initial implementation