1
0
mirror of https://github.com/trezor/trezor-firmware.git synced 2024-11-27 01:48:17 +00:00
trezor-firmware/core/mocks/generated/trezorconfig.pyi

155 lines
3.5 KiB
Python
Raw Normal View History

2017-06-14 17:27:02 +00:00
from typing import *
2017-06-14 15:41:45 +00:00
2017-06-14 15:41:45 +00:00
# extmod/modtrezorconfig/modtrezorconfig.c
2019-06-09 09:24:06 +00:00
def init(
ui_wait_callback: Callable[[int, int, StorageMessage], bool] | None =
None
2019-06-09 09:24:06 +00:00
) -> None:
"""
Initializes the storage. Must be called before any other method is
called from this module!
"""
2017-06-14 15:41:45 +00:00
2018-03-09 10:37:06 +00:00
# extmod/modtrezorconfig/modtrezorconfig.c
def unlock(pin: str, ext_salt: bytes | None) -> bool:
"""
Attempts to unlock the storage with the given PIN and external salt.
Returns True on success, False on failure.
"""
# extmod/modtrezorconfig/modtrezorconfig.c
def check_pin(pin: str, ext_salt: bytes | None) -> bool:
"""
Check the given PIN with the given external salt.
Returns True on success, False on failure.
"""
2019-02-27 10:30:58 +00:00
# extmod/modtrezorconfig/modtrezorconfig.c
def lock() -> None:
"""
2019-02-27 10:30:58 +00:00
Locks the storage.
"""
2019-02-27 10:30:58 +00:00
# extmod/modtrezorconfig/modtrezorconfig.c
def is_unlocked() -> bool:
"""
Returns True if storage is unlocked, False otherwise.
"""
# extmod/modtrezorconfig/modtrezorconfig.c
def has_pin() -> bool:
"""
Returns True if storage has a configured PIN, False otherwise.
"""
# extmod/modtrezorconfig/modtrezorconfig.c
2019-02-27 10:30:58 +00:00
def get_pin_rem() -> int:
"""
2019-02-27 10:30:58 +00:00
Returns the number of remaining PIN entry attempts.
"""
2019-02-27 10:30:58 +00:00
# extmod/modtrezorconfig/modtrezorconfig.c
def change_pin(
oldpin: str,
newpin: str,
old_ext_salt: bytes | None,
new_ext_salt: bytes | None,
) -> bool:
"""
Change PIN and external salt. Returns True on success, False on failure.
"""
# extmod/modtrezorconfig/modtrezorconfig.c
def ensure_not_wipe_code(pin: str) -> None:
"""
Wipes the device if the entered PIN is the wipe code.
"""
# extmod/modtrezorconfig/modtrezorconfig.c
def has_wipe_code() -> bool:
"""
Returns True if storage has a configured wipe code, False otherwise.
"""
# extmod/modtrezorconfig/modtrezorconfig.c
def change_wipe_code(
pin: str,
ext_salt: bytes | None,
wipe_code: str,
) -> bool:
"""
Change wipe code. Returns True on success, False on failure.
"""
# extmod/modtrezorconfig/modtrezorconfig.c
def get(app: int, key: int, public: bool = False) -> bytes | None:
"""
2019-02-27 10:30:58 +00:00
Gets the value of the given key for the given app (or None if not set).
Raises a RuntimeError if decryption or authentication of the stored
value fails.
"""
2017-06-14 15:41:45 +00:00
# extmod/modtrezorconfig/modtrezorconfig.c
def set(app: int, key: int, value: bytes, public: bool = False) -> None:
"""
Sets a value of given key for given app.
"""
2017-06-14 15:41:45 +00:00
2019-02-27 10:30:58 +00:00
# extmod/modtrezorconfig/modtrezorconfig.c
def delete(
app: int, key: int, public: bool = False, writable_locked: bool = False
) -> bool:
"""
2019-02-27 10:30:58 +00:00
Deletes the given key of the given app.
"""
2019-02-27 10:30:58 +00:00
# extmod/modtrezorconfig/modtrezorconfig.c
def set_counter(
app: int, key: int, count: int, writable_locked: bool = False
) -> None:
"""
2019-02-27 10:30:58 +00:00
Sets the given key of the given app as a counter with the given value.
"""
2019-02-27 10:30:58 +00:00
# extmod/modtrezorconfig/modtrezorconfig.c
2019-07-09 12:05:14 +00:00
def next_counter(
app: int, key: int, writable_locked: bool = False,
) -> int:
"""
Increments the counter stored under the given key of the given app and
returns the new value.
"""
2019-02-27 10:30:58 +00:00
# extmod/modtrezorconfig/modtrezorconfig.c
def wipe() -> None:
"""
Erases the whole config. Use with caution!
"""
from enum import IntEnum
# extmod/modtrezorconfig/modtrezorconfig.c
class StorageMessage(IntEnum):
NO_MSG = 0
VERIFYING_PIN_MSG = 1
PROCESSING_MSG = 2
STARTING_MSG = 3
WRONG_PIN_MSG = 4