Skip to main content
Delphix

How to Export and Import Security Key Between Masking Engines to Sync Algorithms (KBA7722)

 

KBA

KBA# 7722

Applicable Delphix Versions

Click here to view the versions of the Delphix engine to which this article applies
Major Release All Sub Releases
6.0 6.0.0.0, 6.0.1.0, 6.0.1.1, 6.0.2.0, 6.0.2.1, 6.0.3.0, 6.0.3.1, 6.0.4.0, 6.0.4.1, 6.0.4.2, 6.0.5.0, 6.0.6.0, 6.0.6.1, 6.0.7.0, 6.0.8.0, 6.0.8.1

5.3

5.3.0.0, 5.3.0.1, 5.3.0.2, 5.3.0.3, 5.3.1.0, 5.3.1.1, 5.3.1.2, 5.3.2.0, 5.3.3.0, 5.3.3.1, 5.3.4.0, 5.3.5.0, 5.3.6.0, 5.3.7.0, 5.3.7.1, 5.3.8.0, 5.3.8.1, 5.3.9.0

5.2

5.2.5.0, 5.2.5.1, 5.2.6.0, 5.2.6.1

How to Task

When you need to sync algorithms between masking engines ensure that all the masking engines have the same global security key. In case of a mismatch of key-value on any of the engines, you need to import the correct key from the other engines.

Prerequisites

Identify the masking engine having a different security key. 

Exporting and Importing the masking key

To export and import the correct security key to the affected engine, complete the following procedure:

  1. Login to the api-client of the masking engine with the correct key using http://MASKING_ENGINE.com:8282/masking/api-client for older versions and http://MASKING_ENGINE.com/masking/api-client for newer versions.
     
  2. Scroll down until you see the login option:
    clipboard_e6bfe0030e4c1ab7a123e0383ab9d6acb.png
     
  3. Login with a masking engine user id and password on the POST /login and click Try it out or Execute API Request.Screenshot 2021-06-02 at 10.12.43 AM.png
  4. If the login is successful, an authorization code is displayed. Copy the authorization code and return to the top of the screen. Paste the authorization key into the value box, then click Authorize.

     clipboard_e2bfaeb49ffce07f1c42519c0acecbc01.png 

    .clipboard_e8fb3529d778f7e0426a606c7ad590d77.png
  5. Back up the object Key
    1. Navigate to sync and perform a get /syncable-objects and click Try it now or Execute API Request
    2. Scroll down to the response body and select the text for "ObjectIdentifier":"KeyId".                                                                                                                                                     clipboard_eed8546c1f44f61a48a74ced2504ac3e7.png
    3. Use the object Identifier code obtained in the previous step to export the masking key. Paste the selected text from the previous text into POST /export body block and
      execute the API request
      Screenshot 2021-06-02 at 10.20.26 AM.png
    4. Successful execution of POST will produce a response code of 200 . Copy the Response Body output and save it in a text file
       
      clipboard_ed9a1736485930278c1f03fd4091693f4.png
       
  6. Login to the api-client for the making engine which has the incorrect key. To login follow step 1-4 on the engine with the incorrect key.
  7. Navigate to sync and select POST /import . Paste the contents of step 5d in the body field of /import, and then execute the API request.clipboard_e717b174ebd1f46e4eeb339922243cc2f.png
  8. You can validate if the right key has been fetched by following step 5 (a) and comparing the revision hash value.

 

Related Articles

The following articles may provide more information or related information to this article:

https://maskingdocs.delphix.com/Managing_Multiple_Engines_for_Masking/Key_Management/