AspNetSaml 2.0.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package AspNetSaml --version 2.0.0
NuGet\Install-Package AspNetSaml -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="AspNetSaml" Version="2.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add AspNetSaml --version 2.0.0
#r "nuget: AspNetSaml, 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 AspNetSaml as a Cake Addin
#addin nuget:?package=AspNetSaml&version=2.0.0

// Install AspNetSaml as a Cake Tool
#tool nuget:?package=AspNetSaml&version=2.0.0

alternate text is missing from this package README image


Very short and simple SAML 2.0 "consumer" implementation in C#.

It's a SAML client library, not a SAML server. As in - allows adding SAML single-sign-on to your ASP.NET app, but not to provide auth services to other apps. In other words, it's a library for "service-providers" not for "identity providers".


Install-Package AspNetSaml

Adds a very small .NET Standard 2.0 library (11KB dll) that works with both ASP.NET Core and the "old" ASP.NET Framework. Please refer to releases for the change log.


How SAML works? (please read this)

SAML workflow has 2 steps:

  1. User is redirected to the SAML provider (with some magic in the query-string) where he authenticates
  2. User is redirected back to your app, where you validate the payload

Here's how you do it (this example is for ASP.NET MVC):

1. Redirecting the user to the saml provider:

//this example is an ASP.NET MVC action method
public IActionResult Login()
	//TODO: specify the SAML provider url here, aka "Endpoint"
	var samlEndpoint = "";

	var request = new AuthRequest(
		"", //TODO: put your app's "entity ID" here
		"" //TODO: put Assertion Consumer URL (where the provider should redirect users after authenticating)

	//redirect the user to the SAML provider
	return Redirect(request.GetRedirectUrl(samlEndpoint));

2. User has been redirected back

User is sent back to your app - you need to validate the SAML response ("assertion") that you recieved via POST.

Here's an example of how you do it in ASP.NET MVC

//ASP.NET MVC action method... But you can easily modify the code for Web-forms etc.
public IActionResult SamlConsume()
	// 1. TODO: specify the certificate that your SAML provider gave you
	string samlCertificate = @"-----BEGIN CERTIFICATE-----

	// 2. Let's read the data - SAML providers usually POST it into the "SAMLResponse" var
	var samlResponse = new Response(samlCertificate, Request.Form["SAMLResponse"]);

	// 3. DONE!
	if (samlResponse.IsValid()) //all good
		//WOOHOO!!! the user is logged in
		username = samlResponse.GetNameID();
		//user has been authenticated
		//put your code here, like set a cookie or something...
		//or call FormsAuthentication.SetAuthCookie() for .NET Framework
		//or call context.SignInAsync() for ASP.NET Core
		//or do something else

Reading more attributes from the provider

SAML providers usually send more data with their response: username, first/last names etc. Here's how to get it:

if (samlResponse.IsValid())
	//WOOHOO!!! user is logged in

	//Some more optional stuff
	//let's extract username/firstname etc
		var username = samlResponse.GetNameID();
		var email = samlResponse.GetEmail();
		var firstname = samlResponse.GetFirstName();
		var lastname = samlResponse.GetLastName();
		//or read some custom-named data that you know the IdP sends
		var officeLocation = samlReponse.GetCustomAttribute("OfficeAddress");
	catch (Exception ex)
		//insert error handling code
		//in case some extra attributes are not present in XML, for example
		return null;

Notes about the source code

All the functionality sits in one single short file Saml.cs other stuff in this repo are just unit tests, nuget-packaging etc. You can take that file and throw it in your project, it should work just fine.

P.S. This library has been battle-tested for years in production in our helpdesk app please check it out if you're looking for a ticketing system for your team. Cheers.

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 netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework 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 tizen40 was computed.  tizen60 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

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.1.2 22,362 1/5/2024
2.1.1 4,845 11/19/2023
2.1.0 18,892 7/10/2023
2.0.1 48,733 4/18/2023
2.0.0 12,235 1/27/2023
2.0.0-beta 147 1/25/2023
1.2.5 46,156 5/24/2022
1.2.4 57,880 7/4/2021
1.2.3 79,397 9/17/2020
1.2.2 23,721 4/12/2020
1.2.1 107,632 3/12/2019
1.2.0 56,638 11/10/2017