mirror of
https://github.com/OpenKMIP/PyKMIP.git
synced 2025-11-04 05:25:17 +01: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.
225 lines
8.6 KiB
Python
225 lines
8.6 KiB
Python
# Copyright (c) 2015 Hewlett Packard Development Company, L.P.
|
|
# 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 import objects
|
|
from kmip.core import primitives
|
|
|
|
from kmip.core.primitives import Struct
|
|
|
|
from kmip.core.utils import BytearrayStream
|
|
|
|
|
|
class RevokeRequestPayload(Struct):
|
|
"""
|
|
A request payload for the Revoke operation.
|
|
|
|
The payload contains a UUID of a cryptographic object that that server
|
|
should revoke. See Section 4.20 of the KMIP 1.1 specification for more
|
|
information.
|
|
|
|
Attributes:
|
|
unique_identifier: The UUID of a managed cryptographic object
|
|
revocation_reason: The reason why the object was revoked
|
|
compromised_date: The date of compromise if the object was compromised
|
|
"""
|
|
|
|
def __init__(self,
|
|
unique_identifier=None,
|
|
revocation_reason=None,
|
|
compromise_occurrence_date=None):
|
|
"""
|
|
Construct a RevokeRequestPayload object.
|
|
Args:
|
|
unique_identifier (UniqueIdentifier): The UUID of a managed
|
|
cryptographic object.
|
|
revocation_reason (RevocationReason): The reason why the object was
|
|
revoked.
|
|
compromise_occurrence_date (DateTime): the datetime when the object
|
|
was first believed to be compromised.
|
|
"""
|
|
super(RevokeRequestPayload, self).__init__(
|
|
tag=enums.Tags.REQUEST_PAYLOAD)
|
|
self.unique_identifier = unique_identifier
|
|
self.compromise_occurrence_date = compromise_occurrence_date
|
|
self.revocation_reason = revocation_reason
|
|
if self.revocation_reason is None:
|
|
self.revocation_reason = objects.RevocationReason()
|
|
self.validate()
|
|
|
|
def read(self, istream, kmip_version=enums.KMIPVersion.KMIP_1_0):
|
|
"""
|
|
Read the data encoding the RevokeRequestPayload object and decode it
|
|
into its constituent parts.
|
|
Args:
|
|
istream (Stream): A data stream containing encoded object data,
|
|
supporting a read method; usually a BytearrayStream object.
|
|
kmip_version (KMIPVersion): An enumeration defining the KMIP
|
|
version with which the object will be decoded. Optional,
|
|
defaults to KMIP 1.0.
|
|
"""
|
|
super(RevokeRequestPayload, self).read(
|
|
istream,
|
|
kmip_version=kmip_version
|
|
)
|
|
tstream = BytearrayStream(istream.read(self.length))
|
|
|
|
self.unique_identifier = attributes.UniqueIdentifier()
|
|
self.unique_identifier.read(tstream, kmip_version=kmip_version)
|
|
|
|
self.revocation_reason = objects.RevocationReason()
|
|
self.revocation_reason.read(tstream, kmip_version=kmip_version)
|
|
|
|
if self.is_tag_next(enums.Tags.COMPROMISE_OCCURRENCE_DATE, tstream):
|
|
self.compromise_occurrence_date = primitives.DateTime(
|
|
tag=enums.Tags.COMPROMISE_OCCURRENCE_DATE)
|
|
self.compromise_occurrence_date.read(
|
|
tstream,
|
|
kmip_version=kmip_version
|
|
)
|
|
|
|
self.is_oversized(tstream)
|
|
self.validate()
|
|
|
|
def write(self, ostream, kmip_version=enums.KMIPVersion.KMIP_1_0):
|
|
"""
|
|
Write the data encoding the RevokeRequestPayload object to a stream.
|
|
Args:
|
|
ostream (Stream): A data stream in which to encode object data,
|
|
supporting a write method; usually a BytearrayStream object.
|
|
kmip_version (KMIPVersion): An enumeration defining the KMIP
|
|
version with which the object will be encoded. Optional,
|
|
defaults to KMIP 1.0.
|
|
"""
|
|
tstream = BytearrayStream()
|
|
|
|
# Write the contents of the request payload
|
|
if self.unique_identifier is not None:
|
|
self.unique_identifier.write(tstream, kmip_version=kmip_version)
|
|
|
|
self.revocation_reason.write(tstream, kmip_version=kmip_version)
|
|
|
|
if self.compromise_occurrence_date is not None:
|
|
self.compromise_occurrence_date.write(
|
|
tstream,
|
|
kmip_version=kmip_version
|
|
)
|
|
|
|
# Write the length and value of the request payload
|
|
self.length = tstream.length()
|
|
super(RevokeRequestPayload, self).write(
|
|
ostream,
|
|
kmip_version=kmip_version
|
|
)
|
|
ostream.write(tstream.buffer)
|
|
|
|
def validate(self):
|
|
"""
|
|
Error check the attributes of the ActivateRequestPayload object.
|
|
"""
|
|
if self.unique_identifier is not None:
|
|
if not isinstance(self.unique_identifier,
|
|
attributes.UniqueIdentifier):
|
|
msg = "invalid unique identifier"
|
|
raise TypeError(msg)
|
|
if self.compromise_occurrence_date is not None:
|
|
if not isinstance(self.compromise_occurrence_date,
|
|
primitives.DateTime):
|
|
msg = "invalid compromise time"
|
|
raise TypeError(msg)
|
|
if not isinstance(self.revocation_reason, objects.RevocationReason):
|
|
msg = "invalid revocation reason"
|
|
raise TypeError(msg)
|
|
|
|
|
|
class RevokeResponsePayload(Struct):
|
|
"""
|
|
A response payload for the Revoke operation.
|
|
The payload contains the server response to the initial Revoke request.
|
|
See Section 4.20 of the KMIP 1.1 specification for more information.
|
|
Attributes:
|
|
unique_identifier: The UUID of a managed cryptographic object.
|
|
"""
|
|
def __init__(self,
|
|
unique_identifier=None):
|
|
"""
|
|
Construct a RevokeResponsePayload object.
|
|
Args:
|
|
unique_identifier (UniqueIdentifier): The UUID of a managed
|
|
cryptographic object.
|
|
"""
|
|
super(RevokeResponsePayload, self).__init__(
|
|
tag=enums.Tags.RESPONSE_PAYLOAD)
|
|
if unique_identifier is None:
|
|
self.unique_identifier = attributes.UniqueIdentifier()
|
|
else:
|
|
self.unique_identifier = unique_identifier
|
|
self.validate()
|
|
|
|
def read(self, istream, kmip_version=enums.KMIPVersion.KMIP_1_0):
|
|
"""
|
|
Read the data encoding the RevokeResponsePayload object and decode it
|
|
into its constituent parts.
|
|
Args:
|
|
istream (Stream): A data stream containing encoded object data,
|
|
supporting a read method; usually a BytearrayStream object.
|
|
kmip_version (KMIPVersion): An enumeration defining the KMIP
|
|
version with which the object will be decoded. Optional,
|
|
defaults to KMIP 1.0.
|
|
"""
|
|
super(RevokeResponsePayload, self).read(
|
|
istream,
|
|
kmip_version=kmip_version
|
|
)
|
|
tstream = BytearrayStream(istream.read(self.length))
|
|
|
|
self.unique_identifier = attributes.UniqueIdentifier()
|
|
self.unique_identifier.read(tstream, kmip_version=kmip_version)
|
|
|
|
self.is_oversized(tstream)
|
|
self.validate()
|
|
|
|
def write(self, ostream, kmip_version=enums.KMIPVersion.KMIP_1_0):
|
|
"""
|
|
Write the data encoding the RevokeResponsePayload object to a stream.
|
|
Args:
|
|
ostream (Stream): A data stream in which to encode object data,
|
|
supporting a write method; usually a BytearrayStream object.
|
|
kmip_version (KMIPVersion): An enumeration defining the KMIP
|
|
version with which the object will be encoded. Optional,
|
|
defaults to KMIP 1.0.
|
|
"""
|
|
tstream = BytearrayStream()
|
|
|
|
# Write the contents of the response payload
|
|
self.unique_identifier.write(tstream, kmip_version=kmip_version)
|
|
|
|
# Write the length and value of the request payload
|
|
self.length = tstream.length()
|
|
super(RevokeResponsePayload, self).write(
|
|
ostream,
|
|
kmip_version=kmip_version
|
|
)
|
|
ostream.write(tstream.buffer)
|
|
|
|
def validate(self):
|
|
"""
|
|
Error check the attributes of the RevokeRequestPayload object.
|
|
"""
|
|
if not isinstance(self.unique_identifier, attributes.UniqueIdentifier):
|
|
msg = "invalid unique identifier"
|
|
raise TypeError(msg)
|