/* This module is operating on raw user passwords. Be very defensive. Pay special attention when passing the password or even a hash/prefix around. We need to ensure that no parts of it get logged or returned on either the happy path or via an error (message or attributes). */ const { callbackify } = require('util') const { fetchString } = require('@overleaf/fetch-utils') const crypto = require('crypto') const Settings = require('@overleaf/settings') const Metrics = require('@overleaf/metrics') const logger = require('@overleaf/logger') const HEX_CHARS_UPPER = '1234567890ABCDEF' const API_ERROR = new Error('cannot contact HaveIBeenPwned api') const INVALID_PREFIX = new Error( 'This is not a valid hex prefix. Rejecting to pass it to HaveIBeenPwned' ) const INVALID_RESPONSE = new Error('cannot consume HaveIBeenPwned api response') const INVALID_SCORE = new Error( 'non integer score returned by HaveIBeenPwned api' ) const CODED_ERROR_MESSAGES = [ API_ERROR, INVALID_PREFIX, INVALID_RESPONSE, INVALID_SCORE, ].map(err => err.message) async function getScoresForPrefix(prefix) { if ( typeof prefix !== 'string' || prefix.length !== 5 || Array.from(prefix).some(c => !HEX_CHARS_UPPER.includes(c)) ) { // Make sure we do not pass arbitrary objects to the api. throw INVALID_PREFIX } try { return await fetchString( `${Settings.apis.haveIBeenPwned.url}/range/${prefix}`, { headers: { 'User-Agent': 'www.overleaf.com', // Docs: https://haveibeenpwned.com/API/v3#PwnedPasswordsPadding 'Add-Padding': true, }, signal: AbortSignal.timeout(Settings.apis.haveIBeenPwned.timeout), } ) } catch (_errorWithPotentialReferenceToPrefix) { // NOTE: Do not leak request details by passing the original error up. throw API_ERROR } } async function isPasswordReused(password) { const sha1 = crypto .createHash('sha1') .update(password) .digest('hex') .toUpperCase() const prefix = sha1.slice(0, 5) const body = await getScoresForPrefix(prefix) let score = 0 try { for (const line of body.split('\r\n')) { const [candidate, scoreRaw] = line.split(':') if (prefix + candidate === sha1) { score = parseInt(scoreRaw) break } } } catch (_errorWithPotentialReferenceToHash) { // NOTE: Do not leak password details by logging the original error. throw INVALID_RESPONSE } if (Number.isNaN(score)) { // NOTE: Do not leak password details by logging the score. throw INVALID_SCORE } return score > 0 } async function checkPasswordForReuse(password) { if (!Settings.apis.haveIBeenPwned.enabled) { return } try { const isReused = await isPasswordReused(password) Metrics.inc('password_re_use', { status: isReused ? 're-used' : 'unique', }) return isReused } catch (err) { let error = err // Make sure we do not leak any password details. if (!CODED_ERROR_MESSAGES.includes(err.message)) { error = new Error('hidden message') } error = new Error(error.message) Metrics.inc('password_re_use', { status: 'failure' }) throw error } } function checkPasswordForReuseInBackground(password) { checkPasswordForReuse(password).catch(error => { logger.err({ error }, 'cannot check password for re-use') }) } module.exports = { checkPasswordForReuse: callbackify(checkPasswordForReuse), checkPasswordForReuseInBackground, promises: { checkPasswordForReuse, }, }