You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@allura.apache.org by cc...@apache.org on 2026/08/31 19:28:58 UTC

(allura) 02/03: fixup! [#8617] Update User's set_tool_data to store encrypted tool data values

This is an automated email from the ASF dual-hosted git repository.

asf-gitbox-commits pushed a commit to branch cc/8617-part2
in repository https://gitbox.apache.org/repos/asf/allura.git

commit 67f7e24d3fdebd181e9e77c46b4304addc21029f
Author: Carlos Cruz <ca...@slashdotmedia.com>
AuthorDate: Mon Aug 31 11:18:33 2026 -0600

    fixup! [#8617] Update User's set_tool_data to store encrypted tool data values
---
 Allura/allura/model/auth.py                        | 22 ++++---
 Allura/allura/tests/model/test_auth.py             | 69 ++++++++++++++++------
 .../tests/scripts/test_convert_encrypted_field.py  |  8 +--
 3 files changed, 69 insertions(+), 30 deletions(-)

diff --git a/Allura/allura/model/auth.py b/Allura/allura/model/auth.py
index cdc1ba90e..6a6cafe18 100644
--- a/Allura/allura/model/auth.py
+++ b/Allura/allura/model/auth.py
@@ -785,21 +785,27 @@ def by_username(cls, name):
             return user
         return plugin.AuthenticationProvider.get(request).by_username(name)
 
-    def get_tool_data(self, tool, key, default=None):
-        result = self.tool_data.get(tool, {}).get(key, default)
+    def get_tool_data(self, tool, key, default=None, *, decrypt=False):
+        tool_data = self.tool_data.get(tool, {})
+        encrypted_key = f'{key}_encrypted'
+        if decrypt and encrypted_key in tool_data:
+            result = self.decr(tool_data[encrypted_key])
+        else:
+            result = tool_data.get(key, default)
         if hasattr(result, '_deinstrument'):
             return result._deinstrument()
         else:
             return result
 
-    def set_tool_data(self, tool, *, encrypt=False, **kw):
+    def set_tool_data(self, tool, *, encrypt=False, store_plaintext=True, **kw):
         d = self.tool_data.setdefault(tool, {})
-        d.update(kw)
+        if store_plaintext:
+            d.update(kw)
         if encrypt:
-            d.update({
-                f'{key}_encrypted': self.encr(value)
-                for key, value in kw.items()
-            })
+            for key, value in kw.items():
+                d[f'{key}_encrypted'] = self.encr(value)
+                if not store_plaintext:
+                    d.pop(key, None)
         state(self).soil()
 
     def address_object(self, addr):
diff --git a/Allura/allura/tests/model/test_auth.py b/Allura/allura/tests/model/test_auth.py
index e11f7418d..e41e36c1c 100644
--- a/Allura/allura/tests/model/test_auth.py
+++ b/Allura/allura/tests/model/test_auth.py
@@ -497,31 +497,64 @@ def test_preference_email_address_updates_encrypted_field(self):
     def test_set_tool_data_can_dual_write_encrypted_values(self):
         user = M.User(
             username='tool-data-encrypted-setter-test',
-            tool_data={'sfx': {'unrelated': 'keep'}},
+            tool_data={'test_tool': {'unrelated': 'keep'}},
         )
         user.set_tool_data(
-            'sfx',
+            'test_tool',
             encrypt=True,
-            registration_ip='198.51.100.12',
-            registration_rdns=None,
-            normalized_email='',
+            store_plaintext=True,
+            field='field value',
+            optional_field=None,
+            empty_field='',
         )
-        user.set_tool_data('temp_reg_fields', encrypt=True, phone_ext='104')
-        user.set_tool_data('sfx', registration_ua='TestBrowser/1.0')
+        user.set_tool_data(
+            'other_tool', encrypt=True, store_plaintext=True, field='another field value')
+        user.set_tool_data('test_tool', public_value='public value')
         ThreadLocalODMSession.flush_all()
 
         tool_data = state(user).document['tool_data']
-        assert tool_data['sfx']['registration_ip'] == '198.51.100.12'
-        assert tool_data['sfx']['registration_ip_encrypted'] == M.User.encr('198.51.100.12')
-        assert tool_data['sfx']['registration_rdns'] is None
-        assert tool_data['sfx']['registration_rdns_encrypted'] is None
-        assert tool_data['sfx']['normalized_email'] == ''
-        assert tool_data['sfx']['normalized_email_encrypted'] == M.User.encr('')
-        assert tool_data['temp_reg_fields']['phone_ext'] == '104'
-        assert tool_data['temp_reg_fields']['phone_ext_encrypted'] == M.User.encr('104')
-        assert tool_data['sfx']['registration_ua'] == 'TestBrowser/1.0'
-        assert 'registration_ua_encrypted' not in tool_data['sfx']
-        assert tool_data['sfx']['unrelated'] == 'keep'
+        assert tool_data['test_tool']['field'] == 'field value'
+        assert tool_data['test_tool']['field_encrypted'] == M.User.encr('field value')
+        assert tool_data['test_tool']['optional_field'] is None
+        assert tool_data['test_tool']['optional_field_encrypted'] is None
+        assert tool_data['test_tool']['empty_field'] == ''
+        assert tool_data['test_tool']['empty_field_encrypted'] == M.User.encr('')
+        assert tool_data['other_tool']['field'] == 'another field value'
+        assert tool_data['other_tool']['field_encrypted'] == M.User.encr('another field value')
+        assert tool_data['test_tool']['public_value'] == 'public value'
+        assert 'public_value_encrypted' not in tool_data['test_tool']
+        assert tool_data['test_tool']['unrelated'] == 'keep'
+
+    def test_set_tool_data_can_store_only_encrypted_values(self):
+        user = M.User(
+            username='tool-data-encrypted-only-setter-test',
+            tool_data={'test_tool': {'field': 'old field'}},
+        )
+
+        user.set_tool_data(
+            'test_tool',
+            encrypt=True,
+            store_plaintext=False,
+            field='new field',
+        )
+        ThreadLocalODMSession.flush_all()
+
+        tool_data = state(user).document['tool_data']['test_tool']
+        assert 'field' not in tool_data
+        assert tool_data['field_encrypted'] == M.User.encr('new field')
+
+    def test_get_tool_data_can_decrypt_encrypted_value(self):
+        user = M.User(
+            username='tool-data-encrypted-getter-test',
+            tool_data={'test_tool': {
+                'field': 'old field',
+                'field_encrypted': M.User.encr('new field'),
+            }},
+        )
+
+        assert user.get_tool_data('test_tool', 'field') == 'old field'
+        assert user.get_tool_data(
+            'test_tool', 'field', decrypt=True) == 'new field'
 
     def test_personal_data_fields_are_stored_encrypted_on_creation(self):
         user = M.User(
diff --git a/Allura/allura/tests/scripts/test_convert_encrypted_field.py b/Allura/allura/tests/scripts/test_convert_encrypted_field.py
index 1af6d4e88..9ede77ad5 100644
--- a/Allura/allura/tests/scripts/test_convert_encrypted_field.py
+++ b/Allura/allura/tests/scripts/test_convert_encrypted_field.py
@@ -74,8 +74,8 @@ class PreMigrationTestModel:
 def test_encryption_schema_info_supports_opted_in_dynamic_field():
     field_schema, traverses_array = _encryption_schema_info(
         DynamicToolDataModel,
-        'tool_data.sfx.registration_ip',
-        'tool_data.sfx.registration_ip_encrypted',
+        'tool_data.test_tool.field',
+        'tool_data.test_tool.field_encrypted',
         encrypt_dynamic_field=True,
     )
 
@@ -87,8 +87,8 @@ def test_encryption_schema_info_rejects_dynamic_field_without_opt_in():
     with pytest.raises(AssertionError, match='--encrypt-dynamic-field'):
         _encryption_schema_info(
             DynamicToolDataModel,
-            'tool_data.sfx.registration_ip',
-            'tool_data.sfx.registration_ip_encrypted',
+            'tool_data.test_tool.field',
+            'tool_data.test_tool.field_encrypted',
         )