4 Oracle Key Vault SDKの設定

クライアントSDKは、CとJavaの両方で使用できます。

4.1 エンドポイントのエンロール

エンドポイントにSDKコンテンツをダウンロードする前に、Oracle Key Vaultサーバーにエンドポイントを登録してエンロールしておく必要があります。

SDKのダウンロード前に、エンドポイントの登録とエンロールを済ませていない場合は、「Oracle Key Vaultのエンドポイントのエンロール」の手順に従ってエンドポイントをエンロールしてください。

4.2 CまたはJavaのSDKソフトウェアのダウンロード

CまたはJavaバージョンの適切なソフトウェア開発キット(SDK)ソフトウェアをダウンロードする必要があります。

  1. SDKをデプロイするエンドポイントから、Oracle Key Vault管理コンソールにアクセスします。
  2. Oracle Key Vault管理コンソールへのログイン・ページが表示されます。
    ログインしないでください
  3. 「Login」ボタンの下側にある「Endpoint Enrollment and Software Download」リンクをクリックします。

    図4-1 Endpoint Enrollment and Software Download

    管理コンソールのログイン画面で、「Endpoint Enrollment and Software Download」リンクをクリックします。
    「図4-1 Endpoint Enrollment and Software Download」の説明
  4. 「Enroll Endpoint & Download Software」画面が表示されます。
    上部に4つのタブがあります。
    • Enroll Endpoint & Download Software
    • Download Endpoint Software Only
    • Download RESTful Service Utility
    • Download Software Development Kit
  5. 「Download Software Development Kit」タブをクリックします。

    図4-2 Download Software Development Kit

    図4-2の説明はこの後にあります
    「図4-2 Download Software Development Kit」の説明
  6. 「Download Software Development Kit」画面が表示され、CまたはJavaのSDKのどちらかを選択するオプションが示されます。

    図4-3 「SDK Language」としてCを選択

    図4-3の説明はこの後にあります
    「図4-3 「SDK Language」としてCを選択」の説明
  7. C SDKを選択した場合は、デプロイ対象のプラットフォームを選択する必要があります。
    プラットフォームのオプションは、次のとおりです。
    • Linux
    • Solaris SPARC
    • Solaris x64
    • AIX
    • HP-UX

    図4-4 「SDK Platform」の選択

    図4-4の説明が続きます。
    「図4-4 「SDK Platform」の選択」の説明

    Java SDKを選択した場合は、プラットフォームの依存性がないためプラットフォームの選択は不要です。

    図4-5 「SDK Language」としてJavaを選択

    図4-5の説明はこの後にあります
    「図4-5 「SDK Language」としてJavaを選択」の説明
  8. 「Download」をクリックします。
    任意の場所にSDKのzipファイルを保存します。
  9. エンドポイントにソフトウェアをインストールするために必要な管理権限があることを確認します。
  10. OKV_HOME環境変数が正しく設定されていることを確認します。
    詳細は、zipファイルに含まれているREADMEファイルを参照してください。
  11. zipファイルを保存したディレクトリに移動します。
  12. SDKファイルを解凍します。
    たとえば、LinuxではJava SDKファイルの解凍に次を使用します。
    unzip -o okv_jsdk.zip -d $OKV_HOME
    C SDKファイルの場合は、次を使用します。
    unzip -o okv_csdk.zip -d $OKV_HOME

    ノート:

    SDKソフトウェアの内容は、OKV_HOMEの下にデプロイすることをお薦めします。これは、SDKソフトウェアの再デプロイ時や新しいバージョンへのアップグレード時にも当てはまります。

    SDKソフトウェアをOracle Key Vault 21.1にすでにデプロイしてある場合は、Oracle Key Vault 21.2へのアップグレード後に、同じ場所にSDKソフトウェアを再デプロイすることをお薦めします。

4.3 C SDKファイルの内容

C SDKファイルの内容には、デモ・プログラムやSDKライブラリ・ファイルなどの必要なファイルが含まれています。

図4-6 C SDKのディレクトリとファイル

図4-6の説明はこの後にあります
「図4-6 C SDKのディレクトリとファイル」の説明

includeディレクトリには、C SDK APIのヘッダー・ファイルが含まれています。libディレクトリには、共有ライブラリ・オブジェクトが含まれています。binは、デモ・プログラムのオブジェクト・ファイルと実行可能ファイルを配置するための空のディレクトリです。

demoディレクトリには、C SDK APIの使用方法を示すサンプル・プログラムが含まれています。次の表に、各サンプル・プログラムの簡単な説明を示します。

表4-1 サンプル・プログラム

サンプル・プログラム 説明
AsymmetricKeysDemo.c 非対称キー管理操作(秘密キーおよび公開キーの属性の登録、アクティブ化、取得、すべて取得など)のアプリケーション。
AttributeOperationDemo.c KMIP属性操作(属性の追加、変更、取得、削除など)のアプリケーション。
BatchOperationDemo.c バッチ処理(作成、アクティブ化、属性の追加、キーの取得や破棄などの操作のバッチ処理)を示すアプリケーション。
CertificateDemo.c 証明書管理操作(証明書の登録、アクティブ化、取得、およびすべての属性の取得など)のアプリケーション。
CertificateRequestDemo.c 証明書リクエスト管理操作(証明書リクエストの登録、取得、およびすべての属性の取得など)のアプリケーション。
CreateKeyDemo.c KMIPのキーの作成操作とアクティブ化操作のアプリケーション。
CreateKeyInVirtualWalletDemo.c 指定のウォレット内でのKMIPのキー作成操作とキーのアクティブ化のためのアプリケーション。
CryptoOperationsDemo.c 暗号化および復号化操作を示すアプリケーション。
DestroyKeyDemo.c 指定の名前によるKMIPの検索操作とキーの破棄のアプリケーション。
KeyManagementApp.c キー管理操作(キーの作成、アクティブ化、取得、非アクティブ化、破棄など)のアプリケーション。
LocateGetKeyDemo.c 指定の名前によるKMIPの検索操作と、キーの長さ、アルゴリズム、値などのキーの詳細を取得するアプリケーション。
OpaqueDataDemo.c 不透明データ管理操作(不透明なデータの登録、取得、属性の追加、破棄など)のアプリケーション。
RegisterKeyDemo.c KMIPのキー登録操作のアプリケーション。
SecretDataDemo.c シークレット・データ管理操作(シークレット・データの登録、取得、属性の追加、破棄など)のアプリケーション。

デモ・プログラムの環境構成、コンパイルおよび実行の詳細は、C SDKに付属のREADMEファイルを参照してください。

4.4 Java SDKファイルの内容

Java SDKファイルの内容には、デモ・プログラムやSDKライブラリjarファイルなどの必要なファイルが含まれています。

図4-7 Java SDKのディレクトリとファイル

図4-7の説明はこの後にあります
「図4-7 Java SDKのディレクトリとファイル」の説明

libディレクトリには、Oracle Key VaultクライアントJava SDK jarファイルのokvjsdk.jarとサンプルのjava.util.logging構成ファイルlogging.propertiesが含まれています。binは、Javaデモ・プログラム・クラス・ファイルを配置するための空のディレクトリです。

demoディレクトリには、Java SDK APIの使用方法を示すサンプル・プログラムが含まれています。次の表に、各サンプル・プログラムの簡単な説明を示します。

表4-2 サンプル・プログラム

サンプル・プログラム 説明
AsymmetricKeysDemo.java 非対称キー管理操作(秘密キーおよび公開キーの属性の登録、アクティブ化、取得、すべて取得など)のアプリケーション。
AttributeOperationDemo.java KMIP属性操作(属性の追加、変更、取得、削除など)のアプリケーション。
BatchOperationDemo.java バッチ処理(作成、アクティブ化、属性の追加、キーの取得や破棄などの操作のバッチ処理)を示すアプリケーション。
CertificateDemo.java 証明書管理操作(証明書の登録、アクティブ化、取得、およびすべての属性の取得など)のアプリケーション。
CertificateRequestDemo.java 証明書リクエスト管理操作(証明書リクエストの登録、取得、およびすべての属性の取得など)のアプリケーション。
CreateKeyDemo.java KMIPのキーの作成操作とアクティブ化操作のアプリケーション。
CreateKeyInVirtualWalletDemo.java 指定のウォレット内でのKMIPのキー作成操作とキーのアクティブ化のためのアプリケーション。
CryptoOperationsDemo.java 暗号化および復号化操作を示すアプリケーション。
DestroyKeyDemo.java 指定の名前によるKMIPの検索操作とキーの破棄のアプリケーション。
KeyManagementApp.java キー管理操作(キーの作成、アクティブ化、取得、非アクティブ化、破棄など)のアプリケーション。
LocateGetKeyDemo.java 指定の名前によるKMIPの検索操作と、キーの長さ、アルゴリズム、値などのキーの詳細を取得するアプリケーション。
OpaqueDataDemo.java 不透明データ管理操作(不透明なデータの登録、取得、属性の追加、破棄など)のアプリケーション。
RegisterKeyDemo.java KMIPのキー登録操作のアプリケーション。
SecretDataDemo.java シークレット・データ管理操作(シークレット・データの登録、取得、属性の追加、破棄など)のアプリケーション。

デモ・プログラムの環境構成、コンパイルおよび実行の詳細は、Java SDKに付属のREADMEファイルを参照してください。