Skip to content

Fix: avoid mutating device.name in _get_common_name #1300

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
k-sumayya wants to merge 3 commits into
base: master
Choose a base branch
from
+5 −3
Open

Fix: avoid mutating device.name in _get_common_name #1300

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
46acb5f
[fix] Avoid mutating device.name in _get_common_name #1300
k-sumayya Mar 19, 2026
520e8a0
[fix] Add regression test for _get_common_name #1300
k-sumayya Jun 13, 2026
715c852
Merge branch 'master' into fix-common-name-bug
k-sumayya Jun 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions openwisp_controller/config/base/vpn.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -892,12 +892,12 @@ def _get_common_name(self):
"""
d = self.config.device
end = 63 - len(d.mac_address)
d.name = d.name[:end]
name = d.name[:end]
unique_slug = shortuuid.ShortUUID().random(length=8)
cn_format = app_settings.COMMON_NAME_FORMAT
if cn_format == "{mac_address}-{name}" and d.name == d.mac_address:
if cn_format == "{mac_address}-{name}" and name == d.mac_address:
cn_format = "{mac_address}"
common_name = cn_format.format(**d.__dict__)[:55]
common_name = cn_format.format(**{**d.__dict__, "name": name})[:55]
common_name = f"{common_name}-{unique_slug}"
return common_name

Expand Down
2 changes: 2 additions & 0 deletions openwisp_controller/config/tests/test_vpn.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -413,6 +413,8 @@ def test_auto_create_cert_with_long_device_name(self):
)
client.full_clean()
client.save()
# Ensure _get_common_name does not mutate device.name
self.assertEqual(d.name, device_name)
# The last 9 characters gets truncated and replaced with unique id
self.assertIn(
"{mac_address}-{name}".format(**d.__dict__)[:-9], client._get_common_name()
Expand Down
Loading