Skip to content

Commit

Permalink
Update Readme.MD
Browse files Browse the repository at this point in the history
Refer to new readthedocs site for documentation.
  • Loading branch information
AndersAbel committed Sep 13, 2018
1 parent db4caec commit f0f7535
Showing 1 changed file with 4 additions and 65 deletions.
69 changes: 4 additions & 65 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
[![Build status](https://ci.appveyor.com/api/projects/status/kf9r7lh4mh28rg2d?branch=master&svg=true&passingText=master%20-%20OK&failingText=master%20-%20Failed!&pendingText=master%20-%20Pending...)](https://ci.appveyor.com/project/Sustainsys/Saml2)
[![Coverage Status](https://coveralls.io/repos/github/Sustainsys/Saml2/badge.svg?branch=master)](https://coveralls.io/github/Sustainsys/Saml2?branch=master)
[![Coverage status](https://coveralls.io/repos/github/Sustainsys/Saml2/badge.svg?branch=master)](https://coveralls.io/github/Sustainsys/Saml2?branch=master)
[![Docs status](https://readthedocs.org/projects/saml2/badge/?version=stable)]
[![Join the chat at https://gitter.im/Susatinsys/Saml2](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/Sustainsys/Saml2)
Sustainsys.Saml2
=============
Expand All @@ -10,67 +11,5 @@ to act as a SAML2 Service Provider (SP). The library was previously named Kentor
Sustainsys.Saml2 is open sourced and contributions are welcome, please see
[contributing guidelines](CONTRIBUTING.md) for info on coding standards etc.

## Using
The Saml2 library can be used through three different ways:

* An Http Module, loaded into the IIS pipeline. The module is compatible with ASP.NET web
forms sites.
* An ASP.NET MVC Controller for better integration and error handling in ASP.NET Applications.
* An Owin Middleware to use with the Owin Pipeline or for integration with ASP.NET Identity.
* An ASP.NET Core2 Handler for use with ASP.NET Core 2.x applications.

Note that the Owin & ASP.NET Core2 modules enables SAML identity providers to be integrated within
[IdentityServer3](https://github.com/IdentityServer/IdentityServer3) and
[IdentityServer4](https://github.com/IdentityServer/IdentityServer4) packages. Review
[this document](docs/IdentityServer3Okta.md) 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.

There are five nuget packages available. The core
[Sustainsys.Saml2](https://www.nuget.org/packages/Sustainsys.Saml2/) contains the core
functionality. The [Sustainsys.Saml2.HttpModule](https://www.nuget.org/packages/Sustainsys.Saml2.HttpModule/)
contains an IIS Http Module.
The [Sustainsys.Saml2.Mvc](https://www.nuget.org/packages/Sustainsys.Saml2.Mvc/)
package contains the MVC controller. The [Sustainsys.Saml2.Owin](https://www.nuget.org/packages/Sustainsys.Saml2.Owin/)
package contains the Owin middleware. Finally the [Sustainsys.Saml2.AspNetCore2](https://nuget.org/packages/Sustainsys.Saml2.AspNetCore2)
contains a Saml2 authentication handler for ASP.NET Core 2.x.

Once the nuget packages are installed you must provide configuration either through code
or through `web.config` sections.
See [configuration](docs/Configuration.md) for details.

## Troubleshooting

* Check the [issues archive](https://github.com/SustainsysIT/Saml2/issues).
* Check the [SAML2 specification](http://saml.xml.org/saml-specifications), starting with the core section.
* Log your actual SAML2 conversation with [SAML Chrome Panel](https://chrome.google.com/webstore/detail/saml-chrome-panel/paijfdbeoenhembfhkhllainmocckace) or [SAML Tracer for Firefox](https://addons.mozilla.org/sv-se/firefox/addon/saml-tracer/).
* Connect an `ILoggerAdapter` to your `SPOptions.Logger`. If you are using the OWIN middleware this is done for you automatically and you can see the output in the OWIN/Katana logging.
* Last but not least, download the Saml2 source and check out what's really happening.

## Saml2AuthenticationModule
The Saml2AuthenticationModule provides Saml2 authentication to IIS web sites. In many cases it should just be
[configured](docs/Configuration.md) in and work without any code written in the application
at all (even though [providing an own ClaimsAuthenticationManager](docs/ClaimsAuthenticationManager.md)
for claims translation is highly recommended).

## Mvc Controller
The MVC package contains an MVC controller that will be accessible in your application just
by installing the package in the application. For MVC applications a controller is preferred
over using the authentication module as it integrates with MVC's error handling.

## Owin Middleware
The Owin middleware is modeled after the external authentication modules for social login
(such as Google, Facebook, Twitter). This allows easy integration with ASP.NET Identity
for keeping application specific user and role information. See the
[Owin Middleware](docs/OwinMiddleware.md) page for information on how to set up and use the middleware.

## ASP.NET Core 2 Handler
The ASP.NET Core 2 Handler is compatible with the ASP.NET Core 2.0 authentication model.

## Stub Idp
The solution also contains a stub (i.e. dummy) identity provider that can be used for testing.
Download the solution, or use the instance that's provided for free at https://stubidp.sustainsys.com.

## Protocol Classes
The protocol handling classes are available as a public API as well, making it possible to
reuse some of the internals for writing your own service provider or identity provider.
## Documentation
Complete documentation is available at [our documentation site](https://saml2.sustainsys.com).

0 comments on commit f0f7535

Please sign in to comment.