merge: branch 'bg/secret-agent-gi'

examples: add secret agent example in python/gi

https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/merge_requests/2166

examples/python/gi/secret-agent.py

@@ -0,0 +1,92 @@
+#!/usr/bin/env python
+# SPDX-License-Identifier: LGPL-2.1-or-later
+
+import gi
+
+gi.require_version("NM", "1.0")
+from gi.repository import GLib, NM, Gio
+
+# This example shows how to implement a very simple secret agent for
+# NetworkManager. The secret agent registers to the NM daemon and can
+# provide missing secrets like Wi-Fi or VPN passwords. Set environment
+# variable "LIBNM_CLIENT_DEBUG=trace" to enable libnm verbose logging.
+
+
+class SecretAgent(NM.SecretAgentOld):
+    def __init__(self):
+        super().__init__(identifier="MySecretAgent")
+        super().init()
+
+    def do_get_secrets(
+        self,
+        connection,
+        connection_path,
+        setting_name,
+        hints,
+        flags,
+        callback,
+        callback_data,
+    ):
+        print(
+            "get_secrets for '{}', interface '{}', setting '{}'".format(
+                connection.get_id(), connection.get_interface_name(), setting_name
+            )
+        )
+
+        # Implement here the logic to retrieve the secrets.
+        # As an example, we return a hardcoded Wi-Fi PSK.
+        if (
+            connection.get_connection_type() == "802-11-wireless"
+            and setting_name == "802-11-wireless-security"
+        ):
+            s_wifi = connection.get_setting_wireless()
+            ssid = NM.utils_ssid_to_utf8(s_wifi.get_ssid().get_data())
+
+            if ssid == "home":
+                secrets = GLib.Variant(
+                    "a{sa{sv}}",
+                    {
+                        "802-11-wireless-security": {
+                            "psk": GLib.Variant("s", "abcd1234")
+                        }
+                    },
+                )
+                print("Sending secrets {}".format(secrets))
+                callback(self, connection, secrets, None)
+                return
+
+        # We don't have the secret, NM will ask to another agent or fail
+        callback(
+            self,
+            connection,
+            None,
+            GLib.GError.new_literal(
+                NM.SecretAgentError.quark(),
+                "No secrets found",
+                NM.SecretAgentError.NOSECRETS,
+            ),
+        )
+
+    def do_cancel_get_secrets(self, connection_path, connection_name):
+        pass
+
+    def do_save_secrets(self, connection, connection_path, callback, callback_data):
+        # Implement this if you want to store "agent-owned" secrets
+        callback(self, connection, None)
+
+    def do_delete_secrets(self, connection, connection_path, callback, callback_data):
+        # Implement this if you want to store "agent-owned" secrets
+        callback(self, connection, None)
+
+
+def main():
+    agent = SecretAgent()
+    loop = GLib.MainLoop()
+    try:
+        loop.run()
+    except KeyboardInterrupt:
+        print("Exiting Secret Agent...")
+
+
+if __name__ == "__main__":
+    main()

src/libnm-client-public/nm-secret-agent-old.h

@@ -39,13 +39,13 @@ typedef struct {
  * note that this object will be unrefed after the callback has returned, use
  * g_object_ref()/g_object_unref() if you want to use this object after the callback
  * has returned
- * @secrets: the #GVariant of type %NM_VARIANT_TYPE_CONNECTION containing the requested
+ * @secrets: (nullable): the #GVariant of type %NM_VARIANT_TYPE_CONNECTION containing the requested
  * secrets (as created by nm_connection_to_dbus() for example).  Each key in @secrets
  * should be the name of a #NMSetting object (like "802-11-wireless-security")
  * and each value should be an %NM_VARIANT_TYPE_SETTING variant.  The sub-dicts
  * map string:value, where the string is the setting property name (like "psk")
  * and the value is the secret
- * @error: if the secrets request failed, give a descriptive error here
+ * @error: (nullable): if the secrets request failed, give a descriptive error here
  * @user_data: caller-specific data to be passed to the function
  *
  * Called as a result of a request by NM to retrieve secrets.  When the
@@ -90,7 +90,7 @@ typedef void (*NMSecretAgentOldGetSecretsFunc)(NMSecretAgentOld *agent,
  * note that this object will be unrefed after the callback has returned, use
  * g_object_ref()/g_object_unref() if you want to use this object after the callback
  * has returned
- * @error: if the saving secrets failed, give a descriptive error here
+ * @error: (nullable): if the saving secrets failed, give a descriptive error here
  * @user_data: caller-specific data to be passed to the function
  *
  * Called as a result of a request by NM to save secrets.  When the
@@ -109,7 +109,7 @@ typedef void (*NMSecretAgentOldSaveSecretsFunc)(NMSecretAgentOld *agent,
  * note that this object will be unrefed after the callback has returned, use
  * g_object_ref()/g_object_unref() if you want to use this object after the callback
  * has returned
- * @error: if the deleting secrets failed, give a descriptive error here
+ * @error: (nullable): if the deleting secrets failed, give a descriptive error here
  * @user_data: caller-specific data to be passed to the function
  *
  * Called as a result of a request by NM to delete secrets.  When the