Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

Caché が OAuth 2.0 および OpenID Connect をサポートする方法

この章では、OAuth 2.0 および OpenID Connect に対する Caché のサポートについて説明します。

サポートされているシナリオ

OAuth 2.0 および OpenID connect に対する Caché のサポートにより、以下のいずれかまたはすべてを行うことができます。

  • クライアントとして Caché Web アプリケーションを使用する

  • リソース・サーバとして Caché Web アプリケーションを使用する

  • 承認サーバとして Caché インスタンスを使用する

例えば、サードパーティ・テクノロジを採用した承認サーバのクライアントとして、Caché Web アプリケーションを使用することができます。または、サードパーティのクライアントを Caché を基盤とする承認サーバと使用することもできます。1 台以上のリソース・サーバを Caché または別のテクノロジで実装することもできます。

いずれの場合でも、承認サーバが最も複雑な要素であり、通常は最初に作成します。クライアントはそのあと作成します。一般にクライアントを作成するときは、サポートするスコープなど、承認サーバの機能と要件に関する知識を必要とします。

OAuth 2.0 および OpenID Connect に対する Caché のサポート

OAuth 2.0 および OpenID Connect に対する Caché のサポートは、以下の要素で構成されます。

  • 管理ポータルの構成ページ。

    クライアント (またはリソース・サーバ) を構成する場合は、[システム管理][セキュリティ][OAuth 2.0][クライアント構成] のオプションを使用します。

    承認サーバを構成する場合は、[システム管理][セキュリティ][OAuth 2.0][サーバ構成] のオプションを使用します。

  • %SYS.OAuth2 パッケージのクラス。これらのクラスはクライアント API です。Caché Web アプリケーションを OAuth 2.0 クライアントとして定義すると、そのクライアントはこれらのクラスのメソッドを使用します。

  • %OAuth2 パッケージのクラス。OAuth 2.0 承認サーバとして Caché インスタンスを使用する場合は、%OAuth2.Server パッケージの 1 つ以上のクラスからサブクラスを作成することでサーバをカスタマイズします。%OAuth2 の他のクラスは、コードが呼び出すユーティリティ・メソッドを提供します。

  • OAuth2 パッケージのクラス (CACHESYS データベース内)。このクラスには、Caché 内部で使用される永続クラスが含まれます。そのほとんどは無視できます。ただし、構成項目をプログラムで作成する場合は、このパッケージに含まれるクラスのサブセットを使用することになります。

以下のサブセクションに構成項目の概要を示します。

クライアントの構成項目

OAuth 2.0 クライアントとして機能している Caché インスタンス内で、サーバ記述 (承認サーバを記述) と クライアント構成 (クライアントを構成) という 2 つの結合された構成項目を指定されたクライアント・アプリケーションに対して定義する必要があります。特定の Caché インスタンスでは、任意の数のサーバ記述を定義できます。下図が示すように、それぞれのサーバ記述は複数のクライアント構成があります。この図は、これらの構成項目に格納されている情報の一部も示しています。

generated description: client-side-config

このアーキテクチャにより、同じ承認サーバを使用する複数のクライアント構成を定義することが可能になり、承認サーバの詳細を繰り返し定義する必要がなくなるため構成を簡素化することができます。

OAuth 2.0 クライアントとしての Caché Web アプリケーションの使用法” の章に記載されているように、これらの項目は管理ポータルで作成することができます。“”または、付録の “プログラムによる構成項目の作成方法” に記載されているように、プログラムで構成項目を作成することもできます。

サーバの構成項目

OAuth 2.0 承認サーバとして機能している Caché インスタンス内で、サーバ構成 (承認サーバを構成) と複数のクライアント記述を定義する必要があります。下図は、これらの構成項目に格納されている情報の一部を示しています。

generated description: server-side-config

特定の Caché インスタンスは、1 つのサーバ構成と複数のクライアント記述を持つことができます。クライアント・アプリケーションごとに 1 つのクライアント記述が必要になります。クライアント記述は、承認サーバのエンドポイントを使用する各リソース・サーバでもそれぞれ 1 つ必要になります。承認サーバのエンドポイントを使用しないリソース・サーバでは、クライアント記述を作成する必要はありません。

OAuth 2.0 承認サーバとしての Caché の使用法” の章に記載されているように、これらの項目は管理ポータルで作成することができます。または、付録の “プログラムによる構成項目の作成方法” に記載されているように、プログラムで構成項目を作成することもできます。

Caché でサポートされる標準規格

このセクションでは、OAuth 2.0 および OpenID Connect に対して Caché がサポートしている標準規格を示します。

FeedbackOpens in a new tab