Encryption of PII data in Sunbird

[thillaibirla]

Hi,

We would need the documentation around the encryption of PII data in Sunbird, can you pls point us to the right documentation.

Thanks,
Thillai.

[mohitga]

Hi @thillaibirla

Here is how you can PII data encryption in Sunbird.

To set up PII data encryption in Sunbird, follow these steps:
Execute the CURL command to download the "Decryption Tool" from the provided link:

curl --location --request POST '{{host}}/api/data/v1/system/settings/set' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{api_key}}' \
--header 'x-authenticated-user-token: {{user_token}}' \
--data-raw '{
"request": {
"id": "decryptionToolLink",
"field": "decryptionToolLink",
"value": "{\"link\":\"<link to download decryption tool>\", \"Comments\": \"To use this tool, run the command with encrypted file and key to decrypt\"}"
}
}'
Set up the default 'Data Security Policy' settings using the tenant preference API:
curl --location --request POST '{{host}}/api/org/v2/preferences/create' \
--header 'x-authenticated-user-token: {{user_authentication_token}}' \
--header 'Authorization: Bearer {{kong_api_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"request": {
"orgId": "default",
"key": "dataSecurityPolicy",
"data": {
"level": "PLAIN_DATASET",
"dataEncrypted": "No",
"comments": "Data is not encrypted",
"job": {
"userinfo-exhaust": {
"level": "PASSWORD_PROTECTED_DATASET",
"dataEncrypted": "No",
"comments": "Password protected file."
}
},
"securityLevels": {
"PLAIN_DATASET": "Data is present in plain text/zip. Generally applicable to open datasets.",
"PASSWORD_PROTECTED_DATASET": "Password protected zip file. Generally applicable to non PII data sets but can contain sensitive information which may not be considered open.",
"TEXT_KEY_ENCRYPTED_DATASET": "Data encrypted with a user provided encryption key. Generally applicable to non PII data but can contain sensitive information which may not be considered open.",
"PUBLIC_KEY_ENCRYPTED_DATASET": "Data encrypted via an org provided public/private key. Generally applicable to all PII data exhaust."
}
}
}
}'
Set up the default 'PII data security settings' using the tenant preference API:
curl --location --request POST '{{host}}/api/org/v2/preferences/create' \
--header 'x-authenticated-user-token: {{user_authentication_token}}' \
--header 'Authorization: Bearer {{kong_api_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"request": {
"orgId": "default",
"key": "userPrivateFields",
"data": {
"PIIFields": [
"email",
"phone",
"userName",
"prevUsedEmail",
"prevUsedPhone",
"recoveryEmail",
"recoveryPhone"
]
}
}
}'

Configure tenant-specific 'Data Security Policy' settings using the tenant preference create API.
Upload the public PEM key file for "PUBLIC_KEY_ENCRYPTED_DATASET" security configuration using the update encryption key API.
Please note that the provided commands and placeholders need to be replaced with the actual values specific to your Sunbird installation.

for further details have a look at 5.3.0 release Note

[mohitga]

@thillaibirla let us know if above provided information has helped and answered your query.

[mohitga]

@thillaibirla, marking the thread as answered, Please feel free to open the thread again if you any query on the same.