diff --git a/kmip/demos/pie/locate.py b/kmip/demos/pie/locate.py index 2ef5682..5ea294a 100644 --- a/kmip/demos/pie/locate.py +++ b/kmip/demos/pie/locate.py @@ -38,6 +38,7 @@ if __name__ == '__main__': object_type = opts.object_type cryptographic_algorithm = opts.cryptographic_algorithm cryptographic_length = opts.cryptographic_length + unique_identifier = opts.unique_identifier attribute_factory = AttributeFactory() @@ -136,6 +137,13 @@ if __name__ == '__main__': ) ) sys.exit(-6) + if unique_identifier: + attributes.append( + attribute_factory.create_attribute( + enums.AttributeType.UNIQUE_IDENTIFIER, + unique_identifier + ) + ) # Build the client and connect to the server with client.ProxyKmipClient( diff --git a/kmip/demos/units/locate.py b/kmip/demos/units/locate.py index f8eeb71..08785ad 100644 --- a/kmip/demos/units/locate.py +++ b/kmip/demos/units/locate.py @@ -41,6 +41,7 @@ if __name__ == '__main__': object_type = opts.object_type cryptographic_algorithm = opts.cryptographic_algorithm cryptographic_length = opts.cryptographic_length + unique_identifier = opts.unique_identifier attribute_factory = AttributeFactory() credential_factory = CredentialFactory() @@ -163,6 +164,13 @@ if __name__ == '__main__': ) client.close() sys.exit(-6) + if unique_identifier: + attributes.append( + attribute_factory.create_attribute( + enums.AttributeType.UNIQUE_IDENTIFIER, + unique_identifier + ) + ) result = client.locate(attributes=attributes, credential=credential) client.close() diff --git a/kmip/demos/utils.py b/kmip/demos/utils.py index 8b7593a..80068ca 100644 --- a/kmip/demos/utils.py +++ b/kmip/demos/utils.py @@ -287,6 +287,15 @@ def build_cli_parser(operation=None): dest="cryptographic_length", help="The cryptographic length of the secret (e.g., 128, 2048)" ) + parser.add_option( + "-i", + "--unique-identifier", + action="store", + type="str", + default=None, + dest="unique_identifier", + help="The unique identifier of the secret (e.g., 1, 2, 3)" + ) elif operation is Operation.REGISTER: parser.add_option( "-f", diff --git a/kmip/services/server/engine.py b/kmip/services/server/engine.py index e838c46..068df21 100644 --- a/kmip/services/server/engine.py +++ b/kmip/services/server/engine.py @@ -1715,6 +1715,20 @@ class KmipEngine(object): ) add_object = False break + elif name == "Unique Identifier": + value = value.value + if value != attribute: + self._logger.debug( + "Failed match: " + "the specified unique identifier ({}) " + "does not match the object's unique " + "identifier ({}).".format( + value, + attribute + ) + ) + add_object = False + break elif name == enums.AttributeType.INITIAL_DATE.value: initial_date["value"] = attribute self._track_date_attributes( diff --git a/kmip/tests/integration/services/test_integration.py b/kmip/tests/integration/services/test_integration.py index e5f4d27..f0686a0 100644 --- a/kmip/tests/integration/services/test_integration.py +++ b/kmip/tests/integration/services/test_integration.py @@ -1421,6 +1421,39 @@ class TestIntegration(testtools.TestCase): ) self.assertEqual(0, len(result.uuids)) + # Test locating each key by its unique identifier. + result = self.client.locate( + attributes=[ + self.attr_factory.create_attribute( + enums.AttributeType.UNIQUE_IDENTIFIER, + uid_a + ) + ] + ) + self.assertEqual(1, len(result.uuids)) + self.assertIn(uid_a, result.uuids) + + result = self.client.locate( + attributes=[ + self.attr_factory.create_attribute( + enums.AttributeType.UNIQUE_IDENTIFIER, + uid_b + ) + ] + ) + self.assertEqual(1, len(result.uuids)) + self.assertIn(uid_b, result.uuids) + + result = self.client.locate( + attributes=[ + self.attr_factory.create_attribute( + enums.AttributeType.UNIQUE_IDENTIFIER, + "unknown" + ) + ] + ) + self.assertEqual(0, len(result.uuids)) + # Clean up keys result = self.client.destroy(uid_a) self.assertEqual(ResultStatus.SUCCESS, result.result_status.value) diff --git a/kmip/tests/integration/services/test_proxykmipclient.py b/kmip/tests/integration/services/test_proxykmipclient.py index aa6904e..032236d 100644 --- a/kmip/tests/integration/services/test_proxykmipclient.py +++ b/kmip/tests/integration/services/test_proxykmipclient.py @@ -1076,6 +1076,39 @@ class TestProxyKmipClientIntegration(testtools.TestCase): ) self.assertEqual(0, len(result)) + # Test locating each key by its unique identifier. + result = self.client.locate( + attributes=[ + self.attribute_factory.create_attribute( + enums.AttributeType.UNIQUE_IDENTIFIER, + a_id + ) + ] + ) + self.assertEqual(1, len(result)) + self.assertIn(a_id, result) + + result = self.client.locate( + attributes=[ + self.attribute_factory.create_attribute( + enums.AttributeType.UNIQUE_IDENTIFIER, + b_id + ) + ] + ) + self.assertEqual(1, len(result)) + self.assertIn(b_id, result) + + result = self.client.locate( + attributes=[ + self.attribute_factory.create_attribute( + enums.AttributeType.UNIQUE_IDENTIFIER, + "unknown" + ) + ] + ) + self.assertEqual(0, len(result)) + # Clean up the keys self.client.destroy(a_id) self.client.destroy(b_id) diff --git a/kmip/tests/unit/services/server/test_engine.py b/kmip/tests/unit/services/server/test_engine.py index 6c392e1..393c9fd 100644 --- a/kmip/tests/unit/services/server/test_engine.py +++ b/kmip/tests/unit/services/server/test_engine.py @@ -5065,6 +5065,119 @@ class TestKmipEngine(testtools.TestCase): ) self.assertEqual(0, len(response_payload.unique_identifiers)) + def test_locate_with_unique_identifier(self): + """ + Test the Locate operation when the 'Unique Identifier' attribute + is given. + """ + e = engine.KmipEngine() + e._data_store = self.engine + e._data_store_session_factory = self.session_factory + e._data_session = e._data_store_session_factory() + e._is_allowed_by_operation_policy = mock.Mock(return_value=True) + e._logger = mock.MagicMock() + + key = ( + b'\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00' + ) + + obj_a = pie_objects.SymmetricKey( + enums.CryptographicAlgorithm.AES, + 128, + key, + name='name1' + ) + obj_b = pie_objects.SecretData( + key, + enums.SecretDataType.PASSWORD + ) + + e._data_session.add(obj_a) + e._data_session.add(obj_b) + e._data_session.commit() + e._data_session = e._data_store_session_factory() + + id_a = str(obj_a.unique_identifier) + id_b = str(obj_b.unique_identifier) + + attribute_factory = factory.AttributeFactory() + + # Locate the symmetric key object based on its unique identifier. + attrs = [ + attribute_factory.create_attribute( + enums.AttributeType.UNIQUE_IDENTIFIER, + id_a + ) + ] + payload = payloads.LocateRequestPayload(attributes=attrs) + e._logger.reset_mock() + response_payload = e._process_locate(payload) + e._data_session.commit() + e._data_session = e._data_store_session_factory() + + e._logger.info.assert_any_call("Processing operation: Locate") + e._logger.debug.assert_any_call( + "Locate filter matched object: {}".format(id_a) + ) + e._logger.debug.assert_any_call( + "Failed match: " + "the specified unique identifier ({}) does not match " + "the object's unique identifier ({}).".format(id_a, id_b) + ) + self.assertEqual(1, len(response_payload.unique_identifiers)) + self.assertIn(id_a, response_payload.unique_identifiers) + + attrs = [ + attribute_factory.create_attribute( + enums.AttributeType.UNIQUE_IDENTIFIER, + id_b + ) + ] + payload = payloads.LocateRequestPayload(attributes=attrs) + e._logger.reset_mock() + response_payload = e._process_locate(payload) + e._data_session.commit() + e._data_session = e._data_store_session_factory() + + e._logger.info.assert_any_call("Processing operation: Locate") + e._logger.debug.assert_any_call( + "Failed match: " + "the specified unique identifier ({}) does not match " + "the object's unique identifier ({}).".format(id_b, id_a) + ) + e._logger.debug.assert_any_call( + "Locate filter matched object: {}".format(id_b) + ) + self.assertEqual(1, len(response_payload.unique_identifiers)) + self.assertIn(id_b, response_payload.unique_identifiers) + + # Try to locate a non-existent object based on its cryptographic + # algorithm. + attrs = [ + attribute_factory.create_attribute( + enums.AttributeType.UNIQUE_IDENTIFIER, + "unknown" + ) + ] + payload = payloads.LocateRequestPayload(attributes=attrs) + e._logger.reset_mock() + response_payload = e._process_locate(payload) + e._data_session.commit() + e._data_session = e._data_store_session_factory() + + e._logger.info.assert_any_call("Processing operation: Locate") + e._logger.debug.assert_any_call( + "Failed match: " + "the specified unique identifier ({}) does not match " + "the object's unique identifier ({}).".format("unknown", id_a) + ) + e._logger.debug.assert_any_call( + "Failed match: " + "the specified unique identifier ({}) does not match " + "the object's unique identifier ({}).".format("unknown", id_b) + ) + self.assertEqual(0, len(response_payload.unique_identifiers)) + def test_get(self): """ Test that a Get request can be processed correctly.