使用 MAzure Active Directory 剪裁 Azure AI 搜索结果的安全筛选器

项目
02/15/2024

本文演示如何将安全标识与 Azure AI 搜索中的筛选器结合使用，以根据用户组成员身份剪裁搜索结果。

本文涵盖以下任务：

创建组和用户
将用户与创建的组相关联
缓存新组
使用关联的组编制文档索引
使用组标识符筛选器发出搜索请求

先决条件

Azure AI 搜索中的索引必须有一个安全字段用于存储对文档拥有读取访问权限的组标识列表。此用例假设某个安全对象项（例如个人的大学申请）与指定谁有权访问该项（招生人员）的安全字段之间存在一对一的对应关系。

必须具有租户管理员权限（所有者或管理员）才能创建用户、组和关联。

应用程序还必须注册为多租户应用，如以下过程所述。

将应用程序注册到 Azure Active Directory

此步骤将应用程序与 Azure Active Directory 集成，以便接受用户和组帐户的登录。如果你不是组织的租户管理员，则可能需要创建新租户来执行以下步骤。

在 Azure 门户中，找到 Azure Active Directory 租户。
在左侧的“管理”下选择“应用注册”，然后选择“新建注册” 。
为注册提供一个名称，该名称可以是与搜索应用程序名称类似的名称。若要了解其他可选属性，请参阅此文章。
选择“注册”。
创建应用注册后，复制应用程序（客户端）ID。需要将此字符串提供给应用程序。

如果要单步执行 DotNetHowToSecurityTrimming，请将此值粘贴到 app.config 文件中。
复制目录（租户）ID。
在左侧，依次选择“API 权限”、“添加权限”。
依次选择“Microsoft Graph”、“委托的权限”。
搜索并添加以下委托的权限：
- Directory.ReadWrite.All
- Group.ReadWrite.All
- User.ReadWrite.All
Microsoft Graph 提供了一个 API，允许通过 REST API 以编程方式访问 Azure Active Directory。本演练的代码示例使用调用 Microsoft 图形 API 的权限来创建组、用户和关联。还可以使用 API 缓存组标识符以提高筛选速度。
选择“向租户授予管理员同意”以完成同意过程。

创建用户和组

如果要将搜索添加到已建立的应用程序，则可能在 Azure Active Directory 中具有现有的用户和组标识符。在这种情况下，可以跳过接下来的三个步骤。

但是，如果没有现有用户，可以使用 Microsoft 图形 API 创建安全主体。以下代码片段演示如何生成标识符，这些标识符将成为 Azure AI 搜索索引中安全字段的数据值。在虚构的大学招生应用程序中，这些标识符将是招生工作人员的安全标识符。

用户和组的成员身份可能很不稳定，尤其是在大型组织中。生成用户和组标识的代码应该以足够高的频率运行，以拾取组织成员身份的更改。同样，Azure AI 搜索索引需有类似的更新计划，以反映受允许用户和资源的当前状态。

步骤 1：创建组

private static Dictionary<Group, List<User>> CreateGroupsWithUsers(string tenant)
{
    Group group = new Group()
    {
        DisplayName = "My First Prog Group",
        SecurityEnabled = true,
        MailEnabled = false,
        MailNickname = "group1"
    };

步骤 2：创建用户

User user1 = new User()
{
    GivenName = "First User",
    Surname = "User1",
    MailNickname = "User1",
    DisplayName = "First User",
    UserPrincipalName = String.Format("user1@{0}", tenant),
    PasswordProfile = new PasswordProfile() { Password = "********" },
    AccountEnabled = true
};

步骤 3：将用户和组相关联

List<User> users = new List<User>() { user1, user2 };
Dictionary<Group, List<User>> groups = new Dictionary<Group, List<User>>() { { group, users } };

步骤 4：缓存组标识符

（可选）为了降低网络延迟，可以缓存用户组关联，以便在发出搜索请求时，从缓存返回组，从而节省往返。可以使用 Batch API 发送包含多个用户的单个 Http 请求并生成缓存。

Microsoft Graph 能够处理大量的请求。如果发出无以数计的请求，Microsoft Graph 将会失败并返回 HTTP 状态代码 429。有关详细信息，请参阅 Microsoft Graph 限制。

使用受允许的组编制文档索引

Azure AI 搜索中的查询操作是基于 Azure AI 搜索索引执行的。在此步骤中，索引操作会将可搜索的数据（包括用作安全筛选器的标识符）导入索引。

Azure AI 搜索不会验证用户的身份，也不提供逻辑来确定用户有权查看哪些内容。安全修整的用例假设在某个敏感文档与有权访问该文档的组标识符之间提供了关联，并将这种关联按原样导入了搜索索引。

在虚构的示例中，Azure AI 搜索索引中 PUT 请求的正文应包含申请者的大学申请短文或成绩报告单，以及有权查看该内容的组标识符。

在本演练的代码示例使用的常规示例中，索引操作可能如下所示：

private static void IndexDocuments(string indexName, List<string> groups)
{
    IndexDocumentsBatch<SecuredFiles> batch = IndexDocumentsBatch.Create(
        IndexDocumentsAction.Upload(
            new SecuredFiles()
            {
                FileId = "1",
                Name = "secured_file_a",
                GroupIds = new[] { groups[0] }
            }),
              ...
            };

IndexDocumentsResult result = searchClient.IndexDocuments(batch);

发出搜索请求

为了进行安全修整，索引的安全字段中的值是静态值，用于在搜索结果中包含或排除文档。例如，如果招生人员的组标识符为“A11B22C33D44-E55F66G77-H88I99JKK”，则会在发回给调用方的搜索结果中，包含（或排除）安全字段包含该标识符的 Azure AI 搜索索引中的所有文档。

若要基于发出请求的用户组筛选搜索结果中返回的文档，请查看以下步骤。

步骤 1：检索用户的组标识符

如果用户的组尚未缓存或缓存已过期，请发出组请求。

private static async void RefreshCache(IEnumerable<User> users)
{
    HttpClient client = new HttpClient();
    var userGroups = await _microsoftGraphHelper.GetGroupsForUsers(client, users);
    _groupsCache = new ConcurrentDictionary<string, List<string>>(userGroups);
}

步骤 2：撰写搜索请求

假设你拥有用户的组成员身份，则可以使用相应的筛选器值发出搜索请求。

private static void SearchQueryWithFilter(string user)
{
    // Using the filter below, the search result will contain all documents that their GroupIds field   
    // contain any one of the Ids in the groups list
    string filter = String.Format("groupIds/any(p:search.in(p, '{0}'))", string.Join(",", String.Join(",", _groupsCache[user])));
    SearchOptions searchOptions =
        new SearchOptions()
        {
            Filter = filter
        };
    searchOptions.Select.Add("name");

    SearchResults<SecuredFiles> results = searchClient.Search<SecuredFiles>("*", searchOptions);

    Console.WriteLine("Results for groups '{0}' : {1}", _groupsCache[user], results.GetResults().Select(r => r.Document.Name));
}

步骤 3：处理结果

响应包含文档的筛选列表，该列表由用户有权查看的文档构成。根据搜索结果页的构造方式，可能需要包含视觉线索来反映筛选的结果集。

要点

在本演练中，你了解了使用用户登录筛选 Azure AI 搜索结果中的文档的模式，并剪裁了与请求上提供的筛选器不匹配的文档的结果。

通过