mirror of
https://github.com/OpenKMIP/PyKMIP.git
synced 2025-05-05 07:20:08 +02:00
b99bf8cbf4
This change is primarily a reorganization of the message payload code originally found in kmip/core/messages/operations.py. The code from that module has been moved to a new package, kmip.core.messages.payloads, and split into separate modules according to each supported KMIP operation. The surrounding KMIP codebase has been updated to use the new package structure and a placeholder test suite has been put in place for future tests. This change does NOT include test cases as these would primarily be a refactoring from the current test suite found in kmip/tests/core/messages/test_messages.py and that work has not been done yet.
157 lines
5.2 KiB
Python
157 lines
5.2 KiB
Python
# Copyright (c) 2014 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.factories.secrets import SecretFactory
|
|
|
|
from kmip.core import attributes
|
|
from kmip.core import enums
|
|
from kmip.core.enums import Tags
|
|
|
|
from kmip.core.objects import KeyWrappingSpecification
|
|
|
|
from kmip.core.primitives import Struct
|
|
from kmip.core.primitives import Enumeration
|
|
|
|
from kmip.core.utils import BytearrayStream
|
|
|
|
|
|
# 4.11
|
|
class GetRequestPayload(Struct):
|
|
|
|
# 9.1.3.2.2
|
|
class KeyCompressionType(Enumeration):
|
|
ENUM_TYPE = enums.KeyCompressionType
|
|
|
|
def __init__(self, value=None):
|
|
super(self.__class__, self).__init__(value,
|
|
Tags.KEY_COMPRESSION_TYPE)
|
|
|
|
# 9.1.3.2.3
|
|
class KeyFormatType(Enumeration):
|
|
ENUM_TYPE = enums.KeyFormatType
|
|
|
|
def __init__(self, value=None):
|
|
super(self.__class__, self).__init__(value, Tags.KEY_FORMAT_TYPE)
|
|
|
|
def __init__(self,
|
|
unique_identifier=None,
|
|
key_format_type=None,
|
|
key_compression_type=None,
|
|
key_wrapping_specification=None):
|
|
super(self.__class__, self).__init__(tag=enums.Tags.REQUEST_PAYLOAD)
|
|
self.unique_identifier = unique_identifier
|
|
self.key_format_type = key_format_type
|
|
self.key_compression_type = key_compression_type
|
|
self.key_wrapping_specification = key_wrapping_specification
|
|
self.validate()
|
|
|
|
def read(self, istream):
|
|
super(self.__class__, self).read(istream)
|
|
tstream = BytearrayStream(istream.read(self.length))
|
|
|
|
if self.is_tag_next(Tags.UNIQUE_IDENTIFIER, tstream):
|
|
self.unique_identifier = attributes.UniqueIdentifier()
|
|
self.unique_identifier.read(tstream)
|
|
|
|
if self.is_tag_next(Tags.KEY_FORMAT_TYPE, tstream):
|
|
self.key_format_type = GetRequestPayload.KeyFormatType()
|
|
self.key_format_type.read(tstream)
|
|
|
|
if self.is_tag_next(Tags.KEY_COMPRESSION_TYPE, tstream):
|
|
self.key_compression_type = GetRequestPayload.KeyCompressionType()
|
|
self.key_compression_type.read(tstream)
|
|
|
|
if self.is_tag_next(Tags.KEY_WRAPPING_SPECIFICATION, tstream):
|
|
self.key_wrapping_specification = KeyWrappingSpecification()
|
|
self.key_wrapping_specification.read(tstream)
|
|
|
|
self.is_oversized(tstream)
|
|
self.validate()
|
|
|
|
def write(self, ostream):
|
|
tstream = BytearrayStream()
|
|
|
|
# Write the contents of the request payload
|
|
if self.unique_identifier is not None:
|
|
self.unique_identifier.write(tstream)
|
|
if self.key_format_type is not None:
|
|
self.key_format_type.write(tstream)
|
|
if self.key_compression_type is not None:
|
|
self.key_compression_type.write(tstream)
|
|
if self.key_wrapping_specification is not None:
|
|
self.key_wrapping_specification.write(tstream)
|
|
|
|
# Write the length and value of the request payload
|
|
self.length = tstream.length()
|
|
super(self.__class__, self).write(ostream)
|
|
ostream.write(tstream.buffer)
|
|
|
|
def validate(self):
|
|
self.__validate()
|
|
|
|
def __validate(self):
|
|
# TODO (peter-hamilton) Finish implementation
|
|
pass
|
|
|
|
|
|
class GetResponsePayload(Struct):
|
|
|
|
def __init__(self,
|
|
object_type=None,
|
|
unique_identifier=None,
|
|
secret=None):
|
|
super(self.__class__, self).__init__(tag=Tags.RESPONSE_PAYLOAD)
|
|
self.object_type = object_type
|
|
self.unique_identifier = unique_identifier
|
|
self.secret = secret
|
|
self.secret_factory = SecretFactory()
|
|
self.validate()
|
|
|
|
def read(self, istream):
|
|
super(self.__class__, self).read(istream)
|
|
tstream = BytearrayStream(istream.read(self.length))
|
|
|
|
self.object_type = attributes.ObjectType()
|
|
self.unique_identifier = attributes.UniqueIdentifier()
|
|
|
|
self.object_type.read(tstream)
|
|
self.unique_identifier.read(tstream)
|
|
|
|
secret_type = self.object_type.enum
|
|
self.secret = self.secret_factory.create_secret(secret_type)
|
|
self.secret.read(tstream)
|
|
|
|
self.is_oversized(tstream)
|
|
self.validate()
|
|
|
|
def write(self, ostream):
|
|
tstream = BytearrayStream()
|
|
|
|
self.object_type.write(tstream)
|
|
self.unique_identifier.write(tstream)
|
|
self.secret.write(tstream)
|
|
|
|
# Write the length and value of the request payload
|
|
self.length = tstream.length()
|
|
super(self.__class__, self).write(ostream)
|
|
ostream.write(tstream.buffer)
|
|
|
|
def validate(self):
|
|
self.__validate()
|
|
|
|
def __validate(self):
|
|
# TODO (peter-hamilton) Finish implementation.
|
|
pass
|