This repository has been archived on 2020-03-24. You can view files and clone it, but cannot push or open issues or pull requests.
quay/endpoints/key_server.py

205 lines
5.9 KiB
Python
Raw Normal View History

import logging
2016-04-13 19:50:56 +00:00
from datetime import datetime, timedelta
2016-03-16 19:49:25 +00:00
from cryptography.hazmat.backends import default_backend
from cryptography.hazmat.primitives.asymmetric.ec import EllipticCurvePublicNumbers
from cryptography.hazmat.primitives.asymmetric.rsa import RSAPublicNumbers
from flask import Blueprint, jsonify, abort, request, make_response
from jwkest.jwk import keyrep, RSAKey, ECKey
from jwt import get_unverified_header
2016-03-16 19:49:25 +00:00
import data.model
import data.model.service_keys
2016-04-01 17:55:29 +00:00
from data.model.log import log_action
2016-03-16 19:49:25 +00:00
2016-03-30 20:16:11 +00:00
from app import app
from auth.registry_jwt_auth import TOKEN_REGEX
2016-03-16 19:49:25 +00:00
from util.security import strictjwt
logger = logging.getLogger(__name__)
2016-03-16 19:49:25 +00:00
key_server = Blueprint('key_server', __name__)
JWT_HEADER_NAME = 'Authorization'
JWT_AUDIENCE = app.config['PREFERRED_URL_SCHEME'] + '://' + app.config['SERVER_HOSTNAME']
2016-03-16 19:49:25 +00:00
2016-04-07 00:03:48 +00:00
def _validate_jwk(jwk):
2016-03-25 22:44:11 +00:00
if 'kty' not in jwk:
abort(400)
if jwk['kty'] == 'EC':
if 'x' not in jwk or 'y' not in jwk:
abort(400)
elif jwk['kty'] == 'RSA':
if 'e' not in jwk or 'n' not in jwk:
abort(400)
else:
abort(400)
def _jwk_dict_to_public_key(jwk):
jwkest_key = keyrep(jwk)
if isinstance(jwkest_key, RSAKey):
pycrypto_key = jwkest_key.key
return RSAPublicNumbers(e=pycrypto_key.e, n=pycrypto_key.n).public_key(default_backend())
elif isinstance(jwkest_key, ECKey):
x, y = jwkest_key.get_key()
return EllipticCurvePublicNumbers(x, y, jwkest_key.curve).public_key(default_backend())
2016-03-25 22:44:11 +00:00
def _validate_jwt(encoded_jwt, jwk, service):
public_key = _jwk_dict_to_public_key(jwk)
2016-03-16 19:49:25 +00:00
try:
2016-03-23 22:16:03 +00:00
strictjwt.decode(encoded_jwt, public_key, algorithms=['RS256'],
audience=JWT_AUDIENCE, issuer=service)
2016-03-16 19:49:25 +00:00
except strictjwt.InvalidTokenError:
2016-04-01 17:55:29 +00:00
logger.exception('JWT validation failure')
2016-03-16 19:49:25 +00:00
abort(400)
2016-03-28 23:00:00 +00:00
def _signer_kid(encoded_jwt):
headers = get_unverified_header(encoded_jwt)
return headers.get('kid', None)
2016-03-23 22:16:03 +00:00
2016-03-30 17:20:35 +00:00
def _signer_key(service, signer_kid):
2016-03-28 23:00:00 +00:00
try:
2016-03-30 17:20:35 +00:00
return data.model.service_keys.get_service_key(signer_kid, service=service)
2016-03-28 23:00:00 +00:00
except data.model.ServiceKeyDoesNotExist:
abort(403)
2016-03-23 22:16:03 +00:00
2016-03-16 19:49:25 +00:00
@key_server.route('/services/<service>/keys', methods=['GET'])
2016-03-30 17:20:35 +00:00
def list_service_keys(service):
keys = data.model.service_keys.list_service_keys(service)
2016-03-23 22:16:03 +00:00
return jsonify({'keys': [key.jwk for key in keys]})
2016-03-16 19:49:25 +00:00
2016-03-25 22:44:11 +00:00
@key_server.route('/services/<service>/keys/<kid>', methods=['GET'])
def get_service_key(service, kid):
2016-03-29 18:49:07 +00:00
try:
key = data.model.service_keys.get_service_key(kid)
except data.model.ServiceKeyDoesNotExist:
abort(404)
if key.approval is None:
abort(409)
2016-03-29 18:49:07 +00:00
2016-04-13 19:50:56 +00:00
resp = jsonify(key.jwk)
# Set the cache header to be a year for non-expiring keys.
lifetime = timedelta(days=365)
if key.expiration_date is not None:
lifetime = key.expiration_date - key.created_date
resp.cache_control.max_age = lifetime.seconds
return resp
2016-03-25 22:44:11 +00:00
2016-03-16 19:49:25 +00:00
@key_server.route('/services/<service>/keys/<kid>', methods=['PUT'])
def put_service_key(service, kid):
metadata = {'ip': request.remote_addr}
rotation_duration = request.args.get('rotation', None)
2016-03-16 19:49:25 +00:00
expiration_date = request.args.get('expiration', None)
if expiration_date is not None:
2016-03-16 19:49:25 +00:00
try:
expiration_date = datetime.utcfromtimestamp(float(expiration_date))
except ValueError:
2016-04-01 17:55:29 +00:00
logger.exception('Error parsing expiration date on key')
2016-03-16 19:49:25 +00:00
abort(400)
try:
jwk = request.get_json()
2016-03-16 19:49:25 +00:00
except ValueError:
2016-04-01 17:55:29 +00:00
logger.exception('Error parsing JWK')
2016-03-16 19:49:25 +00:00
abort(400)
jwt_header = request.headers.get(JWT_HEADER_NAME, '')
match = TOKEN_REGEX.match(jwt_header)
if match is None:
2016-04-01 17:55:29 +00:00
logger.error('Could not find matching bearer token')
2016-03-23 22:16:03 +00:00
abort(400)
2016-04-01 17:55:29 +00:00
encoded_jwt = match.group(1)
2016-03-23 22:16:03 +00:00
2016-04-07 00:03:48 +00:00
_validate_jwk(jwk)
2016-03-28 23:00:00 +00:00
signer_kid = _signer_kid(encoded_jwt)
if kid == signer_kid or signer_kid is None:
2016-03-29 18:49:07 +00:00
# The key is self-signed. Create a new instance and await approval.
_validate_jwt(encoded_jwt, jwk, service)
data.model.service_keys.create_service_key('', kid, service, jwk, metadata, expiration_date,
rotation_duration=rotation_duration)
2016-04-01 17:55:29 +00:00
key_log_metadata = {
'kid': kid,
'preshared': False,
'service': service,
'name': '',
'expiration_date': expiration_date,
'user_agent': request.headers.get('User-Agent'),
'ip': request.remote_addr,
}
log_action('service_key_create', None, metadata=key_log_metadata, ip=request.remote_addr)
2016-03-29 18:49:07 +00:00
return make_response('', 202)
metadata.update({'created_by': 'Key Rotation'})
2016-03-30 17:20:35 +00:00
signer_key = _signer_key(service, signer_kid)
2016-03-29 18:49:07 +00:00
signer_jwk = signer_key.jwk
2016-03-28 23:00:00 +00:00
if signer_key.service != service:
abort(403)
2016-03-29 18:49:07 +00:00
_validate_jwt(encoded_jwt, signer_jwk, service)
2016-03-23 22:16:03 +00:00
2016-03-25 22:44:11 +00:00
try:
data.model.service_keys.replace_service_key(signer_key.kid, kid, jwk, metadata, expiration_date)
2016-03-25 22:44:11 +00:00
except data.model.ServiceKeyDoesNotExist:
2016-03-28 23:00:00 +00:00
abort(404)
2016-03-16 19:49:25 +00:00
2016-04-01 17:55:29 +00:00
key_log_metadata = {
'kid': kid,
'signer_kid': signer_key.kid,
'service': service,
'name': signer_key.name,
'expiration_date': expiration_date,
'user_agent': request.headers.get('User-Agent'),
'ip': request.remote_addr,
}
log_action('service_key_rotate', None, metadata=key_log_metadata, ip=request.remote_addr)
2016-03-29 18:49:07 +00:00
return make_response('', 200)
2016-03-16 19:49:25 +00:00
@key_server.route('/services/<service>/keys/<kid>', methods=['DELETE'])
def delete_service_key(service, kid):
jwt_header = request.headers.get(JWT_HEADER_NAME, '')
match = TOKEN_REGEX.match(jwt_header)
if match is None:
2016-03-16 19:49:25 +00:00
abort(400)
2016-04-13 17:59:07 +00:00
encoded_jwt = match.group(1)
2016-03-23 22:16:03 +00:00
2016-03-28 23:00:00 +00:00
signer_kid = _signer_kid(encoded_jwt)
2016-03-30 17:20:35 +00:00
signer_key = _signer_key(service, signer_kid)
2016-03-16 19:49:25 +00:00
2016-03-30 17:20:35 +00:00
self_signed = kid == signer_kid or signer_kid == ''
approved_key_for_service = signer_key.approval is not None
if self_signed or approved_key_for_service:
2016-03-28 23:00:00 +00:00
_validate_jwt(encoded_jwt, signer_key.jwk, service)
2016-03-30 17:20:35 +00:00
2016-03-28 23:00:00 +00:00
try:
2016-04-07 00:03:48 +00:00
data.model.service_keys.delete_service_key(kid)
2016-03-28 23:00:00 +00:00
except data.model.ServiceKeyDoesNotExist:
abort(404)
2016-03-30 17:20:35 +00:00
2016-04-07 00:03:48 +00:00
return make_response('', 204)
2016-03-16 19:49:25 +00:00
2016-03-28 23:00:00 +00:00
abort(403)