mirror of
https://github.com/OpenKMIP/PyKMIP.git
synced 2025-10-22 08:04:40 +02:00
dcade2a264
This change updates the PyKMIP object hierarchy's read/write method signatures to support propagation of the KMIP version. The introduction of KMIP 2.0 introduces future KMIP message encodings that break backwards compatibility; to support this, PyKMIP must know what KMIP version is being used when encoding or decoding an object; the KMIP version residing in the client or server alone is now insufficient. Prior versions of KMIP, namely 1.0 - 1.4, have been backwards compatible, obviating the need for the KMIP version at encode/decode time. Going forward, this is no longer true. The PyKMIP client and server have been updated to include the KMIP version when making calls to read/write, as have the associated test cases covering this functionality.
152 lines
5.5 KiB
Python
152 lines
5.5 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 import attributes
|
|
from kmip.core import enums
|
|
from kmip.core.enums import Tags
|
|
|
|
from kmip.core.objects import Attribute
|
|
|
|
from kmip.core.primitives import Struct
|
|
from kmip.core.primitives import Enumeration
|
|
from kmip.core.primitives import Integer
|
|
|
|
from kmip.core.utils import BytearrayStream
|
|
|
|
|
|
class LocateRequestPayload(Struct):
|
|
|
|
# 9.1.3.2.33
|
|
class ObjectGroupMember(Enumeration):
|
|
|
|
def __init__(self, value=None):
|
|
super(LocateRequestPayload.ObjectGroupMember, self).__init__(
|
|
enums.ObjectGroupMember, value, Tags.OBJECT_GROUP_MEMBER)
|
|
|
|
class MaximumItems(Integer):
|
|
def __init__(self, value=None):
|
|
super(LocateRequestPayload.MaximumItems, self).__init__(
|
|
value, Tags.MAXIMUM_ITEMS)
|
|
|
|
# 9.1.3.3.2
|
|
class StorageStatusMask(Enumeration):
|
|
|
|
def __init__(self, value=None):
|
|
super(LocateRequestPayload.StorageStatusMask, self).__init__(
|
|
enums.StorageStatusMask, value, Tags.STORAGE_STATUS_MASK)
|
|
|
|
def __init__(self, maximum_items=None, storage_status_mask=None,
|
|
object_group_member=None, attributes=None):
|
|
super(LocateRequestPayload, self).__init__(enums.Tags.REQUEST_PAYLOAD)
|
|
self.maximum_items = maximum_items
|
|
self.storage_status_mask = storage_status_mask
|
|
self.object_group_member = object_group_member
|
|
self.attributes = attributes or []
|
|
self.validate()
|
|
|
|
def read(self, istream, kmip_version=enums.KMIPVersion.KMIP_1_0):
|
|
super(LocateRequestPayload, self).read(
|
|
istream,
|
|
kmip_version=kmip_version
|
|
)
|
|
tstream = BytearrayStream(istream.read(self.length))
|
|
if self.is_tag_next(Tags.MAXIMUM_ITEMS, tstream):
|
|
self.maximum_items = LocateRequestPayload.MaximumItems()
|
|
self.maximum_items.read(tstream, kmip_version=kmip_version)
|
|
if self.is_tag_next(Tags.STORAGE_STATUS_MASK, tstream):
|
|
self.storage_status_mask = LocateRequestPayload.StorageStatusMask()
|
|
self.storage_status_mask.read(tstream, kmip_version=kmip_version)
|
|
if self.is_tag_next(Tags.OBJECT_GROUP_MEMBER, tstream):
|
|
self.object_group_member = LocateRequestPayload.ObjectGroupMember()
|
|
self.object_group_member.read(tstream, kmip_version=kmip_version)
|
|
while self.is_tag_next(Tags.ATTRIBUTE, tstream):
|
|
attr = Attribute()
|
|
attr.read(tstream, kmip_version=kmip_version)
|
|
self.attributes.append(attr)
|
|
|
|
self.validate()
|
|
|
|
def write(self, ostream, kmip_version=enums.KMIPVersion.KMIP_1_0):
|
|
tstream = BytearrayStream()
|
|
if self.maximum_items is not None:
|
|
self.maximum_items.write(tstream, kmip_version=kmip_version)
|
|
if self.storage_status_mask is not None:
|
|
self.storage_status_mask.write(tstream, kmip_version=kmip_version)
|
|
if self.object_group_member is not None:
|
|
self.object_group_member.write(tstream, kmip_version=kmip_version)
|
|
if self.attributes is not None:
|
|
for a in self.attributes:
|
|
a.write(tstream, kmip_version=kmip_version)
|
|
|
|
# Write the length and value of the request payload
|
|
self.length = tstream.length()
|
|
super(LocateRequestPayload, self).write(
|
|
ostream,
|
|
kmip_version=kmip_version
|
|
)
|
|
ostream.write(tstream.buffer)
|
|
|
|
def validate(self):
|
|
self._validate()
|
|
|
|
def _validate(self):
|
|
# TODO Finish implementation.
|
|
pass
|
|
|
|
|
|
class LocateResponsePayload(Struct):
|
|
|
|
def __init__(self, unique_identifiers=[]):
|
|
super(LocateResponsePayload, self).__init__(
|
|
enums.Tags.RESPONSE_PAYLOAD)
|
|
self.unique_identifiers = unique_identifiers or []
|
|
self.validate()
|
|
|
|
def read(self, istream, kmip_version=enums.KMIPVersion.KMIP_1_0):
|
|
super(LocateResponsePayload, self).read(
|
|
istream,
|
|
kmip_version=kmip_version
|
|
)
|
|
tstream = BytearrayStream(istream.read(self.length))
|
|
|
|
while self.is_tag_next(Tags.UNIQUE_IDENTIFIER, tstream):
|
|
ui = attributes.UniqueIdentifier()
|
|
ui.read(tstream, kmip_version=kmip_version)
|
|
self.unique_identifiers.append(ui)
|
|
|
|
self.is_oversized(tstream)
|
|
self.validate()
|
|
|
|
def write(self, ostream, kmip_version=enums.KMIPVersion.KMIP_1_0):
|
|
tstream = BytearrayStream()
|
|
|
|
for ui in self.unique_identifiers:
|
|
ui.write(tstream, kmip_version=kmip_version)
|
|
|
|
# Write the length and value of the request payload
|
|
self.length = tstream.length()
|
|
super(LocateResponsePayload, self).write(
|
|
ostream,
|
|
kmip_version=kmip_version
|
|
)
|
|
ostream.write(tstream.buffer)
|
|
|
|
def validate(self):
|
|
self.__validate()
|
|
|
|
def __validate(self):
|
|
# TODO Finish implementation.
|
|
pass
|