ledger_go

README

ledger-go

This project provides a library to connect to ledger devices.

It handles USB (HID) communication and APDU encapsulation.

Linux, OSX and Windows are supported.

Building

go build

Documentation

Index

• Constants
• func CountLedgerDevices() uint
• func DeserializePacket(channel uint16, buffer []byte, sequenceIdx uint16) (result []byte, totalResponseLength uint16, err error)
• func ErrorMessage(errorCode uint16) string
• func ListDevices()
• func SerializePacket(channel uint16, command []byte, packetSize int, sequenceIdx uint16) (result []byte, offset int, err error)
• func UnwrapResponseAPDU(channel uint16, pipe <-chan []byte, packetSize int) ([]byte, error)
• func WrapCommandAPDU(channel uint16, command []byte, packetSize int) (result []byte, err error)
• type Ledger
  • func FindLedger() (*Ledger, error)
  • func GetLedger(requiredIndex uint) (*Ledger, error)
  • func (ledger *Ledger) Close() error
  • func (ledger *Ledger) Exchange(command []byte) ([]byte, error)
  • func (ledger *Ledger) Read() <-chan []byte
  • func (ledger *Ledger) Write(buffer []byte) (int, error)

Constants

const (
	VendorLedger         = 0x2c97
	UsagePageLedgerNanoS = 0xffa0
	//ProductNano     = 1
	Channel    = 0x0101
	PacketSize = 64
)

Functions

func CountLedgerDevices

func CountLedgerDevices() uint

func DeserializePacket

func DeserializePacket(
	channel uint16,
	buffer []byte,
	sequenceIdx uint16) (result []byte, totalResponseLength uint16, err error)

func ErrorMessage

func ErrorMessage(errorCode uint16) string

func ListDevices

func ListDevices()

func SerializePacket

func SerializePacket(
	channel uint16,
	command []byte,
	packetSize int,
	sequenceIdx uint16) (result []byte, offset int, err error)

func UnwrapResponseAPDU

func UnwrapResponseAPDU(channel uint16, pipe <-chan []byte, packetSize int) ([]byte, error)

UnwrapResponseAPDU parses a response of 64 byte packets into the real data

func WrapCommandAPDU

func WrapCommandAPDU(
	channel uint16,
	command []byte,
	packetSize int) (result []byte, err error)

WrapCommandAPDU turns the command into a sequence of 64 byte packets

Types

type Ledger

type Ledger struct {
	Logging bool
	// contains filtered or unexported fields
}

func FindLedger

func FindLedger() (*Ledger, error)

func GetLedger

func GetLedger(requiredIndex uint) (*Ledger, error)

func (*Ledger) Close

func (ledger *Ledger) Close() error

func (*Ledger) Exchange

func (ledger *Ledger) Exchange(command []byte) ([]byte, error)

func (*Ledger) Read

func (ledger *Ledger) Read() <-chan []byte

func (*Ledger) Write

func (ledger *Ledger) Write(buffer []byte) (int, error)