0002-Issue-4701-RFE-Exclude-attributes-from-retro-changel.patch 10.5 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
From 1e1c2b23c35282481628af7e971ac683da334502 Mon Sep 17 00:00:00 2001
From: James Chapman <jachapma@redhat.com>
Date: Tue, 27 Apr 2021 17:00:15 +0100
Subject: [PATCH 02/12] Issue 4701 - RFE - Exclude attributes from retro
 changelog (#4723)

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: https://github.com/389ds/389-ds-base/issues/4701

Reviewed by: mreynolds389, droideck (Thanks folks)
---
 .../tests/suites/retrocl/basic_test.py        | 292 ++++++++++++++++++
 1 file changed, 292 insertions(+)
 create mode 100644 dirsrvtests/tests/suites/retrocl/basic_test.py

diff --git a/dirsrvtests/tests/suites/retrocl/basic_test.py b/dirsrvtests/tests/suites/retrocl/basic_test.py
new file mode 100644
index 000000000..112c73cb9
--- /dev/null
+++ b/dirsrvtests/tests/suites/retrocl/basic_test.py
@@ -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)
-- 
2.26.3