Masashi Ishikawa's portfolio

AppSync + Cognitoによる認可制御

2019/03/17

AppSync

AWS

Cognito

なにこれ

AppSyncはCognitoと連携して認可制御ができます。今回はそのやり方についてご紹介します。ざっくりいうと以下のようなことが実現可能です。

✨スキーマ定義におけるQueryやMutationごとの認可制御（ユーザーグループ）
💎リゾルバーにおける項目ごとの認可制御（ユーザーグループ）
🎊リゾルバーにおける細かな認可制御（ユーザーグループ、ユーザー名）

スキーマ定義におけるQueryやMutationごとの認可制御（ユーザーグループ）

@aws_authアノテーションをQueryやMutationに付与します。以下の例ではCognitoのユーザーグループごとに

管理者は登録、参照、更新、削除
営業は登録、参照、更新
一般メンバーは参照

のように認可制御しています。

スキーマ定義における@aws_authを使った認可制御の例

type Mutation {
  createTask(input: CreateTaskInput): CraeteTaskPayload
    @aws_auth(cognito_groups: [      "admin",      "sales",    ])	updateTask(input: UpdateTaskInput): UpdateTaskPayload
    @aws_auth(cognito_groups: [      "admin",      "sales",    ])  deleteTask(input: DeleteTaskInput): DeleteTaskPayload
    @aws_auth(cognito_groups: [      "admin",    ])}

type Query {
  getTask(id: ID!): Task
    @aws_auth(cognito_groups: [      "admin",      "sales",      "member"    ])}

デフォルトの認可制御

AppSyncではエンドポイントごとに@aws_auth未定義の場合の挙動を以下2つから選択できます。

ALLOW
- 認証済ユーザーであれば、すべてのユーザーを許可する
DENY
- 認証済ユーザーであっても、すべてのユーザーを許可しない　※@aws_authを定義しないとアクセスできない

リゾルバーにおける項目ごとの認可制御（ユーザーグループ）

リゾルバー中でユーザーグループを参照できるので、それを使って項目ごとの認可制御ができます。以下の例では、管理者、営業、一般ユーザーのCognitoユーザーグループがある場合に、タスク情報の登録日と更新日については、管理者と営業のみが参照可能できるように制御しています。

ユーザーグループごとにレスポンス項目を制御する例

## 一般メンバーか判定
#foreach($group in $context.identity.claims.get("cognito:groups"))    #if($group == "member")
        #set($isMember = true)
    #end
#end

#set($result={})
$util.qr($result.put("id", $ctx.result.id))
$util.qr($result.put("discription", $ctx.result.discription))
$util.qr($result.put("owner", $ctx.result.owner))

## 一般メンバーには返さない(管理者と営業のみ参照できる)
#if(!$isMember)  $util.qr($result.put("created", $ctx.result.created))  $util.qr($result.put("updated", $ctx.result.updated))#end
$util.toJson($result)

リゾルバーにおける細かな認可制御（ユーザーグループ、ユーザー名）

ユーザーグループだけではなくユーザー名でも認可制御が可能です。例えば「一般ユーザーは自分が登録した情報のみ参照でき、管理者はすべて参照できる」のような要件を実現する場合です。ここではAppSync + Cognito + Dynamoの例を考えます。まずタスクテーブルに「owner」カラムを設けて、タスクを登録者のCognitoユーザー名を登録しておきます。

タスクテーブル

id	description	owner
123	今週のブログ書く	takumon
124	CodeBuildとGitHubのプルリク連携を調べる	takumon
125	今週のGoogle Cloud Platform Podcast聞く	inoue

そして更新用レスポンスマッピングテンプレートで以下のようにします。

ユーザーグループとユーザー名で認可制御する例

## 管理者か判定
#foreach($group in $context.identity.claims.get("cognito:groups"))  #if($group == "admin")
    #set($isAdmin = true)
  #end
#end

#set($result = [])
## 管理者はすべてのタスクを参照できる
#if($isAdmin)
  #set($result = $context.result.items)
#else
  ## 一般ユーザーは自分が登録したタスクのみ参照できる
  #foreach($item in $context.result.items)
    #if($item.owner == $context.identity.username)      #set($myResults.add($item))
    #end
  #end
#end
$utils.toJson($results)

これでtakumonの場合は2件、inoueの場合は1件、管理者の場合は3件参照できるようになります。なお$util.unauthorized()を使えば認可エラーを返せます。リゾルバーの書き方しだいで複雑な要件も実現できるでしょう。

クライアント側

なおCognitoと連携する場合、クライアント側も対応が必要です。

Vue + Apmlifyの場合

Vue + Apmlifyの場合は以下のようにします。参考ソースコード

Vue

import Amplify, { Auth } from 'aws-amplify';
import { AmplifyPlugin } from 'aws-amplify-vue';

// 環境変数から読み込み
const config = {
  aws_project_region: process.env.VUE_APP_AWS_PROJECT_REGION,
  aws_appsync_graphqlEndpoint: process.env.VUE_APP_AWS_APPSYNC_GRAPHQLENDPOINT,
  aws_appsync_region: process.env.VUE_APP_AWS_APPSYNC_REGION,
  aws_appsync_authenticationType: process.env.VUE_APP_AWS_APPSYNC_AUTHENTICATIONT_TYPE,
  Auth: {
    identityPoolId: process.env.VUE_APP_AWS_COGNIT_IDENTITY_POOL_ID,
    region: process.env.VUE_APP_AWS_COGNIT_REGION,
    identityPoolRegion: process.env.VUE_APP_AWS_COGNIT_IDENTITY_POOL_REGION,
    userPoolId: process.env.VUE_APP_AWS_COGNIT_USER_POOL_ID,
    userPoolWebClientId: process.env.VUE_APP_AWS_COGNIT_USER_POOL_WEB_CLIENT_ID,
  },
};

Amplify.configure(config);
Vue.use(AmplifyPlugin, Amplify);

次にログイン画面を作ります。 Amplifyが用意している<amplify-authenticator>タグで簡単に実現できます。参考ソースコード