사용자 지정 SMS 발신자 Lambda 트리거 - Amazon Cognito

사용자 지정 SMS 발신자 Lambda 트리거

Amazon Cognito는 서드 파티 공급자가 사용자에게 SMS 알림을 보낼 수 있도록 AWS Lambda 함수 코드에서 사용자 지정 SMS 발신자 트리거를 호출합니다. Amazon Cognito는 SMS 메시지 이벤트를 Lambda 함수에 요청으로 보냅니다. 그러면 함수의 사용자 지정 코드가 메시지를 처리하고 전달해야 합니다.

참고

현재 Amazon Cognito 콘솔에서 사용자 지정 SMS 발신자 트리거를 할당할 수 없습니다. CreateUserPool 또는 UpdateUserPool API 요청에서 LambdaConfig 파라미터를 사용하여 트리거를 할당할 수 있습니다.

이 트리거를 설정하려면 다음 단계를 수행합니다.

  1. 사용자 지정 SMS 발신자 트리거로 할당할 Lambda 함수를 생성합니다.

  2. AWS Key Management Service(AWS KMS)에서 암호화 키를 생성합니다. Amazon Cognito에서 암호(임시 암호 및 권한 부여 코드)를 생성한 다음 이 키를 사용하여 암호화합니다. 그런 다음 Lambda 함수에서 AWS Encryption SDK를 사용하여 코드를 해독하고 사용자에게 일반 텍스트로 보낼 수 있습니다.

  3. Amazon Cognito 서비스 보안 주체 cognito-idp.amazonaws.com에 Lambda 함수를 호출할 수 있는 권한을 부여합니다.

  4. 사용자 지정 전송 방법 또는 서드 파티 공급자에게 SMS 메시지를 전달하는 Lambda 함수 코드를 작성합니다.

  5. 사용자 지정 발신자 Lambda 트리거를 사용하도록 사용자 풀을 업데이트합니다.

중요

사용자 지정 이메일 또는 사용자 지정 SMS 발신자 함수를 구성할 때 새 대칭 AWS KMS key를 생성합니다. Amazon Cognito는 구성된 KMS 키를 사용하여 코드 또는 임시 암호를 암호화합니다. Amazon Cognito는 base64로 인코딩된 암호화 텍스트를 Lambda 함수로 전송합니다. 자세한 내용은 대칭 KMS 키를 참조하세요.

사용자 지정 SMS 발신자 Lambda 트리거 파라미터

이러한 파라미터는 Amazon Cognito가 공통 파라미터의 이벤트 정보와 함께 이 Lambda 함수에 전달하는 파라미터입니다.

JSON
{ "request": { "type": "customSMSSenderRequestV1", "code": "string", "clientMetadata": { "string": "string", . . . }, "userAttributes": { "string": "string", . . . } }

사용자 지정 SMS 발신자 요청 파라미터

type

요청 버전입니다. 사용자 지정 SMS 발신자 이벤트의 경우 이 문자열의 값은 항상 customSMSSenderRequestV1입니다.

code

함수가 해독하여 사용자에게 보낼 수 있는 암호화된 코드입니다.

clientMetadata

사용자 지정 SMS 발신자 Lambda 함수 트리거에 대한 사용자 지정 입력으로 제공할 수 있는 하나 이상의 키-값 페어입니다. 이 데이터를 Lambda 함수에 전달하려면 AdminRespondToAuthChallengeRespondToAuthChallenge API 작업에서 ClientMetadata 파라미터를 사용합니다. Amazon Cognito는 사후 승인 함수에 전달하는 요청에 있는 AdminInitiateAuthInitiateAuth API 작업의 ClientMetadata 파라미터에서 전달된 데이터를 포함하지 않습니다.

userAttributes

사용자 속성을 나타내는 하나 이상의 키-값 페어입니다.

사용자 지정 SMS 발신자 응답 파라미터

Amazon Cognito는 응답에서 추가 반환 정보를 기대하지 않습니다. 함수는 API 작업을 사용하여 리소스를 쿼리 및 수정하거나 이벤트 메타데이터를 외부 시스템에 기록할 수 있습니다.

사용자 지정 SMS 발신자 Lambda 트리거 활성화

사용자 지정 로직을 사용하여 사용자 풀에 대한 SMS 메시지를 보내는 사용자 지정 SMS 발신자 트리거를 설정하려면 다음과 같이 트리거를 활성화합니다.

1단계: Lambda 함수 생성

사용자 지정 SMS 발신자 트리거에 대한 Lambda 함수를 생성합니다. Amazon Cognito는 AWS 암호화 SDK를 사용하여 비밀(임시 암호 또는 인증 코드)을 암호화합니다.

2단계: AWS KMS에서 암호화 키 생성

AWS KMS에서 암호화 키를 생성합니다. 이 키는 Amazon Cognito가 생성하는 임시 암호 및 권한 부여 코드를 암호화합니다. 그런 다음 사용자 지정 발신자 Lambda 함수에서 이러한 보안 암호를 해독하여 사용자에게 일반 텍스트로 보낼 수 있습니다.

3단계: Lambda 함수를 호출할 수 있도록 Amazon Cognito 서비스 주체에 cognito-idp.amazonaws.com 액세스 권한 부여

다음 명령을 사용하여 Lambda 함수에 대한 액세스 권한을 부여합니다.

aws lambda add-permission --function-name lambda_arn --statement-id "CognitoLambdaInvokeAccess" --action lambda:InvokeFunction --principal cognito-idp.amazonaws.com

4단계: 사용자 지정 발신자를 사용하도록 코드 편집

Amazon Cognito는 AWS Encryption SDK를 사용하여 암호(임시 암호 및 권한 부여 코드)를 암호화한 다음 사용자 지정 발신자 Lambda 함수로 보냅니다. 이러한 보안 암호는 원하는 사용자 지정 공급자를 사용하여 사용자에게 보내기 전에 해독합니다. AWS Encryption SDK를 Lambda 함수와 함께 사용하려면 SDK를 함수와 함께 패키징해야 합니다. 자세한 내용은 JavaScript용 AWS 암호화 SDK 설치를 참조하세요. Lambda 패키지를 업데이트하려면 다음 단계를 수행하세요.

  1. 콘솔에서 Lambda 함수 패키지를 내보냅니다.

  2. 패키지의 압축을 풉니다.

  3. 패키지에 AWS Encryption SDK를 추가합니다. 예를 들어 Node.js를 사용하는 경우 node_modules 디렉터리를 추가하고 @aws-crypto/client-node의 라이브러리를 포함합니다.

  4. 패키지를 다시 생성합니다.

  5. 수정된 디렉터리에서 Lambda 함수 코드를 업데이트합니다.

5단계: 사용자 풀을 업데이트하여 사용자 지정 발신자 Lambda 트리거 추가

UpdateUserPool API 작업에서 CustomSMSSender 파라미터로 사용자 풀을 업데이트합니다. UpdateUserPool에는 사용자 풀의 모든 파라미터와 변경할 파라미터가 필요합니다. 관련 파라미터를 모두 제공하지 않으면 Amazon Cognito에서 누락된 파라미터 값을 기본값으로 설정합니다. 자세한 정보는 사용자 풀 구성 업데이트을 참조하십시오.

#Send this parameter in an 'aws cognito-idp update-user-pool' CLI command, along with any existing user pool configurations. --lambda-config "CustomSMSSender={LambdaVersion=V1_0,LambdaArn= lambda-arn },KMSKeyID= key-id"

사용자 지정 SMS 보낸 사람 Lambda 트리거를 AWS CLI에서 제거하려면 --lambda-config에서 CustomSMSSender 파라미터를 생략하고 사용자 풀과 함께 사용할 다른 모든 트리거를 포함합니다. UpdateUserPool API 요청이 포함된 사용자 지정 SMS 보낸 사람 Lambda 트리거를 제거하려면 나머지 사용자 풀 구성이 포함된 요청 본문에서 CustomSMSSender를 제거하면 됩니다. 자세한 정보는 Amazon Cognito API 또는 AWS CLI를 사용하여 사용자 풀 업데이트을 참조하십시오.

코드 예제

다음 Node.js 예에서는 사용자 지정 SMS 발신자 Lambda 함수에서 SMS 메시지 이벤트를 처리하는 방법을 보여줍니다.

const AWS = require('aws-sdk'); const b64 = require('base64-js'); const encryptionSdk = require('@aws-crypto/client-node'); #Configure the encryption SDK client with the KMS key from the environment variables. const { encrypt, decrypt } = encryptionSdk.buildClient(encryptionSdk.CommitmentPolicy.REQUIRE_ENCRYPT_ALLOW_DECRYPT); const generatorKeyId = process.env.KEY_ALIAS; const keyIds = [ process.env.KEY_ID ]; const keyring = new encryptionSdk.KmsKeyringNode({ generatorKeyId, keyIds }) exports.handler = async (event) => { #Decrypt the secret code using encryption SDK. let plainTextCode; if(event.request.code){ const { plaintext, messageHeader } = await decrypt(keyring, b64.toByteArray(event.request.code)); plainTextCode = plaintext } #PlainTextCode now has the decrypted secret. if(event.triggerSource == 'CustomSMSSender_SignUp'){ #Send sms to end-user using custom or 3rd party provider. #Include temporary password in the email. }else if(event.triggerSource == 'CustomSMSSender_ResendCode'){ }else if(event.triggerSource == 'CustomSMSSender_ForgotPassword'){ }else if(event.triggerSource == 'CustomSMSSender_UpdateUserAttribute'){ }else if(event.triggerSource == 'CustomSMSSender_VerifyUserAttribute'){ }else if(event.triggerSource == 'CustomSMSSender_AdminCreateUser'){ }else if(event.triggerSource == 'CustomSMSSender_AccountTakeOverNotification'){ } return; };

사용자 지정 SMS 발신자 함수로 SMS 메시지 기능 평가

사용자 지정 SMS 발신자 Lambda 함수는 사용자 풀이 보낼 SMS 메시지를 수락하고, 함수는 사용자 지정 논리를 기반으로 콘텐츠를 전달합니다. Amazon Cognito는 사용자 지정 SMS 발신자 Lambda 트리거 파라미터를 사용자의 함수에 보냅니다. 함수는 이 정보로 원하는 것을 할 수 있습니다. 예를 들어, 코드를 Amazon SNS Simple Notification Service(Amazon SNS) 주제에 보낼 수 있습니다. Amazon SNS 주제 구독자는 SMS 메시지, HTTPS 엔드포인트 또는 이메일 주소일 수 있습니다.

사용자 지정 SMS 발신자 Lambda 함수를 사용하여 Amazon Cognito SMS 메시징에 대한 테스트 환경을 생성하려면 GitHub의 aws-samples 라이브러리amazon-cognito-user-pool-development-and-testing-with-sms-redirected-to-email을 참조하세요. 리포지토리에는 새 사용자 풀을 생성할 수 있거나 이미 존재하는 사용자 풀 작업을 수행할 수 있는 AWS CloudFormation 템플릿이 포함되어 있습니다. 이러한 템플릿은 Lambda 함수와 Amazon SNS 주제를 생성합니다. 템플릿이 사용자 지정 SMS 발신자 트리거로 할당하는 Lambda 함수는 SMS 메시지를 Amazon SNS 주제의 구독자로 리디렉션합니다.

이 솔루션을 사용자 풀에 배포하면 Amazon Cognito가 일반적으로 SMS 메시징을 통해 보내는 모든 메시지, 즉 Lambda 함수는 대신 중앙 이메일 주소로 보냅니다. 이 솔루션을 사용하여 SMS 메시지를 사용자 지정하고 미리 보고 Amazon Cognito에서 SMS 메시지를 보내도록 하는 사용자 풀 이벤트를 테스트할 수 있습니다. 테스트를 완료한 후 CloudFormation 스택을 롤백하거나 사용자 풀에서 사용자 지정 SMS 발신자 함수 할당을 제거합니다.

중요

amazon-cognito-user-pool-development-and-testing-with-sms-redirected-to-email의 템플릿을 사용하여 프로덕션 환경을 구축하지 않습니다. 솔루션의 사용자 지정 SMS 발신자 Lambda 함수에서 SMS 메시지를 시뮬레이션하지만 Lambda 함수는 이 모든 메시지를 하나의 중앙 이메일 주소로 보냅니다. 프로덕션 Amazon Cognito 사용자 풀에서 SMS 메시지를 보내려면 먼저 Amazon Cognito 사용자 풀의 SMS 메시지 설정에 표시된 요구 사항을 완료해야 합니다.

사용자 지정 SMS 발신자 Lambda 트리거 소스

다음 표에는 Lambda 코드의 사용자 지정 SMS 트리거 소스에 대한 트리거 이벤트가 나와 있습니다.

TriggerSource value 트리거하는 이벤트
CustomSMSSender_SignUp 사용자가 가입하면 Amazon Cognito에서 시작 메시지를 보냅니다.
CustomSMSSender_ForgotPassword 사용자가 암호를 재설정하는 코드를 요청합니다.
CustomSMSSender_ResendCode 사용자가 암호를 재설정하는 대체 코드를 요청합니다.
CustomSMSSender_VerifyUserAttribute 사용자가 새 이메일 주소 또는 전화 번호 속성을 생성하면 Amazon Cognito에서 속성을 확인하는 코드를 보냅니다.
CustomSMSSender_UpdateUserAttribute 사용자가 이메일 주소 또는 전화 번호 속성을 업데이트하면 Amazon Cognito에서 속성을 확인하는 코드를 보냅니다.
CustomSMSSender_Authentication SMS 멀티 팩터 인증(MFA)으로 구성된 사용자가 로그인합니다.
CustomSMSSender_AdminCreateUser 사용자 풀에 새 사용자를 생성하면 Amazon Cognito에서 해당 사용자에게 임시 암호를 보냅니다.