Skip to content

Latest commit

 

History

History
69 lines (56 loc) · 2.51 KB

index.rst

File metadata and controls

69 lines (56 loc) · 2.51 KB

Welcome to Sustainsys.Saml2

The Sustainsys.Saml2 library adds SAML2P support to ASP.NET web sites, allowing the web site to act as a SAML2 Service Provider (SP). The library was previously named Kentor.AuthServices. Sustainsys.Saml2 is open sourced and contributions are welcome, please see :doc:`contributing guidelines <contributing>` for info on coding standards etc.

Using Sustainsys.Saml2

Using the Sustainsys.Saml2 library to add SAML2P support into your ASP.NET web applications is a two-step process:

  1. Reference the Nuget package
  2. Provide the necessary configuration information

The exact nature of these steps depends on the ASP.NET integration you're after. See :doc:`getting-started` for all the details.

Versions

There are two supported major version of the library.

1.X is built for .Net Framework only. It is fully supported with security updates being released if needed, but no new functionality is added. The latest 1.X version is recommended for anyone upgrading from previous versions (including from Kentor.AuthServices).

2.X is built for both .Net Framework and .Net Core and is where new features are added. For new implementations 2.X versions are recommended.

Licensing

The library is licensed under the MIT license.

The library was previously (before version 2.0.0) licensed under the GNU Lesser General Public License (LPGL). Please note that the license change only applies to the new versions, the old versions are still under the LGPL license.

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Saml2

   getting-started
   configuration
   owin-middleware
   troubleshooting
   contributing

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: web.config elements

   config-elements/sustainsys-saml2
   config-elements/name-id-policy
   config-elements/requested-authn-context
   config-elements/metadata
   config-elements/organization
   config-elements/contact-person
   config-elements/requested-attributes
   config-elements/identity-providers
   config-elements/signing-certificate
   config-elements/federations
   config-elements/service-certificates
   config-elements/compatibility