This is an API that securely downloads a private file from S3. It is written in Python & Flask. and it is deployed in a Lambda function with Zappa.
This is an API based on a seed project from Auth0. For details, you can find more documentation here to better understand this API.
First, be sure to set up a virtual environment:
virtualenv venv
source venv/bin/activateIn order to run the example you need to have python and pip installed.
You also need to set up a series of environment variables, including your Auth0 Domain and the CLIENT_ID (as audience id) as environment variables with the following names respectively: AUTH0_DOMAIN and CLIENT_ID, as well as AWS credentials and additional bucket settings.
Option A) Rename .env.example file to .env and fill in the blanks.
# .env.example
AUTH0_DOMAIN="atd-datatech.auth0.com"
CLIENT_ID="2qbqz2sf8L9idBOwn0d5YA9efNgQbL7c"
...Option B) Export directly in bash:
export AUTH0_DOMAIN=atd-datatech.auth0.com
export CLIENT_ID=2qbqz2sf8L9idBOwn0d5YA9efNgQbL7c
...Once you've set those 2 environment variables:
- Install the needed dependencies with
pip install -r requirements.txt - Start the server with
python server.py - Try calling http://localhost:3010/download/<crash_id>
You can then try to do a GET to http://localhost:3010/download which will throw an error if you don't send an access token signed with RS256 with the appropriate issuer and audience in the Authorization header.
The script uses the Zappa framework to deploy to AWS, please refer to the zappa documentation for specific details.
There is already a zappa_settings.json file that determines the configuration of the deployment and the necessary environment variables.
To deploy and or update:
# First make sure you have sourced your environment:
$ source venv/bin/activate
# Then, to deploy for the first time:
$ zappa deploy staging
$ zappa deploy production
# Or to update:
$ zappa update staging
$ zappa update productionYou will be provided with a lambda endpoint if successful.