Added secret_fields_names attribute to settings

igo95862 · igo95862 · commit 4cd0cb15fc76 · 2022-12-17T20:57:39.000+03:00
It contains the names of the fields that are secret and must
be fetched separately.
diff --git a/sdbus_async/networkmanager/settings/adsl.py b/sdbus_async/networkmanager/settings/adsl.py
@@ -3,13 +3,14 @@
 # if possible, please make changes by also updating the script.
 from __future__ import annotations
 from dataclasses import dataclass, field
-from typing import Optional
+from typing import ClassVar, List, Optional
 from .base import NetworkManagerSettingsMixin
 
 
 @dataclass
 class AdslSettings(NetworkManagerSettingsMixin):
     """ADSL Settings"""
+    secret_fields_names: ClassVar[List[str]] = ['password']
 
     encapsulation: Optional[str] = field(
         metadata={
diff --git a/sdbus_async/networkmanager/settings/base.py b/sdbus_async/networkmanager/settings/base.py
@@ -1,14 +1,16 @@
+# SPDX-License-Identifier: LGPL-2.1-or-later
 from __future__ import annotations
+
 from dataclasses import fields
 from functools import lru_cache
-from typing import Any, Dict, Type, cast
+from typing import Any, ClassVar, Dict, List, Type, cast
 
-from ..types import (
-    NetworkManagerSettingsDomain,
-)
+from ..types import NetworkManagerSettingsDomain
 
 
 class NetworkManagerSettingsMixin:
+    secret_fields_names: ClassVar[List[str]] = []
+
     def to_dbus(self) -> NetworkManagerSettingsDomain:
         """Return a dbus dictionary for NetworkManager to add/update profiles
 
diff --git a/sdbus_async/networkmanager/settings/cdma.py b/sdbus_async/networkmanager/settings/cdma.py
@@ -3,13 +3,14 @@
 # if possible, please make changes by also updating the script.
 from __future__ import annotations
 from dataclasses import dataclass, field
-from typing import Optional
+from typing import ClassVar, List, Optional
 from .base import NetworkManagerSettingsMixin
 
 
 @dataclass
 class CdmaSettings(NetworkManagerSettingsMixin):
     """CDMA-based Mobile Broadband Settings"""
+    secret_fields_names: ClassVar[List[str]] = ['password']
 
     mtu: Optional[int] = field(
         metadata={
diff --git a/sdbus_async/networkmanager/settings/connection.py b/sdbus_async/networkmanager/settings/connection.py
@@ -3,13 +3,14 @@
 # if possible, please make changes by also updating the script.
 from __future__ import annotations
 from dataclasses import dataclass, field
-from typing import List, Optional
+from typing import ClassVar, List, Optional
 from .base import NetworkManagerSettingsMixin
 
 
 @dataclass
 class ConnectionSettings(NetworkManagerSettingsMixin):
     """General Connection Profile Settings"""
+    secret_fields_names: ClassVar[List[str]] = ['mptcp']
 
     auth_retries: Optional[int] = field(
         metadata={
diff --git a/sdbus_async/networkmanager/settings/dcb.py b/sdbus_async/networkmanager/settings/dcb.py
@@ -3,13 +3,14 @@
 # if possible, please make changes by also updating the script.
 from __future__ import annotations
 from dataclasses import dataclass, field
-from typing import List, Optional
+from typing import ClassVar, List, Optional
 from .base import NetworkManagerSettingsMixin
 
 
 @dataclass
 class DcbSettings(NetworkManagerSettingsMixin):
     """Data Center Bridging Settings"""
+    secret_fields_names: ClassVar[List[str]] = ['app_fcoe', 'app_fip', 'app_iscsi', 'priority_flow_control', 'priority_group']
 
     app_fcoe_flags: Optional[int] = field(
         metadata={
diff --git a/sdbus_async/networkmanager/settings/eapol.py b/sdbus_async/networkmanager/settings/eapol.py
@@ -3,13 +3,14 @@
 # if possible, please make changes by also updating the script.
 from __future__ import annotations
 from dataclasses import dataclass, field
-from typing import List, Optional
+from typing import ClassVar, List, Optional
 from .base import NetworkManagerSettingsMixin
 
 
 @dataclass
 class EapolSettings(NetworkManagerSettingsMixin):
     """IEEE 802.1x Authentication Settings"""
+    secret_fields_names: ClassVar[List[str]] = ['ca_cert_password', 'client_cert_password', 'password', 'password_raw', 'phase1_auth', 'phase2_ca_cert_password', 'phase2_client_cert_password', 'phase2_private_key_password', 'pin', 'private_key_password']
 
     altsubject_matches: Optional[List[str]] = field(
         metadata={
diff --git a/sdbus_async/networkmanager/settings/gsm.py b/sdbus_async/networkmanager/settings/gsm.py
@@ -3,13 +3,14 @@
 # if possible, please make changes by also updating the script.
 from __future__ import annotations
 from dataclasses import dataclass, field
-from typing import Optional
+from typing import ClassVar, List, Optional
 from .base import NetworkManagerSettingsMixin
 
 
 @dataclass
 class GsmSettings(NetworkManagerSettingsMixin):
     """GSM-based Mobile Broadband Settings"""
+    secret_fields_names: ClassVar[List[str]] = ['password', 'pin']
 
     apn: Optional[str] = field(
         metadata={
diff --git a/sdbus_async/networkmanager/settings/ipv4.py b/sdbus_async/networkmanager/settings/ipv4.py
@@ -3,14 +3,15 @@
 # if possible, please make changes by also updating the script.
 from __future__ import annotations
 from dataclasses import dataclass, field
-from typing import Any, List, Optional, Tuple
+from typing import Any, ClassVar, List, Optional, Tuple
 from .base import NetworkManagerSettingsMixin
 from .datatypes import AddressData, RouteData, RoutingRules
 
 
 @dataclass
 class Ipv4Settings(NetworkManagerSettingsMixin):
     """IPv4 Settings"""
+    secret_fields_names: ClassVar[List[str]] = ['dhcp_hostname']
 
     address_data: Optional[List[AddressData]] = field(
         metadata={
diff --git a/sdbus_async/networkmanager/settings/ipv6.py b/sdbus_async/networkmanager/settings/ipv6.py
@@ -3,14 +3,15 @@
 # if possible, please make changes by also updating the script.
 from __future__ import annotations
 from dataclasses import dataclass, field
-from typing import Any, List, Optional, Tuple
+from typing import Any, ClassVar, List, Optional, Tuple
 from .base import NetworkManagerSettingsMixin
 from .datatypes import AddressData, RouteData, RoutingRules
 
 
 @dataclass
 class Ipv6Settings(NetworkManagerSettingsMixin):
     """IPv6 Settings"""
+    secret_fields_names: ClassVar[List[str]] = ['dhcp_hostname']
 
     addr_gen_mode: Optional[int] = field(
         metadata={
diff --git a/sdbus_async/networkmanager/settings/macsec.py b/sdbus_async/networkmanager/settings/macsec.py
@@ -3,13 +3,14 @@
 # if possible, please make changes by also updating the script.
 from __future__ import annotations
 from dataclasses import dataclass, field
-from typing import Optional
+from typing import ClassVar, List, Optional
 from .base import NetworkManagerSettingsMixin
 
 
 @dataclass
 class MacsecSettings(NetworkManagerSettingsMixin):
     """MACSec Settings"""
+    secret_fields_names: ClassVar[List[str]] = ['mka_cak']
 
     encrypt: Optional[bool] = field(
         metadata={
diff --git a/sdbus_async/networkmanager/settings/pppoe.py b/sdbus_async/networkmanager/settings/pppoe.py
@@ -3,13 +3,14 @@
 # if possible, please make changes by also updating the script.
 from __future__ import annotations
 from dataclasses import dataclass, field
-from typing import Optional
+from typing import ClassVar, List, Optional
 from .base import NetworkManagerSettingsMixin
 
 
 @dataclass
 class PppoeSettings(NetworkManagerSettingsMixin):
     """PPP-over-Ethernet Settings"""
+    secret_fields_names: ClassVar[List[str]] = ['password']
 
     parent: Optional[str] = field(
         metadata={
diff --git a/sdbus_async/networkmanager/settings/wireguard.py b/sdbus_async/networkmanager/settings/wireguard.py
@@ -3,14 +3,15 @@
 # if possible, please make changes by also updating the script.
 from __future__ import annotations
 from dataclasses import dataclass, field
-from typing import Any, List, Optional, Tuple
+from typing import Any, ClassVar, List, Optional, Tuple
 from .base import NetworkManagerSettingsMixin
 from .datatypes import WireguardPeers
 
 
 @dataclass
 class WireguardSettings(NetworkManagerSettingsMixin):
     """WireGuard Settings"""
+    secret_fields_names: ClassVar[List[str]] = ['private_key']
 
     fwmark: Optional[int] = field(
         metadata={
diff --git a/sdbus_async/networkmanager/settings/wireless_security.py b/sdbus_async/networkmanager/settings/wireless_security.py
@@ -3,13 +3,14 @@
 # if possible, please make changes by also updating the script.
 from __future__ import annotations
 from dataclasses import dataclass, field
-from typing import List, Optional
+from typing import ClassVar, List, Optional
 from .base import NetworkManagerSettingsMixin
 
 
 @dataclass
 class WirelessSecuritySettings(NetworkManagerSettingsMixin):
     """Wi-Fi Security Settings"""
+    secret_fields_names: ClassVar[List[str]] = ['leap_password', 'psk', 'wep_key']
 
     auth_alg: Optional[str] = field(
         metadata={
diff --git a/tools/generate-settings-dataclasses-jinja.py b/tools/generate-settings-dataclasses-jinja.py
@@ -21,7 +21,7 @@
 from re import Pattern
 from re import compile as regex_compile
 from textwrap import fill
-from typing import List, Optional
+from typing import List, Optional, Set
 from xml.etree.ElementTree import Element, parse
 
 from jinja2 import Environment, FileSystemLoader
@@ -125,7 +125,7 @@ def __init__(self, name: str,
 
         extra_typing = dbus_to_python_extra_typing_imports.get(dbus_type)
         if extra_typing is not None:
-            parent.typing_imports.update(extra_typing)
+            parent.properties_want_imports.update(extra_typing)
 
     @cached_property
     def python_type(self) -> str:
@@ -146,10 +146,19 @@ def __init__(self, name: str, description: str, name_upper: str,
         self.description = description
         self.name_upper = name_upper
 
-        self.typing_imports = {'Optional'}
-
+        self.properties_want_imports = {'Optional'}
         self.properties: List[NmSettingPropertyIntrospection] = []
 
+    @cached_property
+    def typing_imports(self) -> List[str]:
+        typing_imports: Set[str] = self.properties_want_imports.copy()
+
+        if self.secret_fields:
+            typing_imports.add('ClassVar')
+            typing_imports.add('List')
+
+        return typing_imports
+
     @cached_property
     def python_class_name(self) -> str:
 
@@ -188,6 +197,16 @@ def is_optional_setting(self) -> bool:
 
         return True
 
+    @cached_property
+    def secret_fields(self) -> List[str]:
+        secret_fields: List[str] = []
+
+        for x in self.properties:
+            if x.python_name.endswith('_flags') and x.python_type == 'int':
+                secret_fields.append(x.python_name.removesuffix('_flags'))
+
+        return secret_fields
+
 
 def extract_docbook_paragraphs(docbook_node: Element) -> List[str]:
     return [x.text for x in docbook_node]
diff --git a/tools/jinja_templates/setting.py.jinja2 b/tools/jinja_templates/setting.py.jinja2
@@ -12,6 +12,9 @@ from .datatypes import {{ setting.datatypes_imports|sort|join(', ') }}
 @dataclass
 class {{ setting.python_class_name }}(NetworkManagerSettingsMixin):
     """{{ setting.description }}"""
+{%- if setting.secret_fields %}
+    secret_fields_names: ClassVar[List[str]] = ['{{ setting.secret_fields|sort|join("', '") }}']
+{%- endif %}
 {% for property in setting.properties %}
     {{ property.python_name }}: Optional[{{ property.python_type }}] = field(
         metadata={
