Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
…4746) Description: When the retro changelog plugin is enabled it writes the added/modified values to the "cn-changelog" suffix. In some cases an entries attribute values can be of a sensitive nature and should be excluded. This RFE adds functionality that will allow an admin exclude certain attributes from the retro changelog DB. Relates: #4701 Reviewed by: mreynolds389, droideck (Thanks folks)
- Loading branch information
Showing
5 changed files
with
366 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,292 @@ | ||
| # --- BEGIN COPYRIGHT BLOCK --- | ||
| # Copyright (C) 2021 Red Hat, Inc. | ||
| # All rights reserved. | ||
| # | ||
| # License: GPL (version 3 or any later version). | ||
| # See LICENSE for details. | ||
| # --- END COPYRIGHT BLOCK --- | ||
|
|
||
| import logging | ||
| import ldap | ||
| import time | ||
| import pytest | ||
| from lib389.topologies import topology_st | ||
| from lib389.plugins import RetroChangelogPlugin | ||
| from lib389._constants import * | ||
| from lib389.utils import * | ||
| from lib389.tasks import * | ||
| from lib389.cli_base import FakeArgs, connect_instance, disconnect_instance | ||
| from lib389.cli_base.dsrc import dsrc_arg_concat | ||
| from lib389.cli_conf.plugins.retrochangelog import retrochangelog_add | ||
| from lib389.idm.user import UserAccount, UserAccounts, nsUserAccounts | ||
|
|
||
| pytestmark = pytest.mark.tier1 | ||
|
|
||
| USER1_DN = 'uid=user1,ou=people,'+ DEFAULT_SUFFIX | ||
| USER2_DN = 'uid=user2,ou=people,'+ DEFAULT_SUFFIX | ||
| USER_PW = 'password' | ||
| ATTR_HOMEPHONE = 'homePhone' | ||
| ATTR_CARLICENSE = 'carLicense' | ||
|
|
||
| log = logging.getLogger(__name__) | ||
|
|
||
| def test_retrocl_exclude_attr_add(topology_st): | ||
| """ Test exclude attribute feature of the retrocl plugin for add operation | ||
| :id: 3481650f-2070-45ef-9600-2500cfc51559 | ||
| :setup: Standalone instance | ||
| :steps: | ||
| 1. Enable dynamic plugins | ||
| 2. Confige retro changelog plugin | ||
| 3. Add an entry | ||
| 4. Ensure entry attrs are in the changelog | ||
| 5. Exclude an attr | ||
| 6. Add another entry | ||
| 7. Ensure excluded attr is not in the changelog | ||
| :expectedresults: | ||
| 1. Success | ||
| 2. Success | ||
| 3. Success | ||
| 4. Success | ||
| 5. Success | ||
| 6. Success | ||
| 7. Success | ||
| """ | ||
|
|
||
| st = topology_st.standalone | ||
|
|
||
| log.info('Enable dynamic plugins') | ||
| try: | ||
| st.config.set('nsslapd-dynamic-plugins', 'on') | ||
| except ldap.LDAPError as e: | ||
| ldap.error('Failed to enable dynamic plugins ' + e.args[0]['desc']) | ||
| assert False | ||
|
|
||
| log.info('Configure retrocl plugin') | ||
| rcl = RetroChangelogPlugin(st) | ||
| rcl.disable() | ||
| rcl.enable() | ||
| rcl.replace('nsslapd-attribute', 'nsuniqueid:targetUniqueId') | ||
|
|
||
| log.info('Restarting instance') | ||
| try: | ||
| st.restart() | ||
| except ldap.LDAPError as e: | ||
| ldap.error('Failed to restart instance ' + e.args[0]['desc']) | ||
| assert False | ||
|
|
||
| users = UserAccounts(st, DEFAULT_SUFFIX) | ||
|
|
||
| log.info('Adding user1') | ||
| try: | ||
| user1 = users.create(properties={ | ||
| 'sn': '1', | ||
| 'cn': 'user 1', | ||
| 'uid': 'user1', | ||
| 'uidNumber': '11', | ||
| 'gidNumber': '111', | ||
| 'givenname': 'user1', | ||
| 'homePhone': '0861234567', | ||
| 'carLicense': '131D16674', | ||
| 'mail': 'user1@whereever.com', | ||
| 'homeDirectory': '/home/user1', | ||
| 'userpassword': USER_PW}) | ||
| except ldap.ALREADY_EXISTS: | ||
| pass | ||
| except ldap.LDAPError as e: | ||
| log.error("Failed to add user1") | ||
|
|
||
| log.info('Verify homePhone and carLicense attrs are in the changelog changestring') | ||
| try: | ||
| cllist = st.search_s(RETROCL_SUFFIX, ldap.SCOPE_SUBTREE, '(targetDn=%s)' % USER1_DN) | ||
| except ldap.LDAPError as e: | ||
| log.fatal("Changelog search failed, error: " +str(e)) | ||
| assert False | ||
| assert len(cllist) > 0 | ||
| if cllist[0].hasAttr('changes'): | ||
| clstr = (cllist[0].getValue('changes')).decode() | ||
| assert ATTR_HOMEPHONE in clstr | ||
| assert ATTR_CARLICENSE in clstr | ||
|
|
||
| log.info('Excluding attribute ' + ATTR_HOMEPHONE) | ||
| args = FakeArgs() | ||
| args.connections = [st.host + ':' + str(st.port) + ':' + DN_DM + ':' + PW_DM] | ||
| args.instance = 'standalone1' | ||
| args.basedn = None | ||
| args.binddn = None | ||
| args.starttls = False | ||
| args.pwdfile = None | ||
| args.bindpw = None | ||
| args.prompt = False | ||
| args.exclude_attrs = ATTR_HOMEPHONE | ||
| args.func = retrochangelog_add | ||
| dsrc_inst = dsrc_arg_concat(args, None) | ||
| inst = connect_instance(dsrc_inst, False, args) | ||
| result = args.func(inst, None, log, args) | ||
| disconnect_instance(inst) | ||
| assert result is None | ||
|
|
||
| log.info("5s delay for retrocl plugin to restart") | ||
| time.sleep(5) | ||
|
|
||
| log.info('Adding user2') | ||
| try: | ||
| user2 = users.create(properties={ | ||
| 'sn': '2', | ||
| 'cn': 'user 2', | ||
| 'uid': 'user2', | ||
| 'uidNumber': '22', | ||
| 'gidNumber': '222', | ||
| 'givenname': 'user2', | ||
| 'homePhone': '0879088363', | ||
| 'carLicense': '04WX11038', | ||
| 'mail': 'user2@whereever.com', | ||
| 'homeDirectory': '/home/user2', | ||
| 'userpassword': USER_PW}) | ||
| except ldap.ALREADY_EXISTS: | ||
| pass | ||
| except ldap.LDAPError as e: | ||
| log.error("Failed to add user2") | ||
|
|
||
| log.info('Verify homePhone attr is not in the changelog changestring') | ||
| try: | ||
| cllist = st.search_s(RETROCL_SUFFIX, ldap.SCOPE_SUBTREE, '(targetDn=%s)' % USER2_DN) | ||
| assert len(cllist) > 0 | ||
| if cllist[0].hasAttr('changes'): | ||
| clstr = (cllist[0].getValue('changes')).decode() | ||
| assert ATTR_HOMEPHONE not in clstr | ||
| assert ATTR_CARLICENSE in clstr | ||
| except ldap.LDAPError as e: | ||
| log.fatal("Changelog search failed, error: " +str(e)) | ||
| assert False | ||
|
|
||
| def test_retrocl_exclude_attr_mod(topology_st): | ||
| """ Test exclude attribute feature of the retrocl plugin for mod operation | ||
| :id: f6bef689-685b-4f86-a98d-f7e6b1fcada3 | ||
| :setup: Standalone instance | ||
| :steps: | ||
| 1. Enable dynamic plugins | ||
| 2. Confige retro changelog plugin | ||
| 3. Add user1 entry | ||
| 4. Ensure entry attrs are in the changelog | ||
| 5. Exclude an attr | ||
| 6. Modify user1 entry | ||
| 7. Ensure excluded attr is not in the changelog | ||
| :expectedresults: | ||
| 1. Success | ||
| 2. Success | ||
| 3. Success | ||
| 4. Success | ||
| 5. Success | ||
| 6. Success | ||
| 7. Success | ||
| """ | ||
|
|
||
| st = topology_st.standalone | ||
|
|
||
| log.info('Enable dynamic plugins') | ||
| try: | ||
| st.config.set('nsslapd-dynamic-plugins', 'on') | ||
| except ldap.LDAPError as e: | ||
| ldap.error('Failed to enable dynamic plugins ' + e.args[0]['desc']) | ||
| assert False | ||
|
|
||
| log.info('Configure retrocl plugin') | ||
| rcl = RetroChangelogPlugin(st) | ||
| rcl.disable() | ||
| rcl.enable() | ||
| rcl.replace('nsslapd-attribute', 'nsuniqueid:targetUniqueId') | ||
|
|
||
| log.info('Restarting instance') | ||
| try: | ||
| st.restart() | ||
| except ldap.LDAPError as e: | ||
| ldap.error('Failed to restart instance ' + e.args[0]['desc']) | ||
| assert False | ||
|
|
||
| users = UserAccounts(st, DEFAULT_SUFFIX) | ||
|
|
||
| log.info('Adding user1') | ||
| try: | ||
| user1 = users.create(properties={ | ||
| 'sn': '1', | ||
| 'cn': 'user 1', | ||
| 'uid': 'user1', | ||
| 'uidNumber': '11', | ||
| 'gidNumber': '111', | ||
| 'givenname': 'user1', | ||
| 'homePhone': '0861234567', | ||
| 'carLicense': '131D16674', | ||
| 'mail': 'user1@whereever.com', | ||
| 'homeDirectory': '/home/user1', | ||
| 'userpassword': USER_PW}) | ||
| except ldap.ALREADY_EXISTS: | ||
| pass | ||
| except ldap.LDAPError as e: | ||
| log.error("Failed to add user1") | ||
|
|
||
| log.info('Verify homePhone and carLicense attrs are in the changelog changestring') | ||
| try: | ||
| cllist = st.search_s(RETROCL_SUFFIX, ldap.SCOPE_SUBTREE, '(targetDn=%s)' % USER1_DN) | ||
| except ldap.LDAPError as e: | ||
| log.fatal("Changelog search failed, error: " +str(e)) | ||
| assert False | ||
| assert len(cllist) > 0 | ||
| if cllist[0].hasAttr('changes'): | ||
| clstr = (cllist[0].getValue('changes')).decode() | ||
| assert ATTR_HOMEPHONE in clstr | ||
| assert ATTR_CARLICENSE in clstr | ||
|
|
||
| log.info('Excluding attribute ' + ATTR_CARLICENSE) | ||
| args = FakeArgs() | ||
| args.connections = [st.host + ':' + str(st.port) + ':' + DN_DM + ':' + PW_DM] | ||
| args.instance = 'standalone1' | ||
| args.basedn = None | ||
| args.binddn = None | ||
| args.starttls = False | ||
| args.pwdfile = None | ||
| args.bindpw = None | ||
| args.prompt = False | ||
| args.exclude_attrs = ATTR_CARLICENSE | ||
| args.func = retrochangelog_add | ||
| dsrc_inst = dsrc_arg_concat(args, None) | ||
| inst = connect_instance(dsrc_inst, False, args) | ||
| result = args.func(inst, None, log, args) | ||
| disconnect_instance(inst) | ||
| assert result is None | ||
|
|
||
| log.info("5s delay for retrocl plugin to restart") | ||
| time.sleep(5) | ||
|
|
||
| log.info('Modify user1 carLicense attribute') | ||
| try: | ||
| st.modify_s(USER1_DN, [(ldap.MOD_REPLACE, ATTR_CARLICENSE, b"123WX321")]) | ||
| except ldap.LDAPError as e: | ||
| log.fatal('test_retrocl_exclude_attr_mod: Failed to update user1 attribute: error ' + e.message['desc']) | ||
| assert False | ||
|
|
||
| log.info('Verify carLicense attr is not in the changelog changestring') | ||
| try: | ||
| cllist = st.search_s(RETROCL_SUFFIX, ldap.SCOPE_SUBTREE, '(targetDn=%s)' % USER1_DN) | ||
| assert len(cllist) > 0 | ||
| # There will be 2 entries in the changelog for this user, we are only | ||
| #interested in the second one, the modify operation. | ||
| if cllist[1].hasAttr('changes'): | ||
| clstr = (cllist[1].getValue('changes')).decode() | ||
| assert ATTR_CARLICENSE not in clstr | ||
| except ldap.LDAPError as e: | ||
| log.fatal("Changelog search failed, error: " +str(e)) | ||
| assert False | ||
|
|
||
| if __name__ == '__main__': | ||
| # Run isolated | ||
| # -s for DEBUG mode | ||
| CURRENT_FILE = os.path.realpath(__file__) | ||
| pytest.main("-s %s" % CURRENT_FILE) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.