mirror of
https://github.com/openkmip/pykmip
synced 2025-12-20 10:13:18 +00:00
This change adds an ObjectFactory for the Pie object hierarchy. It provides easy translation to and from Pie objects to the original core object hierarchy. The factory is only used by the new Pie client and should never be used outside of this context. A unit test suite for the factory is included.
97 lines
3.6 KiB
Python
97 lines
3.6 KiB
Python
# Copyright (c) 2015 The Johns Hopkins University/Applied Physics Laboratory
|
|
# All Rights Reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
from kmip.core import attributes
|
|
from kmip.core import misc
|
|
from kmip.core import objects as cobjects
|
|
from kmip.core import secrets
|
|
|
|
from kmip.pie import objects as pobjects
|
|
|
|
|
|
class ObjectFactory:
|
|
"""
|
|
A factory to convert between the Pie and core object hierarchies.
|
|
"""
|
|
|
|
def __init__(self):
|
|
"""
|
|
Construct an ObjectFactory.
|
|
"""
|
|
pass
|
|
|
|
def convert(self, obj):
|
|
"""
|
|
Convert a Pie object into a core secret object and vice versa.
|
|
|
|
Args:
|
|
obj (various): A Pie or core secret object to convert into the
|
|
opposite object space. Required.
|
|
|
|
Raises:
|
|
TypeError: if the object type is unrecognized or unsupported.
|
|
"""
|
|
if isinstance(obj, pobjects.SymmetricKey):
|
|
return self._build_core_key(obj, secrets.SymmetricKey)
|
|
elif isinstance(obj, secrets.SymmetricKey):
|
|
return self._build_pie_key(obj, pobjects.SymmetricKey)
|
|
elif isinstance(obj, pobjects.PublicKey):
|
|
return self._build_core_key(obj, secrets.PublicKey)
|
|
elif isinstance(obj, secrets.PublicKey):
|
|
return self._build_pie_key(obj, pobjects.PublicKey)
|
|
elif isinstance(obj, pobjects.PrivateKey):
|
|
return self._build_core_key(obj, secrets.PrivateKey)
|
|
elif isinstance(obj, secrets.PrivateKey):
|
|
return self._build_pie_key(obj, pobjects.PrivateKey)
|
|
else:
|
|
raise TypeError("object type unsupported and cannot be converted")
|
|
|
|
def _build_pie_key(self, key, cls):
|
|
algorithm = key.key_block.cryptographic_algorithm.enum
|
|
length = key.key_block.cryptographic_length.value
|
|
value = key.key_block.key_value.key_material.value
|
|
format_type = key.key_block.key_format_type.enum
|
|
|
|
if cls is pobjects.SymmetricKey:
|
|
key = cls(algorithm, length, value)
|
|
if key.key_format_type != format_type:
|
|
raise TypeError(
|
|
"core key format type not compatible with Pie "
|
|
"SymmetricKey; expected {0}, observed {1}".format(
|
|
key.key_format_type, format_type))
|
|
else:
|
|
return key
|
|
else:
|
|
return cls(algorithm, length, value, format_type)
|
|
|
|
def _build_core_key(self, key, cls):
|
|
algorithm = key.cryptographic_algorithm
|
|
length = key.cryptographic_length
|
|
value = key.value
|
|
format_type = key.key_format_type
|
|
|
|
key_material = cobjects.KeyMaterial(value)
|
|
key_value = cobjects.KeyValue(key_material)
|
|
key_block = cobjects.KeyBlock(
|
|
key_format_type=misc.KeyFormatType(format_type),
|
|
key_compression_type=None,
|
|
key_value=key_value,
|
|
cryptographic_algorithm=attributes.CryptographicAlgorithm(
|
|
algorithm),
|
|
cryptographic_length=attributes.CryptographicLength(length),
|
|
key_wrapping_data=None)
|
|
|
|
return cls(key_block)
|