クレデンシャル SDK は、KMS OpenAPI および KMS インスタンス API を中心としたカスタムラッパーです。アプリケーション内での認証情報のキャッシュと更新機能をカプセル化し、ビジネスの安定性を高め、開発者による統合を容易にします。このドキュメントでは、クレデンシャル SDK をビジネスアプリケーションに統合する方法について説明します。
統合の概要
クレデンシャル SDK は、ビジネス運用のための認証情報の値の取得のみをサポートします。共有ゲートウェイと専用ゲートウェイの両方を通じたアクセスをサポートします。
共有ゲートウェイと専用ゲートウェイの違い
クレデンシャル SDK は、共有ゲートウェイと専用ゲートウェイを介して OpenAPI とインスタンス API を呼び出すことにより、認証情報の取得をサポートします。共有ゲートウェイは KMS サービスのグローバルネットワークであり、インターネットまたは VPC ネットワーク経由でアクセスできます。専用ゲートウェイは特定の KMS インスタンスのネットワークであり、プライベートネットワーク経由のアクセスのみをサポートします。
相違点 | 共有ゲートウェイ | 専用ゲートウェイ |
推奨シナリオ |
|
|
ネットワーク | インターネットまたは VPC ネットワーク。 | KMS プライベートネットワーク。 |
パフォーマンス | 例えば、共有ゲートウェイを介した暗号化と復号の QPS は 1,000 です。 | 購入したインスタンスの コンピューティングパフォーマンス 仕様 (1,000 や 2,000 など) に基づきます。詳細については、 |
クライアントの初期化設定 |
|
|
API の可用性 |
認証と認可
クレデンシャル SDK は、RAM 認証と AAP 認証 (非推奨) の 2 つの認証方式をサポートします。
認証方式 | サポートされる認証情報タイプ |
RAM 認証 | RamRoleArn、ECS RAM ロール、STS トークン、AccessKey、Alibaba Cloud デフォルト認証情報チェーン、OIDC Role ARN など。 説明 RAM 認証情報プラグインは ECS RAM ロールのみをサポートします。 |
AAP 認証 (非推奨) | ClientKey (共有ゲートウェイ設定)、ClientKey (専用ゲートウェイ設定) |
SDK タイプ
クレデンシャル SDK は、クレデンシャルクライアント、クレデンシャル JDBC クライアント、RAM 認証情報プラグインの 3 種類の SDK を提供します。これらの SDK は、共有ゲートウェイまたは専用ゲートウェイを介して OpenAPI-GetSecretValue またはインスタンス API-GetSecretValue (非推奨) を呼び出すことにより、KMS 認証情報の値を取得します。サポートされる認証方式と API タイプは、次の表に示すように SDK タイプによって異なります。
SDK タイプ | 説明 | ゲートウェイと認証 |
| 共有ゲートウェイと専用ゲートウェイ：RamRoleArn、ECS RAM ロール、STS トークン、AccessKey、Alibaba Cloud デフォルト認証情報チェーン、OIDC Role ARN、ClientKey など。 説明 クレデンシャルクライアント V2 SDK の使用を推奨します。バージョンの違いに関する詳細については、「Secrets manager クライアント」をご参照ください。 | |
| 共有ゲートウェイ：
専用ゲートウェイ (非推奨)： AAP 認証：ClientKey (専用ゲートウェイ設定)。 | |
| 共有ゲートウェイ：
専用ゲートウェイ (非推奨)： AAP 認証：ClientKey (専用ゲートウェイ設定)。 |
サポートされる API
API | 説明 | 共有ゲートウェイ | 専用ゲートウェイ |
GetSecretValue (OpenAPI) | 認証情報の値を取得します。 | ||
GetSecretValue (インスタンス API) | 認証情報の値を取得します。 |
サポートされるプログラミング言語
次の表に、サポートされるプログラミング言語と各言語の SDK ドキュメントリファレンスを示します。
クレデンシャル SDK | サポート言語 |
Java (Java 8 以降)、Python、Go | |
Java (Java 8 以降) | |
Java (Java 8 以降)、Python、Go |