このセクションでは、RESTサービスをインストールする前のセットアップの準備について説明します。RESTをインストールおよび設定するには、次のタスクを実行する必要があります。
pkcs12サーバ証明書を取得します。外部認証局またはOpenText Identity Consoleによって生成されたサーバ証明書を使用できます。詳細については、サーバ証明書オブジェクトを作成するを参照してください。
認証局証明書ファイルを.pem形式で取得してください。たとえば、OpenText eDirectory認証局証明書(SSCert.pem)を使用できます。
(省略可能) RESTサービスをインストールする前に、OSPをインストールして設定します。詳細については、「OSPコンテナの展開」を参照してください。
次の環境設定パラメータを使用して、環境設定ファイルを作成します。たとえば、edirapi.confファイルを作成します。環境設定ファイルの値は、要件に応じて変更できます。
メモ:2つのサンプル環境設定ファイルがtarballイメージにバンドルされます。ビジネス要件に応じてこれらのファイルに変更を加えることもできます。
OSPありでRESTを構成する場合は、次に示すように環境設定ファイルを作成します。
listen = ":9000" ldapserver = "192.168.1.1:636" ldapuser = "cn=admin,ou=sa,o=system" ldappassword = "novell" pfxpassword = "novell" ospmode = "true" osp-token-endpoint = "https://10.10.10.10:8543/osp/a/idm/auth/oauth2/getattributes" osp-authorize-url = "https://10.10.10.10:8543/osp/a/idm/auth/oauth2/grant" osp-logout-url = "https://10.10.10.10:8543/osp/a/idm/auth/app/logout" osp-redirect-url = "https://10.10.10.10:9000/eDirAPI/v1/edirtree/authcoderedirect" osp-client-id = "identityconsole" ospclientpass = "novell" ospcert = "/etc/opt/novell/eDirAPI/cert/SSCert.pem" bcert = "/etc/opt/novell/eDirAPI/cert/" loglevel = "error" check-origin = "true" origin = "https://10.10.10.10:9000,https://192.168.1.1:8543"
OSPなしでRESTを構成する場合は、OSPパラメータを指定せずに、次に示すように環境設定ファイルを作成します。
listen = ":9000" pfxpassword = "novell" ospmode = "false" bcert = "/etc/opt/novell/eDirAPI/cert/" edir-hosts = "<ip_address-1>:636,<ip_address-2>:636"
表 27-1 環境設定ファイル内の環境設定パラメータの説明
|
環境設定パラメータ |
説明 |
|---|---|
|
listen |
コンテナ内のRESTサーバの待ち受けポートとして9000を指定します。 |
|
ldapserver |
OpenText eDirectoryホストサーバのIPを指定します |
|
ldapuser |
eDirectoryツリーの管理者権限を持つユーザのユーザ名を指定します. 重要:ユーザ名は小文字にする必要があります。ユーザ名が大文字の場合、eDirAPI Dockerコンテナの初期化に失敗する場合があります。 |
|
ldappassword |
LDAPサーバのパスワードを指定します |
|
pfxpassword |
.pfx証明書ファイルのパスワードを指定します |
|
ospmode |
OSPをOpenText Identity Consoleと統合するにはtrueを指定します。falseに設定すると、OpenText Identity ConsoleでLDAPログインが使用されます |
|
osp-token-endpoint |
このURLは、OSPサーバから特定の属性をフェッチして、認証トークンの有効性を検証するために使用します |
|
osp-authorize-url |
このURLは、ユーザが認証トークンを取得するために資格情報を提供する際に使用します |
|
osp-logout-url |
このURLを使用して、ユーザとOSPサーバ間のセッションを終了します |
|
osp-redirect-url |
OSPサーバは、認証トークンを付与した後、ユーザをこのURLにリダイレクトします |
|
osp-client-id |
RESTをOSPに登録したときに提供されたOSPクライアントIDを指定します |
|
ospclientpass |
RESTをOSPに登録したときに提供されたOSPクライアントパスワードを指定します |
|
ospcert |
OSPサーバの認証局証明書の場所を指定します |
|
bcert |
OpenText Identity Consoleの認証局証明書の場所を指定します |
|
loglevel |
ログファイルに含めるログレベルを指定します。このパラメータは、「fatal」、「error」、「warn」、または「info」に設定できます。 |
|
check-origin |
これをtrueに設定すると、RESTサーバで要求のオリジン値が比較されます。使用可能なオプションは、trueまたはfalseのいずれかです。DNS設定を使用する場合、check-originパラメータ値がfalseに設定されている場合でも、originパラメータは必須です。 |
|
origin |
eDirAPIは、要求のオリジン値をこのフィールドで指定された値と比較します。 メモ:eDirAPI 1.4以降では、このパラメータはcheck-originパラメータとは独立しています。また、DNS設定を使用する場合は必須です。 |
|
enableaudit |
RESTサービスの監査を有効にするには、このオプションをtrueに設定します。使用可能なオプションは、trueまたはfalseのいずれかです。 |
|
enableservicestartaudit |
このオプションをtrueに設定すると、RESTサービスの開始イベントが通知されます。使用可能なオプションは、trueまたはfalseのいずれかです。 |
|
enableservicestopaudit |
このオプションをtrueに設定すると、RESTサービスの停止イベントが通知されます。使用可能なオプションは、trueまたはfalseのいずれかです。 |
|
enablelogsessioncreationaudit |
このオプションをtrueに設定すると、RESTサービスのセッション作成イベントが通知されます。使用可能なオプションは、trueまたはfalseのいずれかです。 |
|
enablelogsessionterminationaudit |
このオプションをtrueに設定すると、RESTサービスのセッション終了イベントが通知されます。使用可能なオプションは、trueまたはfalseのいずれかです。 |
|
auditlogmaxsize |
それぞれのRESTサービスの監査ログファイルサイズの最大限度を指定します。デフォルトでは、ファイルサイズは50MBです。 |
|
edirapilogmaxsize |
それぞれのRESTサーバのログファイルサイズの最大限度を指定します。 |
|
scope |
RESTサーバがOAuth用語で言うところのリソースサーバとして使用されている場合は、そのスコープを指定します。デフォルトでは、edirapi <tree_name>に設定されています。 |
|
maxclients |
edirapiにアクセスできる同時クライアントの最大数。この制限を超えるクライアントはキュー内で待機する必要があります。 |
|
edir-hosts |
edir-hostは、OpenText Identity Consoleを介して接続するeDirectoryのIPアドレスを格納するパラメータです。 |
重要:
OSP関連の環境設定パラメータは、OSPとRESTサービスを統合する計画の場合にのみ使用してください。
RESTサービスの監査を有効にするには、環境設定ファイルに監査関連パラメータを設定する必要があります。
OSP HTTPS URLは、2048ビットキーが含まれている証明書を使用して検証する必要があります。この検証は、4096または8192ビットキーが含まれている証明書では失敗します。