ウェブサイトのアイデンティティプロバイダー
ウェブサイト認証はAmazon Cognitoユーザープールを作成し、デフォルトではそのプールにユーザー名とパスワードを持つユーザーのみがサインインできます。スタッフや顧客がOkta、Auth0、Microsoft Entra IDなどのアイデンティティプロバイダー(IdP)に既にアカウントを持っている場合、ウェブサイト専用の2つ目のアカウントが必要になってしまいます。
ts#website#authを--federation=oidcで実行すると、外部のOpenID Connect(OIDC)アイデンティティプロバイダーをユーザープールに追加できます。アイデンティティプロバイダーをインフラストラクチャコードにリストします:CDKではUserIdentityのoidcIdentityProvidersプロパティ、Terraformではuser_identityモジュールのoidc_identity_providers変数です。サインインページには、ユーザー名とパスワードフォームの横に各アイデンティティプロバイダー用のボタンが表示されるようになります。
- ウェブサイトは引き続きユーザーをCognitoサインインページに送信します。このページには、各アイデンティティプロバイダーにちなんだ名前のボタンが表示されます。
- ボタンを選択したユーザーは、そのアイデンティティプロバイダーでサインインします。アイデンティティプロバイダーは、リダイレクトURI
https://<cognito domain>/oauth2/idpresponseでユーザーをCognitoに送り返します。 - Cognitoは、ユーザープールにフェデレーテッドユーザーとしてユーザーを作成し、マッピングしたクレーム(例:
email)をユーザーの属性にコピーします。 - その後、Cognitoはローカルユーザーに発行するのと同じ種類のトークンを発行します。API、エージェント、アイデンティティプールは、変更なしでそれらを受け入れます。
プールにユーザー名とパスワードを持つユーザーは、引き続きサインインできます。
サインインできるユーザー
Section titled “サインインできるユーザー”アイデンティティプロバイダーを追加すると、予想よりも多くの人がウェブサイトにアクセスできるようになる可能性があります。ts#website#authのallowSignupオプションは、フェデレーテッドユーザーには適用されません。Cognitoは、ユーザープールがユーザーの自己サインアップを許可していない場合でも、誰かがアイデンティティプロバイダーを通じて初めてサインインしたときにフェデレーテッドユーザーを作成します。各フェデレーテッドユーザーは、アイデンティティプールの認証済みロールも取得するため、サインインしたユーザーと同様にAPIやエージェントを呼び出すことができます。
アイデンティティプロバイダーは、ユーザープール全体に適用されます。プールを使用するすべてのウェブサイトで、それらのボタンが表示され、ユーザーが受け入れられます。
したがって、アイデンティティプロバイダーがサインインできるユーザーを決定します。ウェブサイトを必要とする人だけがサインインできるように設定してください:
- Microsoft Entra ID:アプリケーションのエンタープライズアプリケーションプロパティで、「割り当てが必要ですか?」を「はい」に設定し、アクセスが必要なユーザーまたはグループのみを割り当てます。デフォルトの「いいえ」では、テナント内のすべてのユーザーがサインインできます。
- Okta:アクセスが必要なグループにのみアプリケーションを割り当てます。
- Auth0:アプリケーションが使用する各接続でサインアップを無効にし、ユーザーがアクセスを必要とする接続のみをアプリケーションに対して有効にします。そうしないと、有効な接続(例:ソーシャル接続)を通じてサインアップした人は誰でもサインインできます。
OpenID Connectフェデレーションの追加
Section titled “OpenID Connectフェデレーションの追加”ts#website#authジェネレーターを--federation=oidcで実行します。まだ認証がないウェブサイトでも、既に認証があるウェブサイトでも実行できます。どちらも同じ結果になります。
このジェネレーターを実行@aws/nx-plugin:ts#website#auth
pnpm nx g @aws/nx-plugin:ts#website#auth --federation=oidc yarn nx g @aws/nx-plugin:ts#website#auth --federation=oidc npx nx g @aws/nx-plugin:ts#website#auth --federation=oidc bunx nx g @aws/nx-plugin:ts#website#auth --federation=oidc- インストール Nx Console VSCode Plugin まだインストールしていない場合
- VSCodeでNxコンソールを開く
- クリック
Generate (UI)"Common Nx Commands"セクションで - 検索
@aws/nx-plugin - ts#website#auth - 必須パラメータを入力
- federation: oidc
- クリック
Generate
コマンドを組み立てる6
必須
ジェネレーターはアイデンティティプロバイダーを追加しません。リストは空で開始されるため、エントリを追加するまでサインインは以前と同じように機能します。アイデンティティプロバイダーはインフラストラクチャコードに追加するため、2つ目を追加するのに別のジェネレーター実行は必要ありません。
--federation=oidcでジェネレーターを再度実行してもファイルは変更されません。--federation=noneで実行するか、--federationなしで実行すると、既に存在するフェデレーションが保持されます。
アイデンティティプロバイダーの追加
Section titled “アイデンティティプロバイダーの追加”各アイデンティティプロバイダーに対してエントリを追加し、デプロイします。クライアントシークレットはコードに含まれません。アイデンティティプロバイダーの設定で説明されているように、AWS Secrets Managerに保存してその名前を指定します。
スタックでUserIdentityにアイデンティティプロバイダーを渡します:
import { MyWebsite, UserIdentity } from '@my-scope/common-constructs';
const identity = new UserIdentity(this, 'Identity', { oidcIdentityProviders: [ { name: 'Okta', issuerUrl: 'https://example.okta.com', clientId: '0oa1example', clientSecretName: 'okta-oidc-client-secret', }, { name: 'Entra', issuerUrl: 'https://login.microsoftonline.com/<tenant-id>/v2.0', clientId: '11111111-2222-3333-4444-555555555555', clientSecretName: 'entra-oidc-client-secret', identifiers: ['example.com'], }, ],});new MyWebsite(this, 'MyWebsite');各エントリの型であるOidcIdentityProviderPropsは、共有コンストラクトパッケージからエクスポートされているため、リストを別の場所で構築して型をインポートできます。
ルートモジュールでuser_identityモジュールにアイデンティティプロバイダーを渡し、リダイレクトURI用の出力を追加します:
module "user_identity" { source = "../../common/terraform/src/core/user-identity"
oidc_identity_providers = [ { name = "Okta" issuer_url = "https://example.okta.com" client_id = "0oa1example" client_secret_name = "okta-oidc-client-secret" }, ]}
output "idp_redirect_uri" { value = module.user_identity.idp_redirect_uri}各環境で異なるアイデンティティプロバイダーを使用するには、ルート変数を宣言し、各環境の.tfvarsファイルで設定します。モジュールの変数が型をチェックするため、ルート変数はtype = anyを持ちます:
variable "oidc_identity_providers" { type = any default = []}
# packages/infra/src/env/dev.tfvarsoidc_identity_providers = [ { name = "Okta", issuer_url = "https://example.okta.com", client_id = "0oa1example", client_secret_name = "okta-oidc-client-secret" },]
# packages/infra/src/main.tf, in module "user_identity"oidc_identity_providers = var.oidc_identity_providersリスト内の各アイデンティティプロバイダーには、これらのプロパティがあります。ジェネレーターオプションはウェブサイト認証で説明されています。
| CDK prop | Terraform attribute | Required | Default | Description |
|---|---|---|---|---|
name | name | Yes | サインインボタンに表示されます。Cognitoは小文字でフェデレーテッドユーザー名にプレフィックスを付けます(<name>_<sub>)。3-32文字の英字、数字、ハイフンで、英字で始まります。COGNITOは不可。リスト内で大文字小文字を無視して一意。CDKではトークンではなくリテラル文字列である必要があります。 | |
issuerUrl | issuer_url | Yes | アイデンティティプロバイダーのトークンのissクレームに表示される通りの発行者。https://を使用する必要があります。 | |
clientId | client_id | Yes | アイデンティティプロバイダーに登録されたアプリケーションのクライアントID。 | |
clientSecretName | client_secret_name | Yes | クライアントシークレットをプレーン文字列として保持するSecrets Managerシークレットの名前。ARNではなく名前。 | |
scopes | scopes | No | openid, email, profile | リクエストするOAuthスコープ。openidを含める必要があります。 |
attributeMapping | attribute_mapping | No | email、given_name、family_name、それぞれ同じ名前のクレームに | ユーザープール属性からアイデンティティプロバイダークレームへのマッピング。属性マッピングを参照してください。 |
identifiers | identifiers | No | None | Cognitoがこのアイデンティティプロバイダーにユーザーを送信するために使用できる、メールドメインなどの識別子。 |
ベンドされたコードは、何かがデプロイされる前に各エントリをチェックします:
UserIdentityは、ルールを破るエントリで作成されると例外をスローするため、cdk synthが失敗します。infraプロジェクトのビルドはcdk synthを実行します。メッセージはエントリに名前を付けます。例:UserIdentity: oidcIdentityProviders[1] (Entra): Microsoft Entra ID issuers have no trailing slash. Use https://login.microsoftonline.com/<tenant-id>/v2.0。
トークンである値、例えばAWS Systems Manager Parameter Storeから読み取られた値は、チェックされません。間違った値は、synthではなくdeployで失敗します。nameはトークンであってはなりません。
モジュールのoidc_identity_providers変数には、各ルールに対して1つのvalidationブロックがあります。そのエラーメッセージは、ルールを破るエントリに名前を付けません。
user_identityモジュールブロックにリストをリテラルとして記述すると、terraform validateがチェックします。プロジェクトのvalidateターゲットはterraform validateを実行します。上記の.tfvarsパターンのようにリストがルート変数から来る場合、代わりにterraform planがチェックします。
ルール:
name:3-32文字の英字、数字、ハイフンで、英字で始まります。Cognitoがユーザープール自体でのサインイン用に予約しているため、大文字小文字に関係なくCOGNITOは不可。- Cognitoがフェデレーテッドユーザー名に小文字の名前をプレフィックスとして付けるため、名前は大文字小文字を無視してリスト内で一意です。例えば、
OktaとOKTAの両方をリストに含めることはできません。test-idpとtestidpは、プレフィックスが異なるため可能です。 - 発行者は
https://を使用し、クエリ、フラグメント、ユーザー名、パスワード、空白を含みません。CDKではURLとして解析できる必要もあります。Terraformでは正規表現でチェックされ、CDKが拒否するいくつかの不正な形式のURLを受け入れます。 - Microsoft Entra ID:マルチテナント発行者(
common、organizations、consumers、9188040d-6c67-4c5b-b112-36a304b66dad)は拒否され、発行者はスラッシュで終わってはいけません。 - Auth0:
*.auth0.com上の発行者はスラッシュで終わる必要があります。 - クライアントIDは空ではありません。
- シークレット名は1-512文字の英字、数字、
/ _ + = . @ -です。これらはSecrets Managerの命名規則であるため、ARNは拒否されます。 - スコープには
openidが含まれます。CDKでは、各スコープも空でなく、空白を含まない必要があります。 - 属性マッピングのキーと値は、属性マッピングのルールに従います。
- 最大50個の識別子。各識別子は1-40文字の英字、数字、スペース、
_ + = . @ -です。
ジェネレーターの出力
Section titled “ジェネレーターの出力”--federation=oidcでジェネレーターは、選択したiacプロバイダー用にこれらのファイルと編集を追加します:
Directorypackages/common/constructs/src/core
- oidc-identity-providers.ts
OidcIdentityProvidersコンストラクト、そのプロパティ、検証 - index.ts
oidc-identity-providers.tsをエクスポートするようになりました - user-identity.ts
oidcIdentityProvidersプロパティを持ち、アイデンティティプロバイダーを作成するようになりました
- oidc-identity-providers.ts
Directorypackages/common/terraform/src/core/user-identity
- oidc-identity-providers.tf 検証を含む
oidc_identity_providers変数とidp_redirect_uri出力 - main.tf identityモジュールに変数を渡すようになりました
Directoryidentity
- oidc-identity-providers.tf アイデンティティプロバイダー、各クライアントシークレットを読み取るデータソース、
idp_redirect_uri出力 - identity.tf Webクライアントにアイデンティティプロバイダーをリストするようになりました
- oidc-identity-providers.tf アイデンティティプロバイダー、各クライアントシークレットを読み取るデータソース、
- oidc-identity-providers.tf 検証を含む
編集により、ユーザープールのWebクライアント(ウェブサイトがサインインするCognitoアプリクライアント)がアイデンティティプロバイダーを受け入れるようになります:
import { OidcIdentityProviders, type OidcIdentityProviderProps,} from './oidc-identity-providers.js'; readonly mfaSecondFactor?: MfaSecondFactor;
/** * OpenID Connect identity providers users can sign in through, next to the user pool's own sign-in. * Applies to every website that uses this user pool. * ... */ readonly oidcIdentityProviders?: OidcIdentityProviderProps[];} mfaSecondFactor = { sms: true, otp: true }, oidcIdentityProviders = [], }: UserIdentityProps = {}, this.userPoolDomain = this.createUserPoolDomain(this.userPool); new OidcIdentityProviders(this, 'OidcIdentityProviders', { userPool: this.userPool, userPoolDomain: this.userPoolDomain, providers: oidcIdentityProviders, }); this.userPoolClient = this.createUserPoolClient(this.userPool);UserIdentityは、Webクライアントの前にアイデンティティプロバイダーを作成するため、Webクライアントはそれらをリストし、その後にCOGNITOが続きます。
mfa_second_factor_sms = var.mfa_second_factor_smsoidc_identity_providers = var.oidc_identity_providerssupported_identity_providers = ["COGNITO"]supported_identity_providers = concat(["COGNITO"], [for p in aws_cognito_identity_provider.oidc : p.provider_name])各アイデンティティプロバイダーは、その名前をキーとするfor_eachインスタンスです。例:aws_cognito_identity_provider.oidc["Okta"]。したがって、エントリの名前を変更すると、そのアイデンティティプロバイダーが置き換えられます。
ジェネレーターは、新しいファイルへの編集を上書きしません。user-identity.ts、またはmain.tfやidentity.tfを変更してジェネレーターが認識できなくなった場合、ジェネレーターはそれらのファイルを変更せずに残します。それでも新しいファイルを追加し、手動で追加する行を出力します。
アイデンティティプロバイダーの設定
Section titled “アイデンティティプロバイダーの設定”アイデンティティプロバイダーを追加するデプロイでは、Secrets Managerからクライアントシークレットを読み取ります。シークレットが存在しない場合、デプロイは失敗します。
CloudFormationは、スタックの実行ロール(デフォルトではcdk-hnb659fds-cfn-exec-role-<account>-<region>)でシークレットを読み取ります。そのロールには、シークレットに対するsecretsmanager:GetSecretValueと、シークレットがカスタマー管理のAWS KMSキーで暗号化されている場合はキーに対するkms:Decryptが必要です。
terraform applyを実行するアイデンティティがシークレットを読み取ります。シークレットに対するsecretsmanager:GetSecretValueと、シークレットがカスタマー管理のAWS KMSキーで暗号化されている場合はキーに対するkms:Decryptが必要です。
この順序で次の手順に従ってください。ジェネレーターは、完了時にこれらも出力します。
ts#website#authを--federation=oidcで実行し、一度デプロイします。- ユーザープールのリダイレクトURIを見つけます。プールのすべてのアイデンティティプロバイダーは同じものを使用します。
UserIdentityを含むスタックには、<id>OidcIdentityProvidersIdpRedirectUriで始まるキーを持つ出力があります。ここで<id>はUserIdentityに与えたコンストラクトIDです。例:IdentityOidcIdentityProvidersIdpRedirectUri。デプロイ前に、ts#website#auth用に選択したcognitoDomain、AWSアカウントID、リージョンから計算することもできます:
https://<cognitoDomain>-<account>.auth.<region>.amazoncognito.com/oauth2/idpresponseCognitoドメインにはランダムなサフィックスがあるため、リダイレクトURIはデプロイ後にのみ判明します。user_identityモジュールは、それをidp_redirect_uriとして出力します。それを確認するには、ルートモジュールに出力を追加します(例:packages/infra/src/main.tf):
output "idp_redirect_uri" { value = module.user_identity.idp_redirect_uri }-
そのリダイレクトURIでアイデンティティプロバイダーにアプリケーションを登録し、そのクライアントIDとクライアントシークレットをメモします。アイデンティティプロバイダーには、この
/oauth2/idpresponseURIのみを登録してください。ウェブサイト自体のURLは、アイデンティティプロバイダーではなくCognitoに登録されます。 -
クライアントシークレットをSecrets Managerに保存します。コマンドライン引数としてではなく、ファイルで渡してください。引数はシェル履歴に残り、コマンドの実行中は同じコンピューターの他のユーザーがプロセスリストで確認できます:
Terminal window (umask 077d=$(mktemp -d) || exittrap 'rm -rf "$d"' EXITtrap 'exit 1' HUP INT TERMunset CLIENT_SECRETIFS= read -rs CLIENT_SECRET || exit 1printf '%s' "$CLIENT_SECRET" > "$d/secret" || exit 1unset CLIENT_SECRETaws secretsmanager create-secret --name okta-oidc-client-secret --secret-string "file://$d/secret" --region <region>)コマンドは括弧の間でサブシェルで実行されます。
readはクライアントシークレットを貼り付けてEnterを押すのを待ち、表示しません。2つのunsetコマンドは、以前にCLIENT_SECRETをエクスポートした場合でも、awsコマンドの環境からシークレットを除外します。IFS=と-rは、両端のスペースやバックスラッシュを含め、貼り付けた通りにシークレットを保持します。mktemp -dは、あなただけが開くことができる新しいディレクトリ(モード700)を作成し、printfは末尾に改行なしでシークレットを書き込みます。AWS CLIはfile://の後に指定されたファイルから--secret-stringの値を読み取り、変更せずに渡すため、ファイルの末尾の改行はシークレットの一部になります。サブシェルが終了すると、trapコマンドがディレクトリを削除します。awsコマンドが失敗した場合やCtrl-Cを押した場合も同様です。コマンドはbashとzsh(LinuxとmacOSのデフォルトシェル)で動作します。Windowsについては、Mitigate the risks of using the AWS CLI to store your AWS Secrets Manager secretsを参照してください。--regionをスタックのリージョンに設定します。アイデンティティプロバイダーを追加するデプロイの前に、そのリージョンにシークレットが存在する必要があります。Cognitoはシークレット値全体をクライアントシークレットとして受け取るため、シークレットをJSONではなくプレーン文字列として保存してください。Secrets Managerコンソールでは、Key/valueではなくPlaintextを選択してください。 -
アイデンティティプロバイダーの追加で示されているように、シークレットの名前を
clientSecretName(Terraformではclient_secret_name)としてリストにアイデンティティプロバイダーを追加します。その後、デプロイします。
属性マッピング
Section titled “属性マッピング”生成されたユーザープールには、email、given_name、family_name属性が必要です。Cognitoは、サインインのたびにアイデンティティプロバイダーのクレームからこれらを入力します。アイデンティティプロバイダーがそれらのいずれかを送信しない場合、ユーザーの最初のサインインは失敗します。UserIdentityとTerraform変数は、3つのいずれかを省略した属性マッピングを拒否します。
attributeMapping(Terraformではattribute_mapping)は、ユーザープール属性をクレームにマッピングします。各キーはユーザープール属性で、各値はアイデンティティプロバイダーのクレームの名前で、1-128文字の長さです。指定したマッピングはデフォルトを置き換えます。デフォルトでは、各必須属性を同じ名前のクレームにマッピングします:
attributeMapping: { email: 'email', given_name: 'given_name', family_name: 'family_name' },attribute_mapping = { email = "email", given_name = "given_name", family_name = "family_name" }- キーは、
nameやphone_numberなどの標準属性、phone_number_verified、またはcustom:departmentなどのカスタム属性(custom:の後に最大20文字の英字、数字、アンダースコア)にすることができます。キーは、CDKとTerraformの両方でCognito属性名を使用します。usernameは拒否されます。 - Cognitoは、マッピングされたメールアドレスを未検証として扱います。メールアドレスを自身で検証するアイデンティティプロバイダーからのみ
email_verifiedをマッピングしてください。そうしないと、ユーザーがアイデンティティプロバイダーで他人のアドレスを設定し、プールで検証済みとしてマークされる可能性があります。 - ユーザーのメールアドレスがアイデンティティプロバイダーで変更された場合、Cognitoはユーザーの次回サインイン時に新しいアドレスをユーザープールに書き込みます。
email_verifiedはfalseのままです。 - カスタム属性は、ユーザープールに既に存在し、変更可能である必要があります。
Terraformアイデンティティプロバイダーリソース(identity/oidc-identity-providers.tf内)は、Cognitoがアイデンティティプロバイダーを返すときに追加する2つの値も設定します:attribute_mappingのusername = "sub"とprovider_detailsのattributes_url_add_attributes = "false"。ファイルがこれらを設定するため、最初のデプロイ後の2回目のterraform planでは、アイデンティティプロバイダーへの変更は表示されません。別のアイデンティティプロバイダーで2回目のプランがprovider_detailsの変更を表示する場合は、プランがCognitoが返すことを示す値でそのキーをファイルに追加してください。
アイデンティティプロバイダーに関する注意事項
Section titled “アイデンティティプロバイダーに関する注意事項”以下の設定は、各ベンダーのドキュメントから取得したものです。OktaはCDKとTerraformの両方でAWSでテストされています。Auth0とMicrosoft Entra IDの設定は、各ベンダーが公開しているOpenIDディスカバリードキュメントに対して確認されましたが、実際のサインインではテストされていません。
CDKとTerraformでAWSでテストされています。Oktaで、Authorization Codeグラントとクライアントシークレットを持つOIDC Web Applicationを作成します。サインインリダイレクトURIを、アイデンティティプロバイダーの設定の手順2の/oauth2/idpresponseリダイレクトURIに設定します。サインアウトリダイレクトURIは不要です。発行者はOktaドメインhttps://<your-org>.okta.comで、これがテストされた形式です。https://<your-org>.okta.com/oauth2/defaultなどのカスタム認証サーバーにも発行者がありますが、その形式はテストされていません。デフォルトのスコープopenid email profileは、email、given_name、family_nameを返すため、デフォルトのマッピングが機能します。各ユーザーには、Oktaでメール、名、姓が設定されている必要があります。アクセスが必要なユーザーまたはグループにのみアプリケーションを割り当ててください。
Auth0のディスカバリードキュメントに対して確認されましたが、実際のサインインではテストされていません。Auth0でRegular Web Applicationを作成します。発行者はhttps://<your-tenant>.auth0.com/で、末尾のスラッシュを含みます。
Auth0は、ユーザーの接続が提供する場合にのみgiven_nameとfamily_nameを返します。それらのない接続のユーザーは、他のクレームをマッピングするまでサインインできません。
Microsoft Entra ID
Section titled “Microsoft Entra ID”Microsoftのディスカバリードキュメントに対して確認されましたが、実際のサインインではテストされていません。Entra IDでシングルテナントアプリケーションを登録します。発行者はhttps://login.microsoftonline.com/<tenant-id>/v2.0です。ベンドされたコードは、マルチテナント発行者(common、organizations、consumers)を拒否します。これらは任意のEntra IDテナントからのユーザーを受け入れるためです。また、任意の個人用Microsoftアカウントを受け入れるテナント9188040d-6c67-4c5b-b112-36a304b66dadも拒否します。
発行者は末尾にスラッシュを付けてはいけません:/v2.0/ではなく/v2.0を使用してください。Entra IDトークンのissクレームにはスラッシュがないため、サインインは失敗します。ベンドされたコードは、スラッシュ付きの形式を拒否します。
アプリケーションのIDトークンにオプションのクレームとしてemail、given_name、family_nameを追加します。Entra IDは、追加した場合にのみそれらを送信します。各ユーザーにはMailフィールドが設定されている必要があります。そうしないと、emailクレームが空になり、ユーザープールがemailを必要とするため、ユーザーの最初のサインインは失敗します。Entra IDのemailクレームは検証されていないため、Entra IDからemail_verifiedをマッピングしないでください。
Cognito user pool
Section titled “Cognito user pool”アイデンティティプロバイダーとして別のCognitoユーザープールでテストするには、発行者https://cognito-idp.<region>.amazonaws.com/<user pool id>を使用します。そのアプリクライアントに、クライアントシークレット、認証コードグラント、スコープopenid email profileを付与します。
セキュリティ
Section titled “セキュリティ”- ユーザーを
subクレーム(ユーザープール内のユーザーの一意のID)で識別し、emailでは識別しないでください。フェデレーテッドユーザーは、メールがローカルユーザーと一致する場合でも、独自のsubを持つプール内の新しいユーザーです。プラグインが生成するコードはsubを使用します。 - シングルテナント発行者を使用してください。マルチテナント発行者は、任意の組織からのユーザーのサインインを許可します。
- ウェブサイト認証で説明されているように、本番ステージから
http://localhostコールバックURLを削除してください。フェデレーションはコールバックURLを追加しません。
フェデレーションが行わないこと
Section titled “フェデレーションが行わないこと”-
ユーザープールで必要なMFA(多要素認証)は、フェデレーテッドユーザーには適用されません。Cognitoは認証をアイデンティティプロバイダーに任せるため、アイデンティティプロバイダーでMFAを強制してください。
-
ウェブサイトからサインアウトすると、Cognitoセッションのみが終了します。OIDCアイデンティティプロバイダーでのユーザーのセッションは終了しないため、ボタンを介した次回のサインインはパスワードなしで完了できます。共有コンピューターでは、ユーザーはアイデンティティプロバイダーでもサインアウトする必要があります。
-
ユーザーメニューには、Cognitoユーザー名が表示されます。フェデレーテッドユーザーの場合、それはアイデンティティプロバイダー名、アンダースコア、アイデンティティプロバイダーでのユーザーの
subを小文字にしたものです(例:okta_00u1abcd)。 -
アイデンティティプロバイダーでユーザーを削除または無効化しても、そのユーザーの次回のサインインのみが停止されます。Cognitoは独自のリフレッシュトークンでトークンを更新し、アイデンティティプロバイダーに問い合わせません。また、ウェブサイトはユーザーが気付かないうちにトークンを更新します。したがって、ユーザーはリフレッシュトークンが期限切れになるまで、最後のサインインから最大30日間アクセスを維持できます。ユーザーが新しいトークンを取得できないようにするには、すべてのセッションからサインアウトさせ、ユーザープールで無効化します。ユーザー名は
<identity provider name in lowercase>_<sub>です:Terminal window aws cognito-idp admin-user-global-sign-out --user-pool-id <user pool id> --username okta_<sub>aws cognito-idp admin-disable-user --user-pool-id <user pool id> --username okta_<sub>これはAWSでテストされています。
admin-user-global-sign-outとadmin-disable-userの後、アイデンティティプロバイダーは依然としてユーザーをサインインさせますが、Cognitoはそれらを拒否します。これらのコマンドは、ユーザーが既に持っているアクセスを終了しません。
admin-user-global-sign-outはユーザーのリフレッシュトークンを取り消すため、ウェブサイトはそれらの新しいトークンを取得できず、admin-disable-userは次回のサインインを停止します。Cognitoが既に発行したIDトークンとアクセストークンは、期限が切れるまで有効なままです。デフォルトでは、発行から1時間後です(ID and access token validity)。アイデンティティプールが既にウェブサイトに付与したAWS認証情報も、期限が切れるまで有効なままです。発行から1時間後です(identity pools authentication flow)。期限が切れるまで、ユーザーは引き続きウェブサイトとアイデンティティプールの認証済みロールを使用できます。これらのコマンドを実行しない場合、Webクライアントのリフレッシュトークン有効期間を短くする(CDKでは
refreshTokenValidity、Terraformではrefresh_token_validity)と、削除されたユーザーがアクセスを維持する時間が短縮されます。IDトークンとアクセストークンの有効期間を短くする(CDKではidTokenValidityとaccessTokenValidity、Terraformではid_token_validityとaccess_token_validity)と、コマンドを実行した後に既に発行されたトークンが有効なままである時間が短縮されますが、常にある程度の時間は残ります。どちらもAWSではテストされていません。
クライアントシークレット
Section titled “クライアントシークレット”Cognitoは、アイデンティティプロバイダーの設定にクライアントシークレットを保持します。ユーザープールでcognito-idp:DescribeIdentityProviderを呼び出すことが許可されている人は誰でもそれを読み取ることができます。これは、使用するIaCプロバイダーに関係なく、Cognitoの動作方法です。
コンストラクトは、シークレットを動的参照として{{resolve:secretsmanager:<clientSecretName>:SecretString:::}}でCloudFormationに渡します。合成されたテンプレートには、その参照のみが含まれます。CloudFormationは、アイデンティティプロバイダーを作成または更新するときにシークレットを読み取ります。シークレットをローテーションした場合、Cognitoは後のデプロイでアイデンティティプロバイダーリソースが変更されたときにのみ新しい値を取得します。
CloudFormationは、アイデンティティプロバイダーの設定(ProviderDetails)内で参照を解決するため、フェデレーテッドサインインは保存されたシークレットで機能し、デプロイされたテンプレートには参照のみが保持されます。ローテーション後、他の変更のないデプロイでは、古いシークレットがCognitoに残ります。両方ともAWSで確認されています。
モジュールは、data "aws_secretsmanager_secret_version"データソースでシークレットを読み取るため、terraform planは(sensitive value)として表示します。Terraform stateは、データソース用に1回、アイデンティティプロバイダー用に1回、プレーンテキストでシークレットを保持します。ステートバケット内のステートオブジェクトを読み取ることができる人は誰でもシークレットを読み取ることができます。それに応じてステートバケットへの読み取りアクセスを制限してください。
terraform plan -outなどの保存されたプランファイルも、プレーンテキストでシークレットを保持します。ステートバケットでバージョニングが有効になっている場合、terraform destroy後も古いバージョンのステートにシークレットが保持されます。スタックを削除するときは、それらのバージョンも削除してください。テスト後は、アイデンティティプロバイダーでクライアントシークレットをローテーションしてください。
ローテーションされたシークレットをCognitoに送信するには:
ローテーションに続くデプロイでアイデンティティプロバイダーリソースを変更します。1つの方法は、ローテーションされたシークレットを新しい名前で保存し、clientSecretNameをその名前に設定することです。テンプレート内の参照が変更されるため、CloudFormationはアイデンティティプロバイダーを更新し、新しいシークレットを読み取ります。その後、古いシークレットを削除します。これは、動的参照に関するCloudFormationドキュメントに従っており、AWSではテストされていません。
ローテーション後にterraform planとterraform applyを実行します。データソースはプランのたびにシークレットの現在のバージョンを読み取るため、プランはアイデンティティプロバイダーのインプレース更新を示し、applyは新しいシークレットをCognitoに送信します。hashicorp/awsプロバイダーソースでは、provider_detailsへの変更は、アイデンティティプロバイダーをインプレースで更新し、置き換えません。これはAWSではテストされていません。
その他のアプリクライアント
Section titled “その他のアプリクライアント”アプリクライアントは、アプリケーションがサインインするCognito設定です。ジェネレーターは、ウェブサイトのアプリクライアント(Webクライアント)にのみアイデンティティプロバイダーを追加します。同じユーザープール内の別のアプリクライアントは、アイデンティティプロバイダーもリストしている場合にのみフェデレーテッドユーザーを受け入れます。たとえば、DCRプロキシ用に作成するアプリクライアント(MCPクライアント、Model Context Protocolを使用するAIツールがCognitoを通じてサインインできるようにする)には、それらが必要です。そうしないと、フェデレーテッドユーザーはMCPサーバーにサインインできません。
UserIdentityの後にsupportedIdentityProvidersなしでidentity.userPool.addClient(...)で作成するアプリクライアントは、プールのすべてのアイデンティティプロバイダーとCOGNITOをリストします。DCRプロキシの例はこれを行います。アプリクライアントがsupportedIdentityProvidersを設定する場合は、プールのアイデンティティプロバイダーを追加します:
import { UserPoolClientIdentityProvider } from 'aws-cdk-lib/aws-cognito';
supportedIdentityProviders: [ UserPoolClientIdentityProvider.COGNITO, ...identity.userPool.identityProviders.map((p) => UserPoolClientIdentityProvider.custom(p.providerName), ),],各アイデンティティプロバイダーのnameをアプリクライアントのsupported_identity_providersに追加し、アプリクライアントをmodule.user_identityに依存させて、アイデンティティプロバイダーが最初に存在するようにします。
エージェントチャット用のトークン
Section titled “エージェントチャット用のトークン”Cognito認証を使用するTypeScriptエージェントの<agent>-chatターゲットは、AGENT_ACCESS_TOKEN環境変数からCognitoアクセストークンを読み取ります。フェデレーテッドユーザーにはCognitoパスワードがないため、admin-initiate-authは機能しません。代わりに、ウェブサイトにサインインし、ブラウザーの開発者ツールを開き、セッションストレージのoidc.user:...エントリからaccess_tokenをコピーします。