Merge lp:~seb128/ubuntu-system-settings/bluetooth-simple-secure into lp:ubuntu-system-settings

[Sebastien Bacher]

bluetooth: implement simple secure pairing dialog

bluetooth: implement simple secure pairing dialog

[Sebastien Bacher (seb128)]

note that there is no design for that mode at the moment, the current UI is inspired from what the desktop is doing

[Charles Kerr (charlesk)]

I can't do a real-world test with this because I don't have a bluetooth device that triggers this, but wrt reviewing the code, LGTM

review: Approve

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1292
http://jenkins.qa.ubuntu.com/job/ubuntu-system-settings-ci/1958/
Executed test runs:
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/1170
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-system-settings-vivid-i386-ci/228
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/1030
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1168
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1168/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/17767

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-system-settings-ci/1958/rebuild

review: Needs Fixing (continuous-integration)

[Michael Zanetti (mzanetti)]

Tested this on the tablet, seems not to completely work yet. The pin isn't displayed properly.

review: Needs Fixing

[Sebastien Bacher (seb128)]

I had a look at Michael's issue, on that device bluez DisplayPasskey() gives us a random value for "entered" (number of chars already typed) as soon as pairing starts (got 79 and 105 on the most recent runs) where it should be 0, not really a problem in the settings

[Michael Zanetti (mzanetti)]

ok, seems it's indeed not this branch's fault.

review: Abstain

=== modified file 'plugins/bluetooth/CMakeLists.txt'
--- plugins/bluetooth/CMakeLists.txt	2013-10-22 14:44:44 +0000
+++ plugins/bluetooth/CMakeLists.txt	2015-02-04 16:40:34 +0000
@@ -3,6 +3,7 @@
 set(QML_SOURCES
 ProvidePinCodeDialog.qml
 ConfirmPasskeyDialog.qml
+DisplayPasskeyDialog.qml
 ProvidePasskeyDialog.qml
 PageComponent.qml 
 )

=== added file 'plugins/bluetooth/DisplayPasskeyDialog.qml'
--- plugins/bluetooth/DisplayPasskeyDialog.qml	1970-01-01 00:00:00 +0000
+++ plugins/bluetooth/DisplayPasskeyDialog.qml	2015-02-04 16:40:34 +0000
@@ -0,0 +1,56 @@
+/*
+ * This file is part of ubuntu-system-settings
+ *
+ * Copyright (C) 2013 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 3, as published
+ * by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranties of
+ * MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+ * PURPOSE.  See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+
+import QtQuick 2.0
+import Ubuntu.Components 0.1
+import Ubuntu.Components.Popups 0.1
+
+Dialog {
+    id: root
+    title: i18n.tr("Bluetooth Pairing Request")
+
+    property string name: "Unknown"
+    property string passkey: "000000"
+    property string entered: "0"
+
+    signal canceled
+
+    // TRANSLATORS: %1 is the name of the bluetooth device being paired
+    text: i18n.tr("Please enter the following PIN on %1 and press “Enter” on the keyboard:").arg(root.name)
+
+    Label {
+        /* display the number of chars that remain to be typed */
+        text: root.passkey.slice(entered)+"⏎"
+        fontSize: "x-large"
+        verticalAlignment: Text.AlignVCenter
+        horizontalAlignment: Text.AlignHCenter
+    }
+
+    Row {
+        spacing: units.gu(1)
+        Button {
+            text: i18n.tr("Cancel")
+            onClicked: {
+                root.canceled()
+                PopupUtils.close(root)
+            }
+            width: (parent.width - parent.spacing)
+        }
+    }
+}

=== modified file 'plugins/bluetooth/PageComponent.qml'
--- plugins/bluetooth/PageComponent.qml	2014-12-10 20:55:12 +0000
+++ plugins/bluetooth/PageComponent.qml	2015-02-04 16:40:34 +0000
@@ -32,6 +32,8 @@
     title: i18n.tr("Bluetooth")
     objectName: "bluetoothPage"
 
+    property var dialogPopupId
+
     UbuntuBluetoothPanel { id: backend }
 
     Component {
@@ -49,6 +51,11 @@
         ProvidePinCodeDialog { }
     }
 
+    Component {
+        id: displayPasskeyDialog
+        DisplayPasskeyDialog { }
+    }
+
     Connections {
         target: backend.agent
         onPasskeyConfirmationNeeded: {
@@ -69,6 +76,24 @@
             popup.canceled.connect(function() {target.providePinCode(request_tag, false, "")})
             popup.provided.connect(function(pinCode) {target.providePinCode(request_tag, true, pinCode)})
         }
+        onDisplayPasskeyNeeded: {
+            if (!root.dialogPopupId)
+            {
+                var request_tag = tag
+                root.dialogPopupId  = PopupUtils.open(displayPasskeyDialog, root, {passkey: passkey, name: device.name,
+                                                 entered: entered})
+                root.dialogPopupId.canceled.connect(function() {root.dialogPopupId = null;
+                    target.displayPasskeyCallback(request_tag)})
+            }
+            else
+            {
+                root.dialogPopupId.entered = entered
+            }
+        }
+        onPairingDone: {
+            if (root.dialogPopupId)
+                PopupUtils.close(root.dialogPopupId)
+        }
     }
 
     function getDisplayName(type, displayName) {

=== modified file 'plugins/bluetooth/agent.cpp'
--- plugins/bluetooth/agent.cpp	2015-02-04 16:40:34 +0000
+++ plugins/bluetooth/agent.cpp	2015-02-04 16:40:34 +0000
@@ -22,7 +22,6 @@
 
 #include <cassert>
 
-
 /***
 ****
 ***/
@@ -54,7 +53,7 @@
  */
 void Agent::Release()
 {
-    Q_EMIT(onPairingDone());
+    Q_EMIT(pairingDone());
 }
 
 /***
@@ -219,20 +218,59 @@
     }
 }
 
-/***
-****
-***/
+/** This method gets called when the service daemon
+ * needs to display a passkey for an authentication.
+ * The entered parameter indicates the number of already
+ * typed keys on the remote side.
+ * An empty reply should be returned. When the passkey
+ * needs no longer to be displayed, the Cancel method
+ * of the agent will be called.
+ * During the pairing process this method might be
+ * called multiple times to update the entered value.
+ * Note that the passkey will always be a 6-digit number,
+ * so the display should be zero-padded at the start if
+ * the value contains less than 6 digits.
+ */
 
 void Agent::DisplayPasskey(const QDBusObjectPath &objectPath, uint passkey, ushort entered)
 {
-    Q_UNUSED(objectPath);
-    Q_UNUSED(passkey);
-    Q_UNUSED(entered);
-
-    // unimplemented -- unneeded for headsets
+    auto device = m_devices.getDeviceFromPath(objectPath.path());
+    if (device) {
+        const uint tag = m_tag++;
+
+        setDelayedReply(true);
+        assert(!m_delayedReplies.contains(tag));
+        m_delayedReplies[tag] = message();
+
+        QString passkeyStr = QString("%1").arg(passkey, 6, 10, QChar('0'));
+        Q_EMIT(displayPasskeyNeeded(tag, device.data(), passkeyStr, entered));
+    } else { // confirmation requested for an unknown device..?!
+        reject(message(), __func__);
+    }
 }
 
+/**
+ * This method gets called to indicate that the agent
+ * request failed before a reply was returned.
+ */
 void Agent::Cancel()
 {
-    // unimplemented -- companion function for DisplayPasskey
+    qWarning() << "Cancel callback called";
+}
+
+/**
+ * Invoked by the user-facing code after it prompts the user to cancel
+ * the passkey passed from an Agent::displayPasskeyNeeded signal.
+ *
+ * @param tag: the tag from the Agent::displayPasskeyNeeded signal
+ */
+void Agent::displayPasskeyCallback(uint tag)
+{
+    if (m_delayedReplies.contains(tag)) {
+        QDBusMessage message = m_delayedReplies[tag];
+
+        cancel(message, __func__);
+
+        m_delayedReplies.remove(tag);
+    }
 }

=== modified file 'plugins/bluetooth/agent.h'
--- plugins/bluetooth/agent.h	2015-02-04 16:40:34 +0000
+++ plugins/bluetooth/agent.h	2015-02-04 16:40:34 +0000
@@ -41,6 +41,7 @@
     Q_INVOKABLE void confirmPasskey(uint tag, bool confirmed);
     Q_INVOKABLE void providePasskey(uint tag, bool provided, uint passkey);
     Q_INVOKABLE void providePinCode(uint tag, bool provided, QString pinCode);
+    Q_INVOKABLE void displayPasskeyCallback(uint tag);
 
 public Q_SLOTS: // received from the system's bluez service
     void Cancel();
@@ -54,7 +55,8 @@
     void pinCodeNeeded(int tag, Device* device);
     void passkeyNeeded(int tag, Device* device);
     void passkeyConfirmationNeeded(int tag, Device* device, QString passkey);
-    void onPairingDone();
+    void displayPasskeyNeeded(int tag, Device* device, QString passkey, ushort entered);
+    void pairingDone();
 
 private:
     Q_DISABLE_COPY(Agent)