Skip to content

Commit

Permalink
Documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
AndersAbel committed Mar 27, 2020
1 parent f4f5fd5 commit 4fccfbb
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 20 deletions.
8 changes: 4 additions & 4 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ To make a clean pull request, it is important to follow some git best practices.

Licensing
---------
The library is licensed under LGPL and by submitting code it is accepted that the submitted code will be
released under the same license. Third party code may only be added to the library if the author of the
pull request holds the copyright to the code, or the code is previously licensed under a
license compatible with LGPL.
The library is licensed under MIT (for the master branch) and by submitting code it is accepted that the
submitted code will be released under the same license. Third party code may only be added to the
library if the author of the pull request holds the copyright to the code, or the code is previously
licensed under a license compatible with MIT.
15 changes: 4 additions & 11 deletions docs/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,24 +51,17 @@ authentication model.

Nuget Package to use: `Sustainsys.Saml2.AspNetCore2 <https://www.nuget.org/packages/Sustainsys.Saml2.AspNetCore2/>`_

IdentityServer[3/4] Integration
IdentityServer4 Integration
-------------------------------
If you're using ``IdentityServer`` (v3 or later), you may want to
If you're using ``IdentityServer``, you may want to
configure SAML identity providers like Okta or Ping as external
identity providers within your IdentityServer implementation.

The ``Owin`` & ``ASP.NET Core2`` modules enable SAML identity
providers to be integrated within `IdentityServer3 <https://github.com/IdentityServer/IdentityServer3>`_ and
`IdentityServer4 <https://github.com/IdentityServer/IdentityServer4>`_ packages.
The ``ASP.NET Core2`` module enable SAML identity
providers to be integrated within `IdentityServer4 <https://github.com/IdentityServer/IdentityServer4>`_ packages.

Nuget Package to use for IdentityServer3: `Sustainsys.Saml2.Owin <https://www.nuget.org/packages/Sustainsys.Saml2.Owin/>`_
Nuget Package for IdentityServer4: `Sustainsys.Saml2.AspNetCore2 <https://www.nuget.org/packages/Sustainsys.Saml2.AspNetCore2/>`_

Review :doc:`this document <identity-server-3-okta>` to see how to configure Saml2 with
IdentityServer3 and Okta to add Okta as an
identity provider to an IdentityServer3 project. There is
also a SampleIdentityServer3 project in the Saml2 repository.

.. note::

There is also a Sustainsys.Saml2 Nuget package, but this only contains functionality shared
Expand Down
16 changes: 11 additions & 5 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,17 @@ Using the Sustainsys.Saml2 library to add SAML2P support into your ASP.NET web a
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 <https://github.com/Sustainsys/Saml2/blob/master/LICENSE>`_.
Expand Down Expand Up @@ -56,8 +67,3 @@ the license change only applies to the new versions, the old versions are still
config-elements/federations
config-elements/service-certificates
config-elements/compatibility





0 comments on commit 4fccfbb

Please sign in to comment.