connect.js 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390
  1. "use strict";
  2. Object.defineProperty(exports, "__esModule", { value: true });
  3. exports.LEGAL_TCP_SOCKET_OPTIONS = exports.LEGAL_TLS_SOCKET_OPTIONS = exports.prepareHandshakeDocument = exports.connect = exports.AUTH_PROVIDERS = void 0;
  4. const net = require("net");
  5. const tls = require("tls");
  6. const constants_1 = require("../constants");
  7. const deps_1 = require("../deps");
  8. const error_1 = require("../error");
  9. const utils_1 = require("../utils");
  10. const auth_provider_1 = require("./auth/auth_provider");
  11. const gssapi_1 = require("./auth/gssapi");
  12. const mongocr_1 = require("./auth/mongocr");
  13. const mongodb_aws_1 = require("./auth/mongodb_aws");
  14. const mongodb_oidc_1 = require("./auth/mongodb_oidc");
  15. const plain_1 = require("./auth/plain");
  16. const providers_1 = require("./auth/providers");
  17. const scram_1 = require("./auth/scram");
  18. const x509_1 = require("./auth/x509");
  19. const connection_1 = require("./connection");
  20. const constants_2 = require("./wire_protocol/constants");
  21. /** @internal */
  22. exports.AUTH_PROVIDERS = new Map([
  23. [providers_1.AuthMechanism.MONGODB_AWS, new mongodb_aws_1.MongoDBAWS()],
  24. [providers_1.AuthMechanism.MONGODB_CR, new mongocr_1.MongoCR()],
  25. [providers_1.AuthMechanism.MONGODB_GSSAPI, new gssapi_1.GSSAPI()],
  26. [providers_1.AuthMechanism.MONGODB_OIDC, new mongodb_oidc_1.MongoDBOIDC()],
  27. [providers_1.AuthMechanism.MONGODB_PLAIN, new plain_1.Plain()],
  28. [providers_1.AuthMechanism.MONGODB_SCRAM_SHA1, new scram_1.ScramSHA1()],
  29. [providers_1.AuthMechanism.MONGODB_SCRAM_SHA256, new scram_1.ScramSHA256()],
  30. [providers_1.AuthMechanism.MONGODB_X509, new x509_1.X509()]
  31. ]);
  32. function connect(options, callback) {
  33. makeConnection({ ...options, existingSocket: undefined }, (err, socket) => {
  34. if (err || !socket) {
  35. return callback(err);
  36. }
  37. let ConnectionType = options.connectionType ?? connection_1.Connection;
  38. if (options.autoEncrypter) {
  39. ConnectionType = connection_1.CryptoConnection;
  40. }
  41. const connection = new ConnectionType(socket, options);
  42. performInitialHandshake(connection, options).then(() => callback(undefined, connection), error => {
  43. connection.destroy({ force: false });
  44. callback(error);
  45. });
  46. });
  47. }
  48. exports.connect = connect;
  49. function checkSupportedServer(hello, options) {
  50. const maxWireVersion = Number(hello.maxWireVersion);
  51. const minWireVersion = Number(hello.minWireVersion);
  52. const serverVersionHighEnough = !Number.isNaN(maxWireVersion) && maxWireVersion >= constants_2.MIN_SUPPORTED_WIRE_VERSION;
  53. const serverVersionLowEnough = !Number.isNaN(minWireVersion) && minWireVersion <= constants_2.MAX_SUPPORTED_WIRE_VERSION;
  54. if (serverVersionHighEnough) {
  55. if (serverVersionLowEnough) {
  56. return null;
  57. }
  58. const message = `Server at ${options.hostAddress} reports minimum wire version ${JSON.stringify(hello.minWireVersion)}, but this version of the Node.js Driver requires at most ${constants_2.MAX_SUPPORTED_WIRE_VERSION} (MongoDB ${constants_2.MAX_SUPPORTED_SERVER_VERSION})`;
  59. return new error_1.MongoCompatibilityError(message);
  60. }
  61. const message = `Server at ${options.hostAddress} reports maximum wire version ${JSON.stringify(hello.maxWireVersion) ?? 0}, but this version of the Node.js Driver requires at least ${constants_2.MIN_SUPPORTED_WIRE_VERSION} (MongoDB ${constants_2.MIN_SUPPORTED_SERVER_VERSION})`;
  62. return new error_1.MongoCompatibilityError(message);
  63. }
  64. async function performInitialHandshake(conn, options) {
  65. const credentials = options.credentials;
  66. if (credentials) {
  67. if (!(credentials.mechanism === providers_1.AuthMechanism.MONGODB_DEFAULT) &&
  68. !exports.AUTH_PROVIDERS.get(credentials.mechanism)) {
  69. throw new error_1.MongoInvalidArgumentError(`AuthMechanism '${credentials.mechanism}' not supported`);
  70. }
  71. }
  72. const authContext = new auth_provider_1.AuthContext(conn, credentials, options);
  73. conn.authContext = authContext;
  74. const handshakeDoc = await prepareHandshakeDocument(authContext);
  75. // @ts-expect-error: TODO(NODE-5141): The options need to be filtered properly, Connection options differ from Command options
  76. const handshakeOptions = { ...options };
  77. if (typeof options.connectTimeoutMS === 'number') {
  78. // The handshake technically is a monitoring check, so its socket timeout should be connectTimeoutMS
  79. handshakeOptions.socketTimeoutMS = options.connectTimeoutMS;
  80. }
  81. const start = new Date().getTime();
  82. const response = await conn.commandAsync((0, utils_1.ns)('admin.$cmd'), handshakeDoc, handshakeOptions);
  83. if (!('isWritablePrimary' in response)) {
  84. // Provide hello-style response document.
  85. response.isWritablePrimary = response[constants_1.LEGACY_HELLO_COMMAND];
  86. }
  87. if (response.helloOk) {
  88. conn.helloOk = true;
  89. }
  90. const supportedServerErr = checkSupportedServer(response, options);
  91. if (supportedServerErr) {
  92. throw supportedServerErr;
  93. }
  94. if (options.loadBalanced) {
  95. if (!response.serviceId) {
  96. throw new error_1.MongoCompatibilityError('Driver attempted to initialize in load balancing mode, ' +
  97. 'but the server does not support this mode.');
  98. }
  99. }
  100. // NOTE: This is metadata attached to the connection while porting away from
  101. // handshake being done in the `Server` class. Likely, it should be
  102. // relocated, or at very least restructured.
  103. conn.hello = response;
  104. conn.lastHelloMS = new Date().getTime() - start;
  105. if (!response.arbiterOnly && credentials) {
  106. // store the response on auth context
  107. authContext.response = response;
  108. const resolvedCredentials = credentials.resolveAuthMechanism(response);
  109. const provider = exports.AUTH_PROVIDERS.get(resolvedCredentials.mechanism);
  110. if (!provider) {
  111. throw new error_1.MongoInvalidArgumentError(`No AuthProvider for ${resolvedCredentials.mechanism} defined.`);
  112. }
  113. try {
  114. await provider.auth(authContext);
  115. }
  116. catch (error) {
  117. if (error instanceof error_1.MongoError) {
  118. error.addErrorLabel(error_1.MongoErrorLabel.HandshakeError);
  119. if ((0, error_1.needsRetryableWriteLabel)(error, response.maxWireVersion)) {
  120. error.addErrorLabel(error_1.MongoErrorLabel.RetryableWriteError);
  121. }
  122. }
  123. throw error;
  124. }
  125. }
  126. }
  127. /**
  128. * @internal
  129. *
  130. * This function is only exposed for testing purposes.
  131. */
  132. async function prepareHandshakeDocument(authContext) {
  133. const options = authContext.options;
  134. const compressors = options.compressors ? options.compressors : [];
  135. const { serverApi } = authContext.connection;
  136. const handshakeDoc = {
  137. [serverApi?.version ? 'hello' : constants_1.LEGACY_HELLO_COMMAND]: 1,
  138. helloOk: true,
  139. client: options.metadata,
  140. compression: compressors
  141. };
  142. if (options.loadBalanced === true) {
  143. handshakeDoc.loadBalanced = true;
  144. }
  145. const credentials = authContext.credentials;
  146. if (credentials) {
  147. if (credentials.mechanism === providers_1.AuthMechanism.MONGODB_DEFAULT && credentials.username) {
  148. handshakeDoc.saslSupportedMechs = `${credentials.source}.${credentials.username}`;
  149. const provider = exports.AUTH_PROVIDERS.get(providers_1.AuthMechanism.MONGODB_SCRAM_SHA256);
  150. if (!provider) {
  151. // This auth mechanism is always present.
  152. throw new error_1.MongoInvalidArgumentError(`No AuthProvider for ${providers_1.AuthMechanism.MONGODB_SCRAM_SHA256} defined.`);
  153. }
  154. return provider.prepare(handshakeDoc, authContext);
  155. }
  156. const provider = exports.AUTH_PROVIDERS.get(credentials.mechanism);
  157. if (!provider) {
  158. throw new error_1.MongoInvalidArgumentError(`No AuthProvider for ${credentials.mechanism} defined.`);
  159. }
  160. return provider.prepare(handshakeDoc, authContext);
  161. }
  162. return handshakeDoc;
  163. }
  164. exports.prepareHandshakeDocument = prepareHandshakeDocument;
  165. /** @public */
  166. exports.LEGAL_TLS_SOCKET_OPTIONS = [
  167. 'ALPNProtocols',
  168. 'ca',
  169. 'cert',
  170. 'checkServerIdentity',
  171. 'ciphers',
  172. 'crl',
  173. 'ecdhCurve',
  174. 'key',
  175. 'minDHSize',
  176. 'passphrase',
  177. 'pfx',
  178. 'rejectUnauthorized',
  179. 'secureContext',
  180. 'secureProtocol',
  181. 'servername',
  182. 'session'
  183. ];
  184. /** @public */
  185. exports.LEGAL_TCP_SOCKET_OPTIONS = [
  186. 'family',
  187. 'hints',
  188. 'localAddress',
  189. 'localPort',
  190. 'lookup'
  191. ];
  192. function parseConnectOptions(options) {
  193. const hostAddress = options.hostAddress;
  194. if (!hostAddress)
  195. throw new error_1.MongoInvalidArgumentError('Option "hostAddress" is required');
  196. const result = {};
  197. for (const name of exports.LEGAL_TCP_SOCKET_OPTIONS) {
  198. if (options[name] != null) {
  199. result[name] = options[name];
  200. }
  201. }
  202. if (typeof hostAddress.socketPath === 'string') {
  203. result.path = hostAddress.socketPath;
  204. return result;
  205. }
  206. else if (typeof hostAddress.host === 'string') {
  207. result.host = hostAddress.host;
  208. result.port = hostAddress.port;
  209. return result;
  210. }
  211. else {
  212. // This should never happen since we set up HostAddresses
  213. // But if we don't throw here the socket could hang until timeout
  214. // TODO(NODE-3483)
  215. throw new error_1.MongoRuntimeError(`Unexpected HostAddress ${JSON.stringify(hostAddress)}`);
  216. }
  217. }
  218. function parseSslOptions(options) {
  219. const result = parseConnectOptions(options);
  220. // Merge in valid SSL options
  221. for (const name of exports.LEGAL_TLS_SOCKET_OPTIONS) {
  222. if (options[name] != null) {
  223. result[name] = options[name];
  224. }
  225. }
  226. if (options.existingSocket) {
  227. result.socket = options.existingSocket;
  228. }
  229. // Set default sni servername to be the same as host
  230. if (result.servername == null && result.host && !net.isIP(result.host)) {
  231. result.servername = result.host;
  232. }
  233. return result;
  234. }
  235. const SOCKET_ERROR_EVENT_LIST = ['error', 'close', 'timeout', 'parseError'];
  236. const SOCKET_ERROR_EVENTS = new Set(SOCKET_ERROR_EVENT_LIST);
  237. function makeConnection(options, _callback) {
  238. const useTLS = options.tls ?? false;
  239. const noDelay = options.noDelay ?? true;
  240. const connectTimeoutMS = options.connectTimeoutMS ?? 30000;
  241. const rejectUnauthorized = options.rejectUnauthorized ?? true;
  242. const existingSocket = options.existingSocket;
  243. let socket;
  244. const callback = function (err, ret) {
  245. if (err && socket) {
  246. socket.destroy();
  247. }
  248. _callback(err, ret);
  249. };
  250. if (options.proxyHost != null) {
  251. // Currently, only Socks5 is supported.
  252. return makeSocks5Connection({
  253. ...options,
  254. connectTimeoutMS // Should always be present for Socks5
  255. }, callback);
  256. }
  257. if (useTLS) {
  258. const tlsSocket = tls.connect(parseSslOptions(options));
  259. if (typeof tlsSocket.disableRenegotiation === 'function') {
  260. tlsSocket.disableRenegotiation();
  261. }
  262. socket = tlsSocket;
  263. }
  264. else if (existingSocket) {
  265. // In the TLS case, parseSslOptions() sets options.socket to existingSocket,
  266. // so we only need to handle the non-TLS case here (where existingSocket
  267. // gives us all we need out of the box).
  268. socket = existingSocket;
  269. }
  270. else {
  271. socket = net.createConnection(parseConnectOptions(options));
  272. }
  273. socket.setKeepAlive(true, 300000);
  274. socket.setTimeout(connectTimeoutMS);
  275. socket.setNoDelay(noDelay);
  276. const connectEvent = useTLS ? 'secureConnect' : 'connect';
  277. let cancellationHandler;
  278. function errorHandler(eventName) {
  279. return (err) => {
  280. SOCKET_ERROR_EVENTS.forEach(event => socket.removeAllListeners(event));
  281. if (cancellationHandler && options.cancellationToken) {
  282. options.cancellationToken.removeListener('cancel', cancellationHandler);
  283. }
  284. socket.removeListener(connectEvent, connectHandler);
  285. callback(connectionFailureError(eventName, err));
  286. };
  287. }
  288. function connectHandler() {
  289. SOCKET_ERROR_EVENTS.forEach(event => socket.removeAllListeners(event));
  290. if (cancellationHandler && options.cancellationToken) {
  291. options.cancellationToken.removeListener('cancel', cancellationHandler);
  292. }
  293. if ('authorizationError' in socket) {
  294. if (socket.authorizationError && rejectUnauthorized) {
  295. // TODO(NODE-5192): wrap this with a MongoError subclass
  296. return callback(socket.authorizationError);
  297. }
  298. }
  299. socket.setTimeout(0);
  300. callback(undefined, socket);
  301. }
  302. SOCKET_ERROR_EVENTS.forEach(event => socket.once(event, errorHandler(event)));
  303. if (options.cancellationToken) {
  304. cancellationHandler = errorHandler('cancel');
  305. options.cancellationToken.once('cancel', cancellationHandler);
  306. }
  307. if (existingSocket) {
  308. process.nextTick(connectHandler);
  309. }
  310. else {
  311. socket.once(connectEvent, connectHandler);
  312. }
  313. }
  314. let socks = null;
  315. function loadSocks() {
  316. if (socks == null) {
  317. const socksImport = (0, deps_1.getSocks)();
  318. if ('kModuleError' in socksImport) {
  319. throw socksImport.kModuleError;
  320. }
  321. socks = socksImport;
  322. }
  323. return socks;
  324. }
  325. function makeSocks5Connection(options, callback) {
  326. const hostAddress = utils_1.HostAddress.fromHostPort(options.proxyHost ?? '', // proxyHost is guaranteed to set here
  327. options.proxyPort ?? 1080);
  328. // First, connect to the proxy server itself:
  329. makeConnection({
  330. ...options,
  331. hostAddress,
  332. tls: false,
  333. proxyHost: undefined
  334. }, (err, rawSocket) => {
  335. if (err || !rawSocket) {
  336. return callback(err);
  337. }
  338. const destination = parseConnectOptions(options);
  339. if (typeof destination.host !== 'string' || typeof destination.port !== 'number') {
  340. return callback(new error_1.MongoInvalidArgumentError('Can only make Socks5 connections to TCP hosts'));
  341. }
  342. try {
  343. socks ??= loadSocks();
  344. }
  345. catch (error) {
  346. return callback(error);
  347. }
  348. // Then, establish the Socks5 proxy connection:
  349. socks.SocksClient.createConnection({
  350. existing_socket: rawSocket,
  351. timeout: options.connectTimeoutMS,
  352. command: 'connect',
  353. destination: {
  354. host: destination.host,
  355. port: destination.port
  356. },
  357. proxy: {
  358. // host and port are ignored because we pass existing_socket
  359. host: 'iLoveJavaScript',
  360. port: 0,
  361. type: 5,
  362. userId: options.proxyUsername || undefined,
  363. password: options.proxyPassword || undefined
  364. }
  365. }).then(({ socket }) => {
  366. // Finally, now treat the resulting duplex stream as the
  367. // socket over which we send and receive wire protocol messages:
  368. makeConnection({
  369. ...options,
  370. existingSocket: socket,
  371. proxyHost: undefined
  372. }, callback);
  373. }, error => callback(connectionFailureError('error', error)));
  374. });
  375. }
  376. function connectionFailureError(type, err) {
  377. switch (type) {
  378. case 'error':
  379. return new error_1.MongoNetworkError(error_1.MongoError.buildErrorMessage(err), { cause: err });
  380. case 'timeout':
  381. return new error_1.MongoNetworkTimeoutError('connection timed out');
  382. case 'close':
  383. return new error_1.MongoNetworkError('connection closed');
  384. case 'cancel':
  385. return new error_1.MongoNetworkError('connection establishment was cancelled');
  386. default:
  387. return new error_1.MongoNetworkError('unknown network error');
  388. }
  389. }
  390. //# sourceMappingURL=connect.js.map