Future Tech Blog
フューチャー技術ブログ

Auth0の設定をバージョン管理し、Auth0 Deploy CLIを利用してデプロイ環境を整える


はじめに

こんにちは、TIG/DXユニットの市川です。

私が所属しているプロジェクトでは認証認可基盤としてAuth0を使用しています。検証段階や初期構築段階では各種設定をダッシュボードから操作することが多いと思いますが、実際に本番運用を行っていると、Auth0の設定やRulesのスクリプトをGit管理し、変更履歴を追えるようにしたいというケースが出てくるかと思います。

今回は、Auth0から提供されているAuth0 Deploy CLIという拡張機能を利用して、Auth0テナントの設定をエクスポートする方法と私のプロジェクトで実際に行っているAuth0テナントへのデプロイの方法をお伝えします。

最終的なイメージは下記の通りです。

1. 実行環境

今回の記事の作成で使用した実行環境は以下の通りです。

npm:6.14.5
auth0-deploy-cli:5.0.0

2. Auth0 Deploy CLIとは

Auth0 Deploy CLIとはAuth0で提供されている拡張機能です。
これを利用するとAuth0テナントの設定情報をエクスポートできることに加え、テナントの設定情報を記載したファイルを、各Auth0テナントへ反映できます。
よって、この拡張機能をCI/CDに組み込み、そこからデプロイを行うことも可能です。

3. 既存環境のエクスポート

では早速既存環境のエクスポートから行っていきます。

3-1. Auth0 Deploy CLIで使用するアプリケーションを各テナントに作成する

Auth0テナントにAuth0 Deploy CLIで使用するアプリケーションを作成します。
(各環境ごとにAuth0テナントを作成している場合は、それぞれのテナントごとにApplicationを作成する必要があります)

Application Type はM2M(Machine to Machine Applications)を指定します。

使用するAPIはAuth0 Management APIを選択し、auth0-deploy-cliを使用するに当たり必要となるSCOPEを設定します。

必要となるSCOPEは下記をご確認ください。

Required Scopes - Create and Configure the Deploy CLI Application Manually

SCOPE設定後、ポップアップ下部のAUTHORIZEを押下します。

3-2. ローカル環境にAuth0 Deploy CLIの拡張機能をインストールする。

npmを使用して、auth0-deploy-cliをローカル環境にインストールします。

1
$ npm i -g auth0-deploy-cli

3-3. エクスポート先のディレクトリの作成

まずエクスポートする設定の置き場所となる任意のディレクトリを作成します。

1
2
$ mkdir auth0-deploy
$ cd auth0-deploy

3-4 設定ファイルのconfig.jsonを作成

次にエクスポートを行う際に使用するconfig.jsonを作成します。

1
$ touch config.json

作成したconfig.jsonに、先程作成したアプリケーションのdomainやclient id、client secrtetの情報を下記のフォーマットで記載します。

auth0-deploy/config.json
1
2
3
4
5
{
"AUTH0_DOMAIN": "YOUR_DOMAIN",
"AUTH0_CLIENT_ID": "YOUR_CLIENT_ID",
"AUTH0_CLIENT_SECRET": "YOUR_CLIENT_SECRET"
}

client id等の情報はAuth0のダッシュボードから確認することができます。

3-5. exportコマンドでエクスポートする

これでテナントの設定をエクスポートする準備が整いました。
下記コマンドを実行して、Auth0テナントの設定をエクスポートします。

1
$ a0deploy export -c config.json -f yaml -o ./

-cはconfigファイル、-fはフォーマット、-oはエクスポート先のディレクトリを指定します。
プロキシ経由の場合はプロキシのオプション(-p)を設定します。

詳細はこちらをご確認ください。

コマンドを実行し、ログの最後にExport Successfulが出力されれば、エクスポートは成功です。

1
2
3
4
5
6
7
$ 20XX-YY-ZZ:ZZ:SS.SSSZ - info: Loading Auth0 Tenant Data
$ 20XX-YY-ZZ:ZZ:SS.SSSZ - info: Retrieving rules data from Auth0
...
$ 20XX-YY-ZZ:ZZ:SS.SSSZ - info: Exporting guardianFactorTemplates
$ 20XX-YY-ZZ:ZZ:SS.SSSZ - info: Exporting roles
$ 20XX-YY-ZZ:ZZ:SS.SSSZ - info: Writing tenant.yaml
$ 20XX-YY-ZZ:ZZ:SS.SSSZ - info: Export Successful

3-6. ディレクトリ構成

各環境が設定している内容により異なることはありますが、私が使用しているテナントは下記のようなディレクトリ構成となりました。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|   # 新規登録時やアカウントブロック時に送信されるemailテンプレート
├── emailTemplates
│ ├── blocked_account.html
│ ├── reset_email.html
│ └── verify_email.html
|
| # Universal Loginで使用するログイン画面やパスワード再発行ページ
├── pages            
| ├── error_page.html
| ├── login.html
| └── password_reset.html
|
| # テナントにされている各Rulesのスクリプト
├── rules
| ├── hoge.js
| └── fuga.js
|
| # テナントの設定が記載されているyamlファイル
└── tenant.yaml

3-7. 各環境ごとのデプロイに対応したディレクトリ構成に変更する

私が所属しているプロジェクトでは3つの環境を使用しているため、Auth0テナントも3つ使用しています。
各環境ごとに設定内容が同一ではない項目もあるため、テナントの設定が記載されているyamlファイルを環境ごとに作成しています。
よって下記のようなディレクトリ構成となります。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
|   # 新規登録時やアカウントブロック時に送信されるemailテンプレート
├── emailTemplates
│ ├── blocked_account.html
│ ├── reset_email.html
│ └── verify_email.html
|
| # Universal Loginで使用するログイン画面やパスワード再発行ページ
├── pages            
| ├── error_page.html
| ├── login.html
| └── password_reset.html
|
| # テナントにされている各Rulesのスクリプト
├── rules
| ├── hoge.js
| └── fuga.js
|
| テナントの設定が記載されているyamlファイル
└── tenant-dev.yaml
└── tenant-stg.yaml
└── tenant-prd.yaml

4. 環境ごとに差異がある値を環境変数に定義する

テナントの設定をエクスポートした時点ではドメイン等、環境によって変えたい変数がハードコーディングされている状態になっています。
もしrulesやemailTemplate配下のファイルで環境ごとにセットしたい値が異なる場合は、環境変数を用いて正しい値がセットされるようにします。

Auth0 Deploy CLIでは、デプロイ時に指定するconfigファイルにAUTH0_KEYWORD_REPLACE_MAPPINGS を指定して環境変数のセットを行うと、configファイルから値を読み取って環境変数がセットされます。

auth0-deploy/config.json
1
2
3
4
5
6
7
8
{
"AUTH0_DOMAIN": "YOUR_DOMAIN",
"AUTH0_CLIENT_ID": "YOUR_CLIENT_ID",
"AUTH0_CLIENT_SECRET": "YOUR_CLIENT_SECRET",
"AUTH0_KEYWORD_REPLACE_MAPPINGS": {
"DOMAIN": "https://www.example.com",
}
}

下記に例を記載します。

login.htmlが下記の様になっていた場合、

auth0-source/pages/login.html
1
<a href="##DOMAIN##/sample">サンプルリンク</a>

デプロイ時にはconfig.jsonファイルから環境変数が適用され、環境ごとに値を変えることができます。

1
<a href="https://www.example.com/sample">サンプルリンク</a>

5. デプロイ環境の整備

私のプロジェクトではソースコードの管理をGitlabで行っており、上記作業完了後、リモートリポジトリにpushします。

その後、Gitlab CI/CDを起動して上記テナントのディレクトリをS3へアップロードしたことをトリガーにCodePipelineが起動し、CodeBuild上でAuth0テナントのデプロイを行っています。

実際に使用しているbuildspec.ymlは下記の通りです。
client idやclient secretを指定するconfigファイルはAWSのParameter Storeから読みとった値をCodeBuild上でセットしています。

buildspec.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
version: 0.2
phases:
pre_build:
commands:
- npm install
- npm i -g auth0-deploy-cli@5.0.0
post_build:
commands:
- echo creating config file started
# ↓リポジトリ上ではclient id等をハードコーディングしたconfig.jsonファイルは保持せず、config.jsonのテンプレートファイルのみ保持し、Parameter Storeの値をもとにファイルを新規作成しています。
- envsubst < config-template.json > config.json
- echo finished creating config file
- cat config.json
- echo auth0-deploy-cli version
- a0deploy --version
- echo Auth0 Deploy started
# ↓ENVは環境変数から読み取っています
- a0deploy import -c config.json -i tenant-${ENV}.yaml
- echo Auth0 Deploy completed

これでデプロイ環境を整備することができました。

基本的には初期構築時のExportファイルを正として管理を行っていますが、Auth0上で大きな設定変更が生じた際は念の為テナント設定のExportを行い、正管理ファイルに誤りがないかどうか、必要に応じて確認を行っています。

6. 最後に

Auth0 Deploy CLIを利用して既存テナントの設定をエクスポートするところから、実際にCI/CDに組み込んでデプロイを行う部分までをご紹介してきました。
ただ、Auth0の設定管理は今回扱ったAuth0 Deploy CLIだけでなく、Teraformで管理することも可能です。(https://www.terraform.io/docs/providers/auth0/index.html)

そのため、自身が所属しているプロジェクトの状況に応じて適切なものを選択・利用していくのが良いかと思います。

7. 関連リンク

Auth0 Deploy CLI Tool
Auth0 導入編
Auth0 EmailまたはSMSを使ったパスワードレス認証を設定する
Auth0のRulesを使って認証認可を自在にカスタマイズする