db.rotateCertificates() (método mongosh)

Definición

db.rotateCertificates(message)

Rotates the currently used TLS certificates for a mongod or mongos to use the updated values for these certificates defined in the configuration file.

db.rotateCertificates(message)

The db.rotateCertificates() method takes the following optional argument:

Parameter	Tipo	Descripción
message	string	opcional Un mensaje registrado por el servidor en la entrada de registro y el archivo de auditar.

The db.rotateCertificates() method wraps the rotateCertificates command.

Compatibilidad

Este método está disponible en implementaciones alojadas en los siguientes entornos:

• MongoDB Enterprise: La versión basada en suscripción y autogestionada de MongoDB

• MongoDB Community: La versión de MongoDB con código fuente disponible, de uso gratuito y autogestionada.

Salida

The db.rotateCertificates() method returns a document with the following field:

Comportamiento

La rotación incluye los siguientes certificados:

• TLS Certificates

• CRL (Certificate Revocation List) files (en las plataformas Linux y Windows)

• CA (Certificate Authority) files

Para rotar uno o más de estos certificados:

1. Se debe sustituir el certificado o los certificados que se desean rotar en el sistema de archivos, teniendo en cuenta las siguientes restricciones:

   • Cada nuevo certificado debe tener el mismo nombre de archivo y la misma ruta de archivo que el certificado que está reemplazando.

   • Si rota un certificado cifradoTLS Certificate, su contraseña debe ser la misma que la contraseña del certificado antiguo (como se especifica en los ajustes del archivo de configuración certificateKeyFilePassword). La rotación de certificados admite a la solicitud de contraseña interactiva.

2. Connect mongosh to the mongod or mongos instance that you wish to perform certificate rotation on.

3. Run db.rotateCertificates() to rotate the certificates used by the mongod or mongos instance.

Cuando tiene lugar la rotación de certificados:

• Las conexiones existentes a la instancia de mongod o mongos no se terminan y continuarán usando los certificados antiguos.

• Cualquier nueva conexión utilizará los nuevos certificados.

If you have configured OCSP for your deployment, the db.rotateCertificates() method will also fetch stapled OCSP responses during rotation.

The db.rotateCertificates() method may be run on a running mongod or mongos regardless of replication status.

Only one instance of db.rotateCertificates() or rotateCertificates may run on each mongod or mongos process at a time. Attempting to initiate a second instance while one is already running will result in an error.

Los archivos de certificado incorrectos, caducados, revocados o ausentes harán que falle la rotación del certificado, pero no invalidarán la configuración TLS existente ni terminarán el proceso mongod o mongos en ejecución.

If the mongod or mongos is running with --tlsCertificateSelector set to thumbprint, db.rotateCertificates() will fail and write a warning message to the log file.

Registro

En caso de rotación exitosa, los nombres de sujetos, las huellas digitales y el período de validez de las huellas digitales de los certificados del servidor y del clúster se registran en el destino de registro configurado. Si la función de auditar está habilitada, esta información también se registra en el registro de auditoría.

En las plataformas Linux y Windows, si hay un CRL file presente, su huella digital y el periodo de validez también se registran en estas ubicaciones.

Acceso requerido

You must have the rotateCertificates action in order to use the db.rotateCertificates() method. The rotateCertificates action is part of the hostManager role.

Ejemplo

La siguiente operación rota los certificados en una instancia mongod en funcionamiento, después de haber realizado las actualizaciones apropiadas en el archivo de configuración para especificar la información actualizada del certificado:

db.rotateCertificates()

Lo siguiente realiza la misma función que lo anterior, pero además escribe un mensaje de registro personalizado en el momento de la rotación en la entrada de registro y archivo de auditoría:

db.rotateCertificates("message": "Rotating certificates")