在 ASP.NET 应用中共享身份验证 cookie

作者： Rick Anderson和Luke Latham

网站通常由单独的 web 应用组成。若要提供单一登录（SSO）体验，站点内的 web 应用必须共享身份验证 cookie。若要支持这种情况下，数据保护堆栈允许在共享 Katana cookie 身份验证和 ASP.NET Core cookie 身份验证票证。

在下面的示例中：

身份验证 cookie 名称设置为的.AspNet.SharedCookie公共值。
设置为显式或默认设置为Identity.Application。 AuthenticationType
常见的应用程序名称用于使数据保护系统共享数据保护密钥（SharedCookieApp）。
Identity.Application用作身份验证方案。无论使用哪种方案，都必须在共享 cookie 应用内和中以一致的方式使用它，或者通过显式设置。加密和解密 cookie 时使用该方案，因此必须在应用间使用一致的方案。
使用通用的数据保护密钥存储位置。
- 在 ASP.NET Core 应用中PersistKeysToFileSystem ，用于设置密钥存储位置。
- 在 .NET Framework 应用中，Cookie 身份验证中间件使用DataProtectionProvider的实现。 DataProtectionProvider为身份验证 cookie 负载数据的加密和解密提供数据保护服务。该DataProtectionProvider实例与应用程序的其他部分所使用的数据保护系统隔离。 DataProtectionProvider （DirectoryInfo，Action<IDataProtectionBuilder >）接受DirectoryInfo来指定数据保护密钥存储的位置。
DataProtectionProvider需要 DataProtection NuGet 包AspNetCore ：
- 在 ASP.NET Core 1.x 应用程序中，请参阅AspNetCore 元包。
- 在 .NET Framework 应用中，将包引用添加到AspNetCore. DataProtection。
SetApplicationName设置常见的应用名称。

当使用 ASP.NET Core标识：

数据保护密钥和应用程序名称必须在应用之间共享。在以下示例中，将向PersistKeysToFileSystem方法提供一个公共密钥存储位置。使用SetApplicationName配置公共共享应用名称（SharedCookieApp在以下示例中）。有关详细信息，请参阅配置 ASP.NET Core数据保护。
ConfigureApplicationCookie使用扩展方法为 cookie 设置数据保护服务。
默认的身份验证类型Identity.Application为。

在 Startup.ConfigureServices中：

services.AddDataProtection()
    .PersistKeysToFileSystem("{PATH TO COMMON KEY RING FOLDER}")
    .SetApplicationName("SharedCookieApp");

services.ConfigureApplicationCookie(options => {
    options.Cookie.Name = ".AspNet.SharedCookie";
});

如果在不 ASP.NET Core 标识的情况下直接使用 cookie，请在Startup.ConfigureServices中配置数据保护和身份验证。在下面的示例中，"身份验证类型" Identity.Application设置为：

services.AddDataProtection()
    .PersistKeysToFileSystem("{PATH TO COMMON KEY RING FOLDER}")
    .SetApplicationName("SharedCookieApp");

services.AddAuthentication("Identity.Application")
    .AddCookie("Identity.Application", options =>
    {
        options.Cookie.Name = ".AspNet.SharedCookie";
    });

身份验证 cookie 使用HttpRequest. PathBase作为其默认的cookie。如果应用的 cookie 必须在不同的基路径间共享， Path则必须重写：

services.AddDataProtection()
    .PersistKeysToFileSystem("{PATH TO COMMON KEY RING FOLDER}")
    .SetApplicationName("SharedCookieApp");

services.ConfigureApplicationCookie(options => {
    options.Cookie.Name = ".AspNet.SharedCookie";
    options.Cookie.Path = "/";
});

承载跨子域共享 cookie 的应用时，请在 " Cookie " 属性中指定一个公共域。若contoso.com要在中的应用之间共享 cookie first_subdomain.contoso.com （ second_subdomain.contoso.com例如和） Cookie.Domain ， .contoso.com请将指定为：

options.Cookie.Domain = ".contoso.com";

加密静态数据保护密钥

对于生产部署，请将DataProtectionProvider配置为使用 DPAPI 或 X509Certificate 加密静态密钥。有关详细信息，请参阅在 ASP.NET Core 中存放的密钥加密。在下面的示例中，提供了一个证书指纹ProtectKeysWithCertificate来执行以下操作：

services.AddDataProtection()
    .ProtectKeysWithCertificate("{CERTIFICATE THUMBPRINT}");

使用 Katana Cookie 身份验证中间件的 ASP.NET 4.x 应用程序可以配置为生成与 ASP.NET Core Cookie 身份验证中间件兼容的身份验证 cookie。这允许在多个步骤中升级大型站点的单个应用，同时跨站点提供平稳的 SSO 体验。

当应用使用 Katana Cookie 身份验证中间件时， UseCookieAuthentication它会调用项目的Startup.Auth.cs文件。使用 Visual Studio 2013 和更高版本创建的 ASP.NET 4.x web 应用项目默认使用 Katana Cookie 身份验证中间件。尽管UseCookieAuthentication ASP.NET Core 应用已过时且不受支持， UseCookieAuthentication但在使用 Katana Cookie 身份验证中间件的 ASP.NET 4.x 应用中调用是有效的。

ASP.NET 4.x 应用必须面向 .NET Framework 4.5.1 或更高版本。否则，无法安装所需的 NuGet 包。

若要在 ASP.NET 4.x 应用和 ASP.NET Core 应用之间共享身份验证 cookie，请按在ASP.NET Core 应用之间共享身份验证 cookie部分中所述配置 ASP.NET Core 应用，然后按如下所示配置 ASP.NET 4.x 应用。

确认应用的包已更新到最新版本。将Owin包安装到每个 ASP.NET 1.x 应用程序中。

查找并修改对UseCookieAuthentication的调用：

更改 cookie 名称，使其与 ASP.NET Core cookie 身份验证中间件使用的名称.AspNet.SharedCookie匹配（在本示例中）。
在下面的示例中，"身份验证类型" Identity.Application设置为。
向通用数据保护密钥DataProtectionProvider存储位置提供已初始化的实例。
确认应用名称设置为共享身份验证 cookie 的所有应用使用的通用应用名称（SharedCookieApp在此示例中）。

如果未设置http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier和http://schemas.microsoft.com/accesscontrolservice/2010/07/claims/identityprovider，则UniqueClaimTypeIdentifier将设置为区分唯一用户的声明。

App_Start/ authentication：

app.UseCookieAuthentication(new CookieAuthenticationOptions
{
    AuthenticationType = "Identity.Application",
    CookieName = ".AspNet.SharedCookie",
    LoginPath = new PathString("/Account/Login"),
    Provider = new CookieAuthenticationProvider
    {
        OnValidateIdentity =
            SecurityStampValidator
                .OnValidateIdentity<ApplicationUserManager, ApplicationUser>(
                    validateInterval: TimeSpan.FromMinutes(30),
                    regenerateIdentity: (manager, user) =>
                        user.GenerateUserIdentityAsync(manager))
    },
    TicketDataFormat = new AspNetTicketDataFormat(
        new DataProtectorShim(
            DataProtectionProvider.Create("{PATH TO COMMON KEY RING FOLDER}",
                (builder) => { builder.SetApplicationName("SharedCookieApp"); })
            .CreateProtector(
                "Microsoft.AspNetCore.Authentication.Cookies." +
                    "CookieAuthenticationMiddleware",
                "Identity.Application",
                "v2"))),
    CookieManager = new ChunkingCookieManager()
});

System.Web.Helpers.AntiForgeryConfig.UniqueClaimTypeIdentifier =
    "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name";

生成用户标识时，Identity.Application身份验证类型（）必须与在 AuthenticationType App_Start/中使用 set UseCookieAuthentication with 定义的类型匹配。

模型/IdentityModels：

public class ApplicationUser : IdentityUser
{
    public async Task<ClaimsIdentity> GenerateUserIdentityAsync(
        UserManager<ApplicationUser> manager)
    {
        // The authenticationType must match the one defined in 
        // CookieAuthenticationOptions.AuthenticationType
        var userIdentity = 
            await manager.CreateIdentityAsync(this, "Identity.Application");

        // Add custom user claims here

        return userIdentity;
    }
}

使用公共用户数据库

如果应用使用相同的标识架构（同一版本标识），请确认每个应用的标识系统指向同一用户数据库。否则，当标识系统尝试将身份验证 cookie 中的信息与数据库中的信息进行匹配时，它将在运行时生成故障。

当标识架构在应用中不同时，通常是因为应用使用的是不同的标识版本，因此，在不重新映射和添加其他应用的标识架构中的列的情况下，不能使用最新版本的标识共享公共数据库。将其他应用程序升级到使用最新的标识版本通常更高效，以便应用可以共享公共数据库。

其他资源

在 Web 场中托管 ASP.NET Core

在应用之间共享 Cookie

在 ASP.NET 应用中共享身份验证 cookie

加密静态数据保护密钥

使用公共用户数据库

其他资源

通用

身份验证

授权

数据保护

机密管理

在 ASP.NET 应用中共享身份验证 cookie

与 ASP.NET Core 标识共享身份验证 cookie

共享身份验证 cookie 但不 ASP.NET Core 标识

跨不同的基路径共享 cookie

跨子域共享 cookie

加密静态数据保护密钥

在 ASP.NET 4.x 和 ASP.NET Core 应用之间共享身份验证 cookie

使用公共用户数据库

其他资源

通用

身份验证

授权

数据保护

机密管理