Ho pensato di condividere la configurazione che ho elaborato per utilizzare AWS SES per le email in uscita, i rimbalzi e le email in ingresso. Il servizio SES presenta sicuramente alcune sfumature e ci è voluto un bel po’ di tentativi ed errori per capire esattamente come funziona. Questo è più un “brain dump” (scarico di pensieri) che una guida passo-passo da seguire alla lettera. Dovrebbe essere superfluo, ma usatelo a vostro rischio e pericolo. E, in ogni caso, leggete sempre e capite qualsiasi codice scritto da altri che decidiate di implementare.
Contesto:
Sto lavorando per distribuire Discourse su AWS e sfruttare tutti i loro servizi possibili per garantire affidabilità e ridondanza. In quanto sviluppatore, mi sento più a mio agio con la riga di comando e il codice, e volevo utilizzare l’automazione IaC. Tutta la mia infrastruttura viene distribuita con Terraform, ma ho provato a navigare nella console web e ad allineare le cose il meglio possibile. IAM e i documenti di policy sono fuori dallo scope di questo articolo, ma credo di aver indicato dove sono necessari.
Eseguire un’istanza Postfix sembra eccessivo per una singola applicazione. Usare una casella di posta POP3 è così anni '90. Così mi sono tuffato nel coniglio di AWS.
Ho trovato alcuni post estremamente utili che mi hanno aiutato nella mia ricerca:
- AWS SES / AWS Lambda mail receiver endpoint code?
- How to use Amazon SES for sending emails to users?
- Configure VERP to handle bouncing e-mails
Il contenitore mail-receiver mi ha anche aiutato a capire come Discourse elabori i messaggi:
- Configure direct-delivery incoming email for self-hosted sites with Mail-Receiver
- Update mail-receiver to the release version
Inizialmente mi aspettavo che l’endpoint webhook di AWS gestisse i messaggi in ingresso, ma dopo aver esaminato il codice ho realizzato che non lo avrebbe fatto. Ho basato il mio codice del ricevitore Lambda sull’eccellente esempio di @dltj. Ho optato per utilizzare SNS per la consegna dei messaggi invece di S3.
Prerequisiti
- Account AWS
- Conoscenza operativa di DNS e dei tipi di record relativi alla posta elettronica
- Un dominio (o sottodominio) in cui è possibile apportare modifiche
Note
- Tutto ciò che è documentato deve essere creato nella stessa regione AWS
- Il testo in **grassetto e corsivo come questo rappresenta i valori specifici della vostra implementazione
- Il testo in corsivo rappresenta i nomi di variabili, valori fissi o elementi dell’interfaccia utente
Passaggi
-
Creare un’identità di dominio Simple Email Service (SES), your.domain, in una delle regioni AWS che supportano la ricezione di email
-
Verificare l’identità del dominio
-
Creare un argomento Simple Notification Service (SNS), feedback-sns-topic, per le notifiche di feedback
a. Aggiungere l’ARN dell’argomento feedback-sns-topic alla vostra impostazioneaws_sns_topic_arn_allowlist. -
Configurare l’identità del dominio your.domain
a. Abilitare l’inoltro del feedback delle email
b. Configurare le notifiche di feedback per rimbalzi e reclami (non consegne) per utilizzare l’argomento SNS feedback-sns-topic -
Creare un’abbonamento sull’argomento SNS feedback-sns-topic
a. Il protocollo è HTTPS (non state ancora usando HTTP, vero?)
b. Impostare l’endpoint su https://your.domain/webhooks/aws (vedi post VERP)
c. Assicurarsi che la consegna del messaggio grezzo sia disabilitata -
Creare un altro argomento SNS, incoming-sns-topic, per le email in ingresso
-
Creare un set di regole di ricezione email SES, inbound-mail-set, se non ne esiste già uno attivo. Se ne esiste uno, usatelo, poiché può esserci solo un set di regole attivo alla volta
-
Creare una regola di ricezione nel set di regole di ricezione inbound-mail-set
a. Impostare la condizione del destinatario su your.domain
b. Aggiungere un’azione per pubblicare sull’argomento SNS incoming-sns-topic, con codifica Base64 -
Creare una chiave API nella vostra istanza Discourse per l’utente system, concedendo l’azione receive email sulla risorsa email
-
Creare un segreto in Secret Manager, email-handler-secret, con le seguenti chiavi e i rispettivi valori:
- api_endpoint - https://your.domain/admin/email/handle_mail
- api_key - dal passaggio 9
- api_username - system, a meno che non si sia usato qualcosa di diverso nel passaggio 9
-
Creare un layer Lambda, lambda-receiver-layer, per il runtime python3.10 contenente le librerie requests e aws-lambda-powertools
-
Creare una funzione Lambda, email-receiver-lambda, per il runtime python3.10 con il codice del ricevitore:
# Copyright (c) 2023 Derek J. Lambert
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
import json
import os
from typing import TypedDict
import requests
from aws_lambda_powertools import Logger
from aws_lambda_powertools.utilities import parameters
from aws_lambda_powertools.utilities.data_classes import event_source
from aws_lambda_powertools.utilities.data_classes.sns_event import SNSEvent, SNSEventRecord
from aws_lambda_powertools.utilities.typing import LambdaContext
class Secret(TypedDict):
api_endpoint: str
api_username: str
api_key: str
service = os.getenv('AWS_LAMBDA_FUNCTION_NAME')
logger = Logger(log_uncaught_exceptions=True, service=service)
try:
SECRET_NAME = os.environ['SECRET_NAME']
except KeyError as e:
raise RuntimeError(f'Missing {e} environment variable')
AWS_EXTENSION_PORT = os.getenv('PARAMETERS_SECRETS_EXTENSION_HTTP_PORT', 2773)
EXTENSION_ENDPOINT = f'http://localhost:{AWS_EXTENSION_PORT}/secretsmanager/get?secretId={SECRET_NAME}'
def get_secret() -> Secret:
return parameters.get_secret(SECRET_NAME, transform='json')
def handle_record(record: SNSEventRecord):
sns = record.sns
sns_message = json.loads(sns.message)
try:
message_type = sns_message['notificationType']
message_mail = sns_message['mail']
message_content = sns_message['content']
message_receipt = sns_message['receipt']
except KeyError as exc:
raise RuntimeError(f'Key {exc} missing from message')
try:
receipt_action = message_receipt['action']
except KeyError as exc:
raise RuntimeError(f'Key {exc} missing from receipt')
try:
action_encoding = receipt_action['encoding']
except KeyError as exc:
raise RuntimeError(f'Key {exc} missing from action')
try:
mail_source = message_mail['source']
mail_destination = ','.join(message_mail['destination'])
except KeyError as exc:
raise RuntimeError(f'Key {exc} missing from mail')
logger.info(f'Processing SNS {message_type} {sns.get_type} record with MessageId {sns.message_id} from {mail_source} to {mail_destination}')
# 'email' is deprecated, but just in case something is configured incorrectly
body_key = 'email_encoded' if action_encoding == 'BASE64' else 'email'
request_body = {
body_key: message_content
}
secret = get_secret()
headers = {
'Api-Username': secret['api_username'],
'Api-Key': secret['api_key'],
}
response = requests.post(url=secret['api_endpoint'], headers=headers, json=request_body)
logger.info(response.text)
response.raise_for_status()
@event_source(data_class=SNSEvent)
@logger.inject_lambda_context
def lambda_handler(event: SNSEvent, context: LambdaContext):
for record in event.records:
handle_record(record)
-
Configurare la funzione Lambda email-receiver-lambda:
a. Aggiungere il layer lambda-receiver-layer
b. Aggiungere il layer specifico per la regione per AWS Parameter Store
c. Aggiungere la variabile d’ambiente SECRET_NAME con il valore email-handler-secret
d. Se si desidera che vengano registrate informazioni aggiuntive, aggiungere la variabile d’ambiente POWERTOOLS_LOGGER_LOG_EVENT con il valore true -
Concedere alla funzione Lambda email-receiver-lambda il permesso IAM secretsmanager:GetSecretValue per il segreto email-handler-secret
-
Creare un abbonamento sull’argomento SNS incoming-sns-topic
a. Il protocollo è AWS Lambda
b. Impostare l’endpoint sull’ARN di email-receiver-lambda -
Saranno necessari permessi IAM per l’abbonamento SNS sull’argomento incoming-sns-topic per invocare email-receiver-lambda, ma credo che ciò venga fatto automaticamente quando configurato tramite la console
A scopo di debug, o per semplice auto-irritazione, è possibile aggiungere un abbonamento email a uno dei due argomenti SNS per monitorare le notifiche.
Ho scritto tutto questo in un paio di sedute, ma credo che sia tutto completo. Posso provare a rispondere a domande generali quando il tempo me lo consente.
