本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

配置授权和身份验证以保护您的 GraphQL APIs

AWS AppSync 提供以下授权类型来保护 GraphQL APIs：API 密钥、Lambda、IAM、OpenID Connect 和 Cognito 用户池。每个选项都提供不同的安全方法：

授权类型

您可以通过五种方式授权应用程序与您的 AWS AppSync GraphQL API 进行交互。您可以通过在 AWS AppSync API 或 CLI 调用中指定以下授权类型值之一来指定所使用的授权类型：

这些基本授权类型适用于大多数开发人员。对于更高级的使用案例，您可以通过控制台、CLI 和 AWS CloudFormation添加其他授权模式。对于其他授权模式， AWS AppSync 提供一种采用上面列出的值的授权类型（即API_KEY、AWS_LAMBDA、AWS_IAM、OPENID_CONNECT、和AMAZON_COGNITO_USER_POOLS）。

在将 API_KEY、AWS_LAMBDA 或 AWS_IAM 指定为主要或默认授权类型时，您不能再次将其指定为其他授权模式之一。同样，您不能在其他授权模式中重复使用 API_KEY、AWS_LAMBDA 或 AWS_IAM。您可以使用多个 Amazon Cognito 用户池和 OpenID Connect 提供程序。不过，您不能在默认授权模式和任何其他授权模式之间使用重复的 Amazon Cognito 用户池或 OpenID Connect 提供程序。您可以使用相应的配置正则表达式，为 Amazon Cognito 用户池或 OpenID Connect 提供程序指定不同的客户端。

API_KEY 授权

未经身份验证 APIs 需要比经过身份验证更严格的限制。 APIs一种对未经身份验证的 GraphQL 终端节点的限制进行控制的方法是使用 API 密钥。API 密钥是应用程序中的一个硬编码值，当您创建未经身份验证的 GraphQL 端点时由 AWS AppSync 服务生成。您可以通过控制台或 CLI 轮换 API 密钥，或者按照 AWS AppSync API reference 轮换 API 密钥。

Console

1. 登录 AWS Management Console 并打开AppSync 控制台。

   1. 在APIs 控制面板中，选择你的 GraphQL API。

   2. 在侧边栏中，选择设置。

2. 在默认授权模式下面，选择 API 密钥。

3. 在 API 密钥表中，选择添加 API 密钥。

   将在表中生成一个新的 API 密钥。

   1. 要删除旧 API 密钥，请在表中选择该 API 密钥，然后选择删除。

4. 在页面底部选择 Save (保存)。

CLI

1. 如果您尚未这样做，请配置您对 AWS CLI 的访问权限。有关更多信息，请参阅配置基础知识。

2. 运行 update-graphql-api 命令以创建 GraphQL API 对象。

   您需要为该特定命令键入两个参数：

   1. 您的 GraphQL API 的 api-id。

   2. 您的 API 的新 name。您可以使用相同的 name。

   3. authentication-type，它是 API_KEY。

   注意

   必须配置其他参数（例如 Region），但这些参数通常默认为您的 CLI 配置值。

   示例命令可能如下所示：

   aws appsync update-graphql-api --api-id abcdefghijklmnopqrstuvwxyz --name TestAPI --authentication-type API_KEY

   将在 CLI 中返回输出。以下是 JSON 格式的示例：

   {
       "graphqlApi": {
           "xrayEnabled": false,
           "name": "TestAPI",
           "authenticationType": "API_KEY",
           "tags": {},
           "apiId": "abcdefghijklmnopqrstuvwxyz",
           "uris": {
               "GRAPHQL": "https://s8i3kk3ufhe9034ujnv73r513e.appsync-api.us-west-2.amazonaws.com/graphql",
               "REALTIME": "wss://s8i3kk3ufhe9034ujnv73r513e.appsync-realtime-api.us-west-2.amazonaws.com/graphql"
           },
           "arn": "arn:aws:appsync:us-west-2:348581070237:apis/abcdefghijklmnopqrstuvwxyz"
       }
   }

API 密钥可配置为最多 365 天，并且您可以将现有到期日期再延长多达 365 天（从到期日期当天开始）。建议将 API 密钥用于开发目的或可以安全公开公有 API 的使用案例。

在客户端，通过标头 x-api-key 指定 API 密钥。

例如，如果您的 API_KEY 为 'ABC123'，则您可以通过 curl 发送 GraphQL 查询，如下所示：

$ curl -XPOST -H "Content-Type:application/graphql" -H "x-api-key:ABC123" -d '{ "query": "query { movies { id } }" }' https://YOURAPPSYNCENDPOINT/graphql

AWS_LAMBDA 授权

您可以使用 AWS Lambda 函数实现自己的 API 授权逻辑。您可以将 Lambda 函数用于主要或辅助授权者，但每个 API 只能有一个 Lambda 授权函数。在使用 Lambda 函数进行授权时，以下限制适用：

例如，如果您的授权令牌是 'ABC123'，您可以通过 curl 发送 GraphQL 查询，如下所示：

$ curl -XPOST -H "Content-Type:application/graphql" -H "Authorization:ABC123" -d '{ "query":
         "query { movies { id } }" }' https://YOURAPPSYNCENDPOINT/graphql
      

Lambda 函数是在每个查询或变更之前调用的。可以根据 API ID 和身份验证令牌缓存返回值。默认情况下，不会开启缓存，但可以在 API 级别启用该功能，或者在函数的返回值中设置 ttlOverride 值以启用该功能。

如果需要，可以指定一个正则表达式，以在调用函数之前验证授权令牌。这些正则表达式用于在调用函数之前验证授权令牌格式是否正确。将自动拒绝使用的令牌与该正则表达式不匹配的任何请求。

用于授权的 Lambda 函数需要对其应用委托人策略 AWS AppSync 才能允许调用它们。appsync.amazonaws.com此操作在 AWS AppSync 控制台中自动完成； AWS AppSync 控制台不会删除策略。有关向 Lambda 函数附加策略的更多信息，请参阅开发人员指南中的基于资源的策略。 AWS Lambda

您指定的 Lambda 函数将收到具有以下形状的事件：

{
    "authorizationToken": "ExampleAUTHtoken123123123",
    "requestContext": {
        "apiId": "aaaaaa123123123example123",
        "accountId": "111122223333",
        "requestId": "f4081827-1111-4444-5555-5cf4695f339f",
        "queryString": "mutation CreateEvent {...}\n\nquery MyQuery {...}\n",
        "operationName": "MyQuery",
        "variables": {}
    }
    "requestHeaders": {
        application request headers
    }
}

该event对象包含应用程序客户端在请求中发送到的标头 AWS AppSync。

授权函数必须至少返回一个布尔值isAuthorized，表示请求是否获得授权。 AWS AppSync 识别从 Lambda 授权函数返回的以下密钥：

要在 AWS AppSync中添加 Lambda 函数以作为默认授权模式，请执行以下操作：

Console

1. 登录 AWS AppSync 控制台并导航到您要更新的 API。

2. 导航到您的 API 的“设置”页面。

   将 API 级别授权更改为 AWS Lambda。

3. 选择 AWS 区域 和 Lambda ARN 来授权 API 调用。

   注意

   将自动添加相应的主体策略，从而允许 AWS AppSync 调用您的 Lambda 函数。

4. （可选）设置响应 TTL 和令牌验证正则表达式。

AWS CLI

1. 将以下策略附加到使用的 Lambda 函数：

   aws lambda add-permission --function-name "my-function" --statement-id "appsync" --principal appsync.amazonaws.com --action lambda:InvokeFunction --output text 

   重要

   如果您希望将函数策略锁定到单个 GraphQL API，您可以运行以下命令：

   aws lambda add-permission --function-name “my-function” --statement-id “appsync” --principal appsync.amazonaws.com --action lambda:InvokeFunction --source-arn “<my AppSync API ARN>” --output text

2. 更新您的 AWS AppSync API 以使用给定的 Lambda 函数 ARN 作为授权方：

   aws appsync update-graphql-api --api-id example2f0ur2oid7acexample --name exampleAPI --authentication-type AWS_LAMBDA --lambda-authorizer-config authorizerUri="arn:aws:lambda:us-east-2:111122223333:function:my-function"

   注意

   您还可以包含其他配置选项，例如令牌正则表达式。

以下示例介绍了一个 Lambda 函数，以说明 Lambda 函数在作为 AWS AppSync 授权机制时可能具有的各种身份验证和失败状态：

def handler(event, context):
  # This is the authorization token passed by the client
  token = event.get('authorizationToken')
  # If a lambda authorizer throws an exception, it will be treated as unauthorized. 
  if 'Fail' in token:
    raise Exception('Purposefully thrown exception in Lambda Authorizer.')

  if 'Authorized' in token and 'ReturnContext' in token:
    return {
      'isAuthorized': True,
      'resolverContext': {
        'key': 'value'
      }
    }

  # Authorized with no f
  if 'Authorized' in token:
    return {
      'isAuthorized': True
    }
  # Partial authorization
  if 'Partial' in token:
    return {
      'isAuthorized': True,
      'deniedFields':['user.favoriteColor']
    }
  if 'NeverCache' in token:
    return {
      'isAuthorized': True,
      'ttlOverride': 0
    }
  if 'Unauthorized' in token:
    return {
      'isAuthorized': False
    }
  # if nothing is returned, then the authorization fails. 
  return {}

规避 SigV4 和 OIDC 令牌授权限制

可以使用以下方法规避启用某些授权模式时无法将 SigV4 签名或 OIDC 令牌作为 Lambda 授权令牌的问题。

如果要在为 AWS AppSync API 启用了 AWS_IAM 和 AWS_LAMBDA 授权模式时将 SigV4 签名作为 Lambda 授权令牌，请执行以下操作：

如果要在的 API 启用授权模式或AMAZON_COGNITO_USER_POOLS和授权模式时使用 OIDC 令牌作为 Lambda AWS_LAMBDA 授权令牌，请执行以下操作：OPENID_CONNECT AWS AppSync

AWS_IAM 授权

该授权类型对 GraphQL API 强制执行 AWS 签名版本 4 签名过程。您可以将 Identity and Access Management (IAM) 访问策略与此授权类型关联。您的应用程序可以使用访问密钥（由访问密钥 ID 和秘密访问密钥组成）或 Amazon Cognito 联合身份提供的短期临时凭证以利用该关联。

如果您希望有访问权限的角色执行所有数据操作：

{
   "Version": "2012-10-17",
   "Statement": [
      {
         "Effect": "Allow",
         "Action": [
            "appsync:GraphQL"
         ],
         "Resource": [
            "arn:aws:appsync:us-west-2:123456789012:apis/YourGraphQLApiId/*"
         ]
      }
   ]
}

你可以在 AppSync控制YourGraphQLApiId台的主API列表页面找到你的 API 名称正下方。或者，您也可以使用 CLI 检索它：aws appsync list-graphql-apis

如果您只想限制对某些 GraphQL 操作的访问，您可以对根 Query、Mutation 和 Subscription 字段执行此操作。

{
   "Version": "2012-10-17",
   "Statement": [
      {
         "Effect": "Allow",
         "Action": [
            "appsync:GraphQL"
         ],
         "Resource": [
            "arn:aws:appsync:us-west-2:123456789012:apis/YourGraphQLApiId/types/Query/fields/<Field-1>",
            "arn:aws:appsync:us-west-2:123456789012:apis/YourGraphQLApiId/types/Query/fields/<Field-2>",
            "arn:aws:appsync:us-west-2:123456789012:apis/YourGraphQLApiId/types/Mutation/fields/<Field-1>",
            "arn:aws:appsync:us-west-2:123456789012:apis/YourGraphQLApiId/types/Subscription/fields/<Field-1>"
         ]
     }
   ]
}

例如，假设您具有以下架构，并且您想要限制能够获取所有文章的访问权限：

schema {
   query: Query
   mutation: Mutation
}

type Query {
   posts:[Post!]!
}

type Mutation {
   addPost(id:ID!, title:String!):Post!
}

角色的相应 IAM 策略（例如，您可以将其附加到 Amazon Cognito 身份池）将如下所示：

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
            "appsync:GraphQL"
            ],
            "Resource": [
                "arn:aws:appsync:us-west-2:123456789012:apis/YourGraphQLApiId/types/Query/fields/posts"
            ]
        }
    ]
}

OPENID_CONNECT 授权

该授权类型强制实施 OIDC 兼容服务提供的 OpenID Connect (OIDC) 令牌。您的应用程序可以利用由 OIDC 提供程序定义的用户和权限来控制访问。

发布者 URL 是由您提供给 AWS AppSync 的唯一需要的配置值，例如 https://auth.example.com。此网址必须可通过 HTTPS 进行寻址。 AWS AppSync 附加/.well-known/openid-configuration到颁发者网址并按照 OpenID Connect Discovery 规范找到 https://auth.example.com/.well-known/openid-configuration OpenID 配置。它希望通过此网址检索RFC5785合规的 JSON 文档。此 JSON 文档必须包含一个jwks_uri密钥，该密钥指向带有签名密钥的 JSON Web 密钥集 (JWKS) 文档。 AWS AppSync 要求 JWKS 包含和的 JSON 字段。kty kid

AWS AppSync 支持多种签名算法。

我们建议您使用 RSA 算法。提供程序颁发的令牌必须包括颁发令牌的时间 (iat)，并可能包含对其进行身份验证的时间 (auth_time)。您可以在 OpenID Connect 配置中为颁发时间 (iatTTL) 和身份验证时间 (authTTL) 提供 TTL 值以进行额外的验证。如果您的提供程序授权多个应用程序，还可以提供一个用于按客户端 ID 进行授权的正则表达式 (clientId)。当您clientId的 OpenID Connect 配置中存在时，通过要求与令牌中的aud或azp声明匹配clientId来 AWS AppSync 验证声明。

要验证多个客户端， IDs 请使用管道运算符 (“|”)，这是正则表达式中的 “或”。例如，如果您的 OIDC 应用程序有四个客户端，其客户端（ IDs例如 0A1S2D、1F4G9H、1J6L4B、6 GS5 MG）仅验证前三个客户端，则应在客户端 IDs ID 字段中放置 1F4G9H|1J6L4 GS5 B|6 MG。

AMAZON_COGNITO_USER_POOLS 授权

该授权类型强制实施 Amazon Cognito 用户池提供的 OIDC 令牌。您的应用程序可以利用您的用户池和其他 AWS 账户的用户池中的用户和群组，并将它们与 GraphQL 字段关联以控制访问权限。

在使用 Amazon Cognito 用户池时，您可以创建用户所属的组。此信息以 JWT 令牌编码，您的应用程序在发送 GraphQL 操作时将其发送到授权标头 AWS AppSync 中。您可以在架构上使用 GraphQL 指令以控制哪些组可以对字段调用哪些解析器，从而向客户提供更受控制的访问。

例如，假设您具有以下 GraphQL 架构：

schema {
   query: Query
   mutation: Mutation
}

type Query {
   posts:[Post!]!
}

type Mutation {
   addPost(id:ID!, title:String!):Post!
}
...

如果您在 Amazon Cognito 用户池中具有两个组（bloggers 和 readers），并希望限制读者以使他们无法添加新条目，则架构应如下所示：

schema {
   query: Query
   mutation: Mutation
}

type Query {
   posts:[Post!]!
   @aws_auth(cognito_groups: ["Bloggers", "Readers"])
}

type Mutation {
   addPost(id:ID!, title:String!):Post!
   @aws_auth(cognito_groups: ["Bloggers"])
}
...

请注意，如果您想默认使用特定的访问 grant-or-deny策略，则可以省略该@aws_auth指令。通过控制台或以下 CLI 命令创建 GraphQL API 时，可以在用户池配置中指定 grant-or-deny策略：

$ aws appsync --region us-west-2 create-graphql-api --authentication-type AMAZON_COGNITO_USER_POOLS  --name userpoolstest --user-pool-config '{ "userPoolId":"test", "defaultEffect":"ALLOW", "awsRegion":"us-west-2"}'

使用其他授权模式

添加其他授权模式时，可以直接在 AWS AppSync GraphQL API 级别配置授权设置（即可以直接在GraphqlApi对象上配置的authenticationType字段），它充当架构上的默认设置。这意味着任何没有特定指令的类型都必须通过 API 级别授权设置。

在架构级别，您可以使用架构上的指令指定其他授权模式。您可以在架构中的各个字段上指定授权模式。例如，对于 API_KEY 授权，您将在架构对象类型定义/字段上使用 @aws_api_key。架构字段和对象类型定义支持以下指令：

您不能将 @aws_auth 指令与其他授权模式一起使用。@aws_auth 仅适用于 AMAZON_COGNITO_USER_POOLS 授权的上下文，没有其他授权模式。但是，您可以使用 @aws_cognito_user_pools 指令代替 @aws_auth 指令，使用相同的参数。两者之间的主要区别在于您可以在任何字段和对象类型定义上指定 @aws_cognito_user_pools。

要了解其他授权模式如何工作以及如何在架构上指定它们，我们来看一下以下架构：

schema {
   query: Query
   mutation: Mutation
}

type Query {
   getPost(id: ID): Post
   getAllPosts(): [Post]
   @aws_api_key
}

type Mutation {
   addPost(
      id: ID!
      author: String!
      title: String!
      content: String!
      url: String!
   ): Post!
}

type Post @aws_api_key @aws_iam {
   id: ID!
   author: String
   title: String
   content: String
   url: String
   ups: Int!
   downs: Int!
   version: Int!
}
...

对于此架构，假设这AWS_IAM是 AWS AppSync GraphQL API 上的默认授权类型。这意味着使用 AWS_IAM 保护没有指令的字段。例如，Query 类型上的 getPost 字段就是这种情况。架构指令使您可以使用多种授权模式。例如，您可以在 AWS AppSync GraphQL API 上API_KEY配置为额外的授权模式，也可以使用@aws_api_key指令标记字段（例如，在本示例getAllPosts中）。指令在字段级别工作，因此您也需要授予 API_KEY 访问 Post 类型的权限。您可以通过使用指令标记 Post 类型中的每个字段，或使用 @aws_api_key 指令标记 Post 类型来执行此操作。

要进一步限制对 Post 类型中的字段的访问，可以对 Post 类型中的各个字段使用指令，如下所示。

例如，您可以将 restrictedContent 字段添加到 Post 类型并使用 @aws_iam 指令限制对它的访问。 AWS_IAM 经过身份验证的请求可以访问 restrictedContent，但是，API_KEY 请求将无法访问它。

type Post @aws_api_key @aws_iam{
   id: ID!
   author: String
   title: String
   content: String
   url: String
   ups: Int!
   downs: Int!
   version: Int!
   restrictedContent: String!
   @aws_iam
}
...

精细访问控制

上述信息演示了如何限制或授权对某些 GraphQL 字段的访问权限。如果您想根据某些条件（例如，根据进行调用的用户以及用户是否拥有数据）来设置对数据的访问控制，则可以使用解析器中的映射模板。您还可以执行更复杂的业务逻辑，筛选信息中介绍了相关内容。

本节介绍了如何使用 DynamoDB 解析器映射模板设置数据的访问控制。

在继续操作之前，如果您不熟悉中的 AWS AppSync映射模板，则可能需要查看 DynamoDB 的解析器映射模板参考和 DynamoDB 的解析器映射模板参考。

在使用 DynamoDB 的以下示例中，假设您使用前面的博客文章架构，并且仅允许创建博客的用户对其进行编辑。评估过程将是用户在应用程序中获得凭证（例如，使用 Amazon Cognito 用户池），然后将这些凭证作为 GraphQL 操作的一部分进行传递。然后，映射模板将替换条件语句中凭证（如用户名）的值，该值随后将与数据库中的值进行比较。

要添加此功能，请添加 GraphQL 字段 editPost，如下所示：

schema {
   query: Query
   mutation: Mutation
}

type Query {
   posts:[Post!]!
}

type Mutation {
   editPost(id:ID!, title:String, content:String):Post
   addPost(id:ID!, title:String!):Post!
}
...

editPost 的解析器映射模板（本节末尾的示例中所示）需要针对您的数据存储执行逻辑检查，以仅允许创建文章的用户对文章进行编辑。由于这是一个编辑操作，因此，它对应于 DynamoDB 中的 UpdateItem。您可以先执行条件检查，然后再执行此操作，同时使用传递的上下文进行用户身份验证。这些信息存储在一个 Identity 对象中，该对象具有以下值：

{
   "accountId" : "12321434323",
   "cognitoIdentityPoolId" : "",
   "cognitoIdentityId" : "",
   "sourceIP" : "",
   "caller" : "ThisistheprincipalARN",
   "username" : "username",
   "userArn" : "Sameasabove"
}

要在 DynamoDB UpdateItem 调用中使用该对象，您需要在表中存储用户身份信息以进行比较。首先，您的 addPost 变更需要存储创建者。其次，您的 editPost 变更需要先执行条件检查，然后才能更新。

下面是 addPost 的解析器代码示例，用于将用户身份存储为 Author 列：

import { util, Context } from '@aws-appsync/utils';
import { put } from '@aws-appsync/utils/dynamodb';

export function request(ctx) {
	const { id: postId, ...item } = ctx.args;
	return put({
		key: { postId },
		item: { ...item, Author: ctx.identity.username },
		condition: { postId: { attributeExists: false } },
	});
}

export const response = (ctx) => ctx.result;

请注意，Author 属性通过 Identity 对象填充，该对象来自应用程序。

最后，此处的示例介绍了 editPost 的解析器代码，此代码仅当请求来自创建博客文章的用户时，才更新该博客文章的内容。

import { util, Context } from '@aws-appsync/utils';
import { put } from '@aws-appsync/utils/dynamodb';

export function request(ctx) {
	const { id, ...item } = ctx.args;
	return put({
		key: { id },
		item,
		condition: { author: { contains: ctx.identity.username } },
	});
}

export const response = (ctx) => ctx.result;

此示例使用 PutItem 覆盖所有值，而不是使用 UpdateItem，但同样的概念适用于 condition 语句块。

筛选信息

有时，在成功写入或读取数据来源时，您可能无法控制来自数据来源的响应，但又不想向客户端发送不必要的信息。在这些情况下，您可以使用响应映射模板筛选信息。

例如，假设您的博客文章 DynamoDB 表上没有相应的索引（例如 Author 上的索引），您可以使用以下解析器：

import { util, Context } from '@aws-appsync/utils';
import { get } from '@aws-appsync/utils/dynamodb';

export function request(ctx) {
	return get({ key: { ctx.args.id } });
}

export function response(ctx) {
	if (ctx.result.author === ctx.identity.username) {
		return ctx.result;
	}
	return null;
}

即使调用方不是创建博客文章的作者，请求处理程序也会获取该项目。为了防止它返回所有数据，响应处理程序会进行检查，以确保调用方与项目的作者匹配。如果调用方与此检查不匹配，则只返回 Null 响应。

数据来源访问

AWS AppSync 使用身份和访问管理 (IAM) 角色和访问策略与数据源通信。如果您使用的是现有角色，则需要添加信任策略才能代 AWS AppSync 入该角色。该信任关系将类似于下面内容：

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Principal": {
                "Service": "appsync.amazonaws.com"
            },
            "Action": "sts:AssumeRole"
        }
    ]
}

需要将角色的访问策略缩小为仅具有对必要的最少资源集进行操作的权限，这一点非常重要。使用 AppSync 控制台创建数据源和创建角色时，系统会自动为您完成此操作。但是，当使用 IAM 控制台中的内置示例模板在 AWS AppSync 控制台之外创建角色时，权限不会自动限定在某个资源上，您应该在将应用程序转移到生产之前执行此操作。