Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/approov/quickstart-python-flask-token-check
An Appoov token integration example for Python 3 with Flask. Article: https://blog.approov.io/approov-integration-in-a-python-flask-api
https://github.com/approov/quickstart-python-flask-token-check
api api-python api-rest api-server apis approov approov-demo approov-token flask-api jwt jwt-api jwt-authentication jwt-token python python-flask token
Last synced: 3 days ago
JSON representation
An Appoov token integration example for Python 3 with Flask. Article: https://blog.approov.io/approov-integration-in-a-python-flask-api
- Host: GitHub
- URL: https://github.com/approov/quickstart-python-flask-token-check
- Owner: approov
- Created: 2019-01-21T12:08:39.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-07-26T11:04:33.000Z (4 months ago)
- Last Synced: 2024-07-26T12:34:51.927Z (4 months ago)
- Topics: api, api-python, api-rest, api-server, apis, approov, approov-demo, approov-token, flask-api, jwt, jwt-api, jwt-authentication, jwt-token, python, python-flask, token
- Language: Python
- Homepage: https://approov.io
- Size: 4.55 MB
- Stars: 1
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Approov QuickStart - Python Flask Token Check
[Approov](https://approov.io) is an API security solution used to verify that requests received by your backend services originate from trusted versions of your mobile apps.
This repo implements the Approov server-side request verification code with the Python Flask framework in a simple Hello API server, which performs the verification check before allowing valid traffic to be processed by the API endpoint.
Originally this repo was just to show the Approov token integration example on a Python 3 Flask API as described in the article: [Approov Integration in a Python Flask API](https://approov.io/blog//approov-integration-in-a-python-flask-api), that you can still find at [/servers/shapes-api](/servers/shapes-api).
## Approov Integration Quickstart
The quickstart was tested with the following Operating Systems:
* Ubuntu 20.04
* MacOS Big Sur
* Windows 10 WSL2 - Ubuntu 20.04
First, setup the [Approov CLI](https://approov.io/docs/latest/approov-installation/index.html#initializing-the-approov-cli).
Now, register the API domain for which Approov will issues tokens:
```bash
approov api -add api.example.com
```
> **NOTE:** By default a symmetric key (HS256) is used to sign the Approov token on a valid attestation of the mobile app for each API domain it's added with the Approov CLI, so that all APIs will share the same secret and the backend needs to take care to keep this secret secure.
>
> A more secure alternative is to use asymmetric keys (RS256 or others) that allows for a different keyset to be used on each API domain and for the Approov token to be verified with a public key that can only verify, but not sign, Approov tokens.
>
> To implement the asymmetric key you need to change from using the symmetric HS256 algorithm to an asymmetric algorithm, for example RS256, that requires you to first [add a new key](https://approov.io/docs/latest/approov-usage-documentation/#adding-a-new-key), and then specify it when [adding each API domain](https://approov.io/docs/latest/approov-usage-documentation/#keyset-key-api-addition). Please visit [Managing Key Sets](https://approov.io/docs/latest/approov-usage-documentation/#managing-key-sets) on the Approov documentation for more details.
Next, enable your Approov `admin` role with:
```bash
eval `approov role admin`
````
For the Windows powershell:
```bash
set APPROOV_ROLE=admin:___YOUR_APPROOV_ACCOUNT_NAME_HERE___
```
Now, get your Approov Secret with the [Approov CLI](https://approov.io/docs/latest/approov-installation/index.html#initializing-the-approov-cli):
```bash
approov secret -get base64
```
Next, add the [Approov secret](https://approov.io/docs/latest/approov-usage-documentation/#account-secret-key-export) to your project `.env` file:
```env
APPROOV_BASE64_SECRET=approov_base64_secret_here
```
Now, add to your `requirements.txt` file the [JWT dependency](https://github.com/jpadilla/pyjwt/):
```bash
PyJWT==1.7.1 # update the version to the latest one
```
Next, you need to install the dependencies:
```bash
pip3 install -r requirements.txt
```
Now, add this code to your project, just before your first API endpoint:
```python
from flask import Flask, jsonify, request, abort, g, make_response
# @link https://github.com/jpadilla/pyjwt/
import jwt
import base64
import hashlib
# @link https://github.com/theskumar/python-dotenv
from dotenv import load_dotenv, find_dotenv
load_dotenv(find_dotenv(), override=True)
from os import getenv
api = Flask(__name__)
# Token secret value obtained with the Approov CLI tool:
# - approov secret -get
approov_base64_secret = getenv('APPROOV_BASE64_SECRET')
if approov_base64_secret == None:
raise ValueError("Missing the value for environment variable: APPROOV_BASE64_SECRET")
APPROOV_SECRET = base64.b64decode(approov_base64_secret)
@api.before_request
def _verifyApproovToken():
approov_token = request.headers.get("Approov-Token")
# If we didn't find a token, then reject the request.
if approov_token is None or approov_token == "":
# You may want to add some logging here.
return abort(make_response({}, 401))
try:
# Decode the Approov token explicitly with the HS256 algorithm to
# avoid the algorithm None attack.
g.approov_token_claims = jwt.decode(approov_token, APPROOV_SECRET, algorithms=['HS256'])
# When doesn't occur an exception we have a valid Aproov Token
except jwt.ExpiredSignatureError as e:
# You may want to add some logging here.
return abort(make_response({}, 401))
except jwt.InvalidTokenError as e:
# You may want to add some logging here.
return abort(make_response({}, 401))
except:
return abort(make_response({}, 401))
#@api.route("/")
#def hello():
# return jsonify({"message": "Hello World"})
```
> **NOTE:** When the Approov token validation fails we return a `401` with an empty body, because we don't want to give clues to an attacker about the reason the request failed, and you can go even further by returning a `400`.
Using the `before_request` decorator approach will ensure that all endpoints in your API will be protected by Approov.
Not enough details in the bare bones quickstart? No worries, check the [detailed quickstarts](QUICKSTARTS.md) that contain a more comprehensive set of instructions, including how to test the Approov integration.
## More Information
* [Approov Overview](OVERVIEW.md)
* [Detailed Quickstarts](QUICKSTARTS.md)
* [Examples](EXAMPLES.md)
* [Testing](TESTING.md)
### System Clock
In order to correctly check for the expiration times of the Approov tokens is very important that the backend server is synchronizing automatically the system clock over the network with an authoritative time source. In Linux this is usually done with a NTP server.
## Issues
If you find any issue while following our instructions then just report it [here](https://github.com/approov/quickstart-python-flask-token-check/issues), with the steps to reproduce it, and we will sort it out and/or guide you to the correct path.
## Useful Links
If you wish to explore the Approov solution in more depth, then why not try one of the following links as a jumping off point:
* [Approov Free Trial](https://approov.io/signup)(no credit card needed)
* [Approov Get Started](https://approov.io/product/demo)
* [Approov QuickStarts](https://approov.io/docs/latest/approov-integration-examples/)
* [Approov Docs](https://approov.io/docs)
* [Approov Blog](https://approov.io/blog/)
* [Approov Resources](https://approov.io/resource/)
* [Approov Customer Stories](https://approov.io/customer)
* [Approov Support](https://approov.io/contact)
* [About Us](https://approov.io/company)
* [Contact Us](https://approov.io/contact)