ripple: sign tx command including tests

trezorlib/client.py

@@ -33,6 +33,7 @@ from . import mapping
 from . import nem
 from . import protobuf
 from . import stellar
+from . import ripple
 from .debuglink import DebugLink
 
 if sys.version_info.major < 3:
@@ -1089,6 +1090,14 @@ class ProtocolMixin(object):
             proto.RippleGetAddress(
                 address_n=address_n, show_display=show_display))
 
+    @expect(proto.RippleSignedTx)
+    def ripple_sign_tx(self, n, transaction):
+        ripple.validate(transaction)
+        n = self._convert_prime(n)
+        msg = ripple.create_sign_tx(transaction)
+        msg.address_n = n
+        return self.call(msg)
+
     @field('public_key')
     @expect(proto.StellarPublicKey)
     def stellar_get_public_key(self, address_n, show_display=False):

trezorlib/ripple.py

@@ -0,0 +1,48 @@
+# This file is part of the Trezor project.
+#
+# Copyright (C) 2012-2018 SatoshiLabs and contributors
+#
+# This library is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3
+# as published by the Free Software Foundation.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the License along with this library.
+# If not, see <https://www.gnu.org/licenses/lgpl-3.0.html>.
+
+import base64
+import struct
+import xdrlib
+
+from . import messages as proto
+
+
+def validate(transaction):
+    if False in (k in transaction for k in ("Fee", "Sequence", "TransactionType", "Amount", "Destination")):
+        raise ValueError("Some of the required fields missing (Fee, Sequence, TransactionType, Amount, Destination")
+    if transaction["TransactionType"] != "Payment":
+        raise ValueError("Only Payment transaction type is supported")
+
+
+def create_sign_tx(transaction) -> proto.RippleSignTx:
+    msg = proto.RippleSignTx()
+    msg.fee = transaction["Fee"]
+    msg.sequence = transaction["Sequence"]
+    if "Flags" in transaction:
+        msg.flags = transaction["Flags"]
+    if "LastLedgerSequence" in transaction:
+        msg.last_ledger_sequence = transaction["LastLedgerSequence"]
+
+    msg.payment = create_payment(transaction)
+    return msg
+
+
+def create_payment(transaction) -> proto.RipplePayment:
+    msg = proto.RipplePayment()
+    msg.amount = transaction["Amount"]
+    msg.destination = transaction["Destination"]
+    return msg

trezorlib/tests/device_tests/test_msg_ripple_sign_tx.py

@@ -0,0 +1,85 @@
+# This file is part of the Trezor project.
+#
+# Copyright (C) 2012-2018 SatoshiLabs and contributors
+#
+# This library is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3
+# as published by the Free Software Foundation.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the License along with this library.
+# If not, see <https://www.gnu.org/licenses/lgpl-3.0.html>.
+
+import pytest
+
+from .common import TrezorTest
+from .conftest import TREZOR_VERSION
+from binascii import unhexlify
+from trezorlib import ripple
+from trezorlib import messages as proto
+from trezorlib.client import CallException
+from trezorlib.tools import parse_path
+
+
+@pytest.mark.ripple
+@pytest.mark.skip_t1  # T1 support is not planned
+@pytest.mark.xfail(TREZOR_VERSION == 2, reason="T2 support is not yet finished")
+class TestMsgRippleSignTx(TrezorTest):
+
+    def test_ripple_sign_simple_tx(self):
+        self.setup_mnemonic_allallall()
+
+        resp = self.client.ripple_sign_tx(
+            parse_path("m/44'/144'/0'/0/0"), {
+                "TransactionType": "Payment",
+                "Destination": "rBKz5MC2iXdoS3XgnNSYmF69K1Yo4NS3Ws",
+                "Amount": 100000000,
+                "Flags": 0x80000000,
+                "Fee": 100000,
+                "Sequence": 25,
+            })
+        assert resp.signature == unhexlify('3045022100e243ef623675eeeb95965c35c3e06d63a9fc68bb37e17dc87af9c0af83ec057e02206ca8aa5eaab8396397aef6d38d25710441faf7c79d292ee1d627df15ad9346c0')
+        assert resp.serialized_tx == unhexlify('12000022800000002400000019614000000005f5e1006840000000000186a0732102131facd1eab748d6cddc492f54b04e8c35658894f4add2232ebc5afe7521dbe474473045022100e243ef623675eeeb95965c35c3e06d63a9fc68bb37e17dc87af9c0af83ec057e02206ca8aa5eaab8396397aef6d38d25710441faf7c79d292ee1d627df15ad9346c081148fb40e1ffa5d557ce9851a535af94965e0dd098883147148ebebf7304ccdf1676fefcf9734cf1e780826')
+
+        resp = self.client.ripple_sign_tx(
+            parse_path("m/44'/144'/0'/0/2"), {
+                "TransactionType": "Payment",
+                "Destination": "rNaqKtKrMSwpwZSzRckPf7S96DkimjkF4H",
+                "Amount": 1,
+                "Fee": 10,
+                "Sequence": 1,
+            })
+        assert resp.signature == unhexlify('3044022069900e6e578997fad5189981b74b16badc7ba8b9f1052694033fa2779113ddc002206c8006ada310edf099fb22c0c12073550c8fc73247b236a974c5f1144831dd5f')
+        assert resp.serialized_tx == unhexlify('1200002280000000240000000161400000000000000168400000000000000a732103dbed1e77cb91a005e2ec71afbccce5444c9be58276665a3859040f692de8fed274463044022069900e6e578997fad5189981b74b16badc7ba8b9f1052694033fa2779113ddc002206c8006ada310edf099fb22c0c12073550c8fc73247b236a974c5f1144831dd5f8114bdf86f3ae715ba346b7772ea0e133f48828b766483148fb40e1ffa5d557ce9851a535af94965e0dd0988')
+
+        resp = self.client.ripple_sign_tx(
+            parse_path("m/44'/144'/0'/0/2"), {
+                "TransactionType": "Payment",
+                "Destination": "rNaqKtKrMSwpwZSzRckPf7S96DkimjkF4H",
+                "Amount": 100000009,
+                "Flags": 0,
+                "Fee": 100,
+                "Sequence": 100,
+                "LastLedgerSequence": 333111,
+            })
+
+        assert resp.signature == unhexlify('30440220025a9cc2809527799e6ea5eb029488dc46c6632a8ca1ed7d3ca2d9211e80403a02202cfe8604e6c6d1d3c64246626cc1a1a9bd8a2163b969e561c6adda5dca8fc2a5')
+        assert resp.serialized_tx == unhexlify('12000022800000002400000064201b00051537614000000005f5e109684000000000000064732103dbed1e77cb91a005e2ec71afbccce5444c9be58276665a3859040f692de8fed2744630440220025a9cc2809527799e6ea5eb029488dc46c6632a8ca1ed7d3ca2d9211e80403a02202cfe8604e6c6d1d3c64246626cc1a1a9bd8a2163b969e561c6adda5dca8fc2a58114bdf86f3ae715ba346b7772ea0e133f48828b766483148fb40e1ffa5d557ce9851a535af94965e0dd0988')
+
+    def test_ripple_sign_invalid_fee(self):
+        with pytest.raises(CallException) as exc:
+            self.client.ripple_sign_tx(
+                parse_path("m/44'/144'/0'/0/2"), {
+                    "TransactionType": "Payment",
+                    "Destination": "rNaqKtKrMSwpwZSzRckPf7S96DkimjkF4H",
+                    "Amount": 1,
+                    "Flags": 1,
+                    "Fee": 1,
+                    "Sequence": 1,
+                })
+            assert exc.value.args[0] == proto.FailureType.ProcessError
+            assert exc.value.args[1].endswith('Fee must be in the range of 10 to 10,000 drops')