File Encryption Service

From SysCAD Documentation
Jump to navigation Jump to search

Navigation: User Guide ➔ File Encryption Service

Related Links: PGMs, Reaction Block (RB)


Introduction

For clients with a current SysCAD upgrade and support agreement, Kenwalt can provide a file encryption utility, or more correctly a file obfuscation utility. This utility, or website service, obfuscates portions of a SysCAD project which can be a useful way to share a SysCAD project with a third party while limiting some functionality and visibility in the SysCAD project. This process does not rigorously encrypt or protect intellectual property (IP) in SysCAD projects.

The utility takes text files in original native format and creates obfuscated versions with .x file extensions. The user is responsible for keeping copies of the original files, and repeating the process if any changes to original files are made.

Currently, this can be used to obfuscate General Controller(PGM), Model Procedures(MP), Reaction(RCT), and Graphics Page(DXF) files, which are used with SysCAD projects. Primary use is for PGM files. When a file is obfuscated, it will be:

  1. Illegible in native format, but recognised by SysCAD during project load.
  2. Read only within SysCAD. This will help prevent any unwanted changes to the project for these files.
    • A General controller, or model with Model Procedures, with an obfuscated PGM or MP file will have the edit functionality disabled. User will be able to view and edit the data field values from the Access window, but they will not be allowed to view or make any changes to the file on a code level.
    • A Reaction Block with an obfuscated Reaction file will have the edit functionality disabled. User will be able to view all the reactions from the Access window and adjust any adjustable values as normal, but they won't be able to add or remove reactions.
    • A graphics window with an obfuscated DXF file will have all the Graphics Editing commands disabled. User will be able to see the flowsheet drawing and navigate, but they will not be allowed to make any changes to the drawing. The user will not be able to delete or add models, nor will they be able to manipulate the graphics in any way.
  3. The obfuscated files will stay obfuscated as projects are saved. The process is not reversible.
  4. All obfuscated files in a project can be identified by an extra .x file extension.

Notes:

  • A project may only have a few files of a type obfuscated. The reduced functionality only applies to the obfuscated files. Obfuscating some PGM include files with calculation function definitions is a practical example for using this feature.
  • Kenwalt provides no guarantee on the security of the obfuscated (encrypted) files.
  • Client is responsible for retaining copies of the original files. We do not provide a method of converting obfuscated files back to the original format.


How to Encrypt Files

If you wish to use the file obfuscation (encryption) service, please contact the SysCAD Team for access to the utility.

Encryption Workflow:

  1. Save and close the final version of your project.
  2. Encrypt the required files (see steps below).
  3. Replace the original files in the project folders with the encrypted versions.
  4. Delete the original files from the project (or open the project and perform a "Save Version").
  5. Load the updated project and confirm it runs correctly.
  6. Verify encryption:
    • Open the access window for each General Controller or Reaction Block using an encrypted file.
    • If encryption is active, the Edit PGM/RCT button will not be visible.
  7. Close the project.
  8. Send the project to the third party.

Steps to Encrypt Files:

  1. Obtain the utility from the SysCAD Team.
  2. Create a working folder for the utility and place the following inside:
    • The utility.exe file (Replace with actual file names as needed)
    • The files you want to obfuscate (e.g., .PGM)
  3. Open Command Prompt and navigate to the folder.
  4. Run the command:
    • utility.exe file1.pgm file2.pgm
    • (Replace with actual file names as needed)
  5. The utility will generate encrypted files:
    • file1.pgm.x
    • file2.pgm.x