.net的casclient源码

# Apereo .NET CAS Client # [](https://ci.appveyor.com/project/mmoayyed/dotnet-cas-client/branch/master) [](https://www.nuget.org/packages/DotNetCasClient/) [](https://www.myget.org/feed/dotnetcasclient-prerelease/package/nuget/DotNetCasClient) [](https://www.myget.org/feed/dotnetcasclient-ci/package/nuget/DotNetCasClient) [](https://opensource.org/licenses/Apache-2.0) [](https://gitter.im/apereo/dotnet-cas-client) [](https://stackoverflow.com/questions/tagged/cas%2b.net) ## Introduction ## The Apereo .NET CAS client provides CAS integration for the Microsoft Windows platform via the .NET framework. ## Features ## - Supports CAS Protocol 1.0 and 2.0 and SAML 1.1 - Supports CAS single sign-out - Rich support for Microsoft ASP.NET platform integration through Forms Authentication framework ## Table of Contents ## * [Downloads](#downloads) * [Release Notes](#release-notes) * [License](#license) * [Documentation](#documentation) * [Building](#building) * [Running](#running) * [Integration Instructions](#integration-instructions) ## Downloads ## * The latest (stable) release is [available on NuGet](https://www.nuget.org/packages/DotNetCasClient/) or can be [downloaded from GitHub](https://github.com/apereo/dotnet-cas-client/releases). * Unstable pre-release versions are [available on MyGet](https://www.myget.org/feed/dotnetcasclient-prerelease/package/nuget/DotNetCasClient) ## Release Notes ## See [ReleaseNotes.md](https://github.com/apereo/dotnet-cas-client/blob/master/ReleaseNotes.md) for details. ## License ## The Apereo .NET CAS Client is open source software, licensed under the Apache License 2.0. See [LICENSE.txt](https://github.com/apereo/dotnet-cas-client/blob/master/LICENSE.txt) for details. ## Documentation ## - [Apereo .NET CAS Client](https://wiki.jasig.org/display/casc/.net+cas+client) - [Apereo Central Authentication Service (CAS)](https://apereo.github.io/cas/) ### Building The source is intended to be built with [Visual Studio 2017](https://www.visualstudio.com/downloads/) (any 2017 edition including the free Community edition will work.) The project can also be built via the command line using a [Cake](https://www.cakebuild.net/) build script. If you are building from the command line, PowerShell or on a build server you must have the [Build Tools for Visual Studio 2017](https://www.visualstudio.com/downloads/) installed on the machine the build is occurring on. To build the project from the command line, all you need to do is drop to PowerShell (or open a PowerShell window directly) and then run the **build.ps1** file to build the project and associated NuGet package. The NuGet package will be copied to the **artifacts** folder in the root of the repo when the build process has completed. ### Running The build (via Visual Studio 2017) produces a single managed assembly, DotNetCasClient.dll, that may be included as a dependency of another project. However, it is recommended you install the NuGet package instead of referencing the DotNetCasClient.dll directly in a project because the NuGet package will handle adding/removing/updating other dependencies and references for you. In addition to adding a dependency, the CAS integration must be configured via the web.config file. See the [Integration Instructions](#integration-instructions) below for details. ### Integration Instructions The .NET CAS client integrates with ASP.NET applications by customizing the application web.config file. The client is implemented as an ASP.NET IHttpModule, CasAuthenticationModule, that provides hooks into the ASP.NET request/response pipeline through lifecycle events. This provides a familiar configuration path for client integration, including the following: - Custom `casClientConfig` section containing CAS-specific configuration parameters that apply to `CasAuthenticationModule` - ASP.NET forms authentication - Registration of CasAuthenticationModule - Authorization configuration - Logging configuration (optional) The `CasAuthenticationModule` must be made available to the application via the familiar process for .NET assemblies; either of the following is sufficient: - Ensure it is deployed to the /Bin directory of the Web application - Add it to the .NET Global Assembly Cache - Configure `CasAuthenticationModule` Define the casClientConfig configuration section: - Register casClientConfig Section ```xml <configSections> <section name="casClientConfig" type="DotNetCasClient.Configuration.CasClientConfiguration, DotNetCasClient"/> <!-- Other custom sections here --> </configSections> ``` Place a `<casClientConfig>` configuration element directly under the root `<configuration>` element. The position of the `<casClientConfig>` element in the web.config file is unimportant. ```xml <casClientConfig casServerLoginUrl="https://server.example.com/cas/login" casServerUrlPrefix="https://server.example.com/cas/" serverName="https://client.example.com:8443" notAuthorizedUrl="~/NotAuthorized.aspx" cookiesRequiredUrl="~/CookiesRequired.aspx" redirectAfterValidation="true" renew="false" singleSignOut="true" ticketValidatorName="Cas20" serviceTicketManager="CacheServiceTicketManager" /> ``` The following attributes are supported in the casClientConfig configuration section. | Attribute | Description | Required | | ----------| -----------| ----------| | `casServerLoginUrl` | URL of CAS login form. | Yes | `serverName ` | Host name of the server hosting this application. This is used to generate URLs that will be sent to the CAS server for redirection. The CAS server must be able to resolve this host name. If your web application is behind a load balancer, SSL offloader, or any other type of device that accepts incoming requests on behalf of the web application, you will generally need to supply the public facing host name unless your CAS server is in the same private network as the application server. The protocol prefix is optional (http:// or https://). If you are using a non-standard port number, be sure to include it (i.e., server.school.edu:8443 or https://server.school.edu:8443). Do not include the trailing backslash. | Yes | `casServerUrlPrefix ` | URL to root of CAS server application. | Yes | `ticketValidatorName ` | Name of ticket validator that validates CAS tickets using a particular protocol. Valid values are `Cas10, Cas20, and Saml11`. | Yes | `gateway` | Enable CAS gateway feature, see http://www.jasig.org/cas/protocol section 2.1.1. Default is false. | No | `renew` | Force user to reauthenticate to CAS before accessing this application. This provides additional security at the cost of usability since it effectively disables SSO for this application. Default is false. | No | `singleSignOut ` | Enables this application to receive CAS single sign-out messages sent when the user's SSO session ends. This will cause the user's session in this application to be destroyed. Default is true. | No | `ticketTimeTolerance` | Adds the given amount of tolerance in milliseconds to the client system time when evaluating the SAML assertion validity period. This effectively allows a given amount of system clock drift between the CAS client and server. Increasing this above the default value may have negative security consequences; we recommend fixing source