4 キーストアの管理

Oracle Platform Security Services (OPSS)では、キーストア・サービス(KSS)を使用して、キーストアを表示および管理します。RESTリソースのセットを使用してキーストアを表示および管理できます。

セクション	メソッド	リソース・パス
新しいKSSキーストアのPOSTメソッド	POST	/opss/v2/keystoreservice
KSSキーストアのインポートのPOSTメソッド	POST	/opss/v2/keystoreservice/keystore
パスワード更新KSSキーストアのPUTメソッド	PUT	/opss/v2/keystoreservice
信頼できる証明書KSSキーストアのPOSTメソッド	POST	/opss/v2/keystoreservice/certificates
ストライプKSSキーストアのGETメソッド	GET	/opss/v2/keystoreservice/{stripeName}
別名KSSキーストアのGETメソッド	GET	/opss/v2/keystoreservice/alias/{stripeName}/{keystoreName}/{entryType}
信頼できる証明書KSSキーストアのGETメソッド	GET	/opss/v2/keystoreservice/certificates
信頼できる証明書KSSキーストアのDELETEメソッド	DELETE	/opss/v2/keystoreservice/certificates
秘密キーKSSキーストアのPOST	POST	/opss/v2/keystoreservice/secretkey
秘密キー・プロパティKSSキーストアのGETメソッド	GET	/opss/v2/keystoreservice/secretkey
秘密キーKSSキーストアのDELETEメソッド	DELETE	/opss/v2/keystoreservice/secretkey
キー・ペアKSSキーストアのPOST	POST	/opss/v2/keystoreservice/keypair
キー・ペアKSSキーストアのGETメソッド	GET	/opss/v2/keystoreservice/keypair
キー・ペアKSSキーストアのDELETEメソッド	DELETE	/opss/v2/keystoreservice/keypair
キーストア・サービスKSSキーストアのDELETEメソッド	DELETE	/opss/v2/keystoreservice

新しいKSSキーストアのPOSTメソッド

新しいキーストア・サービス(KSS)キーストアを作成するには、POSTメソッドを使用します。

RESTリクエスト

POST /opss/v2/keystoreservice

リクエスト本文

リクエストまたはレスポンス本文のメディア・タイプ。

メディア・タイプ:                                                         application/json

リクエスト本文には、作成リクエストの詳細が含まれます。

属性	説明	必須
“stripeName”	KSSキーストアを含めるストライプの名前。	はい
“keystoreName”	KSSキーストアの名前。	はい
”keystorePassword”	KSSキーストアのパスワード。	いいえ
“permissionBased”	権限ベースのキーストアを作成するかどうかを指定するブール値。	いいえ

レスポンス本文

リクエストまたはレスポンス本文のメディア・タイプ。

メディア・タイプ:                                                         application/json

返されるレスポンス本文には、作成操作に関する次のようなステータスが含まれます。

属性	説明
“ERROR_CODE”	“STATUS”が“Failed”に設定されている場合はエラー・コードが提供されます。
“ERROR_MSG”	“STATUS”が“Failed”に設定されている場合はエラー・メッセージの内容が提供されます。
"STATUS"	操作のステータス。たとえば、“SUCCEEDED”または“FAILED”。

cURLの例

次の例は、cURLを使用してRESTリソースにPOSTリクエストを発行してKSSキーストアを作成する方法を示しています。

curl -i -X POST -u username:password --data @createkss.json -H Content-Type:application/json https://myhost:7001/opss/v2/keystoreservice

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

{
    "stripeName" : "myStripe",
    "keystoreName" : "myKeystore",
    "keystorePassword" : "myPwd",
    "permissionBased" : "false"
}

注意:

権限に基づくキーストア("permission" : "true")を作成していないかぎり、パスワードは必須です。

レスポンス・ヘッダーの例

次の例に、レスポンス・ヘッダーを示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。

HTTP/1.1 200 OK

レスポンス本文の例

次の例に、JSON形式のレスポンス本文を示します。

{
    "STATUS": "SUCCEEDED"
}

権限ベースのキーストアを作成する例

次に、JSON形式のリクエスト本文の例を示します。

{
    "stripeName" : "myStripe",
    "keystoreName" : "permKeystore",
    "permissionBased" : "true"
}

KSSキーストアのインポートのPOSTメソッド

JKSキーストア・ファイルからキーストア・サービス(KSS)キーストアをインポートするには、POSTメソッドを使用します。

RESTリクエスト

POST /opss/v2/keystoreservice/keystore

リクエスト本文

リクエストまたはレスポンス本文のメディア・タイプ。

メディア・タイプ:                                                      multipart/form-data

レスポンス本文には、インポート・リクエストに関する次のような情報が含まれます。

属性	説明	必須
“stripeName”	ストライプの名前。	はい
“keystoreImportByte”	キーストア・データのバイト配列	はい
“keystoreName”	JKSキーストアの名前。	はい
“keystorePassword”	パスワードで保護されている場合、インポートするローカル・キーストア・ファイルのパスワードおよびキーストア・エントリ。	いいえ
“keystoreType”	キーストア・タイプ。この値はJKSに設定する必要があります。	はい
“keyAliasList”	keystoreFileからインポートするキーの別名のリスト。	はい
“keyPasswordList”	keystoreFileからインポートするキーのパスワードのリスト。	いいえ
“permissionBased”	権限ベースのキーストアとしてインポートするかどうかを指定するブール値。	いいえ

レスポンス本文

リクエストまたはレスポンス本文のメディア・タイプ。

メディア・タイプ:                                                                          application/json

レスポンス本文には、インポート操作に関する次のような情報が含まれます。

属性	説明
“ERROR_CODE”	“STATUS”が“Failed”に設定されている場合はエラー・コードが提供されます。
“ERROR_MSG”	“STATUS”が“Failed”に設定されている場合はエラー・メッセージの内容が提供されます。
“SUCCES MSGS”	成功メッセージ。

cURLの例

次の例は、cURLを使用してRESTリソースにPOSTリクエストを発行してKSSキーストアをインポートする方法を示しています。

curl -i -X PUT -u username:password --data @updatekss.json -H
Content-Type:application/json https://myhost:7001/opss/v2/keystoreservice/keystore

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

"stripeName" : "myStripe", 
"keystoreName" : "myKeystore", 
"keyAliasList" : ["myAlias"], 
"keystorePassword" : "password1", 
"keyPasswordList" : ["password"],
"keystoreType" : "JKS",
"permissionBased" : "false",
"keystoreImportBytes" : [-2, -19, -2, -19, 0, 0, 0, 2, 0, 0, 0, 1, 0, 0, 0, 2, 0, 6, 109, 121, 99, 101, 114, 116, 0, 0, 1, 86, 125, 119, -27, 113, 0, 5, 88, 46, 53, 48, 57, 0, 0, 3, -61, 48, -126, 3, -65, 48, -126, 2, -89, -96, 3, 2, 1, 2, 2, 16, 64, 4, 72, -122, -60, 65, -17, 59, 100, 58, -128, 102, 64, -102, -4, -96, 48, 13, 6, 9, 42, -122, 72, -122, -9, 13, 1, 1, 11, 5, 0, 48, 120, 49, 11, 48, 9, 6, 3, 85, 4, 6, 19, 2, 85, 83, 49, 16, 65, -117, -74]
}

レスポンス・ヘッダーの例

次の例に、レスポンス・ヘッダーを示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。

HTTP/1.1 200 OK

レスポンス本文の例

次の例に、JSON形式のレスポンス本文を示します。

{
    "SUCCESS_MSG":"Aliases: myAlias imported
    successfully"
}

パスワード更新KSSキーストアのPUTメソッド

キーストア・サービス(KSS)キーストアのパスワードを更新するには、PUTメソッドを使用します。

RESTリクエスト

PUT /opss/v2/keystoreservice

リクエスト本文

リクエストまたはレスポンス本文のメディア・タイプ。

メディア・タイプ:                                                          application/json

レスポンス本文には、ロード・バランサのパッチに関する次のような情報が含まれます。

属性	説明	必須
“stripeName”	ストライプの名前。	はい
“keystoreName”	KSSキーストアの名前。	はい
“newPassword”	キーストアの新しいパスワード。	はい
“oldPassword”	キーストアの旧パスワード。	はい

レスポンス本文

リクエストまたはレスポンス本文のメディア・タイプ。

メディア・タイプ:                                               application/json

返されるレスポンス本文には、更新操作に関する次のようなステータスが含まれます。

属性	説明
“ERROR_CODE”	“STATUS”が"Failed"に設定されている場合はエラー・コードが提供されます。
“ERROR_MSG”	“STATUS”が“Failed”に設定されている場合はエラー・メッセージの内容が提供されます。
"STATUS"	操作のステータス。たとえば、“SUCCEEDED”または“FAILED”。

cURLの例

次の例は、cURLを使用してRESTリソースにPUTリクエストを発行してKSSキーストアをインポートする方法を示しています。

curl -i -X PUT -u username:password --data @updatekss.json -H Content-Type:application/json https://myhost:7001/opss/v2/keystoreservice

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

{
    "stripeName" : "myStripe",
    "keystoreName" : "mykssstore",
    "oldPassword" : "myPwd",
    "newPassword" : "myNewPwd"
}

レスポンス・ヘッダーの例

次の例に、レスポンス・ヘッダーを示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。

HTTP/1.1 200 OK

レスポンス本文の例

次の例に、JSON形式のレスポンス本文を示します。

{
    "STATUS": "SUCCEEDED"
}

信頼できる証明書KSSキーストアのPOSTメソッド

キーストア・サービス(KSS)キーストアに信頼できる証明書をインポートするには、POSTメソッドを使用します。

RESTリクエスト

POST /opss/v2/keystoreservice/certificates

リクエスト本文

リクエストまたはレスポンス本文のメディア・タイプ。

メディア・タイプ:                                              application/json

レスポンス本文には、インポート・リクエストに関する次のような情報が含まれます。

属性	説明	必須
“keyAliasList”	信頼できる証明書の別名を含むリスト。	はい
“keystoreEntry”	Base64でエンコードされた証明書。	はい
“keystoreType”	キーストア・エントリのタイプ。有効な値には、Certificate、TrustedCertificateまたはSecretKeyがあります。	はい
“keystoreName”	KSSキーストアの名前。	はい
“stripeName”	ストライプの名前。	はい
“keystorePassword”	KSSキーストアのパスワード。	いいえ
“keyPasswordList”	信頼できる証明書のキー・パスワードを含むリスト。	いいえ

レスポンス本文

リクエストまたはレスポンス本文のメディア・タイプ。

メディア・タイプ:                                                  application/json

返されるレスポンス本文には、インポート操作に関する次のようなステータスが含まれます。

属性	説明
“ERROR_CODE”	“STATUS”が"Failed"に設定されている場合はエラー・コードが提供されます。
“ERROR_MSG”	“STATUS”が“Failed”に設定されている場合はエラー・メッセージの内容が提供されます。
"STATUS"	操作のステータス。たとえば、“SUCCEEDED”または“FAILED”。
“SUBJECT_DN”	インポートされたサブジェクトDNのリスト。

cURLの例

次の例は、cURLを使用してRESTリソースにPOSTリクエストを発行してKSSキーストアを作成する方法を示しています。

curl -i -X POST -u username:password --data @importcertkss.json -H Content-Type:application/json https://myhost:7001/opss/v2/keystoreservice/certificates

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

{
    "keyAliasList" : ["myAlias"],
    "keystoreEntry":
"MIIC7DCCAqqgAwIBAgIEalhBSjALBgcqhkjOOAQDBQAwSDEKMAgGA1UEBhMBeTEKMAgGA1UECBMB\neTEKMAgGA1UEBxMBeTEKMAgGA1UEChMBeTEKMAgGA1UECxMBeTEKMAgGA1UEAxMBeTAeFw0xNDA3\nMDMxMTAwMTZaFw0xNDEwMDExMTAwMTZaMEgxCjAIBgNVBAYTAXkxCjAIBgNVBAgTAXkxCjAIBgNV\nBAcTAXkxCjAIBgNVBAoTAXkxCjAIBgNVBAsTAXkxCjAIBgNVBAMTAXkwggG3MIIBLAYHKoZIzjgE\nATCCAR8CgYEA/X9TgR11EilS30qcLuzk5/YRt1I870QAwx4/gLZRJmlFXUAiUftZPY1Y+r/F9bow\n9subVWzXgTuAHTRv8mZgt2uZUKWkn5/oBHsQIsJPu6nX/rfGG/g7V+fGqKYVDwT7g/bTxR7DAjVU\nE1oWkTL2dfOuK2HXKu/yIgMZndFIAccCFQCXYFCPFSMLzLKSuYKi64QL8Fgc9QKBgQD34aCF1ps9\n3su8q1w2uFe5eZSvu/o66oL5V0wLPQeCZ1FZV4661FlP5nEHEIGAtEkWcSPoTCgWE7fPCTKMyKbh\nPBZ6i1R8jSjgo64eK7OmdZFuo38L+iE1YvH7YnoBJDvMpPG+qFGQiaiD3+Fa5Z8GkotmXoB7VSVk\nAUw7/s9JKgOBhAACgYBrvzkjozmv6t6T0GNJES1R3ypRsBs8VLX2g3GotHd7Kht/TCj4HikelZDd\nuL0t96R5Q4A3srOgSIZ+0INRs1ER8y1Q37LyJNfyqYn5KqLBlN9bhSYAfcuIpjwIXGVfLQGdByD7\ntr4PSvZQx18K6p68HUCh+jXQT9+7n3ZUIBzH5aMhMB8wHQYDVR0OBBYEFPdMpcEBbYSCYMdJiE4r\ncQxf7Me4MAsGByqGSM44BAMFAAMvADAsAhQH/G1ixrEaWAG3lGWafkHgXxnzhwIUW5eSctgmaQBj\nvKaY0E6fYJzcp5c=",
    "keystoreType" : "TrustedCertificate",
    "keystoreName" : "myKeystore",
    "stripeName" : "myStripe",
    "keystorePassword" : "myPwd"
    "keyPasswordList" : ["mykeyPwd"]
}

レスポンス・ヘッダーの例

次の例に、レスポンス・ヘッダーを示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。

HTTP/1.1 200 OK

レスポンス本文の例

次の例に、JSON形式のレスポンス本文を示します。

{
    "STATUS": "SUCCEEDED"
    "SUBJECT_DN": "CN=y,OU=y,O=y,L=y,ST=y,C=y"
}

ストライプKSSキーストアのGETメソッド

ストライプのすべてのキーストア・サービス(KSS)キーストアを返すには、GETメソッドを使用します。

RESTリクエスト

GET /opss/v2/keystoreservice/{stripeName}

パラメータ

次の表は、GETリクエストのパラメータの概要を示します。

名前	説明	タイプ	必須
“stripeName”	すべてのKSSキーストアを参照するストライプの名前。	パス	はい

レスポンス本文

リクエストまたはレスポンス本文のメディア・タイプ。

メディア・タイプ:                                                   application/json

レスポンス本文には、証明書に関する次のような情報が含まれます。

属性	説明
“keystores”	ストライプ内のキーストアのリスト。

cURLの例

次の例は、cURLを使用してRESTリソースにGETリクエストを発行して、別名のすべての証明書を参照する方法を示しています。

curl -i -X GET -u username:password https://myhost:7001/opss/v2/keystoreservice/myStripe

レスポンス・ヘッダーの例

次の例に、レスポンス・ヘッダーを示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。

HTTP/1.1 200 OK

レスポンス本文の例

次の例に、JSON形式のレスポンス本文を示します。

{
    "keystores":["trust","castore"]
}

別名KSSキーストアのGETメソッド

キーストア・サービス(KSS)キーストアの別名を表示するには、GETメソッドを使用します。

RESTリクエスト

GET /opss/v2/keystoreservice/alias/{stripeName}/{keystoreName}/{entryType}

パラメータ

次の表は、GETリクエストのパラメータの概要を示します。

名前	説明	タイプ	必須
“stripeName”	ストライプの名前。	パス	はい
“keystoreName”	キーストアの名前。	パス	はい
“entryType”	キーストア・タイプ。有効な値には、Certificate、TrustedCertificateまたはSecretKeyがあります。ワイルドカード「*」は、すべてのタイプに該当します。	パス	はい
"keystorePassword"	Base64でエンコードされたキーストア・パスワード	ヘッダー	いいえ

レスポンス本文

リクエストまたはレスポンス本文のメディア・タイプ。

メディア・タイプ:                                                   application/json

レスポンス本文には、証明書に関する次のような情報が含まれます。

属性	説明
"Alias"	ストライプ内のキーストア別名のリスト。

cURLの例

次の例は、cURLを使用してRESTリソースにGETリクエストを発行して、別名のすべての証明書を参照する方法を示しています。

curl -i -X GET -u username:password https://myhost:7001/opss/v2/keystoreservice/alias/myStripe/myKeystore/TrustedCertificate

レスポンス・ヘッダーの例

次の例に、レスポンス・ヘッダーを示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。

HTTP/1.1 200 OK

レスポンス本文の例

次の例に、JSON形式のレスポンス本文を示します。

{
   "Alias":["myAlias"]
}

信頼できる証明書KSSキーストアのGETメソッド

キーストア・サービス(KSS)キーストアの信頼できる証明書を表示するには、GETメソッドを使用します。キーストアがパスワードで保護されている場合は、キーストアのパスワードをBase64でエンコードされたヘッダー値として送信する必要があります。

RESTリクエスト

GET /opss/v2/keystoreservice/certificates

パラメータ

次の表は、GETリクエストのパラメータの概要を示します。

名前	説明	タイプ	必須
“stripeName“	ストライプの名前。	問合せ	はい
“keystoreName“	キーストアの名前。	問合せ	はい
“keyAlias“	信頼できる証明書の別名。	問合せ	はい
“keystoreEntryType“	キーストア・エントリのタイプ。有効な値には、Certificate、TrustedCertificateまたはCertificateChainがあります。	問合せ	はい
“keystorePassword“	KSSキーストアのパスワード。	ヘッダー	いいえ

レスポンス本文

リクエストまたはレスポンス本文のメディア・タイプ。

メディア・タイプ:                                                      application/json

レスポンス本文には、証明書に関する次のような情報が含まれます。

属性	説明
"CONTENT"	Base64でエンコードされた証明書の内容。
“Extensions“	特定目的の証明書の発行に使用されるオプションの拡張機能。拡張には次が含まれます。 一意に識別するオブジェクト識別子(oid) 拡張がクリティカルかどうかを示すフラグ 値のセット
“ISSUER_DN“	信頼できる識別名のリスト。
“NOT_AFTER“	証明書が期限切れになる日付。
“NOT_BEFORE“	証明書が有効になる日付。
“SERIAL_NO“	JKSキーストアのシリアル番号。
“SIGNATURE“	Base64でエンコードされた署名キー。
“SIGNING_ALGORITHM“	別名の署名アルゴリズム。
“SUBJECT_DN“	サブジェクト識別名のリスト。
"PUBLIC KEY"	公開キー値の文字列。

cURLの例

次の例は、cURLを使用してRESTリソースにGETリクエストを発行して、別名のすべての証明書を参照する方法を示しています。

curl -i -X GET -u username:password -H keystorePassword:cHdkMQ== -H https://myhost:7001/opss/v2/keystoreservice/certificates?"stripeName=myStripe&keystoreName=myKeystore&keyAlias=client&keystoreEntryType=Certificate"

レスポンス・ヘッダーの例

次の例に、レスポンス・ヘッダーを示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。

HTTP/1.1 200 OK

レスポンス本文の例

次の例に、JSON形式のレスポンス本文を示します。

{
    "SUBJECT_DN":"CN=y,OU=y,O=y,L=y,ST=y,C=y",
    "ISSUER_DN":"CN=y,OU=y,O=y,L=y,ST=y,C=y",
    "NOT_BEFORE":"Fri Jul 25 02:45:11 PDT 2014",
    "NOT_AFTER":"Thu Oct 23 02:45:11 PDT 2014",
    "SERIAL_NO":"982191050",
    "SIGNING_ALGORITHM":"1.2.840.10040.4.3",
    "PUBLIC_KEY": "MIIBtzCCASwGByqGSM44BAEwggEfAoGBAP1/U4EddRIpUt9KnC7s5Of2EbdSPO9EAMMeP4C2USZpRV1AIlH7WT2NWPq/xfW6MPbLm1Vs14E7gB00b/JmYLdrmVClpJ+f6AR7ECLCT7up1/63xhv4O1fnxqimFQ8E+4P208UewwI1VBNaFpEy9nXzrith1yrv8iIDGZ3RSAHHAhUAl2BQjxUjC8yykrmCouuEC/BYHPUCgYEA9+GghdabPd7LvKtcNrhXuXmUr7v6OuqC+VdMCz0HgmdRWVeOutRZT+ZxBxCBgLRJFnEj6EwoFhO3zwkyjMim4TwWeotUfI0o4KOuHiuzpnWRbqN/C/ohNWLx+2J6ASQ7zKTxvqhRkImog9/hWuWfBpKLZl6Ae1UlZAFMO/7PSSoDgYQAAoGAa785I6M5r+rek9BjSREtUd8qUbAbPFS19oNxqLR3eyobf0wo+B4pHpWQ3bi9LfekeUOAN7KzoEiGftCDUbNREfMtUN+y8iTX8qmJ+SqiwZTfW4UmAH3LiKY8CFxlXy0BnQcg+7a+D0r2UMdfCuqevB1Aofo10E/fu592VCAcx+U=""CONTENT":"-----BEGIN CERTIFICATE----- \nMIIC7DCCAqqgAwIBAgIEOosLyjALBgcqhkjOOAQDBQAwS
EKMAgGA1UEBhMBcjEKMAgGA1UECBMB\ncjEKMAgGA1UEBxMBcjEKMAgGA1UEChMBcjEKMAgGA1UECxM
cjEKMAgGA1UEAxMBUjAeFw0xNDA3\nMjUwOTQ1MTFaFw0xNDEwMjMwOTQ1MTFaMEgxCjAIBgNVBAYTA
IxCjAIBgNVBAgTAXIxCjAIBgNV\nBAcTAXIxCjAIBgNVBAoTAXIxCjAIBgNVBAsTAXIxCjAIBgNVBAM
AVIwggG3MIIBLAYHKoZIzjgE\nATCCAR8CgYEA\/X9TgR11EilS30qcLuzk5\/YRt1I870QAwx4\/gL
RJmlFXUAiUftZPY1Y+r\/F9bow\n9subVWzXgTuAHTRv8mZgt2uZUKWkn5\/oBHsQIsJPu6nX\/rfGG
/g7V+fGqKYVDwT7g\/bTxR7DAjVU\nE1oWkTL2dfOuK2HXKu\/yIgMZndFIAccCFQCXYFCPFSMLzLKS
YKi64QL8Fgc9QKBgQD34aCF1ps9\n3su8q1w2uFe5eZSvu\/o66oL5V0wLPQeCZ1FZV4661FlP5nEHE
GAtEkWcSPoTCgWE7fPCTKMyKbh\nPBZ6i1R8jSjgo64eK7OmdZFuo38L+iE1YvH7YnoBJDvMpPG+qFG
iaiD3+Fa5Z8GkotmXoB7VSVk\nAUw7\/s9JKgOBhAACgYAjhpZybXj6rlXDow8srnSFE9dZJJpCKaQV
ACagQogePV+xlqPClDOoiQJ\nuvuUGHerDrThC1\/Wq5Uj1+TnkSKTy0qYxmQoq56xALa47np9TKtqt
4Vy8eUUorakG4lrjNt\/EgR\nfO675n+qINkKXKpcxaCicupRCYPkPXlnT4mtyKMhMB8wHQYDVR0OBB
EFDKbmPa2Il6SylJRPTv8\nQ+4CqpEhMAsGByqGSM44BAMFAAMvADAsAhQbkmlaUG5QDR5mXUiYC74p
\/FBOwIUGx5lc5Y01ppo\nvK3UgL7M8E3eOfc=\n-----END CERTIFICATE-----",
    "SIGNATURE":FEZN2l4SPFEK5jt2QZRb5Q==",
    "Extensions":"{subjectKeyIDExtension {oid = 2.5.29.14 critical = false, value = 329b98f6b6225e92ca52513d3bfc43ee02aa9121}}"
}

信頼できる証明書KSSキーストアのDELETEメソッド

キーストア・サービス(KSS)キーストアから証明書を削除するには、DELETEメソッドを使用します。キーストアがパスワードで保護されている場合は、キーストアおよびキーのパスワードをBase64でエンコードされたヘッダー値として送信する必要があります。

RESTリクエスト

DELETE /opss/v2/keystoreservice/certificates

パラメータ

次の表は、DELETEリクエストのパラメータの概要を示します。

名前	説明	タイプ	必須
“stripeName“	ストライプの名前。	問合せ	はい
“keystoreName“	キーストアの名前。	問合せ	はい
“keyAlias“	KSSキーストアの証明書の別名。	問合せ	はい
“keystorePassword“	Base64でエンコードされたキーストア・パスワード。	ヘッダー	いいえ
“keyPassword“	Base64でエンコードされたキー・パスワード。	ヘッダー	いいえ

レスポンス本文

リクエストまたはレスポンス本文のメディア・タイプ。

メディア・タイプ:                                                          application/json

返されるレスポンス本文には、インポート操作に関する次のようなステータスが含まれます。

属性	説明
“ERROR_CODE”	“STATUS”が“Failed”に設定されている場合はエラー・コードが提供されます。
“ERROR_MSG”	“STATUS”が“Failed”に設定されている場合はエラー・メッセージの内容が提供されます。
"STATUS"	操作のステータス。たとえば、"SUCCEEDED"。

cURLの例

次の例は、cURLを使用してRESTリソースにDELETEリクエストを発行してキーストアから信頼できる証明書を削除する方法を示しています。

curl -i -X DELETE -u username:password -H keystorePassword:cHdkMQ== -H keyPassword:bXlQd2Qy  https://myhost:7001/opss/v2/keystoreservice/certificates?"stripeName=myStripe&keystoreName=myKeystore&keyAlias=myAlias"

レスポンス・ヘッダーの例

次の例に、レスポンス・ヘッダーを示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。

HTTP/1.1 200 OK

レスポンス本文の例

次の例に、JSON形式のレスポンス本文を示します。

{
    "STATUS": "SUCCEEDED"
}

秘密キーKSSキーストアのPOST

KSSキーストアの対称暗号化/復号化に使用される秘密キーを作成するには、POSTメソッドを使用します。

RESTリクエスト

POST /opss/v2/keystoreservice/secretkey

リクエスト本文

リクエストまたはレスポンス本文のメディア・タイプ。

メディア・タイプ:                                                             application/json

リクエスト本文には、作成リクエストの詳細が含まれます。

属性	説明	必須
“stripeName“	ストライプの名前。	はい
“keystoreName“	KSSキーストアの名前。	はい
“keyAliasList“	秘密キーの別名を含むリスト。	はい
“keySize“	暗号アルゴリズムで使用されるキーのサイズ(ビット単位)。	はい
“keyAlgorithm“	メッセージ保護に使用される暗号アルゴリズムの特性を制御します。	はい
“keystorePassword“	KSSキーストアのパスワード。	いいえ
“keyPasswordList“	キーのパスワードを含むリスト。	いいえ

レスポンス本文

リクエストまたはレスポンス本文のメディア・タイプ。

メディア・タイプ:                                                             application/json

返されるレスポンス本文には、インポート操作に関する次のようなステータスが含まれます。

属性	説明
“ERROR_CODE“	“STATUS“が“Failed““に設定されている場合はエラー・コードが提供されます。
“ERROR_MSG“	“STATUS“が“Failed“に設定されている場合はエラー・メッセージの内容が提供されます。
“STATUS“	操作のステータス。たとえば、“SUCCEEDED“または“FAILED“。

cURLの例

次の例は、cURLを使用してRESTリソースにPOSTリクエストを発行して秘密キーを作成する方法を示しています。

curl -i -X POST -u username:password --data @secretkey.json -H Content-Type:application/json https://myhost:7001/opss/v2/keystoreservice/secretkey

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

{
    "stripeName" : "myStripe",
    "keystoreName" : "myKeystore",
    "keyAliasList" : ["myKeyAlias"],
    "keySize" : "56",
    "keyAlgorithm" : "DES",
    "keystorePassword" : "myPwd",
    "keyPasswordList" : ["myKeyPwd"]
}

レスポンス・ヘッダーの例

次の例に、レスポンス・ヘッダーを示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。

HTTP/1.1 200 OK

レスポンス本文の例

次の例に、JSON形式のレスポンス本文を示します。

{
    "STATUS": "SUCCEEDED"
}

秘密キー・プロパティKSSキーストアのGETメソッド

KSSキーストアの秘密キーのプロパティを表示するには、GETメソッドを使用します。キーストアがパスワードで保護されている場合は、キーストアおよびキーのパスワードをBase64でエンコードされたヘッダー値として送信する必要があります。

RESTリクエスト

GET /opss/v2/keystoreservice/secretkey

パラメータ

次の表は、GETリクエストのパラメータの概要を示します。

名前	説明	タイプ	必須
stripeName	ストライプの名前。	問合せ	はい
keystoreName	キーストアの名前。	問合せ	はい
keyAlias	秘密キーの別名。	問合せ	はい
"returnKeyInResponse"	出力でキーが返されるかどうか。	問合せ	いいえ
"keystorePassword"	Base64でエンコードされたキーストア・パスワード。	ヘッダー	いいえ
"keyPassword"	Base64でエンコードされたキー・パスワード。	ヘッダー	いいえ

レスポンス本文

リクエストまたはレスポンス本文のメディア・タイプ。

メディア・タイプ:                                  application/json

レスポンス本文には、証明書に関する次のような情報が含まれます。

属性	説明
"keystore properties"	秘密キー・プロパティのリスト。
"secret key"	"returnKeyInResponse"がtrueに設定されている場合は、秘密キー・データの文字列

cURLの例

次の例は、cURLを使用してRESTリソースにGETリクエストを発行して、別名のすべての証明書を参照する方法を示しています。

curl -i -X GET -u username:password -H keystorePassword:bXlQd2Q= -H keyPassword:bXlLZXlQd2Q= https://myhost:7001/opss/v2/keystoreservice/secretkey?"stripeName=myStripe&keystoreName=myKeystore&keyAlias=myKeyAlias"

レスポンス・ヘッダーの例

次の例に、レスポンス・ヘッダーを示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。

HTTP/1.1 200 OK

レスポンス本文の例

次の例に、JSON形式のレスポンス本文を示します。

{
   "keystore properties":["DES"]
}

次の例は、秘密キー値を含む別名の秘密キーのプロパティを表示する方法を示しています。

curl -i -X GET -u username:password -H keystorePassword:bXlQd2Q= -H keyPassword:bXlLZXlQd2Q= https://myhost:7001/opss/v2/keystoreservice/secretkey?stripeName=myStripe&keystoreName=myKeystore&keyAlias=myKeyAlias&returnKeyInResponse=true

レスポンス本文の例

次の例に、JSON形式のレスポンス本文を示します。

{
"keystore properties":["DES"],
"secret key": "f65uMWvxAdM="
}

秘密キーKSSキーストアのDELETEメソッド

秘密キーを削除するには、DELETEメソッドを使用します。

RESTリクエスト

DELETE /opss/v2/keystoreservice/secretkey

パラメータ

次の表は、DELETEリクエストのパラメータの概要を示します。

名前	説明	タイプ	必須
"stripeName"	ストライプの名前。	問合せ	はい
"keystoreName"	キーストアの名前。	問合せ	はい
"keyAlias"	秘密キーの別名。	問合せ	はい
"keystorePassword"	KSSキーストアのパスワード。	ヘッダー	いいえ
"keyPassword"	キーのパスワード。	ヘッダー	いいえ

レスポンス本文

リクエストまたはレスポンス本文のメディア・タイプ。

メディア・タイプ:                                application/json

返されるレスポンス本文には、削除操作に関する次のようなステータスが含まれます。

属性	説明
"ERROR_CODE"	"STATUS"が"Failed"に設定されている場合はエラー・コードが提供されます。
"ERROR_MSG"	"STATUS"が"Failed"に設定されている場合はエラー・メッセージの内容が提供されます。
"STATUS"	操作のステータス。たとえば、"SUCCEEDED"または"FAILED"。

cURLの例

次の例は、cURLを使用してRESTリソースにDELETEリクエストを発行してキーストアから秘密キーを削除する方法を示しています。

curl -i -X DELETE -u username:password -H keystorePassword:bXlQd2Q=  -H keyPassword:bXlLZXlQd2Q=  https://myhost:7001/opss/v2/keystoreservice/secretkey?"stripeName=myStripe&keystoreName=myKeystore"

レスポンス・ヘッダーの例

次の例に、レスポンス・ヘッダーを示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。

HTTP/1.1 200 OK

レスポンス・ヘッダーの例

次の例に、JSON形式のレスポンス本文を示します。

{
"STATUS": "SUCCEEDED"
}

キー・ペアKSSキーストアのPOST

KSSキーストアの対称暗号化/復号化に使用されるキー・ペアを作成するには、POSTメソッドを使用します。

RESTリクエスト

POST /opss/v2/keystoreservice/keypair

リクエスト本文

リクエストまたはレスポンス本文のメディア・タイプ。

メディア・タイプ:                                                        application/json

リクエスト本文には、作成リクエストの詳細が含まれます。

属性	説明	必須
"stripeName"	ストライプの名前。	はい
"keystoreName"	KSSキーストアの名前。	はい
"keyAliasList"	秘密キーの別名を含むリスト。	はい
"keySize"	暗号アルゴリズムで使用されるキーのサイズ(ビット単位)。	はい
"keyAlgorithm"	メッセージ保護に使用される暗号アルゴリズムの特性を制御します。	はい
"DN"	キーの識別名	はい
"keystorePassword"	KSSキーストアのパスワード。	いいえ
"keyPassword"	キーのパスワード。	いいえ
"keyPasswordList"	リストのパスワードを含むリスト。	いいえ

レスポンス本文

リクエストまたはレスポンス本文のメディア・タイプ。

メディア・タイプ:                                                        application/json

返されるレスポンス本文には、インポート操作に関する次のようなステータスが含まれます。

属性	説明
"ERROR_CODE"	"STATUS"が"Failed"に設定されている場合はエラー・コードが提供されます。
"ERROR_MSG"	"STATUS"が"Failed"に設定されている場合はエラー・メッセージの内容が提供されます。
"STATUS"	操作のステータス。たとえば、"SUCCEEDED"または"FAILED"。

cURLの例

次の例は、cURLを使用してRESTリソースにPOSTリクエストを発行してキー・ペアを作成する方法を示しています。

curl -i -X POST -u username:password --data @keypair.json -H Content-Type:application/json https://myhost:7001/opss/v2/keystoreservice/keypair

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

{
    "stripeName" : "myStripe",
    "keystoreName" : "myKeystore",
    "keyAliasList" : ["myKeyAlias"],
    "keySize" : "256",
    "algorithm" : "EC",
    "DN" : "CN=CertGenCA,OU=FORTESTINGONLY,O=MyOrganization,L=MyTown,ST=MyState,C=US",
    "keystorePassword" : "myPwd",
    "keyPasswordList" : ["myKeyPwd"]
}

レスポンス・ヘッダーの例

次の例に、レスポンス・ヘッダーを示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。

HTTP/1.1 200 OK

レスポンス本文の例

次の例に、JSON形式のレスポンス本文を示します。

{
    "STATUS": "SUCCEEDED"
}

キー・ペアKSSキーストアのGETメソッド

KSSキーストアのキー・ペアを表示するには、GETメソッドを使用します。キーストアがパスワードで保護されている場合は、キーストアおよびキーのパスワードをBase64でエンコードされたヘッダー値として送信する必要があります。

RESTリクエスト

GET /opss/v2/keystoreservice/keypair

パラメータ

次の表は、GETリクエストのパラメータの概要を示します。

名前	説明	タイプ	必須
"stripeName"	ストライプの名前。	問合せ	はい
"keystoreName"	キーストアの名前。	問合せ	はい
"keyAlias"	秘密キーの別名。	問合せ	はい
"keystorePassword"	KSSキーストアのパスワード。	ヘッダー	いいえ
"keyPassword"	キーのパスワード。	ヘッダー	いいえ

レスポンス本文

リクエストまたはレスポンス本文のメディア・タイプ。

メディア・タイプ:                                         application/json

返されるレスポンス本文には、get操作に関する次のようなステータスが含まれます。

属性	説明
"private key"	Base64でエンコードされた秘密キー

cURLの例

次の例は、cURLを使用してRESTリソースにGETリクエストを発行して、キー・ペアを参照する方法を示しています。

curl -i -X GET -u username:password -H keystorePassword:bXlQd2Q= -H keyPassword:bXlLZXlQd2Q= https://myhost:7001/opss/v2/keystoreservice/keypair?stripeName=myStripe&keystoreName=myKeystore&keyAlias=myKeyAlias

レスポンス・ヘッダーの例

次の例に、レスポンス・ヘッダーを示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。

HTTP/1.1 200 OK

レスポンス本文の例

次の例に、JSON形式のレスポンス本文を示します。

{
    "private key":			"MEECAQAwEwYHKoZIzj0CAQYIKoZIzj0DAQcEJzAlAgEBBCBzQbYz6xUZjr/XuwVMJj1XXQCquis0f9q5SD9NXhlBjw=="
}

キー・ペアKSSキーストアのDELETEメソッド

キー・ペアを削除するには、DELETEメソッドを使用します。

RESTリクエスト

DELETE /opss/v2/keystoreservice/keypair

パラメータ

次の表は、DELETEリクエストのパラメータの概要を示します。

名前	説明	タイプ	必須
"stripeName"	ストライプの名前。	問合せ	はい
"keystoreName"	キーストアの名前。	問合せ	はい
"keyAlias"	キー・ペアの別名。	問合せ	はい
"keystorePassword"	Base64でエンコードされたキーストア・パスワード。	ヘッダー	いいえ
"keyPassword"	Base64でエンコードされたキー・パスワード。	ヘッダー	いいえ

レスポンス本文

リクエストまたはレスポンス本文のメディア・タイプ。

メディア・タイプ:                                   application/json

返されるレスポンス本文には、削除操作に関する次のようなステータスが含まれます。

属性	説明
"ERROR_CODE"	"STATUS"が"Failed"に設定されている場合はエラー・コードが提供されます。
"ERROR_MSG"	"STATUS"が"Failed"に設定されている場合はエラー・メッセージの内容が提供されます。
"STATUS"	操作のステータス。たとえば、"SUCCEEDED"または"FAILED"。

cURLの例

次の例は、cURLを使用してRESTリソースにDELETEリクエストを発行してキーストアからキー・ペアを削除する方法を示しています。

curl -i -X DELETE -u username:password -H keystorePassword:bXlQd2Q= https://myhost:7001/opss/v2/keystoreservice/keypair?"stripeName=myStripe&keystoreName=myKeystore&keyAlias=myKeyAlias"

レスポンス・ヘッダーの例

次の例に、レスポンス・ヘッダーを示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。

HTTP/1.1 200 OK

レスポンス本文の例

次の例に、JSON形式のレスポンス本文を示します。

{
    "STATUS": "SUCCEEDED""
}

キーストア・サービスKSSキーストアのDELETEメソッド

キーストア・サービス(KSS)キーストアを削除するには、DELETEメソッドを使用します。キーストアがパスワードで保護されている場合は、キーストアのパスワードをBase64でエンコードされたヘッダー値として送信する必要があります。

RESTリクエスト

DELETE /opss/v2/keystoreservice

パラメータ

次の表は、DELETEリクエストのパラメータの概要を示します。

名前	説明	タイプ	必須
"stripeName"	ストライプの名前。	問合せ	はい
"keystoreName"	キーストアの名前。	問合せ	はい
"keyStorePassword"	キーストアのパスワード。	ヘッダー	いいえ

レスポンス本文

リクエストまたはレスポンス本文のメディア・タイプ。

メディア・タイプ:                                                           application/json

返されるレスポンス本文には、削除操作に関する次のようなステータスが含まれます。

属性	説明
"ERROR_CODE"	"STATUS"が"Failed"に設定されている場合はエラー・コードが提供されます。
"ERROR_MSG"	"STATUS"が"Failed"に設定されている場合はエラー・メッセージの内容が提供されます。
"STATUS"	操作のステータス。たとえば、"SUCCEEDED"または"FAILED"。

cURLの例

次の例は、cURLを使用してRESTリソースにDELETEリクエストを発行してキーストアから信頼できる証明書を削除する方法を示しています。

curl -i -X DELETE -u username:password -H keystorePassword:bXlQd2Q= https://myhost:7001/opss/v2/keystoreservice?"stripeName=myStripe&keystoreName=myKeystore"

レスポンス・ヘッダーの例

次の例に、レスポンス・ヘッダーを示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。

HTTP/1.1 204 No Content