Add support for Satochip hardware wallet

contrib/build-linux/appimage/Dockerfile

@@ -33,6 +33,8 @@ RUN apt-get update -q && \
         zlib1g-dev \
         libffi-dev \
         libncurses5-dev \
+        libpcsclite-dev \
+        swig \
         libncurses5 \
         libtinfo-dev \
         libtinfo5 \

contrib/build-wine/deterministic.spec

@@ -21,6 +21,7 @@ hiddenimports += collect_submodules('keepkeylib')
 hiddenimports += collect_submodules('websocket')
 hiddenimports += collect_submodules('ckcc')
 hiddenimports += collect_submodules('bitbox02')
+hiddenimports += collect_submodules('smartcard') # satochip
 hiddenimports += ['electrum.plugins.jade.jade']
 hiddenimports += ['electrum.plugins.jade.jadepy.jade']
 hiddenimports += ['PyQt5.QtPrintSupport']  # needed by Revealer
@@ -50,6 +51,7 @@ datas += collect_data_files('btchip')
 datas += collect_data_files('keepkeylib')
 datas += collect_data_files('ckcc')
 datas += collect_data_files('bitbox02')
+datas += collect_data_files('pysatochip')
 
 # We don't put these files in to actually include them in the script but to make the Analysis method scan them for imports
 a = Analysis([home+'run_electrum',
@@ -69,6 +71,7 @@ a = Analysis([home+'run_electrum',
               home+'electrum/plugins/keepkey/qt.py',
               home+'electrum/plugins/ledger/qt.py',
               home+'electrum/plugins/coldcard/qt.py',
+              home+'electrum/plugins/satochip/qt.py',
               home+'electrum/plugins/jade/qt.py',
               #home+'packages/requests/utils.py'
               ],

contrib/deterministic-build/requirements-hw.txt

@@ -220,6 +220,18 @@ pyaes==1.6.1 \
 pycparser==2.21 \
     --hash=sha256:8ee45429555515e1f6b185e78100aea234072576aa43ab53aefcae078162fca9 \
     --hash=sha256:e644fdec12f7872f86c58ff790da456218b10f863970249516d60a5eaca77206
+pysatochip==0.12.5 \
+    --hash=sha256:7adc031bbf4f0f6498ad7a2fddc20c9fac8b2e0531556574a32b7ad49042ea05 \
+    --hash=sha256:ce028b718b7a860ed873df0b49122f11bdc66b1437b424ced0fa34b277a4facb
+pyscard==2.0.0 \
+    --hash=sha256:2abc34387ce5d1567a1052edc47797c1288739b51b664468d34ca77c9a3b05c2 \
+    --hash=sha256:59cb506e8e793c397f3014f0933752df8d00c97c9f3a3385698e77213423962f \
+    --hash=sha256:60dbc52f00da90e3428e987679723588598579a7c3c757e9937cecd6e381ddd2 \
+    --hash=sha256:6d6ddcf57f97b0899b952c1c0746177c4b4b52af2ca47eb4d6bd0b9096530181 \
+    --hash=sha256:73945cd5a8c6e2e4982ba24d70fdba9e1b4ca68b82169337f4733823f7b49fb6 \
+    --hash=sha256:852a4e354bb82cc1f68afb204349ca68ea6c5332242644a80651a5c62bb1ab5f \
+    --hash=sha256:b364d9d9186e793c1c4709eb72a4d29e09067d36ca463b2c2abd995bd1055779 \
+    --hash=sha256:e162f9af64b49beb435e6543819f604e45534c822eb77fd100773f359fbcb6d8
 pyserial==3.5 \
     --hash=sha256:3c77e014170dfffbd816e6ffc205e9842efb10be9f58ec16d3e8675b4925cddb \
     --hash=sha256:c4451db6ba391ca6ca299fb3ec7bae67a5c55dde170964c7a14ceefec02f2cf0

contrib/osx/make_osx.sh

@@ -154,6 +154,54 @@ PYINSTALLER_COMMIT="413cce49ff28d87fad4472f4953489226ec90c84"
 info "Installing PyInstaller."
 python3 -m pip install --no-build-isolation --no-dependencies --no-warn-script-location "$CACHEDIR/pyinstaller"
 
+
+info "DEBUG SATOCHIP START"
+
+info "Installing some build-time deps for compilation..."
+brew install autoconf automake libtool gettext coreutils pkgconfig
+
+
+info "Building PyInstaller."
+PYINSTALLER_REPO="https://github.com/pyinstaller/pyinstaller.git"
+PYINSTALLER_COMMIT="40c9abce2d8de879e414fd377c933dccaab1e156"
+# ^ tag "4.2"
+# TODO test newer versions of pyinstaller for build-reproducibility.
+#      we are using this version for now due to change in code-signing behaviour
+#      (https://github.com/pyinstaller/pyinstaller/pull/5581)
+(
+    if [ -f "$CACHEDIR/pyinstaller/PyInstaller/bootloader/Darwin-64bit/runw" ]; then
+        info "pyinstaller already built, skipping"
+        exit 0
+    fi
+    cd "$PROJECT_ROOT"
+    ELECTRUM_COMMIT_HASH=$(git rev-parse HEAD)
+    cd "$CACHEDIR"
+    rm -rf pyinstaller
+    mkdir pyinstaller
+    cd pyinstaller
+    # Shallow clone
+    git init
+    git remote add origin $PYINSTALLER_REPO
+    git fetch --depth 1 origin $PYINSTALLER_COMMIT
+    git checkout -b pinned "${PYINSTALLER_COMMIT}^{commit}"
+    rm -fv PyInstaller/bootloader/Darwin-*/run* || true
+    # add reproducible randomness. this ensures we build a different bootloader for each commit.
+    # if we built the same one for all releases, that might also get anti-virus false positives
+    echo "const char *electrum_tag = \"tagged by Electrum@$ELECTRUM_COMMIT_HASH\";" >> ./bootloader/src/pyi_main.c
+    pushd bootloader
+    # compile bootloader
+    python3 ./waf all CFLAGS="-static"
+    popd
+    # sanity check bootloader is there:
+    [[ -e "PyInstaller/bootloader/Darwin-64bit/runw" ]] || fail "Could not find runw in target dir!"
+    rm pyinstaller.py  # workaround for https://github.com/pyinstaller/pyinstaller/pull/6701
+) || fail "PyInstaller build failed"
+info "Installing PyInstaller."
+python3 -m pip install --no-build-isolation --no-dependencies --no-warn-script-location "$CACHEDIR/pyinstaller"
+
+
+info "DEBUG SATOCHIP END"
+
 info "Using these versions for building $PACKAGE:"
 sw_vers
 python3 --version
@@ -176,6 +224,8 @@ info "generating locale"
     "$CONTRIB/build_locale.sh" "$CONTRIB/deterministic-build/electrum-locale/locale/" "$LOCALE"
 ) || fail "failed generating locale"
 
+info "Installing some build-time deps for compilation..."
+brew install swig
 
 if [ ! -f "$DLL_TARGET_DIR/libsecp256k1.2.dylib" ]; then
     info "Building libsecp256k1 dylib..."

contrib/osx/osx.spec

@@ -28,6 +28,7 @@ hiddenimports += collect_submodules('keepkeylib')
 hiddenimports += collect_submodules('websocket')
 hiddenimports += collect_submodules('ckcc')
 hiddenimports += collect_submodules('bitbox02')
+hiddenimports += collect_submodules('smartcard')   # Satochip
 hiddenimports += ['electrum.plugins.jade.jade']
 hiddenimports += ['electrum.plugins.jade.jadepy.jade']
 hiddenimports += ['PyQt5.QtPrintSupport']  # needed by Revealer
@@ -47,6 +48,7 @@ datas += collect_data_files('btchip')
 datas += collect_data_files('keepkeylib')
 datas += collect_data_files('ckcc')
 datas += collect_data_files('bitbox02')
+datas += collect_data_files('pysatochip')
 
 # Add libusb so Trezor and Safe-T mini will work
 binaries = [(electrum + "electrum/libusb-1.0.dylib", ".")]
@@ -74,6 +76,7 @@ a = Analysis([electrum+ MAIN_SCRIPT,
               electrum+'electrum/plugins/keepkey/qt.py',
               electrum+'electrum/plugins/ledger/qt.py',
               electrum+'electrum/plugins/coldcard/qt.py',
+              electrum+'electrum/plugins/satochip/qt.py', 
               electrum+'electrum/plugins/jade/qt.py',
               ],
              binaries=binaries,

contrib/requirements/requirements-hw.txt

@@ -21,6 +21,10 @@ ckcc-protocol>=0.7.7
 # device plugin: bitbox02
 bitbox02>=6.2.0
 
+# device plugin: satochip
+pyscard>=1.9.9
+pysatochip==0.12.5
+
 # device plugin: jade
 cbor>=1.0.0,<2.0.0
 pyserial>=3.5.0,<4.0.0

electrum/gui/qt/qrcodewidget.py

@@ -128,6 +128,7 @@ def __init__(
             show_text=False,
             help_text=None,
             show_copy_text_btn=False,
+            show_cancel_btn=False,
             config: SimpleConfig,
     ):
         WindowModalDialog.__init__(self, parent, title)
@@ -181,16 +182,27 @@ def copy_text_to_clipboard():
         b = QPushButton(_("Save"))
         hbox.addWidget(b)
         b.clicked.connect(print_qr)
+
+        if show_cancel_btn:
+            b = QPushButton(_("Ok"))
+            hbox.addWidget(b)
+            b.clicked.connect(self.accept)
+            b.setDefault(True)
 
-        b = QPushButton(_("Close"))
-        hbox.addWidget(b)
-        b.clicked.connect(self.accept)
-        b.setDefault(True)
-
+            b = QPushButton(_("Cancel"))
+            hbox.addWidget(b)
+            b.clicked.connect(self.reject)
+            b.setDefault(True)
+        else:
+            b = QPushButton(_("Close"))
+            hbox.addWidget(b)
+            b.clicked.connect(self.accept)
+            b.setDefault(True)
+
         vbox.addLayout(hbox)
         self.setLayout(vbox)
 
         # note: the word-wrap on the text_label is causing layout sizing issues.
         #       see https://stackoverflow.com/a/25661985 and https://bugreports.qt.io/browse/QTBUG-37673
         #       workaround:
-        self.setMinimumSize(self.sizeHint())
+        self.setMinimumSize(self.sizeHint())

electrum/plugins/satochip/README.rst

@@ -0,0 +1,83 @@
+Satochip plugin for electrum
+=================================================================================
+
+::
+
+  Licence: MIT Licence
+  Author: Toporin
+  Language: Python (>= 3.6)
+  Homepage: https://github.com/Toporin/electrum-satochip
+
+Introduction
+============
+
+This plugin allows to integrate the Satochip Hardware Wallet with Electrum. To use it, you need a device with the Satochip javacard applet installed (see https://github.com/Toporin/SatochipApplet).
+If the wallet is not intialized yet, Electrum will perform the setup (you only need to do this once). During setup, a seed is created: this seed allows you to recover your wallet at anytime, so make sure to BACKUP THE SEED SECURELY! During setup, a PIN code is also created: this PIN allows to unlock th device to access your funds. If you try too many wrong PIN, your device will be locked indefinitely (it is 'bricked'). If you loose your PIN or brick your device, you can only recover your funds with the seed backup.
+
+The Satochip wallet is currently in Beta, use with caution!You can use the software on the Bitcoin testnet using the --testnet option.
+This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.
+
+Rem: Electrum uses Python 3.x. In case of error, check first that you are not trying to run Electrum with Python 2.x or with Python 2.x libraries.
+
+Development version (Windows 64bits)
+=====================================
+
+Install the latest python 3.6 release from https://www.python.org (https://www.python.org/downloads/release/python-368/)
+(Caution: installing another release than 3.6 may cause incompatibility issues with pyscard)
+
+Clone or download the code from GitHub.
+
+Open a PowerShell command line in the electrum folder
+
+In PowerShell, install the electrum dependencies::
+
+    python -m pip install .   
+
+You may also ned to install Python3-pyqt5::
+
+    python -m pip install pyqt5
+
+Install pyscard from https://pyscard.sourceforge.io/
+Pyscard is required to connect to the smartcard::
+
+    python -m pip install pyscard
+
+
+In PowerShell, run electrum on the testnet (-v allows for verbose output)::
+
+    python .\run_electrum -v --testnet
+
+
+Development version (Ubuntu)
+==============================
+(Electrum requires Python 3.6, which should be installed by default on Ubuntu)
+(If necessary, install pip: sudo apt-get install python3-pip)
+
+Electrum is a pure python application. To use the
+Qt interface, install the Qt dependencies::
+
+    sudo apt-get install python3-pyqt5
+
+Check out the code from GitHub::
+
+    git clone git://github.com/Toporin/electrum.git
+    cd electrum
+
+In the electrum folder:    
+
+Run install (this should install dependencies)::
+
+    python3 -m pip install .
+
+Install pyscard (https://pyscard.sourceforge.io/)
+Pyscard is required to connect to the smartcard:: 
+    sudo apt-get install pcscd
+    sudo apt-get install python3-pyscard
+(For alternatives, see https://github.com/LudovicRousseau/pyscard/blob/master/INSTALL.md for more detailed installation instructions)
+
+
+To run Electrum use::
+ python3 electrum -v --testnet 
+
+
+

electrum/plugins/satochip/__init__.py

@@ -0,0 +1,6 @@
+
+fullname = 'Satochip Wallet'
+description = 'Provides support for Satochip hardware wallet'
+requires = [('satochip', 'github.com/Toporin/pysatochip')]
+registers_keystore = ('hardware', 'satochip', "Satochip wallet")
+available_for = ['qt']