Encryption of sensitive data #194
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,167 @@ | ||
| 'use strict'; | ||
|
|
||
| /** | ||
| * Encrypt existing plaintext values in user fields: firstName, lastName, email, initialPassword. | ||
| * Also populates emailHash from the newly encrypted email value. | ||
| * | ||
| * Requires DB_ENCRYPTION_KEY to be set in the environment. | ||
| * Skips rows where the field already appears encrypted (safe to re-run). | ||
| */ | ||
|
|
||
| const { encrypt, getKey, initializeEncryptionKey, decrypt } = require('../../utils/helper/encryption'); | ||
|
|
||
| module.exports = { | ||
| async up(queryInterface) { | ||
|
Collaborator
There was a problem hiding this comment. The |
||
| const isEncryptionEnabled = process.env.ENCRYPTION_ENABLED === 'true'; | ||
| if (!isEncryptionEnabled) { | ||
| return; | ||
| } | ||
| initializeEncryptionKey(); | ||
| const encryptionKey = getKey(); | ||
| if (!encryptionKey) { | ||
| throw new Error( | ||
| 'DB_ENCRYPTION_KEY must be set before running the user encryption data migration' | ||
| ); | ||
| } | ||
|
|
||
| const transaction = await queryInterface.sequelize.transaction(); | ||
| try { | ||
| const users = await queryInterface.sequelize.query( | ||
| `SELECT id, "firstName", "lastName", email, "initialPassword", "twoFactorOtp", "totpSecret", "orcidId", "ldapUsername", "samlNameId", "salt" FROM "user"`, | ||
| { type: queryInterface.sequelize.QueryTypes.SELECT, transaction } | ||
| ); | ||
|
|
||
| for (const user of users) { | ||
| const updates = {}; | ||
|
|
||
| if (user.firstName) { | ||
| updates.firstName = encrypt(user.firstName); | ||
| } | ||
| if (user.lastName) { | ||
| updates.lastName = encrypt(user.lastName); | ||
| } | ||
| if (user.email) { | ||
| const encryptedEmail = encrypt(user.email); | ||
| updates.email = encryptedEmail; | ||
| } | ||
| if (user.initialPassword) { | ||
| updates.initialPassword = encrypt(user.initialPassword); | ||
| } | ||
| if (user.twoFactorOtp) { | ||
| updates.twoFactorOtp = encrypt(user.twoFactorOtp); | ||
| } | ||
| if (user.totpSecret) { | ||
| updates.totpSecret = encrypt(user.totpSecret); | ||
| } | ||
| if (user.orcidId) { | ||
| updates.orcidId = encrypt(user.orcidId); | ||
| } | ||
| if (user.ldapUsername) { | ||
| updates.ldapUsername = encrypt(user.ldapUsername); | ||
| } | ||
| if (user.samlNameId) { | ||
| updates.samlNameId = encrypt(user.samlNameId); | ||
| } | ||
| if (user.salt) { | ||
| updates.salt = encrypt(user.salt); | ||
| } | ||
|
|
||
| if (Object.keys(updates).length > 0) { | ||
| const setClauses = Object.keys(updates) | ||
| .map(col => `"${col}" = :${col}`) | ||
| .join(', '); | ||
|
|
||
| await queryInterface.sequelize.query( | ||
| `UPDATE "user" SET ${setClauses} WHERE id = :id`, | ||
| { | ||
| replacements: { ...updates, id: user.id }, | ||
| transaction, | ||
| } | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| await transaction.commit(); | ||
| } catch (err) { | ||
| await transaction.rollback(); | ||
| throw err; | ||
| } | ||
| }, | ||
|
|
||
| async down(queryInterface) { | ||
| const isEncryptionEnabled = process.env.ENCRYPTION_ENABLED === 'true'; | ||
| if (!isEncryptionEnabled) { | ||
| return; | ||
| } | ||
| initializeEncryptionKey(); | ||
| const encryptionKey = getKey(); | ||
| if (!encryptionKey) { | ||
| throw new Error( | ||
| 'DB_ENCRYPTION_KEY must be set before running the user encryption data migration' | ||
| ); | ||
| } | ||
|
|
||
| const transaction = await queryInterface.sequelize.transaction(); | ||
| try { | ||
| const users = await queryInterface.sequelize.query( | ||
| `SELECT id, "firstName", "lastName", email, "initialPassword", "twoFactorOtp", "totpSecret", "orcidId", "ldapUsername", "samlNameId", "salt" FROM "user"`, | ||
| { type: queryInterface.sequelize.QueryTypes.SELECT, transaction } | ||
| ); | ||
|
|
||
| for (const user of users) { | ||
| const updates = {}; | ||
|
|
||
| if (user.firstName) { | ||
| updates.firstName = decrypt(user.firstName); | ||
| } | ||
| if (user.lastName) { | ||
| updates.lastName = decrypt(user.lastName); | ||
| } | ||
| if (user.email) { | ||
| const decryptedEmail = decrypt(user.email); | ||
| updates.email = decryptedEmail; | ||
| } | ||
| if (user.initialPassword) { | ||
| updates.initialPassword = decrypt(user.initialPassword); | ||
| } | ||
| if (user.twoFactorOtp) { | ||
| updates.twoFactorOtp = decrypt(user.twoFactorOtp); | ||
| } | ||
| if (user.totpSecret) { | ||
| updates.totpSecret = decrypt(user.totpSecret); | ||
| } | ||
| if (user.orcidId) { | ||
| updates.orcidId = decrypt(user.orcidId); | ||
| } | ||
| if (user.ldapUsername) { | ||
| updates.ldapUsername = decrypt(user.ldapUsername); | ||
| } | ||
| if (user.samlNameId) { | ||
| updates.samlNameId = decrypt(user.samlNameId); | ||
| } | ||
| if (user.salt) { | ||
| updates.salt = decrypt(user.salt); | ||
| } | ||
|
|
||
| if (Object.keys(updates).length > 0) { | ||
| const setClauses = Object.keys(updates) | ||
| .map(col => `"${col}" = :${col}`) | ||
| .join(', '); | ||
|
|
||
| await queryInterface.sequelize.query( | ||
| `UPDATE "user" SET ${setClauses} WHERE id = :id`, | ||
| { | ||
| replacements: { ...updates, id: user.id }, | ||
| transaction, | ||
| } | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| await transaction.commit(); | ||
| } catch (err) { | ||
| await transaction.rollback(); | ||
| throw err; | ||
| } | ||
| }, | ||
| }; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.