1 Oracle Key Vault RESTfulサービスの概要

Oracle Key Vault RESTfulサービス・ユーティリティ・コマンドを使用すると、エンドポイントの管理やバックアップの実行など、多数のOracle Key Vaultタスクをコマンドラインで実行できます。

• Oracle Key Vault RESTfulサービスについて
  RESTfulサービスを使用することで自動化できるOracle Key Vaultのタスクには、エンドポイント、ウォレット、セキュリティ・オブジェクト、デプロイメント操作およびバックアップ操作の管理が含まれます。
• Oracle Key Vault RESTfulサービスを使用する場合の一般的なプロセス
  RESTfulサービスを有効にした後、通常はOracle Key Vault RESTfulサービスのタスクを実行するためにJSONを使用します。
• RESTfulサービスの使用に必要な権限
  必要なRESTfulサービス権限は、Oracle Key Vault管理コンソールで同じタスクを実行するために必要な権限と一致しています。

1.1 Oracle Key Vault RESTfulサービスについて

RESTfulサービスを使用することで自動化できるOracle Key Vaultのタスクには、エンドポイント、ウォレット、セキュリティ・オブジェクト、デプロイメント操作およびバックアップ操作の管理が含まれます。

このような機能の管理操作にはOracle Key Vault管理コンソールのユーザー・インタフェースで十分ですが、そうしたタスクを完了するプロセスは手動であり、Oracle Key Vault管理者はユーザー・インタフェースのクリックが必要になります。多くの場合、大規模な分散型エンタープライズ・デプロイメントにおいては、一括デプロイメントを可能にするために、スクリプティングによる自動化が必要となります。Oracle Key Vault RESTfulサービス・ユーティリティ・コマンドを使用すると、こうしたタスクのすべてについて、担当者の介入を減らした迅速なデプロイメントを促進する方法で実行できます。

Oracle Key Vault RESTfulサービスでは、コマンドラインから単一のサービス・コマンドを実行できます。ほとんどのOracle Key Vault RESTfulサービス・ユーティリティ・コマンドでは、JavaScript Object Notation (JSON)入力ファイルとしてコマンドライン・オプションを指定できます。このガイドのリファレンスの各項では、各コマンドのJSON入力テンプレートの生成と変更の例を示します。RESTfulサービス・ユーティリティ・コマンドの出力はJSON形式です。コマンドラインからサービス・コマンドを実行するには、特定の構成パラメータを設定する必要があります。RESTfulサービス・ユーティリティ・コマンドの実行は、そうした一般的に使用されるパラメータをRESTfulサービス構成ファイルに含めることで簡略化できます。該当するパラメータでは、コマンドを実行する必要があるRESTful管理者の名前など、汎用的な領域をカバーします。Oracle Key Vaultには、ロギングの処理方法をカスタマイズするためのロギング・プロパティ・ファイルもあります。RESTfulサービス・ユーティリティを実行するには、エンドポイントにJava Runtime Environmentバージョン1.7.0.21以上がインストールされている必要があります。

RESTfulサービスを使用してOracle Key Vaultのタスクを実行した後は、Oracle Key Vaultへのエントリ・ポイントの数を最小限にするために、RESTfulサービスを無効にする必要があります。

1.2 Oracle Key Vault RESTfulサービスを使用する場合の一般的なプロセス

RESTfulサービスを有効にした後、通常はOracle Key Vault RESTfulサービスのタスクを実行するためにJSONを使用します。

Oracle Key Vault RESTfulサービスを構成する場合は、次の一般的なステップに従います。

1. Oracle Key Vault管理コンソールからRESTfulサービスを有効にします。

   このステップは、エンドポイントがシステム要件を満たしていることを確認して、Oracle Key Vault管理コンソールを使用してネットワーク・サービスとRESTfulサービスの機能を有効にするために必要です。

2. RESTfulサービス・ユーティリティokvrestclipackage.zipをダウンロードします。

   このファイルには、okvrestcli.jarファイル、RESTfulサービス・コマンドライン・ユーティリティ・スクリプト、構成ファイルおよびデフォルトのロギング・ファイルが含まれています。

3. 目的の環境で動作するように、次の構成ファイルとロギング・ファイルをカスタマイズします。
   • okvrestcli.iniには、RESTfulサービス・ユーティリティ・コマンドを実行するユーザーの名前など、環境に固有のプロパティが含まれています。
   • okvrestcli_logging.propertiesでは、ロギングの処理方法を決定します。

Oracle Key Vault RESTfulサービスの構成が完了すると、すぐにRESTfulサービス・ユーティリティ・コマンドの使用を開始できます。コマンドは、様々な方法を使用して個別に実行できます。ほとんどの場合、RESTfulサービス・ユーティリティ・コマンドはJSON形式をサポートします。

1.3 RESTfulサービスの使用に必要な権限

必要なRESTfulサービス権限は、Oracle Key Vault管理コンソールで同じタスクを実行するために必要な権限と一致しています。

実行する操作に基づいて、次の権限が必要になります。

• エンドポイントの作成: システム管理者ロールまたはエンドポイント作成システム権限
• エンドポイントの管理: システム管理者ロールまたはエンドポイントに対するエンドポイント管理オブジェクト権限
• エンドポイント・グループの作成: キー管理者ロールまたはエンドポイント・グループ作成システム権限
• エンドポイント・グループの管理: キー管理者ロールまたはエンドポイント・グループに対するエンドポイント・グループ管理オブジェクト権限
• ウォレットとキーの管理: キー管理者ロールまたはウォレット権限

  ウォレット権限には、次の3つのモードがあります。

  • 読取り専用アクセス(RO)
  • 読取りおよび変更アクセス(RM)
  • ウォレット管理アクセス(MW)

  ウォレット権限は、次のいずれかの組合せで付与できます。

  • RO
  • RM
  • RO_MW
  • RM_MW

  たとえば、エンドポイントに読取り専用(RO)と読取りおよび変更(RM)のウォレット・アクセス権のみが割り当てられている場合、そのエンドポイントにはokv managed-object wallet add-memberを使用できません。このコマンドにはウォレット管理アクセス権(RM_MW)が必要になります。

• セキュリティ・オブジェクトの管理: キー管理者ロール
• クラスタまたはプライマリ・スタンバイ・デプロイメントのステータスおよび情報を確認するコマンドの実行: システム管理者ロール
• バックアップとリストアの管理: システム管理者ロール

管理タスクを簡単にするために、該当するロールを1つ以上持つユーザーを作成できます。通常、このユーザーは、これらの権限が必要な操作を実行する必要があるスクリプトを使用して、Oracle Key Vaultにデータベースを自分で登録する必要がある管理者です。

Oracle Key Vault RESTfulサービスを使用するために、エンドポイント管理者権限は必要ありません。