UtilPack.Cryptography.SASL.SCRAM 2.0.0

.NET Standard 1.0 This package targets .NET Standard 1.0. The package is compatible with this framework or higher. .NET Framework 4.0 This package targets .NET Framework 4.0. The package is compatible with this framework or higher. 
dotnet add package UtilPack.Cryptography.SASL.SCRAM --version 2.0.0                

                    
                

            
NuGet\Install-Package UtilPack.Cryptography.SASL.SCRAM -Version 2.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="UtilPack.Cryptography.SASL.SCRAM" Version="2.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add UtilPack.Cryptography.SASL.SCRAM --version 2.0.0                

                    
                

            
#r "nuget: UtilPack.Cryptography.SASL.SCRAM, 2.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install UtilPack.Cryptography.SASL.SCRAM as a Cake Addin
#addin nuget:?package=UtilPack.Cryptography.SASL.SCRAM&version=2.0.0

// Install UtilPack.Cryptography.SASL.SCRAM as a Cake Tool
#tool nuget:?package=UtilPack.Cryptography.SASL.SCRAM&version=2.0.0

UtilPack.Cryptography.SASL.SCRAM

This is library implementing SCRAM-(SHA-1|SHA-256|SHA-512) protocol without dynamically allocating any strings. The SCRAM protocol handlers are accessible via extension methods for BlockDigestAlgorithm interface of UtilPack.Cryptography.Digest project.

Here is an example for authenticating as a client:

using UtilPack.Cryptography.Digest;

// Example of using SCRAM-SHA-256
// Variables username, password, and stream are assumed to be coming from elsewhere in this example.
using ( var client = new SHA256().CreateSASLClientSCRAM() )
{
  var encoding = new UTF8Encoding( false, false ).CreateDefaultEncodingInfo();
  var writeArray = new ResizableArray<Byte>();
  var credentials = new SASLCredentialsSCRAMForClient(
    username,
    password // password may be clear-text password as string, or result of PBKDF2 iteration as byte array.
    );

  // Create client-first message
  (var bytesWritten, var challengeResult) = await client.ChallengeOrThrowOnErrorAsync( credentials.CreateChallengeArguments(
    null, // Initial phase does not read anything
    -1,
    -1,
    writeArray,
    0,
    encoding
    ) );

  // Write client-first message
  await stream.WriteAsync( writeArray.Array, 0, bytesWritten );

  // Read server-first message
  var readBytes = new Byte[10000]; // Assume static max size for this small example
  var readCount = await stream.ReadAsync( readBytes, 0, readBytes.Length ); // Assume this simple and naïve read for this small example

  // Create client-final message
  (bytesWritten, challengeResult) = await client.ChallengeOrThrowOnErrorAsync( credentials.CreateChallengeArguments(
    readBytes,
    0,
    readCount,
    writeArray,
    0,
    encoding
    ) );

  // At this point, credentials.PasswordDigest will contain result of PBKDF2 iteration, if cleartext password was specified earlier

  // Write client-final message
  await stream.WriteAsync( writeArray.Array, 0, bytesWritten );

  // Read server-final message
  var readCount = await stream.ReadAsync(readBytes, 0, readBytes.Length );
  
  // Validate server-final message
  (bytesWritten, challengeResult) = await client.ChallengeOrThrowOnErrorAsync( credentials.CreateChallengeArguments(
    readBytes,
    0,
    readCount,
    writeArray,
    0,
    encoding
    ) );

  // Now bytesWritten will be 0, and challengeResult will be SASLChallengeResult.Completed.
  // An exception will be thrown on authentication error, or if server sents wrong messaage.
}

Distribution

See NuGet package for binary distribution.

TODO

Modify code as needed after starting to use Span<T> (currently, the code for client and server SCRAM not the prettiest code there is). This will require a polyfill (in UtilPack, most likely) for .NET 4.0.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp1.0 was computed.  netcoreapp1.1 was computed.  netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard1.0 is compatible.  netstandard1.1 was computed.  netstandard1.2 was computed.  netstandard1.3 was computed.  netstandard1.4 was computed.  netstandard1.5 was computed.  netstandard1.6 was computed.  netstandard2.0 was computed.  netstandard2.1 was computed. 
.NET Framework net40 is compatible.  net403 was computed.  net45 is compatible.  net451 was computed.  net452 was computed.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen30 was computed.  tizen40 was computed.  tizen60 was computed. 
Universal Windows Platform uap was computed.  uap10.0 was computed. 
Windows Phone wp8 was computed.  wp81 was computed.  wpa81 was computed. 
Windows Store netcore was computed.  netcore45 was computed.  netcore451 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on UtilPack.Cryptography.SASL.SCRAM:

Package Downloads
CBAM.SQL.PostgreSQL.Implementation

The Connection-Based Asynchronous Messaging (CBAM) SQL.PostgreSQL.Implementation assembly provides implementation and API in order to create connection pools which can create connections to PostgreSQL database backend. A good starting point is PgSQLConnectionPool class.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.0.0 18,445 5/26/2018
1.0.0-RC1 1,435 10/29/2017

Updating to newer version of UtilPack.Cryptography.Digest. This introduces binary-incompatible change, resulting in major version number increase.