How to Use Ubiq eFPE

Ubiq Format Preserving Encryption

Introduction

In cryptography, Format-Preserving Encryption, refers to encrypting in such a way that the output (the ciphertext) is in the same format as the input (the plaintext).

Ubiq has integrated this capability into our Platform to work with the following Ubiq libraries:

  • C
  • C++
  • Java
  • C#.NET
  • Node.js

Below are instructions for using this capability.

📘

Tip

Learn more about Format Preserving Encryption here

Getting Started

1. Enable your Application to use eFPE

a. Follow the Ubiq Dashboard / How to Register Applications instructions for registering your Application.

b. Make sure to select Yes on the Application page indicating that your application requires FPE or eFPE (located at the bottom of the Registration Pop-Up):

19901990

c. Make sure to Copy your API Key Credentials.

2. Set up your Field Format Specifications.

a. After registering your application with eFPE activated, on the left-hand Dashboard Menu, navigate to Settings / Field Format Specifications.

12301230

A new Field Format Specifications window will appear:

23862386

b. At the upper right corner, select New Field Format Specification to add new field format specifications.

A new window will appear for you to create a new Field Format Specification:

16301630

c. Complete the entries in the form.

Note: Regex, Tweak Source and Fpe algorithm are currently fixed values and cannot be modified.

🚧

For the first time creating a Field Format Specification, here are some suggested values for the variables:

FFS Name: SSN
Input character set: 0123456789
Output character set: 0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ
Passthrough: - (dash & space)
Min Input Length: 9
Max Input Length: 9

d. Once you have completed all entries, then select Save to continue. You will then see your unpublished Field Format Specification.

24702470

e. Review and if correct, then click the three dots and select Publish. You will then see your published Field Format Specification.

25382538

3. Assign Field Format Specifications (FFS) to your Application.

a. With the Dashboard Left Menu, Navigate to My Applications.

19201920

b. Select the Application for which you would like to assign one, or more, FFS's to and click the three dots on the right side of the row for that application. A Pop-Up menu will appear where you select Link Field Format Specifications:

22242224

c. A new window will appear where you can select one, or more, FFS's to associate with your Application. Press Update prior to exiting.

25982598

4. Make sure to download the latest FPE/eFPE enabled Ubiq Developer Client Libraries and related Sample Applications.

5. Review the README.md files.

6. Start API-based application-level encrypting and decrypting with eFPE.

Congratulations! You are now ready to start encrypting and decrypting with the eFPE enabled Ubiq Client Libraries integrated into your Application and using the configured Field Format Specifications.