267 lines
11 KiB
JavaScript
267 lines
11 KiB
JavaScript
"use strict";
|
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
exports.ScramSHA256 = exports.ScramSHA1 = void 0;
|
|
const saslprep_1 = require("@mongodb-js/saslprep");
|
|
const bson_1 = require("../../bson");
|
|
const error_1 = require("../../error");
|
|
const utils_1 = require("../../utils");
|
|
const auth_provider_1 = require("./auth_provider");
|
|
const providers_1 = require("./providers");
|
|
class ScramSHA extends auth_provider_1.AuthProvider {
|
|
constructor(cryptoMethod) {
|
|
super();
|
|
this.cryptoMethod = cryptoMethod || 'sha1';
|
|
}
|
|
async prepare(handshakeDoc, authContext) {
|
|
const cryptoMethod = this.cryptoMethod;
|
|
const credentials = authContext.credentials;
|
|
if (!credentials) {
|
|
throw new error_1.MongoMissingCredentialsError('AuthContext must provide credentials.');
|
|
}
|
|
const nonce = await (0, utils_1.randomBytes)(24);
|
|
// store the nonce for later use
|
|
authContext.nonce = nonce;
|
|
const request = {
|
|
...handshakeDoc,
|
|
speculativeAuthenticate: {
|
|
...makeFirstMessage(cryptoMethod, credentials, nonce),
|
|
db: credentials.source
|
|
}
|
|
};
|
|
return request;
|
|
}
|
|
async auth(authContext) {
|
|
const { reauthenticating, response } = authContext;
|
|
if (response?.speculativeAuthenticate && !reauthenticating) {
|
|
return await continueScramConversation(this.cryptoMethod, response.speculativeAuthenticate, authContext);
|
|
}
|
|
return await executeScram(this.cryptoMethod, authContext);
|
|
}
|
|
}
|
|
function cleanUsername(username) {
|
|
return username.replace('=', '=3D').replace(',', '=2C');
|
|
}
|
|
function clientFirstMessageBare(username, nonce) {
|
|
// NOTE: This is done b/c Javascript uses UTF-16, but the server is hashing in UTF-8.
|
|
// Since the username is not sasl-prep-d, we need to do this here.
|
|
return bson_1.ByteUtils.concat([
|
|
bson_1.ByteUtils.fromUTF8('n='),
|
|
bson_1.ByteUtils.fromUTF8(username),
|
|
bson_1.ByteUtils.fromUTF8(',r='),
|
|
bson_1.ByteUtils.fromUTF8(bson_1.ByteUtils.toBase64(nonce))
|
|
]);
|
|
}
|
|
function makeFirstMessage(cryptoMethod, credentials, nonce) {
|
|
const username = cleanUsername(credentials.username);
|
|
const mechanism = cryptoMethod === 'sha1' ? providers_1.AuthMechanism.MONGODB_SCRAM_SHA1 : providers_1.AuthMechanism.MONGODB_SCRAM_SHA256;
|
|
// NOTE: This is done b/c Javascript uses UTF-16, but the server is hashing in UTF-8.
|
|
// Since the username is not sasl-prep-d, we need to do this here.
|
|
return {
|
|
saslStart: 1,
|
|
mechanism,
|
|
payload: new bson_1.Binary(bson_1.ByteUtils.concat([bson_1.ByteUtils.fromUTF8('n,,'), clientFirstMessageBare(username, nonce)])),
|
|
autoAuthorize: 1,
|
|
options: { skipEmptyExchange: true }
|
|
};
|
|
}
|
|
async function executeScram(cryptoMethod, authContext) {
|
|
const { connection, credentials } = authContext;
|
|
if (!credentials) {
|
|
throw new error_1.MongoMissingCredentialsError('AuthContext must provide credentials.');
|
|
}
|
|
if (!authContext.nonce) {
|
|
throw new error_1.MongoInvalidArgumentError('AuthContext must contain a valid nonce property');
|
|
}
|
|
const nonce = authContext.nonce;
|
|
const db = credentials.source;
|
|
const saslStartCmd = makeFirstMessage(cryptoMethod, credentials, nonce);
|
|
const response = await connection.command((0, utils_1.ns)(`${db}.$cmd`), saslStartCmd, undefined);
|
|
await continueScramConversation(cryptoMethod, response, authContext);
|
|
}
|
|
async function continueScramConversation(cryptoMethod, response, authContext) {
|
|
const connection = authContext.connection;
|
|
const credentials = authContext.credentials;
|
|
if (!credentials) {
|
|
throw new error_1.MongoMissingCredentialsError('AuthContext must provide credentials.');
|
|
}
|
|
if (!authContext.nonce) {
|
|
throw new error_1.MongoInvalidArgumentError('Unable to continue SCRAM without valid nonce');
|
|
}
|
|
const nonce = authContext.nonce;
|
|
const db = credentials.source;
|
|
const username = cleanUsername(credentials.username);
|
|
const password = credentials.password;
|
|
const processedPassword = cryptoMethod === 'sha256' ? (0, saslprep_1.saslprep)(password) : passwordDigest(username, password);
|
|
const payload = bson_1.ByteUtils.isUint8Array(response.payload)
|
|
? new bson_1.Binary(response.payload)
|
|
: response.payload;
|
|
const dict = parsePayload(payload);
|
|
const iterations = parseInt(dict.i, 10);
|
|
if (iterations && iterations < 4096) {
|
|
// TODO(NODE-3483)
|
|
throw new error_1.MongoRuntimeError(`Server returned an invalid iteration count ${iterations}`);
|
|
}
|
|
const salt = dict.s;
|
|
const rnonce = dict.r;
|
|
if (rnonce.startsWith('nonce')) {
|
|
// TODO(NODE-3483)
|
|
throw new error_1.MongoRuntimeError(`Server returned an invalid nonce: ${rnonce}`);
|
|
}
|
|
// Set up start of proof
|
|
const withoutProof = `c=biws,r=${rnonce}`;
|
|
const saltedPassword = await HI(processedPassword, bson_1.ByteUtils.fromBase64(salt), iterations, cryptoMethod);
|
|
const clientKey = await HMAC(cryptoMethod, saltedPassword, 'Client Key');
|
|
const serverKey = await HMAC(cryptoMethod, saltedPassword, 'Server Key');
|
|
const storedKey = await H(cryptoMethod, clientKey);
|
|
const authMessage = [
|
|
clientFirstMessageBare(username, nonce),
|
|
payload.toString('utf8'),
|
|
withoutProof
|
|
].join(',');
|
|
const clientSignature = await HMAC(cryptoMethod, storedKey, authMessage);
|
|
const clientProof = `p=${xor(clientKey, clientSignature)}`;
|
|
const clientFinal = [withoutProof, clientProof].join(',');
|
|
const serverSignature = await HMAC(cryptoMethod, serverKey, authMessage);
|
|
const saslContinueCmd = {
|
|
saslContinue: 1,
|
|
conversationId: response.conversationId,
|
|
payload: new bson_1.Binary(bson_1.ByteUtils.fromUTF8(clientFinal))
|
|
};
|
|
const r = await connection.command((0, utils_1.ns)(`${db}.$cmd`), saslContinueCmd, undefined);
|
|
const parsedResponse = parsePayload(r.payload);
|
|
if (!compareDigest(bson_1.ByteUtils.fromBase64(parsedResponse.v), serverSignature)) {
|
|
throw new error_1.MongoRuntimeError('Server returned an invalid signature');
|
|
}
|
|
if (r.done !== false) {
|
|
// If the server sends r.done === true we can save one RTT
|
|
return;
|
|
}
|
|
const retrySaslContinueCmd = {
|
|
saslContinue: 1,
|
|
conversationId: r.conversationId,
|
|
payload: bson_1.ByteUtils.allocate(0)
|
|
};
|
|
await connection.command((0, utils_1.ns)(`${db}.$cmd`), retrySaslContinueCmd, undefined);
|
|
}
|
|
function parsePayload(payload) {
|
|
const payloadStr = payload.toString('utf8');
|
|
const dict = {};
|
|
const parts = payloadStr.split(',');
|
|
for (let i = 0; i < parts.length; i++) {
|
|
const valueParts = (parts[i].match(/^([^=]*)=(.*)$/) ?? []).slice(1);
|
|
dict[valueParts[0]] = valueParts[1];
|
|
}
|
|
return dict;
|
|
}
|
|
function passwordDigest(username, password) {
|
|
if (typeof username !== 'string') {
|
|
throw new error_1.MongoInvalidArgumentError('Username must be a string');
|
|
}
|
|
if (typeof password !== 'string') {
|
|
throw new error_1.MongoInvalidArgumentError('Password must be a string');
|
|
}
|
|
if (password.length === 0) {
|
|
throw new error_1.MongoInvalidArgumentError('Password cannot be empty');
|
|
}
|
|
let nodeCrypto;
|
|
try {
|
|
// TODO: NODE-7424 - remove dependency on 'crypto' for SCRAM-SHA-1 authentication
|
|
// eslint-disable-next-line @typescript-eslint/no-require-imports
|
|
nodeCrypto = require('crypto');
|
|
}
|
|
catch (e) {
|
|
throw new error_1.MongoRuntimeError('Node.js crypto module is required for SCRAM-SHA-1 authentication', {
|
|
cause: e
|
|
});
|
|
}
|
|
try {
|
|
const md5 = nodeCrypto.createHash('md5');
|
|
md5.update(`${username}:mongo:${password}`, 'utf8');
|
|
return md5.digest('hex');
|
|
}
|
|
catch (err) {
|
|
if (nodeCrypto.getFips()) {
|
|
// This error is (slightly) more helpful than what comes from OpenSSL directly, e.g.
|
|
// 'Error: error:060800C8:digital envelope routines:EVP_DigestInit_ex:disabled for FIPS'
|
|
throw new Error('Auth mechanism SCRAM-SHA-1 is not supported in FIPS mode');
|
|
}
|
|
throw err;
|
|
}
|
|
}
|
|
// XOR two buffers
|
|
function xor(a, b) {
|
|
const length = Math.max(a.length, b.length);
|
|
const res = [];
|
|
for (let i = 0; i < length; i += 1) {
|
|
res.push(a[i] ^ b[i]);
|
|
}
|
|
return bson_1.ByteUtils.toBase64(bson_1.ByteUtils.fromNumberArray(res));
|
|
}
|
|
async function H(method, text) {
|
|
const buffer = await crypto.subtle.digest(method === 'sha256' ? 'SHA-256' : 'SHA-1', text);
|
|
return new Uint8Array(buffer);
|
|
}
|
|
async function HMAC(method, key, text) {
|
|
const keyBuffer = bson_1.ByteUtils.toLocalBufferType(key);
|
|
const cryptoKey = await crypto.subtle.importKey('raw', keyBuffer, { name: 'HMAC', hash: { name: method === 'sha256' ? 'SHA-256' : 'SHA-1' } }, false, ['sign', 'verify']);
|
|
const textData = typeof text === 'string' ? new TextEncoder().encode(text) : text;
|
|
const textBuffer = bson_1.ByteUtils.toLocalBufferType(textData);
|
|
const signature = await crypto.subtle.sign('HMAC', cryptoKey, textBuffer);
|
|
return new Uint8Array(signature);
|
|
}
|
|
let _hiCache = {};
|
|
let _hiCacheCount = 0;
|
|
function _hiCachePurge() {
|
|
_hiCache = {};
|
|
_hiCacheCount = 0;
|
|
}
|
|
const hiLengthMap = {
|
|
sha256: 32,
|
|
sha1: 20
|
|
};
|
|
async function HI(data, salt, iterations, cryptoMethod) {
|
|
// omit the work if already generated
|
|
const key = [data, bson_1.ByteUtils.toBase64(salt), iterations].join('_');
|
|
if (_hiCache[key] != null) {
|
|
return _hiCache[key];
|
|
}
|
|
const keyMaterial = await crypto.subtle.importKey('raw', new TextEncoder().encode(data), { name: 'PBKDF2' }, false, ['deriveBits']);
|
|
const params = {
|
|
name: 'PBKDF2',
|
|
salt: salt,
|
|
iterations: iterations,
|
|
hash: { name: cryptoMethod === 'sha256' ? 'SHA-256' : 'SHA-1' }
|
|
};
|
|
const derivedBits = await crypto.subtle.deriveBits(params, keyMaterial, hiLengthMap[cryptoMethod] * 8);
|
|
const saltedData = new Uint8Array(derivedBits);
|
|
// cache a copy to speed up the next lookup, but prevent unbounded cache growth
|
|
if (_hiCacheCount >= 200) {
|
|
_hiCachePurge();
|
|
}
|
|
_hiCache[key] = saltedData;
|
|
_hiCacheCount += 1;
|
|
return saltedData;
|
|
}
|
|
function compareDigest(lhs, rhs) {
|
|
if (lhs.length !== rhs.length) {
|
|
return false;
|
|
}
|
|
let result = 0;
|
|
for (let i = 0; i < lhs.length; i++) {
|
|
result |= lhs[i] ^ rhs[i];
|
|
}
|
|
return result === 0;
|
|
}
|
|
class ScramSHA1 extends ScramSHA {
|
|
constructor() {
|
|
super('sha1');
|
|
}
|
|
}
|
|
exports.ScramSHA1 = ScramSHA1;
|
|
class ScramSHA256 extends ScramSHA {
|
|
constructor() {
|
|
super('sha256');
|
|
}
|
|
}
|
|
exports.ScramSHA256 = ScramSHA256;
|
|
//# sourceMappingURL=scram.js.map
|