Skip to content

Latest commit

 

History

History
86 lines (55 loc) · 3.35 KB

README.md

File metadata and controls

86 lines (55 loc) · 3.35 KB

Frends.Community.EnvelopedCms

Frends Community tasks for handling EnvelopedCms assymmetric encryption and decryption of files

Actions Status MyGet License: MIT

Installing

You can install the Task via frends UI Task View or you can find the NuGet package from the following NuGet feed https://www.myget.org/F/frends-community/api/v3/index.json and in Gallery view in MyGet https://www.myget.org/feed/frends-community/package/nuget/Frends.Community.EnvelopedCms

Tasks

DecryptDEREncryptedFile

Decrypts a DER encrypted file

Task Parameters

DecryptDEREncryptedFileInput

DecryptDEREncryptedFileInput consists of four properties EncryptedContentBytes, EncryptedFilePath, PrivateKeyFilePath & PrivateKeyAsBase64EncodedString. The task needs either EncryptedContentBytes or EncryptedFilePath to be provided AND for the private key either PrivateKeyFilePath or PrivateKeyAsBase64EncodedString. If all parameters are given then the EncryptedFilePath & PrivateKeyFilePath are chosen for the decryption.

Property Type Description Example
EncryptedContentBytes byte[] Content of the encrypted file as byte array. [104,84,105,115]
EncryptedFilePath string Full path to the encrypted files location. C:\temp\encrypted_file.txt
PrivateKeyFilePath string Full path to the private key files location. Private key must be in .pem format. C:\temp\privateKey.pem
PrivateKeyAsBase64EncodedString string Private Key files content as a Base64 Encoded String. Must be a valid Base64 string. VGhpcyBpcyBhIHRlc3Q= This is a valid Base64 encoded string but the string will be longer for the private key.

Returns

A DecryptDEREncryptedFileResult object with parameters.

Property Type Description Example
DecryptedFileContentBytes byte[] Decrypted data as byte array. [84,104,105,115]

Usage: To fetch result use syntax:

#result.DecryptedFileContentBytes

Building

Clone a copy of the repository

git clone https://github.com/CommunityHiQ/Frends.Community.EnvelopedCms.git

Rebuild the project

dotnet build

Run tests

dotnet test

Create a NuGet package

dotnet pack --configuration Release

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

  1. Fork the repository on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. Submit a Pull request so that we can review your changes

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

Change Log

Version Changes
1.0.0 Initial version with DecryptDEREncryptedFile task