def test_repr(self):
"""
Test that repr can be applied to a SecretData.
"""
key = SecretData(self.bytes_a, enums.SecretDataType.PASSWORD)
args = "value={0}, data_type={1}".format(
binascii.hexlify(self.bytes_a), enums.SecretDataType.PASSWORD)
expected = "SecretData({0})".format(args)
observed = repr(key)
self.assertEqual(expected, observed)
def test_init(self):
"""
Test that a SecretData object can be instantiated.
"""
secret = SecretData(self.bytes_a, enums.SecretDataType.PASSWORD)
self.assertEqual(secret.value, self.bytes_a)
self.assertEqual(secret.data_type, enums.SecretDataType.PASSWORD)
self.assertEqual(secret.cryptographic_usage_masks, list())
self.assertEqual(secret.names, ['Secret Data'])
def test_save(self):
"""
Test that the object can be saved using SQLAlchemy. This will add it to
the database, verify that no exceptions are thrown, and check that its
unique identifier was set.
"""
obj = SecretData(self.bytes_a, enums.SecretDataType.PASSWORD)
Session = sessionmaker(bind=self.engine)
session = Session()
session.add(obj)
session.commit()
def test_init_with_args(self):
"""
Test that a SecretData object can be instantiated with all arguments.
"""
key = SecretData(self.bytes_a,
enums.SecretDataType.PASSWORD,
masks=[enums.CryptographicUsageMask.VERIFY],
name='Test Secret Data')
self.assertEqual(key.value, self.bytes_a)
self.assertEqual(key.data_type, enums.SecretDataType.PASSWORD)
self.assertEqual(key.cryptographic_usage_masks,
[enums.CryptographicUsageMask.VERIFY])
self.assertEqual(key.names, ['Test Secret Data'])
def _register_secret_data(self, key, conn):
# Create key on the KMIP Server
secret_data = SecretData(key.encode(), enums.SecretDataType.PASSWORD)
try:
uid = conn.register(secret_data)
except KmipOperationFailure as e:
raise CallError(f'Failed to register key with KMIP server: {e}')
else:
try:
conn.activate(uid)
except KmipOperationFailure as e:
error = f'Failed to activate key: {e}'
try:
self._destroy_key(uid, conn)
except CallError as ce:
error += f'\nFailed to destroy created key: {ce}'
raise CallError(error)
return uid
def test_update_with_remove_and_add_name(self):
"""
Tests that a SecretData already stored in the database can be
updated. This will store a SecretData in the database. It will
remove a name and add another one to it in one session, and then
retrieve it in another session to verify that it has all of the correct
names. This simulates multiple operation being sent for the same
object.
"""
names = ['bowser', 'frumpy', 'big fat cat']
obj = SecretData(self.bytes_a,
enums.SecretDataType.PASSWORD,
name=names[0])
obj.names.append(names[1])
obj.names.append(names[2])
Session = sessionmaker(bind=self.engine)
session = Session()
session.add(obj)
session.commit()
session = Session()
update_obj = session.query(SecretData).filter(
ManagedObject.unique_identifier == obj.unique_identifier).one()
update_obj.names.pop()
update_obj.names.pop()
update_obj.names.append('dog')
session.commit()
expected_names = ['bowser', 'dog']
expected_mo_names = list()
expected_mo_names.append(
sqltypes.ManagedObjectName(expected_names[0], 0))
expected_mo_names.append(
sqltypes.ManagedObjectName(expected_names[1], 3))
session = Session()
get_obj = session.query(SecretData).filter(
ManagedObject.unique_identifier == obj.unique_identifier).one()
session.commit()
self.assertEquals(expected_names, get_obj.names)
self.assertEquals(expected_mo_names, get_obj._names)
def test_update_with_remove_name(self):
"""
Tests that a SecretData already stored in the database can be
updated. This will store a SecretData in the database. It will
remove a name from it in one session, and then retrieve it in another
session to verify that it has all of the correct names.
"""
names = ['bowser', 'frumpy', 'big fat cat']
remove_index = 1
obj = SecretData(self.bytes_a,
enums.SecretDataType.PASSWORD,
name=names[0])
obj.names.append(names[1])
obj.names.append(names[2])
Session = sessionmaker(bind=self.engine)
session = Session()
session.add(obj)
session.commit()
expected_names = list()
expected_mo_names = list()
for i, name in enumerate(names):
if i != remove_index:
expected_names.append(name)
expected_mo_names.append(sqltypes.ManagedObjectName(name, i))
session = Session()
update_obj = session.query(SecretData).filter(
ManagedObject.unique_identifier == obj.unique_identifier).one()
update_obj.names.pop(remove_index)
session.commit()
session = Session()
get_obj = session.query(SecretData).filter(
ManagedObject.unique_identifier == obj.unique_identifier).one()
session.commit()
self.assertEquals(expected_names, get_obj.names)
self.assertEquals(expected_mo_names, get_obj._names)
def test_update_with_add_name(self):
"""
Tests that a SecretData already stored in the database can be
updated. This will store a SecretData in the database. It will add a
name to it in one session, and then retrieve it in another session to
verify that it has all of the correct names.
This test and the subsequent test_udpate_* methods are different than
the name tests above because these are updating objects already stored
in the database. This tests will simulate what happens when the KMIP
client calls an add attribute method.
"""
first_name = 'bowser'
obj = SecretData(self.bytes_a,
enums.SecretDataType.PASSWORD,
name=first_name)
Session = sessionmaker(bind=self.engine)
session = Session()
session.add(obj)
session.commit()
added_name = 'frumpy'
expected_names = [first_name, added_name]
expected_mo_names = list()
for i, name in enumerate(expected_names):
expected_mo_names.append(sqltypes.ManagedObjectName(name, i))
session = Session()
update_obj = session.query(SecretData).filter(
ManagedObject.unique_identifier == obj.unique_identifier).one()
update_obj.names.append(added_name)
session.commit()
session = Session()
get_obj = session.query(SecretData).filter(
ManagedObject.unique_identifier == obj.unique_identifier).one()
session.commit()
self.assertEquals(expected_names, get_obj.names)
self.assertEquals(expected_mo_names, get_obj._names)
def test_remove_and_add_name(self):
"""
Tests that names can be removed from the list of names and more added.
This will verify that the list of names is correct. It will verify that
updating this object removes the name from the database. It will verify
that the indices for the removed names are not reused.
"""
names = ['bowser', 'frumpy', 'big fat cat']
obj = SecretData(self.bytes_a,
enums.SecretDataType.PASSWORD,
name=names[0])
obj.names.append(names[1])
obj.names.append(names[2])
obj.names.pop()
obj.names.pop()
obj.names.append('dog')
self.assertEquals(4, obj.name_index)
expected_names = ['bowser', 'dog']
expected_mo_names = list()
expected_mo_names.append(
sqltypes.ManagedObjectName(expected_names[0], 0))
expected_mo_names.append(
sqltypes.ManagedObjectName(expected_names[1], 3))
self.assertEquals(expected_names, obj.names)
self.assertEquals(expected_mo_names, obj._names)
Session = sessionmaker(bind=self.engine)
session = Session()
session.add(obj)
session.commit()
session = Session()
get_obj = session.query(SecretData).filter(
ManagedObject.unique_identifier == obj.unique_identifier).one()
session.commit()
self.assertEquals(expected_names, get_obj.names)
self.assertEquals(expected_mo_names, get_obj._names)
def test_remove_name(self):
"""
Tests that a name can be removed from the list of names. This will
verify that the list of names is correct. It will verify that updating
this object removes the name from the database.
"""
names = ['bowser', 'frumpy', 'big fat cat']
remove_index = 1
obj = SecretData(self.bytes_a,
enums.SecretDataType.PASSWORD,
name=names[0])
obj.names.append(names[1])
obj.names.append(names[2])
obj.names.pop(remove_index)
self.assertEquals(3, obj.name_index)
expected_names = list()
expected_mo_names = list()
for i, name in enumerate(names):
if i != remove_index:
expected_names.append(name)
expected_mo_names.append(sqltypes.ManagedObjectName(name, i))
self.assertEquals(expected_names, obj.names)
self.assertEquals(expected_mo_names, obj._names)
Session = sessionmaker(bind=self.engine)
session = Session()
session.add(obj)
session.commit()
session = Session()
get_obj = session.query(SecretData).filter(
ManagedObject.unique_identifier == obj.unique_identifier).one()
session.commit()
self.assertEquals(expected_names, get_obj.names)
self.assertEquals(expected_mo_names, get_obj._names)
def test_get(self):
"""
Test that the object can be saved and then retrieved using SQLAlchemy.
This adds is to the database and then retrieves it by ID and verifies
some of the attributes.
"""
test_name = 'bowser'
obj = SecretData(self.bytes_a,
enums.SecretDataType.PASSWORD,
name=test_name)
Session = sessionmaker(bind=self.engine)
session = Session()
session.add(obj)
session.commit()
session = Session()
get_obj = session.query(SecretData).filter(
ManagedObject.unique_identifier == obj.unique_identifier).one()
session.commit()
self.assertEqual(1, len(get_obj.names))
self.assertEqual([test_name], get_obj.names)
self.assertEqual(self.bytes_a, get_obj.value)
self.assertEqual(enums.ObjectType.SECRET_DATA, get_obj.object_type)
self.assertEqual(enums.SecretDataType.PASSWORD, get_obj.data_type)