fholler0371 / aws-sns-message-validator

Validate AWS SNS messages in Python.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

AWS SNS Message Validator

Motivation

An HTTP endpoint for AWS SNS needs to validate the received messages before processing them which involves some non-trivial logic, especially signature verification. In terms of implementation, AWS does not offer any help with SNS message validation in their SDK for Python (issue) nor does it provide example code in the documentation (example code is only available in Java). Therefore Python developers would need to invent their own wheels.

To solve this problem, this repository offers an SNS message validator which is implemented according to the guide on the official AWS documentation, and offers example code of how to use it to implement an HTTP endpoint for SNS.

Prerequisite

  • Python >= 3.7

Install

pip install git+https://github.com/wlwg/sns-message-validator.git

Usage

Refer to the example code flask_example.py to see how to use this package in your SNS http endpoint. In order to quickly try out the example code, follow the steps below:

  • Make sure you have Python>=3.7 installed. (Create a virtual environment if you want to.)
  • Checkout this repo and install dev dependencies by python3 -m pip install -r requirements.txt
  • Run FLASK_APP=flask_example.py flask run --port=5000 to start an http server.
  • Use ngrok to expose the local server to the public internet (./ngrok http -bind-tls=true localhost:5000). Now you should get a public endpoint (https://xxxxxxxx.ngrok.io) that can be set as a subscriber of an SNS topic.

Issues

Feel free to create an issue if you found a bug or have a feature request.

About

Validate AWS SNS messages in Python.

License:MIT License


Languages

Language:Python 100.0%