First pass at implementing API authentication using new JWT tokens

- NOTE - this does not manage secrets. There is only one URL and there is no functionality implemented
- prior to rolling out we need to store secrets properly

Uses the JWT libraries in [https://github.com/alphagov/notifications-python-client](https://github.com/alphagov/notifications-python-client)

- Tokens are checked on every request and will be rejected if token is invalid as per the rules in the python clients.
This commit is contained in:
Martyn Inglis
2015-12-15 10:47:20 +00:00
parent 6a3bbbf890
commit dbf70ec1eb
6 changed files with 190 additions and 172 deletions

View File

@@ -1,9 +1,12 @@
import os
from flask._compat import string_types
from flask import Flask
from flask import Flask, _request_ctx_stack
from werkzeug.local import LocalProxy
from config import configs
api_user = LocalProxy(lambda: _request_ctx_stack.top.api_user)
def create_app(config_name):
application = Flask(__name__)

View File

@@ -1,10 +1,5 @@
from flask import Blueprint, request, abort
from jwt import decode, DecodeError
import calendar
import time
import base64
import hashlib
import hmac
from flask import Blueprint
from app.main.authentication.auth import requires_auth
AUTHORIZATION_HEADER = 'Authorization'
AUTHORIZATION_SCHEME = 'Bearer'
@@ -13,87 +8,7 @@ WINDOW = 1
main = Blueprint('main', __name__)
def get_secrets(service_identifier):
"""
Temp method until secrets are stored in database etc
:param service_identifier:
:return: (Boolean, String)
"""
secrets = {
'service1': '1234'
}
if service_identifier not in secrets:
return False, None
return True, secrets[service_identifier]
def get_token_from_headers(headers):
auth_header = headers.get(AUTHORIZATION_HEADER, '')
if auth_header[:7] != AUTHORIZATION_SCHEME + " ":
return None
return auth_header[7:]
def token_is_valid(token):
try:
# decode token to get service identifier
# signature not checked
unverified = decode(token, verify=False, algorithms=['HS256'])
# service identifier used to get secret
found, secret = get_secrets(unverified['iss'])
# use secret to validate the token
verified = decode(token, key=secret.encode(), verify=True, algorithms=['HS256'])
# check expiry
if not calendar.timegm(time.gmtime()) < verified['iat'] + WINDOW:
print("TIMESTAMP FAILED")
return False
# check request
signed_url = base64.b64encode(
hmac.new(
secret.encode(),
"{} {}".format(request.method, request.path).encode(),
digestmod=hashlib.sha256
).digest()
).decode()
if signed_url != verified['req']:
print("URL FAILED")
return False
# check body
signed_json_request = base64.b64encode(
hmac.new(
secret.encode(),
request.data,
digestmod=hashlib.sha256
).digest()
).decode()
print(verified)
if signed_json_request != verified['pay']:
print("PAYLOAD FAILED")
return False
except DecodeError:
print("TOKEN VERIFICATION FAILED")
return False
return True
def perform_authentication():
incoming_token = get_token_from_headers(request.headers)
if not incoming_token:
abort(401)
if not token_is_valid(incoming_token):
abort(403)
main.before_request(perform_authentication)
main.before_request(requires_auth)
from .views import notifications, index

View File

@@ -0,0 +1,51 @@
from flask import request, jsonify, _request_ctx_stack
from client.jwt import decode_jwt_token, get_token_issuer
from client.errors import TokenDecodeError, TokenRequestError, TokenExpiredError, TokenPayloadError
def authentication_response(message, code):
return jsonify(
error=message
), code
def requires_auth():
auth_header = request.headers.get('Authorization', None)
if not auth_header:
return authentication_response('Unauthorized, authentication token must be provided', 401)
auth_scheme = auth_header[:7]
if auth_scheme != 'Bearer ':
return authentication_response('Unauthorized, authentication bearer scheme must be used', 401)
try:
auth_token = auth_header[7:]
api_client = fetch_client(get_token_issuer(auth_token))
if api_client is None:
authentication_response("Invalid credentials", 403)
decode_jwt_token(
auth_token,
api_client['secret'],
request.method,
request.path,
request.data.decode() if request.data else None
)
_request_ctx_stack.top.api_user = api_client
except TokenRequestError:
return authentication_response("Invalid token: request", 403)
except TokenExpiredError:
return authentication_response("Invalid token: expired", 403)
except TokenPayloadError:
return authentication_response("Invalid token: payload", 403)
except TokenDecodeError:
return authentication_response("Invalid token: signature", 403)
def fetch_client(client):
return {
"client": client,
"secret": "secret"
}