Habilitar e configurar TLS

Visão geral

Neste guia, você verá como usar o protocolo TLS para proteger sua conexão com um MongoDB deployment. Para configurar sua conexão para usar TLS, habilite a opção TLS e forneça seus certificados para validação ao criar um cliente.

Este guia inclui as seguintes seções:

• Habilitar TLS descreve maneiras de habilitar o TLS em sua conexão

• Configurar certificados descreve os certificados necessários para configurar o TLS

• Certificados de Referência em um Cliente fornece um exemplo de como criar uma estrutura Config para configurar suas opções de TLS

• Informações adicionais fornecem links para recursos e documentação da API para os tipos e métodos mencionados neste guia

Habilitar TLS

Você pode habilitar o TLS em uma conexão com sua instância do MongoDB de uma das seguintes maneiras:

• Definindo a opção tls para true em sua connection string

• Passando uma estrutura Config vazia para o método SetTLSConfig() ao criar uma instância ClientOptions

Selecione entre as seguintes abas Connection String e ClientOptions para ver uma amostra de código correspondente:

uri := "mongodb://<hostname>:<port>?tls=true"
opts := options.Client().ApplyURI(uri)
client, _ := mongo.Connect(context.TODO(), opts)

uri := "<connection string>"
opts := options.Client().ApplyURI(uri).SetTLSConfig(&tls.Config{})
client, _ := mongo.Connect(context.TODO(), opts)

Para obter uma lista completa das opções de cliente , consulteOpções de conexão .

Configurar certificados

Para iniciar com êxito uma solicitação de TLS, seu aplicativo deve apresentar certificados criptográficos para provar sua identidade. Os certificados do seu aplicativo devem ser armazenados como arquivos PEM para habilitar o TLS durante a conexão.

A lista a seguir descreve os componentes que seu cliente deve apresentar para estabelecer uma conexão habilitada para TLS:

Certificados de referência em um cliente

Você deve fazer referência aos seus certificados em seu objeto ClientOptions para que o servidor possa validá-los antes que o cliente se conecte. Recomendamos que você defina o TLSConfig campo da instância ClientOptions como uma estrutura Config para configurar sua conexão TLS. As estruturas Config são nativas do Go e permitem que você mantenha todas as suas opções de TLS em um único objeto reutilizável.

Para criar uma instância do Config , importe os pacotes crypto/tls e crypto/x509 . Em seguida, crie uma instância de estrutura Config e defina os campos de estrutura relevantes para sua configuração.

Na sua instância do Config , você pode definir campos opcionais para configurar o TLS na sua conexão. Para fins de teste, você pode definir o campo InsecureSkipVerify como true.

Para saber mais sobre a estrutura Config , consulte a documentação da API tls.Config.

// Enable TLS on a connection by using the Go driver
package main
import (
	"context"
	"crypto/tls"
	"crypto/x509"
	"os"
	"go.mongodb.org/mongo-driver/mongo"
	"go.mongodb.org/mongo-driver/mongo/options"
)
func main() {
	caFile := "<path to CA certificate>"
	certFile := "<path to public client certificate>"
	keyFile := "<path to private client key>"
	// Loads CA certificate file
	caCert, err := os.ReadFile(caFile)
	if err != nil {
		panic(err)
	}
	caCertPool := x509.NewCertPool()
	if ok := caCertPool.AppendCertsFromPEM(caCert); !ok {
		panic("Error: CA file must be in PEM format")
	}
	// Loads client certificate files
	cert, err := tls.LoadX509KeyPair(certFile, keyFile)
	if err != nil {
		panic(err)
	}
	// Instantiates a Config instance
	tlsConfig := &tls.Config{
		RootCAs:      caCertPool,
		Certificates: []tls.Certificate{cert},
	}
	uri := "<connection string>"
	// Sets TLS options in options instance
	opts := options.Client().ApplyURI(uri).SetTLSConfig(tlsConfig)
	// Connects to MongoDB with TLS enabled
	client, err := mongo.Connect(context.TODO(), opts)
	if err != nil {
		panic(err)
	}
	defer func() {
		if err = client.Disconnect(context.TODO()); err != nil {
			panic(err)
		}
	}()
}

Informações adicionais

Para saber mais sobre como habilitar o TLS em uma conexão, consulte a seguinte documentação de manual do servidor:

• TLS/SSL (Criptografia de transporte)

• Configuração TLS/SSL para clientes