mirror of
https://github.com/FabInfra/S22.Sasl.git
synced 2025-03-12 06:41:52 +01:00
83 lines
2.2 KiB
Markdown
83 lines
2.2 KiB
Markdown
# COMMENTED by Kaleyroy
|
|
|
|
## Upgrade project to netstandard2 & Fixed DIGEST-MD5 issue
|
|
|
|
1. Support netcore (Upgrade netfx45 to netstandard2)
|
|
2. Removed System.Configuration dependency (Netfx legacy)
|
|
3. Removed RIPEMD-160 algorithm (Not supported in netcore)
|
|
4. Fixed DIGEST-MD5 issue (Please refer to https://github.com/smiley22/S22.Sasl/pull/3)
|
|
5. Excluded /Tests folder from project (For building only)
|
|
|
|
-----------------------------------------------------------------------------------
|
|
|
|
### Introduction
|
|
|
|
This repository contains a .NET assembly implementing the "Authentication and Security Layer" (SASL)
|
|
framework. SASL specifies a protocol for authentication and optional establishment of a security
|
|
layer between client and server applications and is used by internet protocols such as IMAP, POP3,
|
|
SMTP, XMPP and others.
|
|
|
|
|
|
### Usage & Examples
|
|
|
|
To use the library add the S22.Sasl.dll assembly to your project references in Visual Studio. Here's
|
|
a simple example which instantiates a new instance of the Digest-Md5 authentication mechanism and
|
|
demonstrates how it can be used to perform authentication.
|
|
|
|
using System;
|
|
using S22.Sasl;
|
|
|
|
namespace Test {
|
|
class Program {
|
|
static void Main(string[] args) {
|
|
SaslMechanism m = SaslFactory.Create("Digest-Md5");
|
|
|
|
// Add properties needed by authentication mechanism.
|
|
m.Properties.Add("Username", "Foo");
|
|
m.Properties.Add("Password", "Bar");
|
|
|
|
while(!m.IsCompleted)
|
|
{
|
|
byte[] serverChallenge = GetDataFromServer(...);
|
|
byte[] clientResponse = m.ComputeResponse(serverChallenge);
|
|
|
|
SendMyDataToServer(clientResponse);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
### Features
|
|
|
|
The library supports the following authentication mechanisms:
|
|
* Plain
|
|
* Cram-Md5
|
|
* NTLM
|
|
* NTLMv2
|
|
* OAuth
|
|
* OAuth 2.0
|
|
* Digest-Md5
|
|
* Scram-Sha-1
|
|
* SRP
|
|
|
|
Custom SASL Security Providers can be implemented through a simple plugin
|
|
mechanism.
|
|
|
|
|
|
### Credits
|
|
|
|
This library is copyright © 2013-2014 Torben Könke.
|
|
|
|
|
|
|
|
### License
|
|
|
|
This library is released under the [MIT license](https://github.com/smiley22/S22.Sasl/blob/master/License.md).
|
|
|
|
|
|
### Bug reports
|
|
|
|
Please send your bug reports to [smileytwentytwo@gmail.com](mailto:smileytwentytwo@gmail.com) or create a new
|
|
issue on the GitHub project homepage.
|