1. 内容概述

自定义安全提供程序是一个实现了Wyn Enterprise规定接口的DLL程序。该程序的核心是一个验证用户账号和密码，通过验证后返回一个令牌。令牌是一个特殊的字符串，可用于访问Wyn Enterprise的报表和仪表板等内容。

2. 操作步骤

编写一个自定义安全提供程序的步骤如下：

(1)  创建项目

使用Microsoft Visual Studio 2017（以下简称VS2017），创建一个新的项目，类型选为 Visual C# - .NET Standard - 类库(.NET Standard)，输入项目名称，如：MySecurityProvider：

(2)  添加程序包依赖

自定义安全提供程序所实现的接口是由几个程序包定义的，为此需要添加对这几个程序包的依赖。方法如下：

首先将下面这两个文件下载保存到本地硬盘，比如C:\Temp\pkg 文件夹下：

grapecity.enterprise.identity.externalidentityprovider.1.0.2.nupkg

GrapeCity.Enterprise.Identity.SecurityProvider.1.0.3.nupkg

单击VS2017的“工具”菜单的“NuGet包管理器”>“程序包管理器设置”：

选中“程序包源”，再单击加号按钮：

单击【...】按钮，指定“源”的路径为nupkg文件所在的文件夹，如：C:\temp\pkg

单击“确定”按钮保存设置。

在右侧解决方案资源管理器窗格中，右键单击“依赖项”，点击“管理NuGet程序包”，再点击“浏览”，选中新添加的程序包源，将会列出两个需要依赖的程序包：

GrapeCity.Enterprise.Identity.ExternalIdentityProvider和GrapeCity.Enterprise.Identity.SecurityProvider，如下图：

逐个选中程序包，点击“安装”，即可添加本项目对这两个程序包的依赖。

(3)  实现接口

自定义安全提供程序需要实现两个接口：ISecurityProviderFactory和ISecurityProvider。

实现第一个接口的操作步骤：

添加一个新的类文件，如MySecurityProviderFactory.cs，以实现ISecurityProviderFactory接口。

public class MySecurityProviderFactory: ISecurityProviderFactory

该接口规定了两个属性和一个方法：

public string Description // 本安全提供程序的描述字串。

public IEnumerable<ConfigurationItem> SupportedSettings // 本安全提供程序支持的用户配置项。

这些用户配置项将出现在Wyn的管理画面中，允许系统管理员进行设置。典型的配置项是用户信息数据库的连接字串。通过提供这种配置项目，可以避免在安全提供程序中硬编码用户信息数据库连接字串的问题。

public Task<ISecurityProvider> CreateAsync(IEnumerable<ConfigurationItem> settings) // 本安全提供程序的实例创建方法。

这个方法的内容几乎是固定的，如：

public Task<ISecurityProvider> CreateAsync(IEnumerable<ConfigurationItem> settings)
{
	return Task.FromResult<ISecurityProvider>(new MySecurityProvider(settings));
}

实现ISecurityProvider接口

这个ISecurityProvider接口是安全提供程序的核心，其规定的属性和方法如下：

除了上表所列成员，还有IExternalUserDescriptor，IExternalUserContext等接口，这些接口只是规定了实体类的属性，使用自定义类实现这些接口即可。

下面的文件附件是一个自定义安全提供程序的示例代码。

MySecurityProvider.zip

此示例代码中的解决方案（.sln）可在Visual Studio 2017中直接打开。示例代码文件夹\bin\debug中也包含Build产物DLL，可直接配置为Wyn Enterprise的安全提供程序。示例的用户信息是保存在SQL Server数据库中的，请将本文件包中的db\MyUsers.bak文件恢复为SQL Server数据库。

有关接口的详细说明，请参考下面的接口介绍。

3. 接口介绍

ISecurityProviderFactory接口

定义

public interface ISecurityProviderFactory  
{
	string ProviderName { get; }
	string Description { get; }
	IEnumerable<ConfigurationItem> SupportedSettings { get; }
	Task<ISecurityProvider> CreateAsync(IEnumerable<ConfigurationItem> settings);
}

接口说明

ISecurityProvider接口

定义

public interface ISecurityProvider
{
	string ProviderName { get; }
	Task DisposeTokenAsync(string token);
	Task<string> GenerateTokenAsync(string username, string password, object customizedParam = null);
	Task<IExternalUserContext> GetUserContextAsync(string token);
	Task<IExternalUserDescriptor> GetUserDescriptorAsync(string token);
	Task<string[]> GetUserOrganizationsAsync(string token);
	Task<string[]> GetUserRolesAsync(string token);
	Task<bool> ValidateTokenAsync(string token);
}

接口说明

IExternalUserDescriptor接口

定义

public interface IExternalUserDescriptor
{
	string ExternalUserId { get; }
	string ExternalUserName { get; }
	string ExternalProvider { get; }
}

接口说明

IExternalUserContext接口

定义

public interface IExternalUserContext
{
	IEnumerable<string> Keys { get; }
	Task<string> GetValueAsync(string key);
	Task<IEnumerable<string>> GetValuesAsync(string key);
}

接口说明

编写好的安全提供程序，通过构建，得到DLL文件。然后就可以配置到Wyn Enterprise系统中了，具体步骤参见：

配置自定义安全提供程序