IRIS for Health 上でFHIR リポジトリ+OAuth2 認可サーバ/リソースサーバ構成を構築する パート1

Primary tabs

 

開発者の皆さん、こんにちは。

今回の記事ではFHIRと組み合わせて使用されるケースが増えてきている、権限の認可(Authorization)を行うためのOAuth2について取り上げます。

まずこのパート1では、IRIS for HealthおよびApacheのDockerコンテナの起動と、IRIS for Health上で、OAuth2認可サーバ機能を構成し、REST開発ツールPostmanからアクセスし、アクセストークンを取得する方法について解説します。
さらにパート2以降では、IRIS for HealthにFHIRリポジトリ機能を追加し、OAuth2リソースサーバ構成を追加して、Postmanからアクセストークンを使用したFHIRリクエストの実行方法まで解説します。

InterSystems製品のOAuth2機能の解説については、すでにいくつかの記事が開発者コミュニティ上に公開されていますが、今回は改めて最新バージョンでの構成方法を解説したいと思います。
InterSystems IRIS Open Authorization Framework(OAuth 2.0)の実装 - パート1

今回の記事では、最新のInterSystems IRIS for Health 2020.3 Preview Editionを使用します。実際にこの記事を元にして、環境を構築してみようと思われた方は必ずこのバージョン以降のキットを使用してください。一部機能がこのバージョン以前の製品には含まれていません。

事前準備

まずは事前準備です。セキュアな環境を構築するために、色々と準備することが多いです。

IRIS for Health 2020.3 Preview EditionはDockerコンテナバージョンだけが提供されています。(InterSystems Docker Hub/IRIS for Health)
また、OAuth2構成を行うためには、WebサーバおよびSSL構成を行う必要があります。今回はApacheを使用します。
Apache上でSSL構成を行う場合、SSL構成の証明書は正しくサーバのホスト名と一致している必要があります。この点を注意してください。

intersystems-jp GitHub リポジトリからのサンプルファイルの取得

インターシステムズ開発者コミュニティ専用のGitHubリポジトリに今回の構成で使用するサンプルの docker-compose.yml/Dockerfile等が公開されています。
まずは以下のコマンドでご利用の環境にこのファイルを展開してください。(この記事の添付ファイルにも追加されているのでそちらからでもOKです。)
このdocker-compose.yml/Dockerfile等のファイルは、OpenExchangeに公開されているiris-webgateway-exampleアプリケーションを参考に作成しています。

git clone https://github.com/Intersystems-jp/IRIS4H-OAuth2-handson.git

 

使用するキットに合わせた構成の変更

このdocker-compose.ymlファイルでは、IRIS for Healthのコンテナと、docker buildコマンドでbuildされるApache(httpd)のコンテナの二つが起動するように構成されています。
GitHubで配布しているdocker-compose.ymlファイルでは、IRIS for Health Community Edition Preview Edition(2020.3.200.0) を指定しています。
Community Editionはインターシステムズ製品の評価のために利用していただくことができます。

  iris:
    image: store/intersystems/irishealth-community:2020.3.0.200.0

異なるバージョン(正式リリースバージョンやより新しいバージョン)を使用する場合は、この部分の指定を変更してください。

Apacheの方のコンテナはDockerfileの内容でbuildされますが、その際にApacheからIRISに接続するためのWebGatewayのキットが必要になります。
キットの入手方法についてはインターシステムズパートナーの方々はWRCのキットダウンロードサイトするか、またはWRCサポートセンターへお問い合わせください。
それ以外の方々はお手数ですが、こちらのアドレスまでお問い合わせください。

入手した製品に合わせてDockerfileの以下の箇所を変更します。ホストマシンのOSがWindows/Ubuntu/CentOSいずれであっても、ベースとなるhttpdのコンテナOSがDebianであるため、platformはlnxubuntux64の指定となります。

ARG version=2020.3.0.200.0 
ARG platform=lnxubuntux64
ADD WebGateway-${version}-${platform}.tar.gz /tmp/

 

SSL証明書の用意

次にSSL証明書を用意します。OAuth2 認可アクセス時には、そのWebサーバで設定されているSSL証明書がアクセスしているURLと一致しているか確認を行います。
公式な証明書でなくても、openssl等を使用した証明書作成で問題はありません。証明書作成時にCommon Nameにホスト名を入力してください。

また、作成した証明書は起動時に自動で読み込むため、パスフレーズが不要なファイルに変更しておく必要があります。以下のコマンドを参考にしてください。

$ openssl rsa -in cert.key.org -out cert.key

作成された CRTファイルおよび、KEYファイルをそれぞれ server.crt / server.key というファイル名で、Dockerfileと同じディレクトリにおいてください。

また、Apache Webサーバで利用する以外にも、OAuth2の設定でSSL証明書が必要になります。これらはホスト名の入力等は必要がありませんが、3セット作成しておいてください。(以降の設定ではauth.cer/auth.key , client.cer/client.key , resserver.cer/resserver.key として登場します。 )

dockerビルド と dockerコンテナの起動

これでようやく準備完了です!今ディレクトリには、DLした4つのファイル以外に、Webゲートウェイのインストールキット、そして二つのSSL証明書がある状態です。各ファイルのアクセス・実行権限等にもご注意ください。(例えば私は、webgateway-entrypoint.shに実行許可を追加しました。)

docker-compose build
docker-compose up -d

 

起動したら、docker ps コマンドで二つのコンテナが起動していることを確認します。

ApacheのコンテナIMAGE名:<directoryname>_web
IRIS for Healthのコンテナ:store/intersystems/irishealth-community:2020.3.0.200.0(あるいはそれぞれ指定したIMAGE)

 

次は、以下の3つの方法で管理ポータルにアクセスしてみてください。最後の3番目の方法でうまくアクセスできれば、Apache Webサーバ経由のSSL構成は成功です!

http://<hostname>:52773/csp/sys/UtilHome.csp : このURLはIRIS コンテナのPrivate Apache経由のアクセスです。構成したApacheは経由しません。

http://<hostname>/csp/sys/UtilHome.csp : このURLは構成したApacheを経由して管理ポータルにアクセスしています。

https://<hostname>/csp/sys/UtilHome.csp : このURLは構成したApache経由でSSL接続を使用して管理ポータルにアクセスしています。

 

SSL構成の作成

それでは、IRIS for Healthが起動し、管理ポータルにアクセスできるようになったので、最後の準備としてSSL構成を作成しましょう。

管理ポータル→システム管理→セキュリティ→SSL/TLS構成 と進み、先ほど作成した3ペアの証明書キーを使って、SSLの構成を3つ作成しておいてください。

名前は自由に決めることができますが、この記事では過去のOAuth2関連記事にならって、SSL4AUTH/SSL4CLIENT/SSL4RESSERVER としています。

 

 

*ホストとコンテナのディレクトリ共有について

docker-composeファイルに記載されている以下のvolumes 指定によって、ホストの現在のディレクトリ位置=コンテナ内の /ISC ディレクトリ となっています。
上記の設定等で証明書ファイルを指定する場合は、このディレクトリを活用してください。

このディレクトリには、ファイルだけでなくIRISのデータベースファイルや構成ファイルも配置されます。
詳しくはドキュメント「永続インスタンス・データを保存するための永続的な %SYS」をご覧ください。

 

IRIS for HealthでOAuth2の構成

いよいよIRIS for HealthにOAuth2を使ってアクセスするための具体的な準備に入ります!

OAuth2認可サーバ構成

まずはOAuth2認可サーバの構成です!
管理ポータル→システム管理→セキュリティ→OAuth 2.0→サーバ と進みます。

以下の内容に従って設定します。

「一般」タブ設定内容
発行者エンドポイント:ホスト名 <実際のホスト名を入力します>
                              :プレフィックス 任意の値を入力できますが、ここでは「authserver」としています。
サポートする許可タイプ この記事の中では認証コード(Authorization Code)しか使用しませんが、
他の許可タイプ(Grant Type)もテストしてみたい方はチェックを追加してください。
また、「JWT承認」にもチェックを追加します。
SSL/TLS構成 先ほど追加したSSL構成を指定します。

 

 

「スコープタブ」では、「サポートしているスコープを追加」をクリックして追加します。
あとで、表示される認可コード(Authorization Code)のログイン画面ではここで記述した「説明」が表示されます。

「間隔」タブはデフォルトから変更する内容はありません。
「JWT」タブでは署名アルゴリズムに「RS512」を選択してみましょう。

最後の「カスタマイズ」タブでは、トークン・クラスを生成 の指定を %OAuth2.Server.JWT に変更します。

入力したら、「保存」ボタンを押して、構成を保存します。

これで、IRIS for HealthがOAuth2認可サーバとして稼働する基本の設定ができました。早速Postmanからアクセスしてアクセストークンが取得できるか試してみましょう!

しかし、その前にあと2つ構成を行わなければいけません。

クライアントデスクリプションを追加する

まずはOAuth2クライアントとしてアクセスするPOSTMANの情報を追加します。OAuth2クライアント登録は動的登録などで追加されることもあります。

サーバ構成画面の「クライアントデスクリプション」をクリックして先に進みます。

 

「クライアントデスクリプションを作成」をクリックしてエントリを追加します。

以下の内容に従ってクライアントデスクリプションを作成します。

「一般」タブ設定内容
名前 任意の名前を入力します。ここでは postmanとしました。
クライアントの種別 「機密」を選択します。
リダイレクトURL 「URLを追加」ボタンから追加します。postmanのリダイレクトURLとして
https://www.getpostman.com/oauth2/callback
を指定します。
サポートする許可タイプ OAuth2認可サーバの設定で構成した内容と同じ「認証コード」(Authorization Code) を指定します。(デフォルト)
他の許可タイプもテストしてみたい場合はチェックを追加します。ただし、認可サーバの構成と同じ設定にする必要があります。
また、「JWT承認」にもチェックを入れます。
ただし、ここで指定する
認証署名アルゴリズム サポートする許可タイプで「JWT承認」をチェックすると、選択できるようになります。
「RS512」を選択します。

 

入力できたら「保存」ボタンを押してクライアントデスクリプションを保存します。

「クライアント認証情報」タブをクリックすると、このエントリに対するクライアントIDとクライアントの秘密鍵を確認することができます。
POSTMANからテストするときはこのIDと秘密鍵が必要になります。

 

 

ウェブアプリケーションの追加

POSTMANからアクセスする前にもう一つ大事な設定を加える必要があります。
OAuth2認可サーバ構成画面で、この構成のエンドポイントが https://<hostname>/authserver/oauth2 と決定されました。
このエンドポイントへのアクセスが正しくIRISで処理されるために、このURLパスに対するウェブアプリケーションの追加を行う必要があります。

システム管理→セキュリティ→アプリケーション→ウェブ・アプリケーション と進み、「新しいウェブ・アプリケーションを作成」をクリックします。

OAuth2のウェブ・アプリケーションのテンプレートが用意されているので、まず「コピー元」から「/oauth2」を選択します。

「ウェブ・アプリケーションの編集」設定項目
コピー元 /oauth2 プルダウンから必ずこちらを先に選択します。
名前 /authserver/oauth2 
有効 「REST」のラジオボタンをチェックします。

各値を入力したら保存します。

 

POSTMANからOAuth2のテストを行う

それではPOSTMANからテストしてみましょう。
テストの実行は他のツールや実際のプログラムから行うこともできます。
POSTMANの詳しい説明はこの記事では触れませんが、一点注意点として、POSTMANのSettingでSSL certificate verificationはOFFに変更するようにしてください。
 

POSTMANで新しいリクエストを作成後、AuthorizationタブのTYPEで「OAuth 2.0」を選択し、「Get New Access Token」をクリックします。

 

次の画面で、以下の内容に従って値を入力していきます。

「GET NEW ACCESS TOKEN」設定項目
Token Name 任意の名前を入力します。
Grant Type 「Authorization Code」を指定します。
Callback URL https://www.getpostman.com/oauth2/callback
Auth URL https://<hostname>/authserver/oauth2/authorize?ui_locales=ja
エンドポイント+/authorize の値を入力します。
ui_locales=ja を追加することで日本語のログイン画面を表示させることができます。
Auth Token URL https://<hostname>/authserver/oauth2/token
エンドポイント+/token の値を入力します。
Client ID クライアントデスクリプションの登録後にクライアント認証情報タブに表示される クライアントID を入力します。
Client Secret クライアントデスクリプションの登録後にクライアント認証情報タブに表示される クライアントの秘密鍵 を入力します。
Scope 認可サーバ構成で登録したスコープを入力します。 scope1 など。スペースで区切って複数指定することもできます。
State CSRF対策などで使用されるStateパラメータを入力します。
特に使用しませんが空白にできないので、任意の文字列を入力しています。

 

 

パラメータ入力後、「Request Token」ボタンを押すと、以下のようなログイン画面が表示されたでしょうか?

 

 

管理ポータルにアクセスしているユーザ情報 (_SYSTEM等) でログインしてみてください。

ログイン後の次の画面では、このアプリケーションに権限の許可を与えるかどうか決定できます。
「許可」をクリックしたあと、次の画面で以下のようにAccess Tokenが表示されれば、アクセストークン取得テストは成功です!

 

OpenID Connectのテスト

IRIS for Healthでは、OAuth2の認可処理だけでなく、OpenID Connectに準拠した認証処理を実施することができます。
詳細はこちらのドキュメントを参照してください。

今回の構成では実はOpenID Connectの設定も有効になっています。OpenID ConnectののIDトークンも取得できるかテストしてみましょう!

やり方は簡単です。先ほどのGET NEW ACCESS TOKEN画面で、Scopeに「openid」を追加してリクエストしてみましょう。
 

権限の要求ページでも、OpenID Connectが表記されます。ログイン処理を行い、許可を与えた後に次の画面が表示されたらIDトークン(id_token)も取得できることを確認してください。(画面を下にスクロールする必要があります。)


 

いかがでしたか?Access Token そして id_tokenが取得できたでしょうか?

証明書等、少々手間がかかる準備もありますが、データベースプラットフォームであるIRIS for Health上でもこれだけ簡単にOAuth2認可サーバを構築することができました。

この連載の次のパートでは、いよいよFHIRリポジトリを構築し、FHIRリポジトリのOAuth2リソースサーバ登録、そして再びPOSTMANからOAuth2アクセストークンを使用したFHIRリポジトリへRESTアクセスする方法を紹介していきます。


返信

記事を参考にしてアクセストークンの取得まで試してみたところ問題なく動作しました。
有益な記事をアップして頂きありがとうございます。
以下、記載されている手順以外で実行したものを列挙させて頂きます。
他に試す方のご参考になれば幸いです。

SSL証明書の用意

Apache Webサーバー用のSSL証明書を作成

openssl genrsa 2048 > server.key
openssl req -new -key server.key > server.csr
→ CommonNameにDockerホストのホスト名を指定
openssl x509 -days 100 -req -signkey server.key < server.csr > server.crt

OAuth2.0用のSSL証明書を作成

openssl genrsa 2048 > auth.key
openssl x509 -days 100 -req -key auth.key -out auth.cer

dockerビルド と dockerコンテナの起動
Dockerfileの38行目に以下を追加し、権限を設定

RUN chmod +x /opt/webgateway/bin/webgateway-entrypoint.sh

POSTMANからOAuth2のテストを行う
自己署名証明書のためPostmanで「self signed certificate」エラーが発生するため、
設定から「SSL certificate verification」をOFFに設定。