Pemicu Lambda SMS pengirim kustom - Amazon Cognito

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Pemicu Lambda SMS pengirim kustom

Saat Anda menetapkan pemicu SMS pengirim khusus ke kumpulan pengguna, Amazon Cognito akan memanggil fungsi Lambda, bukan perilaku defaultnya saat peristiwa pengguna mengharuskannya mengirim pesan. SMS Dengan pemicu pengirim khusus, AWS Lambda fungsi Anda dapat mengirim SMS pemberitahuan ke pengguna Anda melalui metode dan penyedia yang Anda pilih. Kode kustom fungsi Anda harus memproses dan mengirimkan semua SMS pesan dari kumpulan pengguna Anda.

Pemicu ini menyajikan skenario di mana Anda mungkin ingin memiliki kontrol yang lebih besar atas cara kumpulan pengguna Anda mengirim SMS pesan. Fungsi Lambda Anda dapat menyesuaikan panggilan ke SNS API operasi Amazon, misalnya saat Anda ingin mengelola beberapa originasi IDs atau silang. Wilayah AWS Fungsi Anda juga dapat mengarahkan pesan ke media pengiriman lain atau layanan pihak ketiga.

catatan

Saat ini, Anda tidak dapat menetapkan pemicu pengirim khusus di konsol Amazon Cognito. Anda dapat menetapkan pemicu dengan LambdaConfig parameter dalam UpdateUserPool API permintaan CreateUserPool atau.

Untuk mengatur pemicu ini, lakukan langkah-langkah berikut:

  1. Buat kunci enkripsi simetris di AWS Key Management Service (AWS KMS). Amazon Cognito menghasilkan rahasia — kata sandi sementara, kode verifikasi, dan kode konfirmasi — kemudian menggunakan kunci ini untuk mengenkripsi rahasia. KMS Anda kemudian dapat menggunakan API operasi Dekripsi di fungsi Lambda Anda untuk mendekripsi rahasia dan mengirimkannya ke pengguna dalam plaintext. AWS Encryption SDKIni adalah alat yang berguna untuk AWS KMS operasi dalam fungsi Anda.

  2. Buat fungsi Lambda yang ingin Anda tetapkan sebagai pemicu pengirim kustom Anda. Berikan kms:Decrypt izin untuk KMS kunci Anda ke peran fungsi Lambda.

  3. Berikan cognito-idp.amazonaws.com akses utama layanan Amazon Cognito untuk menjalankan fungsi Lambda.

  4. Tulis kode fungsi Lambda yang mengarahkan pesan Anda ke metode pengiriman khusus atau penyedia pihak ketiga. Untuk mengirimkan verifikasi atau kode konfirmasi pengguna Anda, Base64 mendekode dan mendekripsi nilai code parameter dalam permintaan. Operasi ini menghasilkan kode teks biasa atau kata sandi yang harus Anda sertakan dalam pesan Anda.

  5. Perbarui kumpulan pengguna sehingga menggunakan pemicu Lambda pengirim khusus. IAMPrinsipal yang memperbarui atau membuat kumpulan pengguna dengan pemicu pengirim khusus harus memiliki izin untuk membuat hibah untuk KMS kunci Anda. LambdaConfigCuplikan berikut menetapkan fungsi kustom SMS dan pengirim email.

    "LambdaConfig": { "KMSKeyID": "arn:aws:kms:us-east-1:123456789012:key/a6c4f8e2-0c45-47db-925f-87854bc9e357", "CustomEmailSender": { "LambdaArn": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", "LambdaVersion": "V1_0" }, "CustomSMSSender": { "LambdaArn": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", "LambdaVersion": "V1_0" }

Parameter pemicu Lambda SMS pengirim kustom

Permintaan yang diteruskan Amazon Cognito ke fungsi Lambda ini adalah kombinasi dari parameter di bawah ini dan parameter umum yang ditambahkan Amazon Cognito ke semua permintaan.

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

Parameter permintaan SMS pengirim kustom

jenis

Versi permintaan. Untuk acara SMS pengirim kustom, nilai string ini selalucustomSMSSenderRequestV1.

code

Kode terenkripsi yang fungsi Anda dapat mendekripsi dan mengirim ke pengguna Anda.

clientMetadata

Satu atau lebih pasangan nilai kunci yang dapat Anda berikan sebagai input khusus ke pemicu fungsi Lambda SMS pengirim kustom. Untuk meneruskan data ini ke fungsi Lambda Anda, Anda dapat menggunakan ClientMetadata parameter dalam AdminRespondToAuthChallengedan RespondToAuthChallengeAPItindakan. Amazon Cognito tidak menyertakan data dari ClientMetadata parameter AdminInitiateAuthdan InitiateAuthAPIoperasi dalam permintaan yang diteruskan ke fungsi otentikasi pos.

userAttributes

Satu atau lebih pasangan kunci-nilai yang mewakili atribut pengguna.

Parameter respons SMS pengirim kustom

Amazon Cognito tidak mengharapkan informasi pengembalian tambahan dalam tanggapan. Fungsi Anda dapat menggunakan API operasi untuk menanyakan dan memodifikasi sumber daya Anda, atau merekam metadata peristiwa ke sistem eksternal.

Mengaktifkan pemicu SMS Lambda pengirim khusus

Anda dapat mengatur pemicu SMS pengirim kustom yang menggunakan logika kustom untuk mengirim SMS pesan ke kumpulan pengguna Anda. Prosedur berikut menetapkan pemicu kustom, SMS pemicu email kustom, atau keduanya ke kumpulan pengguna Anda. Setelah menambahkan pemicu SMS pengirim kustom, Amazon Cognito selalu mengirimkan atribut pengguna, termasuk nomor telepon, dan kode satu kali ke fungsi Lambda, bukan perilaku default yang mengirim SMS pesan dengan Amazon Simple Notification Service.

penting

Amazon Cognito HTML -escapes karakter yang dicadangkan seperti < (&lt;) dan > (&gt;) di kata sandi sementara pengguna Anda. Karakter ini mungkin muncul dalam kata sandi sementara yang dikirimkan Amazon Cognito ke fungsi pengirim email khusus Anda, tetapi tidak muncul dalam kode verifikasi sementara. Untuk mengirim kata sandi sementara, fungsi Lambda Anda harus melepaskan karakter ini setelah mendekripsi kata sandi, dan sebelum mengirim pesan ke pengguna Anda.

  1. Buat sebuah kunci enkripsi di AWS KMS. Kunci ini mengenkripsi kata sandi sementara dan kode otorisasi yang dihasilkan Amazon Cognito. Anda kemudian dapat mendekripsi rahasia ini dalam fungsi Lambda pengirim khusus dan mengirimkannya ke pengguna Anda dalam teks biasa.

  2. Berikan cognito-idp.amazonaws.com akses utama layanan Amazon Cognito untuk mengenkripsi kode dengan kunci. KMS

    Terapkan kebijakan berbasis sumber daya berikut ke kunci Anda. KMS

    { "Version": "2012-10-17", "Statement": [{ "Effect": "Allow", "Principal": { "Service": "cognito-idp.amazonaws.com" }, "Action": "kms:CreateGrant", "Resource": "arn:aws:kms:us-west-2:111222333444:key/1example-2222-3333-4444-999example", "Condition": { "StringEquals": { "aws:SourceAccount": "111222333444" }, "ArnLike": { "aws:SourceArn": "arn:aws:cognito-idp:us-west-2:111222333444:userpool/us-east-1_EXAMPLE" } } }] }
  3. Buat fungsi Lambda untuk pemicu pengirim kustom. Amazon Cognito menggunakan AWS enkripsi SDK untuk mengenkripsi rahasia, kata sandi sementara, dan kode yang mengotorisasi permintaan pengguna Anda. API

    1. Tetapkan IAM peran ke fungsi Lambda Anda yang memiliki, setidaknyakms:Decrypt, izin untuk kunci Anda. KMS

  4. Berikan cognito-idp.amazonaws.com akses utama layanan Amazon Cognito untuk menjalankan fungsi Lambda.

    AWS CLI Perintah berikut memberikan izin Amazon Cognito untuk menjalankan fungsi Lambda Anda:

    aws lambda add-permission --function-name lambda_arn --statement-id "CognitoLambdaInvokeAccess" --action lambda:InvokeFunction --principal cognito-idp.amazonaws.com
  5. Tulis kode fungsi Lambda Anda untuk mengirim pesan Anda. Amazon Cognito menggunakan AWS Encryption SDK untuk mengenkripsi rahasia sebelum Amazon Cognito mengirimkan rahasia ke fungsi Lambda pengirim khusus. Dalam fungsi Anda, dekripsi rahasia dan proses metadata yang relevan. Kemudian kirim kode, pesan kustom Anda sendiri, dan nomor telepon tujuan ke kustom API yang mengirimkan pesan Anda.

  6. Tambahkan AWS Encryption SDK ke fungsi Lambda Anda. Untuk informasi selengkapnya, lihat Bahasa SDK pemrograman AWS enkripsi. Untuk memperbarui paket Lambda, selesaikan langkah-langkah berikut.

    1. Ekspor fungsi Lambda Anda sebagai file.zip di file. AWS Management Console

    2. Buka fungsi Anda dan tambahkan AWS Encryption SDK. Untuk informasi selengkapnya dan tautan unduhan, lihat bahasa AWS Encryption SDK pemrograman di Panduan AWS Encryption SDK Pengembang.

    3. Zip fungsi Anda dengan SDK dependensi Anda, dan unggah fungsi ke Lambda. Untuk informasi selengkapnya, lihat Menerapkan fungsi Lambda sebagai arsip file.zip di AWS Lambda Panduan Pengembang.

  7. Perbarui kumpulan pengguna Anda untuk menambahkan pemicu Lambda pengirim kustom. Sertakan CustomEmailSender parameter CustomSMSSender atau dalam UpdateUserPool API permintaan. UpdateUserPoolAPIOperasi ini membutuhkan semua parameter kumpulan pengguna Anda dan parameter yang ingin Anda ubah. Jika Anda tidak memberikan semua parameter yang relevan, Amazon Cognito menetapkan nilai parameter yang hilang ke defaultnya. Seperti yang ditunjukkan dalam contoh berikut, sertakan entri untuk semua fungsi Lambda yang ingin Anda tambahkan atau simpan di kumpulan pengguna Anda. Untuk informasi selengkapnya, lihat Memperbarui kumpulan pengguna dan konfigurasi klien aplikasi.

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

Untuk menghapus pemicu Lambda pengirim kustom dengan update-user-pool AWS CLI, hilangkan CustomSMSSender parameter CustomEmailSender atau --lambda-config dari, dan sertakan semua pemicu lain yang ingin Anda gunakan dengan kumpulan pengguna Anda.

Untuk menghapus pemicu Lambda pengirim kustom dengan UpdateUserPool API permintaan, hilangkan CustomSMSSender parameter CustomEmailSender atau dari badan permintaan yang berisi konfigurasi kumpulan pengguna lainnya.

Contoh kode

Contoh Node.js berikut memproses peristiwa SMS pesan dalam fungsi Lambda SMS pengirim kustom Anda. Contoh ini mengasumsikan fungsi Anda memiliki dua variabel lingkungan yang ditentukan.

KEY_ALIAS

Alias KMS kunci yang ingin Anda gunakan untuk mengenkripsi dan mendekripsi kode pengguna Anda.

KEY_ARN

Amazon Resource Name (ARN) dari KMS kunci yang ingin Anda gunakan untuk mengenkripsi dan mendekripsi kode pengguna Anda.

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_ARN ]; 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 contains the decrypted secret. if(event.triggerSource == 'CustomSMSSender_SignUp'){ //Send an SMS message to your user via a custom provider. //Include the temporary password in the message. } 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; };

Mengevaluasi kemampuan SMS pesan dengan fungsi SMS pengirim kustom

Fungsi Lambda SMS pengirim kustom menerima SMS pesan yang akan dikirim oleh kumpulan pengguna Anda, dan fungsi tersebut mengirimkan konten berdasarkan logika kustom Anda. Amazon Cognito mengirimkan Parameter pemicu Lambda SMS pengirim kustom ke fungsi Anda. Fungsi Anda dapat melakukan apa yang Anda inginkan dengan informasi ini. Misalnya, Anda dapat mengirim kode ke topik Amazon Simple Notification Service (AmazonSNS). Pelanggan SNS topik Amazon dapat berupa SMS pesan, HTTPS titik akhir, atau alamat email.

Untuk membuat lingkungan pengujian untuk SMS perpesanan Amazon Cognito dengan fungsi Lambda SMS pengirim khusus, amazon-cognito-user-poollihat development-and-testing-with - sms-redirected-to-email - di pustaka aws-samples pada. GitHub Repositori berisi AWS CloudFormation template yang dapat membuat kumpulan pengguna baru, atau bekerja dengan kumpulan pengguna yang sudah Anda miliki. Template ini membuat fungsi Lambda dan topik AmazonSNS. Fungsi Lambda yang ditetapkan template sebagai pemicu SMS pengirim khusus, mengalihkan SMS pesan Anda ke pelanggan ke topik Amazon. SNS

Saat Anda menerapkan solusi ini ke kumpulan pengguna, semua pesan yang biasanya dikirim Amazon Cognito SMS melalui pesan, fungsi Lambda malah mengirim ke alamat email pusat. Gunakan solusi ini untuk menyesuaikan dan melihat pratinjau SMS pesan, dan untuk menguji peristiwa kumpulan pengguna yang menyebabkan Amazon Cognito mengirim SMS pesan. Setelah Anda menyelesaikan pengujian, putar kembali CloudFormation tumpukan, atau hapus tugas fungsi SMS pengirim kustom dari kumpulan pengguna Anda.

penting

Jangan gunakan template di amazon-cognito-user-pool- development-and-testing-with - sms-redirected-to-email untuk membangun lingkungan produksi. Fungsi Lambda SMS pengirim khusus dalam solusi SMS mensimulasikan pesan, tetapi fungsi Lambda mengirimkan semuanya ke satu alamat email pusat. Sebelum Anda dapat mengirim SMS pesan dalam kumpulan pengguna Amazon Cognito produksi, Anda harus melengkapi persyaratan yang ditunjukkan di. SMSpengaturan pesan untuk kumpulan pengguna Amazon Cognito

Sumber pemicu Lambda SMS pengirim khusus

Tabel berikut menunjukkan peristiwa pemicu untuk sumber SMS pemicu kustom dalam kode Lambda Anda.

TriggerSource value Peristiwa
CustomSMSSender_SignUp Seorang pengguna mendaftar dan Amazon Cognito mengirimkan pesan selamat datang.
CustomSMSSender_ForgotPassword Seorang pengguna meminta kode untuk mengatur ulang kata sandi mereka.
CustomSMSSender_ResendCode Pengguna meminta kode baru untuk mengonfirmasi pendaftaran mereka.
CustomSMSSender_VerifyUserAttribute Pengguna membuat atribut alamat email atau nomor telepon baru dan Amazon Cognito mengirimkan kode untuk memverifikasi atribut.
CustomSMSSender_UpdateUserAttribute Pengguna memperbarui alamat email atau atribut nomor telepon dan Amazon Cognito mengirimkan kode untuk memverifikasi atribut.
CustomSMSSender_Authentication Pengguna yang dikonfigurasi dengan autentikasi SMS multi-faktor (MFA) masuk.
CustomSMSSender_AdminCreateUser Anda membuat pengguna baru di kumpulan pengguna Anda dan Amazon Cognito mengirimi mereka kata sandi sementara.