feat(security): RN-1303: Update password storage to use argon2

packages/auth/package.json

@@ -23,6 +23,7 @@
     "test:coverage": "yarn test --coverage"
   },
   "dependencies": {
+    "@node-rs/argon2": "^1.8.3",
     "@tupaia/server-utils": "workspace:*",
     "@tupaia/utils": "workspace:*",
     "jsonwebtoken": "^9.0.0",

packages/auth/src/Authenticator.js

@@ -1,14 +1,14 @@
 /**
  * Tupaia
- * Copyright (c) 2017 - 2020 Beyond Essential Systems Pty Ltd
+ * Copyright (c) 2017 - 2024 Beyond Essential Systems Pty Ltd
  */
 import randomToken from 'rand-token';
 import compareVersions from 'semver-compare';
 
 import { DatabaseError, UnauthenticatedError, UnverifiedError } from '@tupaia/utils';
 import { AccessPolicyBuilder } from './AccessPolicyBuilder';
 import { mergeAccessPolicies } from './mergeAccessPolicies';
-import { encryptPassword } from './utils';
+import { verifyPassword } from './passwordEncryption';
 import { getTokenClaims } from './userAuth';
 
 const REFRESH_TOKEN_LENGTH = 40;
@@ -47,12 +47,11 @@ export class Authenticator {
    * @param {{ username: string, secretKey: string }} apiClientCredentials
    */
   async authenticateApiClient({ username, secretKey }) {
-    const secretKeyHash = encryptPassword(secretKey, process.env.API_CLIENT_SALT);
     const apiClient = await this.models.apiClient.findOne({
       username,
-      secret_key_hash: secretKeyHash,
     });
-    if (!apiClient) {
+    const verified = await verifyPassword(secretKey, apiClient.secret_key_hash);
+    if (!verified) {
       throw new UnauthenticatedError('Could not authenticate Api Client');
     }
     const user = await apiClient.getUser();

packages/auth/src/index.js

@@ -1,11 +1,10 @@
 /**
  * Tupaia
- * Copyright (c) 2017 - 2020 Beyond Essential Systems Pty Ltd
+ * Copyright (c) 2017 - 2024 Beyond Essential Systems Pty Ltd
  */
-
 export { Authenticator } from './Authenticator';
 export { AccessPolicyBuilder } from './AccessPolicyBuilder';
-export * from './utils';
+export { encryptPassword, verifyPassword, sha256EncryptPassword } from './passwordEncryption';
 export { getJwtToken, extractRefreshTokenFromReq, generateSecretKey } from './security';
 export {
   getTokenClaimsFromBearerAuth,

packages/auth/src/passwordEncryption.js

@@ -0,0 +1,35 @@
+/*
+ * Tupaia
+ *  Copyright (c) 2017 - 2024 Beyond Essential Systems Pty Ltd
+ */
+import { hash, verify } from '@node-rs/argon2';
+import sha256 from 'sha256';
+
+/**
+ * Helper function to encrypt passwords using argon2
+ * @param password {string}
+ * @returns {Promise<string>}
+ */
+export function encryptPassword(password) {
+  return hash(password);
+}
+
+/**
+ * Helper function to verify passwords using argon2
+ * @param password
+ * @param hash {string}
+ * @returns {Promise<boolean>}
+ */
+export async function verifyPassword(password, hash) {
+  return verify(hash, password);
+}
+
+/**
+ * Helper function to encrypt passwords using sha256
+ * @param password {string}
+ * @param salt {string}
+ * @returns {string}
+ */
+export function sha256EncryptPassword(password, salt) {
+  return sha256(`${password}${salt}`);
+}

packages/central-server/src/apiV2/changePassword.js

@@ -3,7 +3,7 @@
  * Copyright (c) 2017 Beyond Essential Systems Pty Ltd
  */
 import { DatabaseError, FormValidationError, isValidPassword, respond } from '@tupaia/utils';
-import { hashAndSaltPassword } from '@tupaia/auth';
+import { encryptPassword } from '@tupaia/auth';
 import { allowNoPermissions } from '../permissions';
 
 export async function changePassword(req, res, next) {
@@ -39,7 +39,7 @@ export async function changePassword(req, res, next) {
     if (!isTokenValid) {
       throw new FormValidationError('One time login is invalid');
     }
-  } else if (!user.checkPassword(oldPassword)) {
+  } else if (!(await user.checkPassword(oldPassword))) {
     throw new FormValidationError('Incorrect current password', ['oldPassword']);
   }
 
@@ -53,8 +53,9 @@ export async function changePassword(req, res, next) {
     throw new FormValidationError(error.message, ['password', 'passwordConfirm']);
   }
 
+  const newPasswordHash = await encryptPassword(passwordParam);
   await models.user.updateById(userId, {
-    ...hashAndSaltPassword(passwordParam),
+    password_hash: newPasswordHash,
   });
 
   respond(res, { message: 'Password successfully updated' });

packages/central-server/src/apiV2/import/importUsers.js

@@ -14,10 +14,9 @@ import {
   constructIsOneOf,
   constructIsEmptyOr,
 } from '@tupaia/utils';
-import { hashAndSaltPassword } from '@tupaia/auth';
+import { encryptPassword } from '@tupaia/auth';
 import { VerifiedEmail } from '@tupaia/types';
 import {
-  TUPAIA_ADMIN_PANEL_PERMISSION_GROUP,
   assertAdminPanelAccessToCountry,
   assertAnyPermissions,
   assertBESAdminAccess,
@@ -53,9 +52,11 @@ export async function importUsers(req, res) {
           }
           emails.push(userObject.email);
           const { password, permission_group: permissionGroupName, ...restOfUser } = userObject;
+          const newPasswordHash = await encryptPassword(password);
+
           const userToUpsert = {
             ...restOfUser,
-            ...hashAndSaltPassword(password),
+            password_hash: newPasswordHash,
           };
           const user = await transactingModels.user.updateOrCreate(
             { email: userObject.email },

packages/central-server/src/apiV2/middleware/auth/clientAuth.js

@@ -1,10 +1,9 @@
 /**
- * Tupaia MediTrak
- * Copyright (c) 2017 Beyond Essential Systems Pty Ltd
+ * Tupaia
+ * Copyright (c) 2017 - 2024 Beyond Essential Systems Pty Ltd
  */
-
 import { UnauthenticatedError, requireEnv } from '@tupaia/utils';
-import { encryptPassword, getUserAndPassFromBasicAuth } from '@tupaia/auth';
+import { verifyPassword, getUserAndPassFromBasicAuth } from '@tupaia/auth';
 
 export async function getAPIClientUser(authHeader, models) {
   const { username, password: secretKey } = getUserAndPassFromBasicAuth(authHeader);
@@ -15,12 +14,11 @@ export async function getAPIClientUser(authHeader, models) {
   const API_CLIENT_SALT = requireEnv('API_CLIENT_SALT');
 
   // We always need a valid client; throw if none is found
-  const secretKeyHash = encryptPassword(secretKey, API_CLIENT_SALT);
   const apiClient = await models.apiClient.findOne({
     username,
-    secret_key_hash: secretKeyHash,
   });
-  if (!apiClient) {
+  const verified = await verifyPassword(secretKey, apiClient.secret_key_hash);
+  if (!verified) {
     throw new UnauthenticatedError('Incorrect client username or secret');
   }
   return apiClient.getUser();

packages/central-server/src/apiV2/userAccounts/CreateUserAccounts.js

@@ -1,17 +1,15 @@
-/**
+/*
  * Tupaia
- * Copyright (c) 2017 - 2020 Beyond Essential Systems Pty Ltd
+ *  Copyright (c) 2017 - 2024 Beyond Essential Systems Pty Ltd
  */
 
-import { hashAndSaltPassword, encryptPassword, generateSecretKey } from '@tupaia/auth';
+import { encryptPassword, generateSecretKey } from '@tupaia/auth';
 import { CreateHandler } from '../CreateHandler';
 import {
-  TUPAIA_ADMIN_PANEL_PERMISSION_GROUP,
   assertAdminPanelAccess,
   assertAdminPanelAccessToCountry,
   assertAnyPermissions,
   assertBESAdminAccess,
-  hasTupaiaAdminPanelAccessToCountry,
 } from '../../permissions';
 
 /**
@@ -46,7 +44,7 @@ export class CreateUserAccounts extends CreateHandler {
         await transactingModels.apiClient.create({
           username: user.email,
           user_account_id: user.id,
-          secret_key_hash: encryptPassword(secretKey, process.env.API_CLIENT_SALT),
+          secret_key_hash: await encryptPassword(secretKey),
         });
       }
 
@@ -103,13 +101,15 @@ export class CreateUserAccounts extends CreateHandler {
       ...restOfUser
     },
   ) {
+    const passwordHash = await encryptPassword(password);
+
     return transactingModels.user.create({
       first_name: firstName,
       last_name: lastName,
       email: emailAddress,
       mobile_number: contactNumber,
       primary_platform: primaryPlatform,
-      ...hashAndSaltPassword(password),
+      password_hash: passwordHash,
       verified_email: verifiedEmail,
       ...restOfUser,
     });

packages/central-server/src/apiV2/userAccounts/EditUserAccounts.js

@@ -1,9 +1,9 @@
-/**
+/*
  * Tupaia
- * Copyright (c) 2017 - 2020 Beyond Essential Systems Pty Ltd
+ *  Copyright (c) 2017 - 2024 Beyond Essential Systems Pty Ltd
  */
 
-import { hashAndSaltPassword } from '@tupaia/auth';
+import { encryptPassword } from '@tupaia/auth';
 import { S3Client, S3 } from '@tupaia/server-utils';
 import { EditHandler } from '../EditHandler';
 import {
@@ -49,11 +49,12 @@ export class EditUserAccounts extends EditHandler {
       ...restOfUpdatedFields
     } = this.updatedFields;
     let updatedFields = restOfUpdatedFields;
+    const passwordAndSalt = await encryptPassword(password);
 
     if (password) {
       updatedFields = {
         ...updatedFields,
-        ...hashAndSaltPassword(password),
+        ...passwordAndSalt,
       };
     }
 

packages/central-server/src/apiV2/utilities/emailVerification.js

@@ -1,9 +1,9 @@
 /*
  * Tupaia
- *  Copyright (c) 2017 - 2021 Beyond Essential Systems Pty Ltd
+ *  Copyright (c) 2017 - 2024 Beyond Essential Systems Pty Ltd
  */
 
-import { encryptPassword } from '@tupaia/auth';
+import { encryptPassword, verifyPassword } from '@tupaia/auth';
 import { sendEmail } from '@tupaia/server-utils';
 import { requireEnv } from '@tupaia/utils';
 
@@ -23,8 +23,10 @@ const EMAILS = {
   },
 };
 
+const getEmailVerificationToken = user => `${user.email}${user.password_hash}`;
+
 export const sendEmailVerification = async user => {
-  const token = encryptPassword(user.email + user.password_hash, user.password_salt);
+  const token = await encryptPassword(getEmailVerificationToken(user));
   const platform = user.primary_platform ? user.primary_platform : 'tupaia';
   const { subject, signOff, platformName } = EMAILS[platform];
   const TUPAIA_FRONT_END_URL = requireEnv('TUPAIA_FRONT_END_URL');
@@ -59,5 +61,12 @@ export const verifyEmailHelper = async (models, searchCondition, token) => {
     verified_email: searchCondition,
   });
 
-  return users.find(x => encryptPassword(x.email + x.password_hash, x.password_salt) === token);
+  for (const user of users) {
+    const verified = await verifyPassword(getEmailVerificationToken(user), token);
+
+    if (verified) {
+      return user;
+    }
+  }
+  return null;
 };

packages/central-server/src/dataAccessors/createUser.js

@@ -1,10 +1,10 @@
-/**
- * Tupaia MediTrak
- * Copyright (c) 2017 Beyond Essential Systems Pty Ltd
+/*
+ * Tupaia
+ *  Copyright (c) 2017 - 2024 Beyond Essential Systems Pty Ltd
  */
 
 import { DatabaseError } from '@tupaia/utils';
-import { hashAndSaltPassword, encryptPassword, generateSecretKey } from '@tupaia/auth';
+import { encryptPassword, generateSecretKey } from '@tupaia/auth';
 
 export const createUser = async (
   models,
@@ -39,12 +39,14 @@ export const createUser = async (
         throw new Error(`No such country: ${countryName}`);
       }
 
+      const newPasswordHash = await encryptPassword(password);
+
       const user = await transactingModels.user.create({
         first_name: firstName,
         last_name: lastName,
         email: emailAddress,
         mobile_number: contactNumber,
-        ...hashAndSaltPassword(password),
+        password_hash: newPasswordHash,
         verified_email: verifiedEmail,
         ...restOfUser,
       });
@@ -61,7 +63,7 @@ export const createUser = async (
         await transactingModels.apiClient.create({
           username: user.email,
           user_account_id: user.id,
-          secret_key_hash: encryptPassword(secretKey, process.env.API_CLIENT_SALT),
+          secret_key_hash: await encryptPassword(secretKey),
         });
       }
 

packages/central-server/src/database/models/UserEntityPermission.js

@@ -70,5 +70,5 @@ async function onUpsertSendPermissionGrantEmail(
 async function expireAccess({ new_record: newRecord, old_record: oldRecord }, models) {
   const userId = newRecord?.user_id || oldRecord.user_id;
   const user = await models.user.findById(userId);
-  await user.expireSessionToken('tupaia_web');
+  await user?.expireSessionToken('tupaia_web');
 }