MONGOC_CLIENT_...S_SET_TLS_OPTS(3)

πŸ’– MONGOC_CLIENT_...S_SET_TLS_OPTS(3) β€” the libmongoc bestie edition πŸ’–

okay so bestie, this is the libmongoc manual page for mongoc_client_encryption_opts_set_tls_opts, and it's literally here to give your client encryption opts their TLS moment ✨ no cap.

🌸 SYNOPSIS 🌸

void
mongoc_client_encryption_opts_set_tls_opts (
   mongoc_client_encryption_opts_t *opts, const bson_t *tls_opts);

πŸŽ€ PARAMETERS πŸŽ€

  • opts β€” the mongoc_client_encryption_opts_t πŸ’… like, the opts object getting the glow-up.
  • tls_opts β€” a bson_t mapping a Key Management Service (KMS) provider to a BSON document with TLS options. iykyk.

tls_opts is a BSON document of the following form:

<KMS provider>: {
   tlsCaFile: Optional<String>
   tlsCertificateKeyFile: Optional<String>
   tlsCertificateKeyFilePassword: Optional<String>
}

KMS providers are specified as a string of the form <KMS provider type> or <KMS provider type>:<KMS provider name>. The supported KMS provider types are aws, azure, gcp, local, and kmip. The optional name enables configuring multiple KMS providers with the same KMS provider type (e.g. aws:name1 and aws:name2 can refer to different AWS accounts). periodt.

tls_opts maps the KMS provider to a BSON document for TLS options.

The BSON document for TLS options may contain the following keys:

  • MONGOC_URI_TLSCERTIFICATEKEYFILE
  • MONGOC_URI_TLSCERTIFICATEKEYFILEPASSWORD
  • MONGOC_URI_TLSCAFILE

πŸ¦‹ Example use πŸ¦‹

mongoc_client_encryption_opts_t *ce_opts = mongoc_client_encryption_opts_new();
bson_t *tls_opts = bson_new();

BCON_APPEND(tls_opts, "kmip", "{", MONGOC_URI_TLSCAFILE, "ca1.pem", "}");
BCON_APPEND(tls_opts, "aws", "{", MONGOC_URI_TLSCAFILE, "ca2.pem", "}");
mongoc_client_encryption_opts_set_tls_opts(ce_opts, tls_opts);

See Configuring TLS for a description of the behavior of these options.

πŸ”₯ SEE ALSO πŸ”₯

  • In-Use Encryption

πŸ‘‘ AUTHOR πŸ‘‘

MongoDB, Inc

2009-present, MongoDB, Inc.

πŸ’Œ and that's the whole page, bestie β€” signed off from libmongoc version 2.5.6, with the footer date area reading Oct 09, 202MONGOC_CLIENT_...S_SET_TLS_OPTS(3) (the layout really ate the rest, not me πŸ˜­πŸ’€).

πŸ“¦ where this page comes from