- 07 Oct 2024
- 1 Minute to read
- Print
- DarkLight
Decrypt File
- Updated on 07 Oct 2024
- 1 Minute to read
- Print
- DarkLight
Step Details | |
Introduced in Version | 4.0.0 |
Last Modified in Version | 8.1.0 |
Location | PGP Steps |
The Decrypt File step allows a user to decrypt a PGP encrypted file.
Prerequisites
This step requires the PGP module to be installed before it will be available in the toolbox.
Properties
Inputs
Property | Description | Data Type |
---|---|---|
File | The desired PGP encrypted file | FileData |
Private Key | Generated PGP private key file used for encrypting or decrypting | FileData |
Private Key Password | Password for the specified Private Key | String |
Outputs
Property | Description | Data Type |
---|---|---|
Output | Outputs the decrypted file | FileData |
Example Inputs and Outputs
File | Private Key | Private Key Password | Output |
---|---|---|---|
file.txt | 3992-sec.asc | catch | Id: "ac665621-ad64-4b40-b836-dd73c82b98d7",FileName: "file.txt",Length: 7,FileType: ".txt" |
Null | private-sec.asc | newman | EXCEPTION MESSAGE |
Showdetails.pdf | Null | string | EXCEPTION MESSAGE |
flyer.docx | private-sec.asc | Empty | EXCEPTION MESSAGE |
Common Errors
Object reference not set to an instance of an object
If the File input or the Password for the provided Private Key is null or empty, the step will cause an error.
To correct this, ensure that an encrypted PGP file is uploaded or mapped to the File input and that the password entered for the Private Key is correct.
Exception Message:
Exception Stack Trace: DecisionsFramework.Design.Flow.ErrorRunningFlowStep: Error running step Decrypt File 1[DecryptFile] in flow [Flow 2]: Exception invoking method DecryptFile on class PGPSteps
---> DecisionsFramework.LoggedException: Exception invoking method DecryptFile on class PGPSteps
---> System.NullReferenceException: Object reference not set to an instance of an object. at Decsisions.PGP.Steps.PGPSteps.DecryptFile(Byte[] privateKey, String privateKeyPassword, FileData file)
--- End of inner exception stack trace --- at DecisionsFramework.Design.Flow.StepImplementations.InvokeMethodStep.Run(StepStartData data
at DecisionsFramework.Design.Flow.FlowStep.RunStepInternal(String flowTrackingID, String stepTrackingID, KeyValuePairDataStructure[] stepRunDataValues, AbstractFlowTrackingData trackingData
at DecisionsFramework.Design.Flow.FlowStep.Start(String flowTrackingID, String stepTrackingID, FlowStateData data, AbstractFlowTrackingData trackingData, RunningStepData currentStepData)
--- End of inner exception stack trace ---
Value cannot be null
If the Private Key is null or empty, the step will cause an error.
To correct this, ensure that the correct Private Key file is uploaded or mapped.
Exception Message:
Exception Stack Trace: DecisionsFramework.Design.Flow.ErrorRunningFlowStep: Error running step Decrypt File 1[DecryptFile] in flow [Flow 2]: Value cannot be null. (Parameter 'path')
---> System.ArgumentNullException: Value cannot be null. (Parameter 'path'
at DecisionsFramework.Utilities.Data.DataUtilities.GetValue(IDictionary`2 data, String path, Boolean throwError, Boolean returnReferences
at DecisionsFramework.Design.Flow.Mapping.InputImpl.SelectValueInputMapping.GetInputValue(IDataConsumer consumer, FlowStateData currentData, DecisionsType expectedType, Boolean expectingArray, String valueName, Object parentObject, Boolean canBeNull
at DecisionsFramework.Design.Flow.FlowStep.BuildMappingData(FlowStateData data
at DecisionsFramework.Design.Flow.FlowStep.Start(String flowTrackingID, String stepTrackingID, FlowStateData data, AbstractFlowTrackingData trackingData, RunningStepData currentStepData)
--- End of inner exception stack trace ---
Documentation:
PGP Module
Forum Posts:
Error While Encrypting A File Using PGP
PGP Issues With Decrypting Using Private Key