ragger 1.40.4__py3-none-any.whl → 1.41.0__py3-none-any.whl

ragger/__version__.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '1.40.4'
-__version_tuple__ = version_tuple = (1, 40, 4)
+__version__ = version = '1.41.0'
+__version_tuple__ = version_tuple = (1, 41, 0)
 
 __commit_id__ = commit_id = None

ragger/backend/interface.py

@@ -25,6 +25,7 @@ from warnings import warn
 from ragger.firmware import DEPRECATION_MESSAGE, Firmware
 from ragger.logger import get_default_logger, get_apdu_logger, set_apdu_logger_file
 from ragger.utils import pack_APDU, RAPDU, Crop
+from ragger.error import StatusWords
 
 
 class RaisePolicy(Enum):
@@ -130,7 +131,7 @@ class BackendInterface(ABC):
         """
         return ((self.raise_policy == RaisePolicy.RAISE_ALL)
                 or ((self.raise_policy == RaisePolicy.RAISE_ALL_BUT_0x9000) and
-                    (rapdu.status != 0x9000))
+                    (rapdu.status != StatusWords.SWO_SUCCESS))
                 or ((self.raise_policy == RaisePolicy.RAISE_CUSTOM) and
                     (rapdu.status not in self.whitelisted_status)))
 

ragger/backend/speculos.py

@@ -31,7 +31,7 @@ from ledgered.devices import Device
 from speculos.client import SpeculosClient, screenshot_equal, ApduResponse, ApduException
 from speculos.mcu.seproxyhal import TICKER_DELAY
 
-from ragger.error import ExceptionRAPDU
+from ragger.error import StatusWords, ExceptionRAPDU
 from ragger.logger import get_default_logger
 from ragger.utils import RAPDU, Crop
 from .interface import BackendInterface, GraphicalLibrary
@@ -198,17 +198,18 @@ class SpeculosBackend(BackendInterface):
     @raise_policy_enforcer
     def receive(self) -> RAPDU:
         assert self._pending is not None
-        result = RAPDU(0x9000, self._pending.receive())
+        result = RAPDU(StatusWords.SWO_SUCCESS, self._pending.receive())
         return result
 
     @raise_policy_enforcer
     def exchange_raw(self, data: bytes = b"", tick_timeout: int = 5 * 60 * 10) -> RAPDU:
         self.apdu_logger.info("=> %s", data.hex())
-        return RAPDU(0x9000, self._client._apdu_exchange(data, tick_timeout=tick_timeout))
+        return RAPDU(StatusWords.SWO_SUCCESS,
+                     self._client._apdu_exchange(data, tick_timeout=tick_timeout))
 
     @raise_policy_enforcer
     def _get_last_async_response(self, response) -> RAPDU:
-        return RAPDU(0x9000, response.receive())
+        return RAPDU(StatusWords.SWO_SUCCESS, response.receive())
 
     @contextmanager
     def exchange_async_raw(self, data: bytes = b"") -> Generator[bool, None, None]:

ragger/backend/stub.py

@@ -18,6 +18,7 @@ from pathlib import Path
 from types import TracebackType
 from typing import Any, Generator, Optional, Type
 
+from ragger.error import StatusWords
 from ragger.utils.structs import Crop, RAPDU
 from .interface import BackendInterface
 
@@ -45,10 +46,10 @@ class StubBackend(BackendInterface):
         pass
 
     def receive(self) -> RAPDU:
-        return RAPDU(0x9000, b"")
+        return RAPDU(StatusWords.SWO_SUCCESS, b"")
 
     def exchange_raw(self, data: bytes = b"", tick_timeout: int = 5 * 60 * 10) -> RAPDU:
-        return RAPDU(0x9000, b"")
+        return RAPDU(StatusWords.SWO_SUCCESS, b"")
 
     @contextmanager
     def exchange_async_raw(self, data: bytes = b"") -> Generator[None, None, None]:

ragger/error.py

@@ -14,6 +14,143 @@
    limitations under the License.
 """
 from dataclasses import dataclass
+from enum import IntEnum
+
+
+class StatusWords(IntEnum):
+    """ISO7816 Status Words for APDU responses.
+
+    Refer to:
+     - SDK https://github.com/LedgerHQ/ledger-secure-sdk/blob/master/include/status_words.h
+     - https://www.eftlab.com/knowledge-base/complete-list-of-apdu-responses
+
+    Notes:
+    - The SWO codes are defined based on the ISO/IEC 7816-4 standard for smart cards.
+
+    - 61XX and 6CXX are different.
+      When a command returns 61XX, its process is normally completed,
+      and it indicates the number of available bytes;
+      it then expects a GET RESPONSE command with the appropriate length.
+      When a command returns 6CXX, its process has been aborted,
+      and it expects the command to be reissued.
+      As mentioned above, 61XX indicates a normal completion,
+      and 6CXX is considered as a transport error (defined in ISO7817-3).
+
+    - Except for 63XX and 65XX, which warn that the persistent content has been changed,
+      other status word should be used when the persistent content of the application is unchanged.
+
+    - Status words 67XX, 6BXX, 6DXX, 6EXX, and 6FXX, where XX is not 0, are proprietary status words,
+      as well as 9YYY, where YYY is not 000.
+    """
+
+    # 61 -- Normal processing, lower byte indicates the amount of data to be retrieved
+    SWO_RESPONSE_BYTES_AVAILABLE = 0x6100
+
+    # 62 -- Warning, the state of persistent memory is unchanged
+    SWO_DATA_MAY_BE_CORRUPTED = 0x6281
+    SWO_EOF_REACHED_BEFORE_LE = 0x6282
+    SWO_SELECTED_FILE_INVALIDATED = 0x6283
+    SWO_FILE_INVALID = 0x6284
+    SWO_NO_INPUT_DATA_AVAILABLE = 0x6285
+
+    # 63 -- Warning, the state of persistent memory is changed
+    SWO_CARD_KEY_NOT_SUPPORTED = 0x6382
+    SWO_READER_KEY_NOT_SUPPORTED = 0x6383
+    SWO_PLAINTEXT_TRANS_NOT_SUPPORTED = 0x6384
+    SWO_SECURED_TRANS_NOT_SUPPORTED = 0x6385
+    SWO_VOLATILE_MEM_NOT_AVAILABLE = 0x6386
+    SWO_NON_VOLATILE_MEM_NOT_AVAILABLE = 0x6387
+    SWO_KEY_NUMBER_INVALID = 0x6388
+    SWO_KEY_LENGTH_INCORRECT = 0x6389
+    SWO_VERIFY_FAILED = 0x63C0  # lower 4-bits indicates the number of attempts left
+    SWO_MORE_DATA_EXPECTED = 0x63F1
+
+    # 64 -- Execution error, the state of persistent memory is unchanged
+    SWO_EXECUTION_ERROR = 0x6400
+    SWO_COMMAND_TIMEOUT = 0x6401
+
+    # 65 -- Execution error, the state of persistent memory is changed
+    SWO_MEMORY_WRITE_ERROR = 0x6501
+    SWO_MEMORY_FAILURE = 0x6581
+
+    # 66 -- Security-related issues
+    SWO_SECURITY_ISSUE = 0x6600
+    SWO_RECEIVE_ERROR_PARITY = 0x6601
+    SWO_WRONG_CHECKSUM = 0x6602
+    SWO_INCORRECT_PADDING = 0x6669
+
+    # 67 -- Transport error. The length is incorrect
+    SWO_WRONG_LENGTH = 0x6700
+
+    # 68 -- Functions in CLA not supported
+    SWO_NOT_SUPPORTED_ERROR_NO_INFO = 0x6800
+    SWO_LOGICAL_CHANNEL_NOT_SUPPORTED = 0x6881
+    SWO_SECURE_MESSAGING_NOT_SUPPORTED = 0x6882
+    SWO_LAST_COMMAND_OF_CHAIN_EXPECTED = 0x6883
+    SWO_COMMAND_CHAINING_NOT_SUPPORTED = 0x6884
+
+    # 69 -- Command not allowed
+    SWO_COMMAND_ERROR_NO_INFO = 0x6900
+    SWO_COMMAND_NOT_ACCEPTED = 0x6901
+    SWO_COMMAND_NOT_ALLOWED = 0x6980
+    SWO_SUBCOMMAND_NOT_ALLOWED = 0x6981
+    SWO_SECURITY_CONDITION_NOT_SATISFIED = 0x6982
+    SWO_AUTH_METHOD_BLOCKED = 0x6983
+    SWO_REFERENCED_DATA_BLOCKED = 0x6984
+    SWO_CONDITIONS_NOT_SATISFIED = 0x6985
+    SWO_COMMAND_NOT_ALLOWED_EF = 0x6986
+    SWO_EXPECTED_SECURE_MSG_OBJ_MISSING = 0x6987
+    SWO_INCORRECT_SECURE_MSG_DATA_OBJ = 0x6988
+    SWO_PERMISSION_DENIED = 0x69F0
+    SWO_MISSING_PRIVILEGES = 0x69F1
+
+    # 6A -- Wrong parameters (with details)
+    SWO_PARAMETER_ERROR_NO_INFO = 0x6A00
+    SWO_INCORRECT_DATA = 0x6A80
+    SWO_FUNCTION_NOT_SUPPORTED = 0x6A81
+    SWO_FILE_NOT_FOUND = 0x6A82
+    SWO_RECORD_NOT_FOUND = 0x6A83
+    SWO_INSUFFICIENT_MEMORY = 0x6A84
+    SWO_INCONSISTENT_TLV_STRUCT = 0x6A85
+    SWO_INCORRECT_P1_P2 = 0x6A86
+    SWO_WRONG_DATA_LENGTH = 0x6A87
+    SWO_REFERENCED_DATA_NOT_FOUND = 0x6A88
+    SWO_FILE_ALREADY_EXISTS = 0x6A89
+    SWO_DF_NAME_ALREADY_EXISTS = 0x6A8A
+    SWO_WRONG_PARAMETER_VALUE = 0x6AF0
+
+    # 6B -- Wrong parameters P1-P2
+    SWO_WRONG_P1_P2 = 0x6B00
+
+    # 6C -- Wrong Le field. lower byte indicates the appropriate length
+    SWO_INCORRECT_P3_LENGTH = 0x6C00
+
+    # 6D -- The instruction code is not supported
+    SWO_INVALID_INS = 0x6D00
+
+    # 6E -- The instruction class is not supported
+    SWO_INVALID_CLA = 0x6E00
+
+    # 6F -- No precise diagnosis is given
+    SWO_UNKNOWN = 0x6F00
+
+    # 9- --
+    SWO_SUCCESS = 0x9000
+    SWO_BUSY = 0x9001
+    SWO_PIN_NOT_SUCCESFULLY_VERIFIED = 0x9004
+    SWO_RESULT_OK = 0x9100
+    SWO_STATES_STATUS_WRONG = 0x9101
+    SWO_TRANSACTION_LIMIT_REACHED = 0x9102
+    SWO_INSUFFICIENT_MEM_FOR_CMD = 0x910E
+    SWO_COMMAND_CODE_NOT_SUPPORTED = 0x911C
+    SWO_INVALID_KEY_NUMBER = 0x9140
+    SWO_WRONG_LENGTH_FOR_INS = 0x917E
+    SWO_NO_EF_SELECTED = 0x9400
+    SWO_ADDRESS_RANGE_EXCEEDED = 0x9402
+    SWO_FID_NOT_FOUND = 0x9404
+    SWO_PARSE_ERROR = 0x9405
+    SWO_NO_PIN_DEFINED = 0x9802
+    SWO_ACCESS_CONDITION_NOT_FULFILLED = 0x9804
 
 
 @dataclass

{ragger-1.40.4.dist-info → ragger-1.41.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ragger
-Version: 1.40.4
+Version: 1.41.0
 Summary: Testing framework using Speculos and LedgerComm as backends
 Author-email: Ledger <hello@ledger.fr>
 Project-URL: Homepage, https://github.com/LedgerHQ/ragger

{ragger-1.40.4.dist-info → ragger-1.41.0.dist-info}/RECORD

@@ -1,15 +1,15 @@
 ragger/__init__.py,sha256=Vbk78M7VtDVMTu02zYQquYSTxtgbieknkvr3uXONrig,713
-ragger/__version__.py,sha256=ADu03uY4uf45DUBXt8SOLnUr7Anq23Yo77JHAUgSgiQ,706
-ragger/error.py,sha256=kd9yldPMis080jID6QjyDiCh7TDAVUtF5eczUH5pcKw,1251
+ragger/__version__.py,sha256=E1ZnJIkHAjOyZueq2FTrD7-A-X_nF3GK9RHXFfxJOQQ,706
+ragger/error.py,sha256=G81LOe38jUDV6EzdFc_foKVsMxk09q6N5--0M63qya0,6279
 ragger/logger.py,sha256=XF3DsHDLGOHAG7cqVj_7BQlHKj9J8zw8A9soFHIydc8,2457
 ragger/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ragger/backend/__init__.py,sha256=IQlMre2Pi5QWyYBTROMTbKuonNRUODKrrhj5UxcqQx4,1930
-ragger/backend/interface.py,sha256=nKAp0Q7IYyfyta0__HAxJ3L9BlKlZsqvMsBdUX7jpgQ,21485
+ragger/backend/interface.py,sha256=P_Uk0qXz8xrgy9m6mMaY7HWz_gg9dlYvarjmYpv_6EQ,21539
 ragger/backend/ledgercomm.py,sha256=XhG2GszkfjrJTPAECqUJ35PCkDs9mHnVn4ThbQZhQPg,3882
 ragger/backend/ledgerwallet.py,sha256=b8p6vTPCddAfIk9uT9bJbPqE8e4UqfL3w10ufqPdROc,3733
 ragger/backend/physical_backend.py,sha256=Y5BRhsKliqCyYFFce7D7swRlT3dkwsXptrUq3zm2Oks,5955
-ragger/backend/speculos.py,sha256=6HZ_BsVA19vFOOo91nI__VecMhIPHPUqxruC51lKqpE,16053
-ragger/backend/stub.py,sha256=p06nUL0S5z14rd9ZihVwpPylYPcIaAtD-WKaHTpDyIQ,3213
+ragger/backend/speculos.py,sha256=n83w4RevwHzFz-iF-Qo_tLCEckqxiP8e7PQ3wGMD21U,16138
+ragger/backend/stub.py,sha256=OIn4pIdnBuhgmCAAjGlVTEuWtaCLyCtVLVO-VTAEBRs,3284
 ragger/bip/__init__.py,sha256=7gY5V8gkJfct1g4OgaLg8bNpgoITGaqU9gTKC4tHbAM,920
 ragger/bip/path.py,sha256=uX69L3U8vteIHJy_PE5yPloGaiiYYMq_jLbBSENiRqs,1709
 ragger/bip/seed.py,sha256=yKGM_fkFCh6hNAl7vOMrEv5kEoQoDmVPhBCIMtO8dNk,1758
@@ -50,8 +50,8 @@ ragger/utils/__init__.py,sha256=PUabSv1qx0XyKWovIxvGBI71sd3O3bKp3gCsUxlWm1E,997
 ragger/utils/misc.py,sha256=_ft_CrwEcZ-VVZCBG-_QjYQuTZn-Fht36k3C6BXhHOs,6930
 ragger/utils/packing.py,sha256=2xaRR-FhwVfknP74ZGo-O4JTE6R0HpNqhxKJ9aMrns4,766
 ragger/utils/structs.py,sha256=JMfuX5u-4gSZfqH0SER05B15-mj0YyHjnxLAgxAYtAM,1413
-ragger-1.40.4.dist-info/licenses/LICENSE,sha256=tAkwu8-AdEyGxGoSvJ2gVmQdcicWw3j1ZZueVV74M-E,11357
-ragger-1.40.4.dist-info/METADATA,sha256=FO-46eXbyfrCpCyAdaQUnicWHow4ZFAHlzu1KSmq5_g,10660
-ragger-1.40.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-ragger-1.40.4.dist-info/top_level.txt,sha256=kqJEoAZ6qn0T3iuVa-710gBK7Ik1euCwNwBbyFraRQg,7
-ragger-1.40.4.dist-info/RECORD,,
+ragger-1.41.0.dist-info/licenses/LICENSE,sha256=tAkwu8-AdEyGxGoSvJ2gVmQdcicWw3j1ZZueVV74M-E,11357
+ragger-1.41.0.dist-info/METADATA,sha256=aW_QcwGG5g4ig6mypqRa7AzL-4-kW1yXoQYEWqRRmQ4,10660
+ragger-1.41.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+ragger-1.41.0.dist-info/top_level.txt,sha256=kqJEoAZ6qn0T3iuVa-710gBK7Ik1euCwNwBbyFraRQg,7
+ragger-1.41.0.dist-info/RECORD,,