【Amazon Cognito】IDプールの使い方（Java SDK）

2020年8月14日 2020年8月19日

1 IDプールとは
- 1.1 事前準備
2 IDプールの使い方
3 終わりに

IDプールとは

Amazon Cognitoには、ユーザープールとIDプールが存在します。

ユーザープールでは、認証（ログイン）やユーザー情報、グループの管理などを行うことができます。

IDプールでは、ユーザーのアクセスコントール（S3など利用するAWSサービスを選べる）をすることができ、AWS 認証情報（アクセスキーやシークレットキー）を一時的に生成します。そして、生成されたAWS認証情報を使い、S3などの他のAWSサービスにアクセスすることができます。

本記事では、Java用のSDK（AWS SDK for Java 1.11）でAmazon CognitoのIDプールの使い方を紹介します。

事前準備

AWSのJDKを使う設定をします。pomの場合は、次の内容を追加してAWSのSDKを使用できるようにします。

ユーザープール：aws-java-sdk-cognitoidp
IDプール：aws-java-sdk-cognitoidentity
S3：aws-java-sdk-s3
IAM：aws-java-sdk-iam

<dependency>
  <groupId>com.amazonaws</groupId>
  <artifactId>aws-java-sdk-cognitoidp</artifactId>
  <version>1.11.828</version>
</dependency>

<dependency>
  <groupId>com.amazonaws</groupId>
  <artifactId>aws-java-sdk-cognitoidentity</artifactId>
  <version>1.11.828</version>
</dependency>

<dependency>
  <groupId>com.amazonaws</groupId>
  <artifactId>aws-java-sdk-s3</artifactId>
  <version>1.11.828</version>
</dependency>

<dependency>
  <groupId>com.amazonaws</groupId>
  <artifactId>aws-java-sdk-iam</artifactId>
  <version>1.11.828</version>
</dependency

IDプールの使い方

本記事で紹介する内容は、以下の通りです。

「GetId」でIdentityIdを取得
「GetCredentialsForIdentity」でAWS 認証情報（クレデンシャル）を取得
取得したAWS認証情報でユーザープールに接続
取得したAWS認証情報でIAMに接続
取得したAWS認証情報でS3に接続

IDプールのAPIリファレンスは、以下の公式サイトをご覧ください。

API Reference：https://docs.aws.amazon.com/cognitoidentity/latest/APIReference/Welcome.html

(1) 「GetId」でIdentityIdを取得する

まずは、IDプールに接続するために必要な「AmazonCognitoIdentity」を生成します。

AWSCredentials credentials = new BasicAWSCredentials("アクセスキー","シークレットキー");

AmazonCognitoIdentity idPoolClient =  AmazonCognitoIdentityClientBuilder.standard()
        .withCredentials(new AWSStaticCredentialsProvider(credentials))
        .withRegion(Regions.AP_NORTHEAST_1)
        .build();

次に「GetId」で IdentityId を取得します。IdentityIdは、「GetCredentialsForIdentity」で必要な情報です。

// ログイン情報の生成
// <region>：リージョン
// <YOUR_USER_POOL_ID>：ユーザープールID
// <IdToken>：認証成功時に取得したIdToken
Map<String, String> logins = new HashMap<String, String>();
logins.put("cognito-idp.<region>.amazonaws.com/<YOUR_USER_POOL_ID>", "<IdToken>");

// IdentityIdの取得
GetIdRequest idRequest = new GetIdRequest();
idRequest.setIdentityPoolId("IDプールのID");
idRequest.setLogins(logins);
GetIdResult idResult = idPoolClient.getId(idRequest);

<region>には、リージョン（東京の場合は、ap-northeast-1）、<YOUR_USER_POOL_ID>にはユーザープールID、<IdToken>には、ユーザープールで認証に成功した際に取得した IdToken が入ります。

(2) 「GetCredentialsForIdentity」でAWS 認証情報（クレデンシャル）を取得する

「GetId」で取得した IdentityId を指定してAWS 認証情報（クレデンシャル）を取得します。

※setLoginsには「GetId」と同じ値が入る

// ログインユーザーのクレデンシャル情報の取得
GetCredentialsForIdentityRequest credentialsForIdentityRequest = new GetCredentialsForIdentityRequest();
credentialsForIdentityRequest.setIdentityId(idResult.getIdentityId());
credentialsForIdentityRequest.setLogins(logins);
GetCredentialsForIdentityResult credentialsForIdentityResult =
        idPoolClient.getCredentialsForIdentity(credentialsForIdentityRequest);

(3) 取得したAWS認証情報でユーザープールに接続する

「GetCredentialsForIdentity」で取得した「アクセストークン」「シークレットキー」「セッショントークン」を使いユーザープールのAWSCognitoIdentityProviderを生成します。

// ログインユーザーのクレデンシャル情報でAWSStaticCredentialsProviderを生成
BasicSessionCredentials sessionCredentials = new BasicSessionCredentials(
        credentialsForIdentityResult.getCredentials().getAccessKeyId(),
        credentialsForIdentityResult.getCredentials().getSecretKey(),
        credentialsForIdentityResult.getCredentials().getSessionToken());
AWSStaticCredentialsProvider provider = new AWSStaticCredentialsProvider(sessionCredentials);


// ユーザプールクライアントの生成
AWSCognitoIdentityProvider userPoolClient = AWSCognitoIdentityProviderClientBuilder.standard()
        .withCredentials(provider)
        .withRegion(Regions.AP_NORTHEAST_1)
        .build();

[ユーザープールのAPI使用例]

AdminListGroupsForUserでユーザーが所属しているグループ情報を取得することができます。

AdminListGroupsForUserRequest adGroupsUserRequest = new AdminListGroupsForUserRequest();
adGroupsUserRequest.setUsername("ユーザー名");
adGroupsUserRequest.setUserPoolId("ユーザープールID");
AdminListGroupsForUserResult userPoolClient.adminListGroupsForUser(adGroupsUserRequest);

ユーザープールのAPIリファレンスは、以下の公式サイトをご覧ください。

API Reference：https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference

(4) 取得したAWS認証情報でIAMに接続する

「GetCredentialsForIdentity」で取得した「アクセストークン」「シークレットキー」「セッショントークン」を使いIAMのAmazonIdentityManagementを生成します。

// ログインユーザーのクレデンシャル情報でAWSStaticCredentialsProviderを生成
BasicSessionCredentials sessionCredentials = new BasicSessionCredentials(
        credentialsForIdentityResult.getCredentials().getAccessKeyId(),
        credentialsForIdentityResult.getCredentials().getSecretKey(),
        credentialsForIdentityResult.getCredentials().getSessionToken());
AWSStaticCredentialsProvider provider = new AWSStaticCredentialsProvider(sessionCredentials);

// IAMクライアントの生成
AmazonIdentityManagement iamClient = AmazonIdentityManagementClientBuilder.standard()
        .withCredentials(provider)
        .withRegion(Regions.AP_NORTHEAST_1)
        .build();

[IAMのAPI使用例]

ListRoleTagsでIAMロールのタグ情報を取得することができます。

ListRoleTagsRequest listRoleTagsRequest = new ListRoleTagsRequest().withRoleName("ロール名");
ListRoleTagsResult roleTags = iamClient.listRoleTags(listRoleTagsRequest);

IAMのAPIリファレンスは、以下の公式サイトをご覧ください。

API Reference：https://docs.aws.amazon.com/ja_jp/IAM/latest/APIReference/welcome.html

(5) 取得したAWS認証情報でS3に接続する

「GetCredentialsForIdentity」で取得した「アクセストークン」「シークレットキー」「セッショントークン」を使いS3のAmazonS3を生成します。

// ログインユーザーのクレデンシャル情報でAWSStaticCredentialsProviderを生成
BasicSessionCredentials sessionCredentials = new BasicSessionCredentials(
        credentialsForIdentityResult.getCredentials().getAccessKeyId(),
        credentialsForIdentityResult.getCredentials().getSecretKey(),
        credentialsForIdentityResult.getCredentials().getSessionToken());
AWSStaticCredentialsProvider provider = new AWSStaticCredentialsProvider(sessionCredentials);

// S3クライアントの生成
AmazonS3 s3Client = AmazonS3ClientBuilder
        .standard()
        .withCredentials(provider)
        .withRegion(Regions.AP_NORTHEAST_1)
        .build();

S3のAPIリファレンスは、以下の公式サイトをご覧ください。

API Reference：https://docs.aws.amazon.com/ja_jp/AmazonS3/latest/API/API_Operations_Amazon_Simple_Storage_Service.html

終わりに

本記事では、Amazon CognitoのIDプールの使い方について紹介しました。

次回は「Amazon S3へファイルをアップロードする方法」について紹介します。

[AWS 関連記事]

helpful

この記事は役に立ちましたか？

はじめにメールアドレスのチェックをインターネットで検索すると、正規表現を使ったチェック方法が多く紹介されています。しかし、RFCで定義されているメールアドレスの書式を満たしている正規表現は、ほとんど見たことがありません。たとえば、以下はRFCの規定において有効なメールアドレスです。 Abc@example.com (dot-atom) Abc.123@example.com (dot-atom) user+mailbox/department=shipping@example.com (dot-at ...

2024/5/13

MyBatisで一括登録（バルクインサート）する方法

【MyBatis】BULK INSERTでデータを登録する方法 MyBatisでデータを一括登録（BULK INSERT）する方法を紹介します。また「一括登録（BULK INSERT）」と「1件ずつ登録（INSERT）」する方法で 1万、10万、100万レコードを登録したときにかかる処理時間を測定しています。本記事で使用するテーブル定義は次のとおり。物理名論理名データ型NOT NULL説明idIDBIGINT〇主キー（AUTO_INCREMENT）name名前VARCHAR(100)〇ユーザーの名前 ...

2021/5/15

Javaで時刻チェックを実装する方法

はじめに Javaで時刻チェック（正規表現を使用）を実装する方法を紹介します。今回のチェックでは「HH:ｍｍ:ss」形式または「HH:mm」形式で、有効な時刻のみチェックOKとしています。正規表現による時刻チェック正規表現を使用した時刻チェックは以下の通り。 /** * 時刻チェック * @param value 検証対象の値 * @return 結果（true：時刻、false：時刻ではない） */ public static boolean isTime(String value) { boo ...

2020/8/19

【Java】Amazon Cognitoのユーザープールを使用する方法

はじめに（前準備） Java用のSDK（AWS SDK for Java 1.11）でAmazon Cognitoのユーザープールを使用する方法を紹介します。前準備として、AWS マネジメントコンソールからユーザープールを作成する必要があります。※本記事では、ユーザープールの作成は省略しています。 pom.xml まずはAWSのJDKを使う設定をします。pomの場合は、次の内容を追加してユーザープール用のSDKを使用できるようにします。 <dependency> <groupId&gt ...

2024/6/10

JavaでCSVファイルを出力する方法

はじめに JavaでCSVファイルを出力するには、Java標準で提供されているAPIを使うか、CSVファイルを扱うためのライブラリを使うかのどちらかです。本記事では、Java標準で提供されているAPIを使いCSVファイル出力を行う方法について紹介します。 JavaでCSVファイルを出力する方法 PrintWriterによる書き込み JavaでCSVファイルを出力するには、書き込みに特化したクラスである「PrintWriter」を使うことで簡単に実装できます。次の例では、CsvDataBeanクラスに格 ...

2024/5/13

MyBatisでif文（条件分岐）を使用して動的SQLを生成する

MyBatisで条件分岐を実装する ifで条件分岐 MyBatisで「if test」を使えば、「もし～だったら」という条件文が書けます。次の例で、もし「idがnull以外」の場合「AND id = #{id}」の条件をWHERE句に追加するという条件分岐を作成しています。 <select id="search" resultType="com.example.demo.entity.UserInfo"> SELECT * FROM userinfo ...

【Java】Amazon Cognitoのユーザープールを使用する方法

Amazon S3へファイルをアップロードする方法（Java SDK）

【Amazon Cognito】IDプールの使い方（Java SDK）

IDプールとは

事前準備

IDプールの使い方

(1) 「GetId」でIdentityIdを取得する

(2) 「GetCredentialsForIdentity」でAWS 認証情報（クレデンシャル）を取得する

(3) 取得したAWS認証情報でユーザープールに接続する

(4) 取得したAWS認証情報でIAMに接続する

(5) 取得したAWS認証情報でS3に接続する

終わりに

helpful

ネットワーク層（インターネット層）のプロトコル一覧

通信プロトコルとは

ログファイルとは

NAPT（IPマスカレード）とは

サブドメインとは

ITを分かりやすく解説