/ /

Habilitar soporte de proxy SOCKS5

Overview

En esta guía, puedes aprender a conectarte a instancias de MongoDB mediante un proxy SOCKS5. SOCKS5 es un protocolo estandarizado para conectarse a servicios de red a través de un servidor proxy.

Tip

Para obtener más información sobre el protocolo SOCKS5, consulta la entrada en Wikipedia sobre SOCKS.

Instala el paquete socks

A partir de la versión 6.0 del controlador de Node.js, debes instalar el paquete socks para utilizar el soporte de proxy SOCKS5 en tu aplicación. Puedes instalar socks ejecutando el siguiente comando en tu shell:

npm i socks

Opciones del cliente SOCKS5

Puedes configurar opciones en tu instancia de MongoClientOptions o en tu URI de conexión para configurar compatibilidad con proxy SOCKS5 para tu conexión. La siguiente tabla describe las opciones del cliente relacionadas con SOCKS5:

Nombre	Valores permitidos	Valor por defecto	Descripción
proxyHost	string	`null`	Especifica la dirección IPv4, la dirección IPv6 o el nombre de dominio del proxy SOCKS5.
proxyPort	non-negative integer	`null`	Especifica el número de puerto TCP del servidor proxy SOCKS5. Si estableces la opción `proxyHost`, el valor de esta opción se establece por defecto en `1080`.
proxyUsername	string	`null`	Especifica el nombre de usuario para la autenticación en el servidor proxy SOCKS5. Si configuras esta opción en una string de longitud cero, el controlador la ignora.
proxyPassword	string	`null`	Especifica la contraseña para la autenticación al servidor proxy SOCKS5. Si configuras esta opción en una string de longitud cero, el controlador la ignora.

Importante

El controlador arroja un error si estableces las opciones proxyPort, proxyUsername o proxyPassword sin habilitar la opción proxyHost.

Ejemplo

Este ejemplo muestra cómo instanciar un MongoClient que utiliza soporte de proxy SOCKS5. El siguiente código de ejemplo especifica las opciones del servidor proxy y se conecta a MongoDB:

// Replace the placeholder with your connection string
const uri = "<connection string uri>";
// Replace the placeholders with your SOCKS5 proxy server details
const socksOptions = {
  proxyHost: "<host>",
  proxyPort: 1080,
  proxyUsername: "<username>",
  proxyPassword: "<password>",
};
// Create a new client with the proxy server details
const client = new MongoClient(uri, socksOptions);

Tip

El código de muestra anterior utiliza marcadores de posición para el URI de conexión y los detalles del servidor proxy. Para ejecutar este código, debes reemplazar estos marcadores de posición con la información de tu implementación y servidor proxy.

Información Adicional

Para obtener más información sobre el soporte de proxy SOCKS5, consulta la especificación de MongoDB SOCKS5

Documentación de la API

Para obtener más información sobre los métodos y tipos discutidos en esta guía, consulta la siguiente documentación de la API:

Volver

Protocolo de seguridad TLS

Integra con Mongoose