CSHARP-4193: Add [Beta] flags for public Queryable Encryption API. (#808)

Author: DmitryLukyanov

src/MongoDB.Driver.Core/Core/Configuration/ClusterSettings.cs

@@ -58,7 +58,7 @@ public class ClusterSettings
         /// </summary>
         /// <param name="connectionMode">The connection mode.</param>
         /// <param name="connectionModeSwitch">The connection mode switch.</param>
-        /// <param name="cryptClientSettings">Crypt client settings.</param>
+        /// <param name="cryptClientSettings">[Beta] Crypt client settings.</param>
         /// <param name="directConnection">The directConnection.</param>
         /// <param name="endPoints">The end points.</param>
         /// <param name="loadBalanced">The load balanced.</param>
@@ -142,7 +142,7 @@ public ConnectionModeSwitch ConnectionModeSwitch
         }
 
         /// <summary>
-        /// Gets the crypt client settings.
+        /// [Beta] Gets the crypt client settings.
         /// </summary>
         public CryptClientSettings CryptClientSettings
         {
@@ -286,7 +286,7 @@ public IServerSelector PostServerSelector
         /// </summary>
         /// <param name="connectionMode">The connection mode.</param>
         /// <param name="connectionModeSwitch">The connection mode switch.</param>
-        /// <param name="cryptClientSettings">Crypt client settings.</param>
+        /// <param name="cryptClientSettings">[Beta] Crypt client settings.</param>
         /// <param name="directConnection">The directConnection.</param>
         /// <param name="endPoints">The end points.</param>
         /// <param name="loadBalanced">The load balanced.</param>

src/MongoDB.Driver.Core/Core/Configuration/CryptClientSettings.cs

@@ -20,7 +20,7 @@
 namespace MongoDB.Driver.Core.Configuration
 {
     /// <summary>
-    /// Represents settings for a crypt client.
+    /// [Beta] Represents settings for a crypt client.
     /// </summary>
     public sealed class CryptClientSettings
     {

src/MongoDB.Driver/CreateCollectionOptions.cs

@@ -81,7 +81,7 @@ public ChangeStreamPreAndPostImagesOptions ChangeStreamPreAndPostImagesOptions
         }
 
         /// <summary>
-        /// Gets or sets encrypted fields.
+        /// [Beta] Gets or sets encrypted fields.
         /// </summary>
         public BsonDocument EncryptedFields
         {

src/MongoDB.Driver/DropCollectionOptions.cs

@@ -25,7 +25,7 @@ public class DropCollectionOptions
         private BsonDocument _encryptedFields;
 
         /// <summary>
-        /// Gets or sets encrypted fields.
+        /// [Beta] Gets or sets encrypted fields.
         /// </summary>
         public BsonDocument EncryptedFields
         {

src/MongoDB.Driver/Encryption/AutoEncryptionOptions.cs

@@ -54,8 +54,8 @@ public class AutoEncryptionOptions
         /// <param name="keyVaultClient">The keyVault client.</param>
         /// <param name="schemaMap">The schema map.</param>
         /// <param name="tlsOptions">The tls options.</param>
-        /// <param name="encryptedFieldsMap">The encryptedFields map.</param>
-        /// <param name="bypassQueryAnalysis">The bypass query analysis flag.</param>
+        /// <param name="encryptedFieldsMap">[Beta] The encryptedFields map.</param>
+        /// <param name="bypassQueryAnalysis">[Beta] The bypass query analysis flag.</param>
         public AutoEncryptionOptions(
             CollectionNamespace keyVaultNamespace,
             IReadOnlyDictionary<string, IReadOnlyDictionary<string, object>> kmsProviders,
@@ -93,12 +93,12 @@ public AutoEncryptionOptions(
         public bool BypassAutoEncryption => _bypassAutoEncryption;
 
         /// <summary>
-        /// Gets a value indicating whether to bypass query analysis.
+        /// [Beta] Gets a value indicating whether to bypass query analysis.
         /// </summary>
         public bool? BypassQueryAnalysis => _bypassQueryAnalysis;
 
         /// <summary>
-        /// Gets the encrypted fields map.
+        /// [Beta] Gets the encrypted fields map.
         /// Supplying an encryptedFieldsMap provides more security than relying on an encryptedFields obtained from the server. It protects against a malicious server advertising a false encryptedFields.
         /// </summary>
         public IReadOnlyDictionary<string, BsonDocument> EncryptedFieldsMap => _encryptedFieldsMap;
@@ -109,6 +109,10 @@ public AutoEncryptionOptions(
         /// <value>
         /// The extra options.
         /// </value>
+        /// <remarks>
+        /// All MongoClient objects in the same process should use the same setting for extraOptions.cryptSharedLibPath,
+        /// as it is an error to load more that one crypt_shared dynamic library simultaneously in a single operating system process.
+        /// </remarks>
         public IReadOnlyDictionary<string, object> ExtraOptions => _extraOptions;
 
         /// <summary>
@@ -157,12 +161,12 @@ public AutoEncryptionOptions(
         /// <param name="keyVaultNamespace">The keyVault namespace.</param>
         /// <param name="kmsProviders">The kms providers.</param>
         /// <param name="bypassAutoEncryption">The bypass auto encryption flag.</param>
-        /// <param name="bypassQueryAnalysis">The bypass query analysis flag.</param>
+        /// <param name="bypassQueryAnalysis">[Beta] The bypass query analysis flag.</param>
         /// <param name="extraOptions">The extra options.</param>
         /// <param name="keyVaultClient">The keyVault client.</param>
         /// <param name="schemaMap">The schema map.</param>
         /// <param name="tlsOptions">The tls options.</param>
-        /// <param name="encryptedFieldsMap">The encryptedFields map.</param>
+        /// <param name="encryptedFieldsMap">[Beta] The encryptedFields map.</param>
         /// <returns>A new instance of <see cref="AutoEncryptionOptions"/>.</returns>
         public AutoEncryptionOptions With(
             Optional<CollectionNamespace> keyVaultNamespace = default,

src/MongoDB.Driver/Encryption/EncryptOptions.cs

@@ -19,7 +19,7 @@
 namespace MongoDB.Driver.Encryption
 {
     /// <summary>
-    /// The QueryType to use for "Indexed" queries.
+    /// [Beta] The QueryType to use for "Indexed" queries.
     /// </summary>
     public enum QueryType
     {
@@ -58,8 +58,8 @@ private static string ConvertEnumAlgorithmToString(EncryptionAlgorithm encryptio
         /// <param name="algorithm">The encryption algorithm.</param>
         /// <param name="alternateKeyName">The alternate key name.</param>
         /// <param name="keyId">The key Id.</param>
-        /// <param name="contentionFactor">The contention factor.</param>
-        /// <param name="queryType">The query type.</param>
+        /// <param name="contentionFactor">[Beta] The contention factor.</param>
+        /// <param name="queryType">[Beta] The query type.</param>
         public EncryptOptions(
             string algorithm,
             Optional<string> alternateKeyName = default,
@@ -90,8 +90,8 @@ public EncryptOptions(
         /// <param name="algorithm">The encryption algorithm.</param>
         /// <param name="alternateKeyName">The alternate key name.</param>
         /// <param name="keyId">The key Id.</param>
-        /// <param name="contentionFactor">The contention factor.</param>
-        /// <param name="queryType">The query type.</param>
+        /// <param name="contentionFactor">[Beta] The contention factor.</param>
+        /// <param name="queryType">[Beta] The query type.</param>
         public EncryptOptions(
             EncryptionAlgorithm algorithm,
             Optional<string> alternateKeyName = default,
@@ -125,7 +125,7 @@ public EncryptOptions(
         public string AlternateKeyName => _alternateKeyName;
 
         /// <summary>
-        /// Gets the contention factor.
+        /// [Beta] Gets the contention factor.
         /// </summary>
         /// <value>
         /// The contention factor.
@@ -141,7 +141,7 @@ public EncryptOptions(
         public Guid? KeyId => _keyId;
 
         /// <summary>
-        /// Gets the query type.
+        /// [Beta] Gets the query type.
         /// </summary>
         /// <value>
         /// The query type.
@@ -154,8 +154,8 @@ public EncryptOptions(
         /// <param name="algorithm">The encryption algorithm.</param>
         /// <param name="alternateKeyName">The alternate key name.</param>
         /// <param name="keyId">The keyId.</param>
-        /// <param name="contentionFactor">The contention factor.</param>
-        /// <param name="queryType">The query type.</param>
+        /// <param name="contentionFactor">[Beta] The contention factor.</param>
+        /// <param name="queryType">[Beta] The query type.</param>
         /// <returns>A new EncryptOptions instance.</returns>
         public EncryptOptions With(
             Optional<string> algorithm = default,

src/MongoDB.Driver/Encryption/EncryptionAlgorithm.cs

@@ -29,11 +29,15 @@ public enum EncryptionAlgorithm
         /// </summary>
         AEAD_AES_256_CBC_HMAC_SHA_512_Random,
         /// <summary>
-        /// Indexed algorithm.
+        /// [Beta] Indexed algorithm.
         /// </summary>
+        /// <remarks>
+        /// To insert or query with an "Indexed" encrypted payload, use a MongoClient configured with AutoEncryptionOptions.
+        /// AutoEncryptionOptions.BypassQueryAnalysis may be true. AutoEncryptionOptions.BypassAutoEncryption must be false.
+        /// </remarks>
         Indexed,
         /// <summary>
-        /// Unindexed algorithm.
+        /// [Beta] Unindexed algorithm.
         /// </summary>
         Unindexed
     }