update interfaces to use ABC
This commit is contained in:
Jimmy Zelinskie
parent
a1a930b833
commit
44eca10c05
14 changed files with 467 additions and 508 deletions
|
|
@ -1,7 +1,9 @@
|
|||
from abc import ABCMeta, abstractmethod
|
||||
from collections import namedtuple
|
||||
|
||||
import data.model
|
||||
from six import add_metaclass
|
||||
|
||||
import data.model
|
||||
|
||||
|
||||
class ServiceKey(namedtuple('ServiceKey', ['name', 'kid', 'service', 'jwk', 'metadata',
|
||||
|
|
@ -22,47 +24,48 @@ class ServiceKeyDoesNotExist(ServiceKeyException):
|
|||
pass
|
||||
|
||||
|
||||
# TODO(jzelinskie): make this interface support superuser API
|
||||
# TODO(jzelinskie): maybe make this interface support superuser API
|
||||
@add_metaclass(ABCMeta)
|
||||
class KeyServerDataInterface(object):
|
||||
"""
|
||||
Interface that represents all data store interactions required by a JWT key service.
|
||||
"""
|
||||
|
||||
@classmethod
|
||||
def list_service_keys(cls, service):
|
||||
@abstractmethod
|
||||
def list_service_keys(self, service):
|
||||
"""
|
||||
Returns a list of service keys or an empty list if the service does not exist.
|
||||
"""
|
||||
raise NotImplementedError()
|
||||
pass
|
||||
|
||||
@classmethod
|
||||
def get_service_key(cls, signer_kid, service=None, alive_only=None, approved_only=None):
|
||||
@abstractmethod
|
||||
def get_service_key(self, signer_kid, service=None, alive_only=None, approved_only=None):
|
||||
"""
|
||||
Returns a service kid with the given kid or raises ServiceKeyNotFound.
|
||||
"""
|
||||
raise NotImplementedError()
|
||||
pass
|
||||
|
||||
@classmethod
|
||||
def create_service_key(cls, name, kid, service, jwk, metadata, expiration_date,
|
||||
@abstractmethod
|
||||
def create_service_key(self, name, kid, service, jwk, metadata, expiration_date,
|
||||
rotation_duration=None):
|
||||
"""
|
||||
Stores a service key.
|
||||
"""
|
||||
raise NotImplementedError()
|
||||
pass
|
||||
|
||||
@classmethod
|
||||
def replace_service_key(cls, old_kid, kid, jwk, metadata, expiration_date):
|
||||
@abstractmethod
|
||||
def replace_service_key(self, old_kid, kid, jwk, metadata, expiration_date):
|
||||
"""
|
||||
Replaces a service with a new key or raises ServiceKeyNotFound.
|
||||
"""
|
||||
raise NotImplementedError()
|
||||
pass
|
||||
|
||||
@classmethod
|
||||
def delete_service_key(cls, kid):
|
||||
@abstractmethod
|
||||
def delete_service_key(self, kid):
|
||||
"""
|
||||
Deletes and returns a service key with the given kid or raises ServiceKeyNotFound.
|
||||
"""
|
||||
raise NotImplementedError()
|
||||
pass
|
||||
|
||||
|
||||
class PreOCIModel(KeyServerDataInterface):
|
||||
|
|
@ -70,53 +73,52 @@ class PreOCIModel(KeyServerDataInterface):
|
|||
PreOCIModel implements the data model for JWT key service using a database schema before it was
|
||||
changed to support the OCI specification.
|
||||
"""
|
||||
@classmethod
|
||||
def _db_key_to_servicekey(cls, key):
|
||||
"""
|
||||
Converts the database model of a service key into a ServiceKey.
|
||||
"""
|
||||
return ServiceKey(
|
||||
name=key.name,
|
||||
kid=key.kid,
|
||||
service=key.service,
|
||||
jwk=key.jwk,
|
||||
metadata=key.metadata,
|
||||
created_date=key.created_date,
|
||||
expiration_date=key.expiration_date,
|
||||
rotation_duration=key.rotation_duration,
|
||||
approval=key.approval,
|
||||
)
|
||||
|
||||
@classmethod
|
||||
def list_service_keys(cls, service):
|
||||
def list_service_keys(self, service):
|
||||
return data.model.service_keys.list_service_keys(service)
|
||||
|
||||
@classmethod
|
||||
def get_service_key(cls, signer_kid, service=None, alive_only=True, approved_only=True):
|
||||
def get_service_key(self, signer_kid, service=None, alive_only=True, approved_only=True):
|
||||
try:
|
||||
key = data.model.service_keys.get_service_key(signer_kid, service, alive_only, approved_only)
|
||||
return cls._db_key_to_servicekey(key)
|
||||
return _db_key_to_servicekey(key)
|
||||
except data.model.ServiceKeyDoesNotExist:
|
||||
raise ServiceKeyDoesNotExist()
|
||||
|
||||
@classmethod
|
||||
def create_service_key(cls, name, kid, service, jwk, metadata, expiration_date,
|
||||
def create_service_key(self, name, kid, service, jwk, metadata, expiration_date,
|
||||
rotation_duration=None):
|
||||
key = data.model.service_keys.create_service_key(name, kid, service, jwk, metadata,
|
||||
expiration_date, rotation_duration)
|
||||
return cls._db_key_to_servicekey(key)
|
||||
return _db_key_to_servicekey(key)
|
||||
|
||||
@classmethod
|
||||
def replace_service_key(cls, old_kid, kid, jwk, metadata, expiration_date):
|
||||
def replace_service_key(self, old_kid, kid, jwk, metadata, expiration_date):
|
||||
try:
|
||||
data.model.service_keys.replace_service_key(old_kid, kid, jwk, metadata, expiration_date)
|
||||
except data.model.ServiceKeyDoesNotExist:
|
||||
raise ServiceKeyDoesNotExist()
|
||||
|
||||
@classmethod
|
||||
def delete_service_key(cls, kid):
|
||||
def delete_service_key(self, kid):
|
||||
try:
|
||||
key = data.model.service_keys.delete_service_key(kid)
|
||||
return cls._db_key_to_servicekey(key)
|
||||
return _db_key_to_servicekey(key)
|
||||
except data.model.ServiceKeyDoesNotExist:
|
||||
raise ServiceKeyDoesNotExist()
|
||||
|
||||
|
||||
pre_oci_model = PreOCIModel()
|
||||
|
||||
|
||||
def _db_key_to_servicekey(key):
|
||||
"""
|
||||
Converts the Pre-OCI database model of a service key into a ServiceKey.
|
||||
"""
|
||||
return ServiceKey(
|
||||
name=key.name,
|
||||
kid=key.kid,
|
||||
service=key.service,
|
||||
jwk=key.jwk,
|
||||
metadata=key.metadata,
|
||||
created_date=key.created_date,
|
||||
expiration_date=key.expiration_date,
|
||||
rotation_duration=key.rotation_duration,
|
||||
approval=key.approval,
|
||||
)
|
||||
|
||||
|
|
|
|||
Reference in a new issue