|
| 1 | +<a href="https://www.cortex-ia.co.uk/" target="_blank"><img src="https://github.com/CortexIATest/CTXImages/blob/master/Cortex-350-120.png" alt="Welcome to Cortex!" width="350" height="120" border="0"></a> |
| 2 | + |
1 | 3 | # CTX-Encryption-Module |
2 | | -This module will allow you to encrypt/decrypt file(s) using PGP and AES encryption methods. |
| 4 | +The module uses flows and subtasks to allow users to perform the following functionality: |
| 5 | + * Encrypt file(s) with AES256 Encryption |
| 6 | + * Decrypt file(s) with AES256 Encryption |
| 7 | + * Encrypt file(s) with PGP Encryption |
| 8 | + * Decrypt file(s) with PGP Encryption |
| 9 | + |
| 10 | +* The flow uses LivePortal to allow the user to interactively Encrypt/Decrypt file(s) using a choice between AES256 or PGP Encryption methods. |
| 11 | +* The subtasks allow the user to incorporate the encryption/decyrption functionality into their own flows. |
| 12 | + |
| 13 | +## Table of Contents |
| 14 | +1) [Dependencies](#dependencies) |
| 15 | + * [Cortex Version](#cortex-version) |
| 16 | + * [Files](#files) |
| 17 | +1) [Support and Warranty](#support-and-warranty) |
| 18 | +1) [Installation](#installation) |
| 19 | +1) [How to use](#how-to-use) |
| 20 | +1) [How you can contribute](#how-you-can-contribute) |
| 21 | +1) [Versioning](#versioning) |
| 22 | +1) [Licensing](#licensing) |
| 23 | + |
| 24 | +## Dependencies |
| 25 | +### Cortex Version |
| 26 | +This version of the CTX-Encryption-Module was developed in Cortex v7.1.0. Some functionality may not be available in other verions of Cortex. |
| 27 | + |
| 28 | +### OCIs |
| 29 | +N/A |
| 30 | + |
| 31 | +### Files |
| 32 | +The CTX-Encryption-Module module requires the following files: |
| 33 | +* [CTX-Encryption-Module Studio Package](https://github.com/CortexIntelligentAutomation/CTX-Encryption-Module/releases/download/v1.0/CTX-Encryption-Module.studiopkg) |
| 34 | + |
| 35 | +## Support and Warranty |
| 36 | +This module is supplied as a template that you can amend and extend to fit your requirements, as such it is not supported as part of the Cortex Product suite under the Cortex product support agreement. |
| 37 | + |
| 38 | +## Installation |
| 39 | +Details of how the module should be imported into Cortex can be found in the [Deployment Plan](https://github.com/CortexIntelligentAutomation/CTX-Encryption-Module/blob/master/CTX-Encryption-Module%20-%20Deployment%20Plan.pdf). |
| 40 | + |
| 41 | +## How to use |
| 42 | +A detailed User Guide has been provided with instructions on how to use the flows/subtasks, available [here](https://github.com/CortexIntelligentAutomation/CTX-Encryption-Module/blob/master/CTX-Encryption-Module%20-%20User%20Guide.pdf). Configuring of the subtask's inputs and outputs are detailed in notes on the subtask workspace. |
| 43 | + |
| 44 | +## How you can contribute |
| 45 | +Unfortunately, we cannot offer pull requests at this time or accept any improvements. |
| 46 | + |
| 47 | +## Versioning |
| 48 | +The CTX-Encryption-Module module has the following versions, starting with the most recent: |
| 49 | + |
| 50 | +Version | Release | Functionality | Notes |
| 51 | +------------ | ------------- | ----------- | ----------- |
| 52 | +v1.0 | 09/09/2021 | Encryption-Decryption | Created |
| 53 | + |
| 54 | + |
| 55 | +## Licensing |
| 56 | +All functionality within this module is licensed under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0). |
| 57 | + |
| 58 | +Copyright 2019 Cortex Limited |
| 59 | + |
| 60 | +Licensed under the Apache License, Version 2.0 (the "License"); |
| 61 | +you may not use this file except in compliance with the License. |
| 62 | +You may obtain a copy of the License at |
| 63 | + |
| 64 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 65 | + |
| 66 | +Unless required by applicable law or agreed to in writing, software |
| 67 | +distributed under the License is distributed on an "AS IS" BASIS, |
| 68 | +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 69 | +See the License for the specific language governing permissions and |
| 70 | +limitations under the License. |
0 commit comments