GODRIVER-3289 Add option to configure DEK cache lifetime.

Author: qingyang-hu

etc/install-libmongocrypt.sh

@@ -3,7 +3,7 @@
 # This script installs libmongocrypt into an "install" directory.
 set -eux
 
-LIBMONGOCRYPT_TAG="1.11.0"
+LIBMONGOCRYPT_TAG="1.12.0"
 
 # Install libmongocrypt based on OS.
 if [ "Windows_NT" = "${OS:-}" ]; then

internal/integration/json_helpers_test.go

@@ -162,6 +162,8 @@ func createAutoEncryptionOptions(t testing.TB, opts bson.Raw) *options.AutoEncry
 			aeo.SetEncryptedFieldsMap(encryptedFieldsMap)
 		case "bypassQueryAnalysis":
 			aeo.SetBypassQueryAnalysis(opt.Boolean())
+		case "keyExpirationMS":
+			aeo.SetKeyExpiration(time.Duration(opt.Int64()) * time.Millisecond)
 		default:
 			t.Fatalf("unrecognized auto encryption option: %v", name)
 		}

internal/integration/unified/entity.go

@@ -179,6 +179,7 @@ type clientEncryptionOpts struct {
 	KeyVaultClient    string              `bson:"keyVaultClient"`
 	KeyVaultNamespace string              `bson:"keyVaultNamespace"`
 	KmsProviders      map[string]bson.Raw `bson:"kmsProviders"`
+	keyExpirationMS   *int64              `bson:"keyExpirationMS"`
 }
 
 // EntityMap is used to store entities during tests. This type enforces uniqueness so no two entities can have the same
@@ -735,12 +736,15 @@ func (em *EntityMap) addClientEncryptionEntity(entityOptions *entityOptions) err
 		return newEntityNotFoundError("client", ceo.KeyVaultClient)
 	}
 
-	ce, err := mongo.NewClientEncryption(
-		keyVaultClient.Client,
-		options.ClientEncryption().
-			SetKeyVaultNamespace(ceo.KeyVaultNamespace).
-			SetTLSConfig(tlsconf).
-			SetKmsProviders(kmsProviders))
+	opts := options.ClientEncryption().
+		SetKeyVaultNamespace(ceo.KeyVaultNamespace).
+		SetTLSConfig(tlsconf).
+		SetKmsProviders(kmsProviders)
+	if ceo.keyExpirationMS != nil {
+		opts.SetKeyExpiration(time.Duration(*ceo.keyExpirationMS) * time.Millisecond)
+	}
+
+	ce, err := mongo.NewClientEncryption(keyVaultClient.Client, opts)
 	if err != nil {
 		return err
 	}

mongo/client.go

@@ -193,7 +193,7 @@ func newClient(opts ...*options.ClientOptions) (*Client, error) {
 	}
 	// AutoEncryptionOptions
 	if clientOpts.AutoEncryptionOptions != nil {
-		if err := client.configureAutoEncryption(clientOpts); err != nil {
+		if err = client.configureAutoEncryption(clientOpts); err != nil {
 			return nil, err
 		}
 	} else {
@@ -471,30 +471,48 @@ func (c *Client) endSessions(ctx context.Context) {
 }
 
 func (c *Client) configureAutoEncryption(args *options.ClientOptions) error {
-	c.encryptedFieldsMap = args.AutoEncryptionOptions.EncryptedFieldsMap
+	aeOpts := args.AutoEncryptionOptions
+	c.encryptedFieldsMap = aeOpts.EncryptedFieldsMap
 	if err := c.configureKeyVaultClientFLE(args); err != nil {
 		return err
 	}
 
-	if err := c.configureMetadataClientFLE(args); err != nil {
-		return err
-	}
-
-	mc, err := c.newMongoCrypt(args.AutoEncryptionOptions)
+	mc, err := c.newMongoCrypt(aeOpts)
 	if err != nil {
 		return err
 	}
 
 	// If the crypt_shared library was not loaded, try to spawn and connect to mongocryptd.
 	if mc.CryptSharedLibVersionString() == "" {
-		mongocryptdFLE, err := newMongocryptdClient(args.AutoEncryptionOptions)
+		c.mongocryptdFLE, err = newMongocryptdClient(aeOpts)
 		if err != nil {
 			return err
 		}
-		c.mongocryptdFLE = mongocryptdFLE
 	}
 
-	c.configureCryptFLE(mc, args.AutoEncryptionOptions)
+	kr := keyRetriever{coll: c.keyVaultCollFLE}
+	var cir collInfoRetriever
+	bypass := aeOpts.BypassAutoEncryption != nil && *aeOpts.BypassAutoEncryption
+	if !bypass {
+		if args.MaxPoolSize != nil && *args.MaxPoolSize == 0 {
+			c.metadataClientFLE = c
+		} else {
+			c.metadataClientFLE, err = c.getOrCreateInternalClient(args)
+			if err != nil {
+				return err
+			}
+		}
+		cir.client = c.metadataClientFLE
+	}
+
+	c.cryptFLE = driver.NewCrypt(&driver.CryptOptions{
+		MongoCrypt:           mc,
+		CollInfoFn:           cir.cryptCollInfo,
+		KeyFn:                kr.cryptKeys,
+		MarkFn:               c.mongocryptdFLE.markCommand,
+		TLSConfig:            aeOpts.TLSConfig,
+		BypassAutoEncryption: bypass,
+	})
 	return nil
 }
 
@@ -537,24 +555,6 @@ func (c *Client) configureKeyVaultClientFLE(clientOpts *options.ClientOptions) e
 	return nil
 }
 
-func (c *Client) configureMetadataClientFLE(clientOpts *options.ClientOptions) error {
-	aeOpts := clientOpts.AutoEncryptionOptions
-
-	if aeOpts.BypassAutoEncryption != nil && *aeOpts.BypassAutoEncryption {
-		// no need for a metadata client.
-		return nil
-	}
-	if clientOpts.MaxPoolSize != nil && *clientOpts.MaxPoolSize == 0 {
-		c.metadataClientFLE = c
-		return nil
-	}
-
-	var err error
-	c.metadataClientFLE, err = c.getOrCreateInternalClient(clientOpts)
-
-	return err
-}
-
 func (c *Client) newMongoCrypt(opts *options.AutoEncryptionOptions) (*mongocrypt.MongoCrypt, error) {
 	// convert schemas in SchemaMap to bsoncore documents
 	cryptSchemaMap := make(map[string]bsoncore.Document)
@@ -611,7 +611,8 @@ func (c *Client) newMongoCrypt(opts *options.AutoEncryptionOptions) (*mongocrypt
 		SetEncryptedFieldsMap(cryptEncryptedFieldsMap).
 		SetCryptSharedLibDisabled(cryptSharedLibDisabled || bypassAutoEncryption).
 		SetCryptSharedLibOverridePath(cryptSharedLibPath).
-		SetHTTPClient(opts.HTTPClient))
+		SetHTTPClient(opts.HTTPClient).
+		SetKeyExpiration(opts.KeyExpiration))
 	if err != nil {
 		return nil, err
 	}
@@ -637,28 +638,6 @@ func (c *Client) newMongoCrypt(opts *options.AutoEncryptionOptions) (*mongocrypt
 	return mc, nil
 }
 
-//nolint:unused // the unused linter thinks that this function is unreachable because "c.newMongoCrypt" always panics without the "cse" build tag set.
-func (c *Client) configureCryptFLE(mc *mongocrypt.MongoCrypt, opts *options.AutoEncryptionOptions) {
-	bypass := opts.BypassAutoEncryption != nil && *opts.BypassAutoEncryption
-	kr := keyRetriever{coll: c.keyVaultCollFLE}
-	var cir collInfoRetriever
-	// If bypass is true, c.metadataClientFLE is nil and the collInfoRetriever
-	// will not be used. If bypass is false, to the parent client or the
-	// internal client.
-	if !bypass {
-		cir = collInfoRetriever{client: c.metadataClientFLE}
-	}
-
-	c.cryptFLE = driver.NewCrypt(&driver.CryptOptions{
-		MongoCrypt:           mc,
-		CollInfoFn:           cir.cryptCollInfo,
-		KeyFn:                kr.cryptKeys,
-		MarkFn:               c.mongocryptdFLE.markCommand,
-		TLSConfig:            opts.TLSConfig,
-		BypassAutoEncryption: bypass,
-	})
-}
-
 // validSession returns an error if the session doesn't belong to the client
 func (c *Client) validSession(sess *session.Client) error {
 	if sess != nil && sess.ClientID != c.id {

mongo/client_encryption.go

@@ -59,7 +59,8 @@ func NewClientEncryption(keyVaultClient *Client, opts ...options.Lister[options.
 		// ClientEncryption because it's only needed for AutoEncryption and we don't expect users to
 		// have the crypt_shared library installed if they're using ClientEncryption.
 		SetCryptSharedLibDisabled(true).
-		SetHTTPClient(cea.HTTPClient))
+		SetHTTPClient(cea.HTTPClient).
+		SetKeyExpiration(cea.KeyExpiration))
 	if err != nil {
 		return nil, err
 	}

mongo/options/autoencryptionoptions.go

@@ -9,6 +9,7 @@ package options
 import (
 	"crypto/tls"
 	"net/http"
+	"time"
 
 	"go.mongodb.org/mongo-driver/v2/internal/httputil"
 )
@@ -40,6 +41,7 @@ type AutoEncryptionOptions struct {
 	HTTPClient            *http.Client
 	EncryptedFieldsMap    map[string]interface{}
 	BypassQueryAnalysis   *bool
+	KeyExpiration         *time.Duration
 }
 
 // AutoEncryption creates a new AutoEncryptionOptions configured with default values.
@@ -164,3 +166,10 @@ func (a *AutoEncryptionOptions) SetBypassQueryAnalysis(bypass bool) *AutoEncrypt
 
 	return a
 }
+
+// SetKeyExpiration specifies duration for the key expiration. 0 means "never expire".
+func (a *AutoEncryptionOptions) SetKeyExpiration(expiration time.Duration) *AutoEncryptionOptions {
+	a.KeyExpiration = &expiration
+
+	return a
+}

mongo/options/clientencryptionoptions.go

@@ -10,6 +10,7 @@ import (
 	"crypto/tls"
 	"fmt"
 	"net/http"
+	"time"
 
 	"go.mongodb.org/mongo-driver/v2/internal/httputil"
 )
@@ -22,6 +23,7 @@ type ClientEncryptionOptions struct {
 	KmsProviders      map[string]map[string]interface{}
 	TLSConfig         map[string]*tls.Config
 	HTTPClient        *http.Client
+	KeyExpiration     *time.Duration
 }
 
 // ClientEncryptionOptionsBuilder contains options to configure client
@@ -80,6 +82,17 @@ func (c *ClientEncryptionOptionsBuilder) SetTLSConfig(cfg map[string]*tls.Config
 	return c
 }
 
+// SetKeyExpiration specifies duration for the key expiration. 0 means "never expire".
+func (c *ClientEncryptionOptionsBuilder) SetKeyExpiration(expiration time.Duration) *ClientEncryptionOptionsBuilder {
+	c.Opts = append(c.Opts, func(opts *ClientEncryptionOptions) error {
+		opts.KeyExpiration = &expiration
+
+		return nil
+	})
+
+	return c
+}
+
 // BuildTLSConfig specifies tls.Config options for each KMS provider to use to configure TLS on all connections created
 // to the KMS provider. The input map should contain a mapping from each KMS provider to a document containing the necessary
 // options, as follows: