trezor

package module
v0.0.0-...-9e38328 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 23, 2019 License: BlueOak-1.0.0 Imports: 3 Imported by: 0

README

A CLI-based Trezor PIN entry interface, used to unlock Trezor devices.

Documentation here.

Recording of the UI in action:

Screen recording of PIN input

Documentation

Overview

Package trezor implements a Trezor PIN entry UI.

Unlocking a Trezor requires entering a PIN. The Trezor device itself shows a scrambled PIN entry pad on the screen, and the client software (eg this library) is responsible for providing a blank PIN entry pad for the user to input their PIN with. The user treats that blank entry pad as if it was labeled with numbers in the same order as the scramble they see on their Trezor screen. But the client software (this library) does not know the scramble, so it reports to Trezor the PIN entered by the user as if the entry pad had been a normal 1-9 grid.

This is easier to understand if you have gone through the process yourself. You can do so by using a physical Trezor and the official Trezor wallet software.

This library implements a full-screen terminal-based UI for PIN entry. It is used in [poke](https://github.com/reserve-protocol/poke).

Index

Constants

This section is empty.

Variables

View Source
var ErrUserCancelledInput = errors.New("user cancelled PIN entry")

Functions

func GetPIN

func GetPIN(prompt string) (string, error)

GetPIN implements Trezor PIN entry with a full-screen terminal-based UI.

Types

This section is empty.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL