CSHARP-5315: Mark API as obsolete: Auth (#1486)

Author: papafe

src/MongoDB.Driver.Core/Core/Authentication/AuthenticationHelper.cs

@@ -29,7 +29,9 @@ namespace MongoDB.Driver.Core.Authentication
 {
     internal static class AuthenticationHelper
     {
+#pragma warning disable CS0618 // Type or member is obsolete
         public static void Authenticate(IConnection connection, ConnectionDescription description, IReadOnlyList<IAuthenticator> authenticators, CancellationToken cancellationToken)
+#pragma warning restore CS0618 // Type or member is obsolete
         {
             Ensure.IsNotNull(connection, nameof(connection));
             Ensure.IsNotNull(description, nameof(description));
@@ -45,7 +47,9 @@ public static void Authenticate(IConnection connection, ConnectionDescription de
             }
         }
 
+#pragma warning disable CS0618 // Type or member is obsolete
         public static async Task AuthenticateAsync(IConnection connection, ConnectionDescription description, IReadOnlyList<IAuthenticator> authenticators, CancellationToken cancellationToken)
+#pragma warning restore CS0618 // Type or member is obsolete
         {
             Ensure.IsNotNull(connection, nameof(connection));
             Ensure.IsNotNull(description, nameof(description));

src/MongoDB.Driver.Core/Core/Authentication/AuthenticatorFactory.cs

@@ -21,6 +21,7 @@ namespace MongoDB.Driver.Core.Authentication
     /// <summary>
     /// Represents an authenticator factory.
     /// </summary>
+    [Obsolete("This class will be made internal in a later release.")]
     public class AuthenticatorFactory : IAuthenticatorFactory
     {
         private readonly Func<IAuthenticator> _authenticatorFactoryFunc;

src/MongoDB.Driver.Core/Core/Authentication/DefaultAuthenticator.cs

@@ -29,6 +29,7 @@ namespace MongoDB.Driver.Core.Authentication
     /// Else, uses SCRAM-SHA-256 if present in the list of mechanisms. Otherwise, uses
     /// SCRAM-SHA-1 the default, regardless of whether SCRAM-SHA-1 is in the list.
     /// </summary>
+    [Obsolete("This class will be made internal in a later release.")]
     public class DefaultAuthenticator : IAuthenticator
     {
         // fields

src/MongoDB.Driver.Core/Core/Authentication/GssapiAuthenticator.cs

@@ -28,6 +28,7 @@ namespace MongoDB.Driver.Core.Authentication
     /// <summary>
     /// A GSSAPI SASL authenticator.
     /// </summary>
+    [Obsolete("This class will be made internal in a later release.")]
     public sealed class GssapiAuthenticator : SaslAuthenticator
     {
         // constants

src/MongoDB.Driver.Core/Core/Authentication/IAuthenticator.cs

@@ -13,6 +13,7 @@
 * limitations under the License.
 */
 
+using System;
 using System.Threading;
 using System.Threading.Tasks;
 using MongoDB.Bson;
@@ -23,6 +24,7 @@ namespace MongoDB.Driver.Core.Authentication
     /// <summary>
     /// Represents a connection authenticator.
     /// </summary>
+    [Obsolete("This interface will be made internal in a later release.")]
     public interface IAuthenticator
     {
         /// <summary>

src/MongoDB.Driver.Core/Core/Authentication/IAuthenticatorFactory.cs

@@ -13,11 +13,14 @@
 * limitations under the License.
 */
 
+using System;
+
 namespace MongoDB.Driver.Core.Authentication
 {
     /// <summary>
     /// Represents an authenticator factory.
     /// </summary>
+    [Obsolete("This interface will be made internal in a later release.")]
     public interface IAuthenticatorFactory
     {
         /// <summary>

src/MongoDB.Driver.Core/Core/Authentication/MongoAWSAuthenticator.cs

@@ -30,6 +30,7 @@ namespace MongoDB.Driver.Core.Authentication
     /// <summary>
     /// The Mongo AWS authenticator.
     /// </summary>
+    [Obsolete("This class will be made internal in a later release.")]
     public class MongoAWSAuthenticator : SaslAuthenticator
     {
         // constants

src/MongoDB.Driver.Core/Core/Authentication/MongoDBX509Authenticator.cs

@@ -27,6 +27,7 @@ namespace MongoDB.Driver.Core.Authentication
     /// <summary>
     /// A MongoDB-X509 authenticator.
     /// </summary>
+    [Obsolete("This class will be made internal in a later release.")]
     public sealed class MongoDBX509Authenticator : IAuthenticator
     {
         // static properties

src/MongoDB.Driver.Core/Core/Authentication/NoTransitionClientLastSaslStep.cs

@@ -22,7 +22,9 @@ namespace MongoDB.Driver.Core.Authentication
     /// <summary>
     /// Represents a last SASL step.
     /// </summary>
+#pragma warning disable CS0618 // Type or member is obsolete
     internal sealed class NoTransitionClientLastSaslStep : SaslAuthenticator.ISaslStep
+#pragma warning restore CS0618 // Type or member is obsolete
     {
         private readonly byte[] _bytesToSendToServer;
 
@@ -41,6 +43,7 @@ public NoTransitionClientLastSaslStep(byte[] bytesToSendToServer)
         public bool IsComplete => false;
 
         /// <inheritdoc/>
+#pragma warning disable CS0618 // Type or member is obsolete
         public SaslAuthenticator.ISaslStep Transition(SaslAuthenticator.SaslConversation conversation, byte[] bytesReceivedFromServer)
         {
             if (bytesReceivedFromServer?.Length > 0)
@@ -54,5 +57,6 @@ public SaslAuthenticator.ISaslStep Transition(SaslAuthenticator.SaslConversation
 
         public Task<SaslAuthenticator.ISaslStep> TransitionAsync(SaslAuthenticator.SaslConversation conversation, byte[] bytesReceivedFromServer, CancellationToken cancellationToken)
             => Task.FromResult(Transition(conversation, bytesReceivedFromServer));
+#pragma warning restore CS0618 // Type or member is obsolete
     }
 }

src/MongoDB.Driver.Core/Core/Authentication/Oidc/MongoOidcAuthenticator.cs

@@ -24,7 +24,9 @@
 
 namespace MongoDB.Driver.Core.Authentication.Oidc
 {
+#pragma warning disable CS0618 // Type or member is obsolete
     internal sealed class MongoOidcAuthenticator : SaslAuthenticator
+#pragma warning restore CS0618 // Type or member is obsolete
     {
         #region static
         public const string MechanismName = "MONGODB-OIDC";

src/MongoDB.Driver.Core/Core/Authentication/Oidc/OidcSaslMechanism.cs

@@ -21,7 +21,9 @@
 
 namespace MongoDB.Driver.Core.Authentication.Oidc
 {
+#pragma warning disable CS0618 // Type or member is obsolete
     internal sealed class OidcSaslMechanism : SaslAuthenticator.ISaslMechanism
+#pragma warning restore CS0618 // Type or member is obsolete
     {
         private readonly IOidcCallbackAdapter _oidcCallback;
         private readonly string _principalName;
@@ -37,6 +39,7 @@ public OidcSaslMechanism(IOidcCallbackAdapter oidcCallback, string principalName
 
         public bool HasCachedCredentials => _oidcCallback.CachedCredentials != null;
 
+#pragma warning disable CS0618 // Type or member is obsolete
         public SaslAuthenticator.ISaslStep Initialize(
             IConnection connection,
             SaslAuthenticator.SaslConversation conversation,
@@ -80,5 +83,6 @@ private SaslAuthenticator.ISaslStep CreateNoTransitionClientLastSaslStep(OidcCre
             _usedCredentials = oidcCredentials;
             return new NoTransitionClientLastSaslStep(new BsonDocument("jwt", oidcCredentials.AccessToken).ToBson());
         }
+#pragma warning restore CS0618 // Type or member is obsolete
     }
 }

src/MongoDB.Driver.Core/Core/Authentication/PlainAuthenticator.cs

@@ -25,6 +25,7 @@ namespace MongoDB.Driver.Core.Authentication
     /// <summary>
     /// A PLAIN SASL authenticator.
     /// </summary>
+    [Obsolete("This class will be made internal in a later release.")]
     public sealed class PlainAuthenticator : SaslAuthenticator
     {
         // static properties

src/MongoDB.Driver.Core/Core/Authentication/SaslAuthenticator.cs

@@ -28,6 +28,7 @@ namespace MongoDB.Driver.Core.Authentication
     /// <summary>
     /// Base class for a SASL authenticator.
     /// </summary>
+    [Obsolete("This class will be made internal in a later release.")]
     public abstract class SaslAuthenticator : IAuthenticator
     {
         /// <summary>

src/MongoDB.Driver.Core/Core/Authentication/ScramSha1Authenticator.cs

@@ -31,6 +31,7 @@ namespace MongoDB.Driver.Core.Authentication
     /// <summary>
     /// A SCRAM-SHA1 SASL authenticator.
     /// </summary>
+    [Obsolete("This class will be made internal in a later release.")]
     public sealed class ScramSha1Authenticator : ScramShaAuthenticator
     {
         // static properties

src/MongoDB.Driver.Core/Core/Authentication/ScramSha256Authenticator.cs

@@ -33,6 +33,7 @@ namespace MongoDB.Driver.Core.Authentication
     /// <summary>
     /// A SCRAM-SHA256 SASL authenticator.
     /// </summary>
+    [Obsolete("This class will be made internal in a later release.")]
     public sealed class ScramSha256Authenticator : ScramShaAuthenticator
     {
         // static properties

src/MongoDB.Driver.Core/Core/Authentication/ScramShaAuthenticator.cs

@@ -28,6 +28,7 @@ namespace MongoDB.Driver.Core.Authentication
     /// <summary>
     /// A SCRAM-SHA SASL authenticator.
     /// </summary>
+    [Obsolete("This class will be made internal in a later release.")]
     public abstract class ScramShaAuthenticator : SaslAuthenticator
     {
         /// <summary>

src/MongoDB.Driver.Core/Core/Authentication/UsernamePasswordCredential.cs

@@ -24,6 +24,7 @@ namespace MongoDB.Driver.Core.Authentication
     /// <summary>
     /// Represents a username/password credential.
     /// </summary>
+    [Obsolete("This class will be made internal in a later release.")]
     public sealed class UsernamePasswordCredential
     {
         // fields

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

@@ -290,7 +290,9 @@ private ServerFactory CreateServerFactory()
         private IServerMonitorFactory CreateServerMonitorFactory()
         {
             var serverMonitorConnectionSettings = _connectionSettings
+#pragma warning disable CS0618 // Type or member is obsolete
                 .With(authenticatorFactories: new IAuthenticatorFactory[] { });
+#pragma warning restore CS0618 // Type or member is obsolete
 
             var heartbeatConnectTimeout = _tcpStreamSettings.ConnectTimeout;
             if (heartbeatConnectTimeout == TimeSpan.Zero || heartbeatConnectTimeout == Timeout.InfiniteTimeSpan)

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

@@ -160,7 +160,9 @@ public static ClusterBuilder ConfigureWithConnectionString(
             // Connection
             if (connectionString.Username != null)
             {
+#pragma warning disable CS0618 // Type or member is obsolete
                 var authenticatorFactory = new AuthenticatorFactory(() => CreateAuthenticator(connectionString, serverApi));
+#pragma warning restore CS0618 // Type or member is obsolete
                 builder = builder.ConfigureConnection(s => s.With(authenticatorFactories: new[] { authenticatorFactory }));
             }
             if (connectionString.ApplicationName != null)
@@ -262,6 +264,7 @@ SslPolicyErrors sslPolicyErrors
             return true;
         }
 
+#pragma warning disable CS0618 // Type or member is obsolete
         private static string GetAuthSource(ConnectionString connectionString)
         {
             var defaultSource = GetDefaultAuthSource(connectionString);
@@ -301,11 +304,9 @@ private static IAuthenticator CreateAuthenticator(ConnectionString connectionStr
                 {
                     return new DefaultAuthenticator(credential, serverApi);
                 }
-#pragma warning disable 618
                 else if (connectionString.AuthMechanism == MongoDBCRAuthenticator.MechanismName)
                 {
                     return new MongoDBCRAuthenticator(credential, serverApi);
-#pragma warning restore 618
                 }
                 else if (connectionString.AuthMechanism == ScramSha1Authenticator.MechanismName)
                 {
@@ -359,6 +360,7 @@ private static IAuthenticator CreateAuthenticator(ConnectionString connectionStr
 
             throw new NotSupportedException("Unable to create an authenticator.");
         }
+#pragma warning restore CS0618 // Type or member is obsolete
 
 #if NET472
         /// <summary>

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

@@ -28,7 +28,9 @@ public class ConnectionSettings
     {
         // fields
         private readonly string _applicationName;
+#pragma warning disable CS0618 // Type or member is obsolete
         private readonly IReadOnlyList<IAuthenticatorFactory> _authenticatorFactories;
+#pragma warning restore CS0618 // Type or member is obsolete
         private readonly IReadOnlyList<CompressorConfiguration> _compressors;
         private readonly LibraryInfo _libraryInfo;
         private readonly bool _loadBalanced;
@@ -47,15 +49,19 @@ public class ConnectionSettings
         /// <param name="maxLifeTime">The maximum life time.</param>
         /// <param name="applicationName">The application name.</param>
         public ConnectionSettings(
+#pragma warning disable CS0618 // Type or member is obsolete
             Optional<IEnumerable<IAuthenticatorFactory>> authenticatorFactories = default,
+#pragma warning restore CS0618 // Type or member is obsolete
             Optional<IEnumerable<CompressorConfiguration>> compressors = default(Optional<IEnumerable<CompressorConfiguration>>),
             Optional<LibraryInfo> libraryInfo = default,
             Optional<bool> loadBalanced = default,
             Optional<TimeSpan> maxIdleTime = default(Optional<TimeSpan>),
             Optional<TimeSpan> maxLifeTime = default(Optional<TimeSpan>),
             Optional<string> applicationName = default(Optional<string>))
         {
+#pragma warning disable CS0618 // Type or member is obsolete
             _authenticatorFactories = Ensure.IsNotNull(authenticatorFactories.WithDefault(Enumerable.Empty<IAuthenticatorFactory>()), nameof(authenticatorFactories)).ToList().AsReadOnly();
+#pragma warning restore CS0618 // Type or member is obsolete
             _compressors = Ensure.IsNotNull(compressors.WithDefault(Enumerable.Empty<CompressorConfiguration>()), nameof(compressors)).ToList();
             _libraryInfo = libraryInfo.WithDefault(null);
             _loadBalanced = loadBalanced.WithDefault(false);
@@ -82,7 +88,9 @@ public string ApplicationName
         /// <value>
         /// The authenticator factories.
         /// </value>
+#pragma warning disable CS0618 // Type or member is obsolete
         public IReadOnlyList<IAuthenticatorFactory> AuthenticatorFactories
+#pragma warning restore CS0618 // Type or member is obsolete
         {
             get { return _authenticatorFactories; }
         }
@@ -149,7 +157,9 @@ public TimeSpan MaxLifeTime
         /// <param name="applicationName">The application name.</param>
         /// <returns>A new ConnectionSettings instance.</returns>
         public ConnectionSettings With(
+#pragma warning disable CS0618 // Type or member is obsolete
             Optional<IEnumerable<IAuthenticatorFactory>> authenticatorFactories = default,
+#pragma warning restore CS0618 // Type or member is obsolete
             Optional<IEnumerable<CompressorConfiguration>> compressors = default(Optional<IEnumerable<CompressorConfiguration>>),
             Optional<LibraryInfo> libraryInfo = default,
             Optional<bool> loadBalanced = default,

src/MongoDB.Driver.Core/Core/Connections/ConnectionInitializer.cs

@@ -165,15 +165,19 @@ private CommandWireProtocol<BsonDocument> CreateGetLastErrorProtocol(ServerApi s
             return getLastErrorProtocol;
         }
 
+#pragma warning disable CS0618 // Type or member is obsolete
         private BsonDocument CreateInitialHelloCommand(IReadOnlyList<IAuthenticator> authenticators, bool loadBalanced = false, CancellationToken cancellationToken = default)
+#pragma warning restore CS0618 // Type or member is obsolete
         {
             var command = HelloHelper.CreateCommand(_serverApi, loadBalanced: loadBalanced);
             HelloHelper.AddClientDocumentToCommand(command, _clientDocument);
             HelloHelper.AddCompressorsToCommand(command, _compressors);
             return HelloHelper.CustomizeCommand(command, authenticators, cancellationToken);
         }
 
+#pragma warning disable CS0618 // Type or member is obsolete
         private List<IAuthenticator> CreateAuthenticators(IConnection connection)
+#pragma warning restore CS0618 // Type or member is obsolete
         {
             if (connection.Description.IsInitialized())
             {

src/MongoDB.Driver.Core/Core/Connections/HelloHelper.cs

@@ -61,7 +61,9 @@ internal static BsonDocument CreateCommand(ServerApi serverApi, bool helloOk = f
             };
         }
 
+#pragma warning disable CS0618 // Type or member is obsolete
         internal static BsonDocument CustomizeCommand(BsonDocument command, IReadOnlyList<IAuthenticator> authenticators, CancellationToken cancellationToken)
+#pragma warning restore CS0618 // Type or member is obsolete
         {
             return authenticators.Count == 1 ? authenticators[0].CustomizeInitialHelloCommand(command, cancellationToken) : command;
         }

src/MongoDB.Driver.Core/Core/Connections/IConnectionInitializer.cs

@@ -23,13 +23,17 @@ namespace MongoDB.Driver.Core.Connections
 {
     internal sealed class ConnectionInitializerContext
     {
+#pragma warning disable CS0618 // Type or member is obsolete
         public ConnectionInitializerContext(ConnectionDescription description, IReadOnlyList<IAuthenticator> authenticators)
+#pragma warning restore CS0618 // Type or member is obsolete
         {
             Description = Ensure.IsNotNull(description, nameof(description));
             Authenticators = Ensure.IsNotNull(authenticators, nameof(authenticators));
         }
 
+#pragma warning disable CS0618 // Type or member is obsolete
         public IReadOnlyList<IAuthenticator> Authenticators { get; }
+#pragma warning restore CS0618 // Type or member is obsolete
         public ConnectionDescription Description { get; }
     }
 

src/MongoDB.Driver.Core/Core/Operations/RetryabilityHelper.cs

@@ -94,8 +94,10 @@ static RetryabilityHelper()
 
             __saslCommands = new HashSet<string>
             {
+#pragma warning disable CS0618 // Type or member is obsolete
                 SaslAuthenticator.SaslStartCommand,
                 SaslAuthenticator.SaslContinueCommand
+#pragma warning restore CS0618 // Type or member is obsolete
             };
         }
 

src/MongoDB.Driver/ClusterRegistry.cs

@@ -119,6 +119,7 @@ private ConnectionPoolSettings ConfigureConnectionPool(ConnectionPoolSettings se
         private ConnectionSettings ConfigureConnection(ConnectionSettings settings, ClusterKey clusterKey)
         {
             var endPoints = clusterKey.Servers.Select(s => new DnsEndPoint(s.Host, s.Port)).ToArray();
+#pragma warning disable CS0618 // Type or member is obsolete
             var authenticatorFactories = clusterKey.Credentials.Select(c => new AuthenticatorFactory(() => c.ToAuthenticator(endPoints, clusterKey.ServerApi)));
             return settings.With(
                 authenticatorFactories: Optional.Enumerable<IAuthenticatorFactory>(authenticatorFactories),
@@ -128,6 +129,7 @@ private ConnectionSettings ConfigureConnection(ConnectionSettings settings, Clus
                 maxIdleTime: clusterKey.MaxConnectionIdleTime,
                 maxLifeTime: clusterKey.MaxConnectionLifeTime,
                 applicationName: clusterKey.ApplicationName);
+#pragma warning restore CS0618 // Type or member is obsolete
         }
 
 #pragma warning disable CS0618 // Type or member is obsolete

src/MongoDB.Driver/MongoCredential.cs

@@ -418,6 +418,7 @@ public MongoCredential WithMechanismProperty(string key, object value)
         }
 
         // internal methods
+#pragma warning disable CS0618 // Type or member is obsolete
         internal IAuthenticator ToAuthenticator(IReadOnlyList<EndPoint> endPoints, ServerApi serverApi, IEnvironmentVariableProvider environmentVariableProvider = null)
         {
             var passwordEvidence = _evidence as PasswordEvidence;
@@ -433,11 +434,9 @@ internal IAuthenticator ToAuthenticator(IReadOnlyList<EndPoint> endPoints, Serve
                 {
                     return new DefaultAuthenticator(credential, serverApi);
                 }
-#pragma warning disable 618
                 if (_mechanism == MongoDBCRAuthenticator.MechanismName)
                 {
                     return new MongoDBCRAuthenticator(credential, serverApi);
-#pragma warning restore 618
                 }
                 if (_mechanism == ScramSha1Authenticator.MechanismName)
                 {
@@ -515,6 +514,7 @@ internal IAuthenticator ToAuthenticator(IReadOnlyList<EndPoint> endPoints, Serve
 
             throw new NotSupportedException("Unable to create an authenticator.");
         }
+#pragma warning restore CS0618 // Type or member is obsolete
 
         // internal static methods
         internal static MongoCredential CreateRawOidcCredential(string userName)