rfid

Documentation

Index

• Variables
• func Escapable[T any](ctx context.Context, fn func(context.Context) (T, error)) (_ T, err error)
• func LogHex(key string, value []byte) slog.Attr
• func Must[T any](val T, err error) T
• type APDUer
• type APDUerFunc
  • func (f APDUerFunc) APDU(ctx context.Context, capdu apdu.Capdu) (apdu.Rapdu, error)
  • func (f APDUerFunc) Exchange(ctx context.Context, capdu []byte) (_ []byte, err error)
• type Exchanger
• type ExchangerAPDUer
  • func RawSmartCardAPDUer(sc RawSmartCard) ExchangerAPDUer
  • func RawSmartCardControlAPDUer(sc RawSmartCardControl, ioctl uint32) ExchangerAPDUer
  • func SmartCardControlAPDUer(sc SmartCardControl, code uint16) ExchangerAPDUer
• type ExchangerFunc
  • func (f ExchangerFunc) APDU(ctx context.Context, capdu apdu.Capdu) (_ apdu.Rapdu, err error)
  • func (f ExchangerFunc) Exchange(ctx context.Context, capdu []byte) ([]byte, error)
• type RawSmartCard
• type RawSmartCardControl
• type SmartCardControl
  • func RawSmartCardControlToSmartCardControl(sc RawSmartCardControl, controlCodeToIoctl func(code uint16) uint32) SmartCardControl
• type SmartCardControlFunc
  • func (f SmartCardControlFunc) Control(ctx context.Context, code uint16, data []byte) ([]byte, error)

Variables

var DeferWrap = func(ctx context.Context, err *error) {}

DeferWrap is called by library functions when returning errors to enrich them with stack trace information. By default, this is a no-op but exists so consumers of the library can BYO their own library If context is not available in a given function context.Background() will be used

var ErrorAttrs = func(err error) slog.Attr {
	return slog.String("error", err.Error())
}

Functions

func Escapable

func Escapable[T any](ctx context.Context, fn func(context.Context) (T, error)) (_ T, err error)

Escapable runs the given func in a goroutine and waits for the response. This is useful to convert non-context aware blocking functions to be context aware with the caveat that cancellation will not abort the non-context aware function but does enabling returning early. If the context is cancelled it returns immediately with the context.Cause abandoning the goroutine If the context is already cancelled it returns immediately without invoking the func.

func LogHex

func LogHex(key string, value []byte) slog.Attr

func Must

func Must[T any](val T, err error) T

Types

type APDUer

type APDUer interface {
	APDU(context.Context, apdu.Capdu) (apdu.Rapdu, error)
}

APDUer is a higher level version of Exchanger that operates on parsed ISO7816 APDUs instead of raw byte slices

type APDUerFunc

type APDUerFunc func(context.Context, apdu.Capdu) (apdu.Rapdu, error)

APDUerFunc implements the ExchangerAPDUer interface as an APDUer.APDU func

func (APDUerFunc) APDU

func (f APDUerFunc) APDU(ctx context.Context, capdu apdu.Capdu) (apdu.Rapdu, error)

func (APDUerFunc) Exchange

func (f APDUerFunc) Exchange(ctx context.Context, capdu []byte) (_ []byte, err error)

type Exchanger

type Exchanger interface {
	Exchange(ctx context.Context, capdu []byte) ([]byte, error)
}

Exchanger is a higher level version of RawSmartCard that takes a context for cancellation

type ExchangerAPDUer

type ExchangerAPDUer interface {
	Exchanger
	APDUer
}

ExchangerAPDUer is a composite interface of Exchanger and APDUer

func RawSmartCardAPDUer

func RawSmartCardAPDUer(sc RawSmartCard) ExchangerAPDUer

RawSmartCardAPDUer transforms RawSmartCard into an ExchangerAPDUer with the ability to abandon waiting for a response if the context is cancelled

func RawSmartCardControlAPDUer

func RawSmartCardControlAPDUer(sc RawSmartCardControl, ioctl uint32) ExchangerAPDUer

RawSmartCardControlAPDUer transforms RawSmartCard into an ExchangerAPDUer by performing escape functions with the given ioctl. It also provides the ability to abandon waiting for a response if the context is cancelled

func SmartCardControlAPDUer

func SmartCardControlAPDUer(sc SmartCardControl, code uint16) ExchangerAPDUer

SmartCardControlAPDUer transforms SmartCardControl into an ExchangerAPDUer by performing control functions with the given code.

type ExchangerFunc

type ExchangerFunc func(ctx context.Context, capdu []byte) ([]byte, error)

ExchangerFunc implements the ExchangerAPDUer interface as an Exchanger.Exchange func

func (ExchangerFunc) APDU

func (f ExchangerFunc) APDU(ctx context.Context, capdu apdu.Capdu) (_ apdu.Rapdu, err error)

func (ExchangerFunc) Exchange

func (f ExchangerFunc) Exchange(ctx context.Context, capdu []byte) ([]byte, error)

type RawSmartCard

type RawSmartCard interface {
	Transmit(data []byte) ([]byte, error)
}

RawSmartCard is an interface that is implemented by *github.com/ebfe/go-scard.Card

type RawSmartCardControl

type RawSmartCardControl interface {
	Control(ioctl uint32, data []byte) ([]byte, error)
}

RawSmartCardControl is an interface that is implemented by *github.com/ebfe/go-scard.Card

type SmartCardControl

type SmartCardControl interface {
	Control(ctx context.Context, code uint16, data []byte) ([]byte, error)
}

SmartCardControl is a higher level version of RawSmartCardControl that takes control codes instead of ioctls for platform portability and accepts a context for cancellation

func RawSmartCardControlToSmartCardControl

func RawSmartCardControlToSmartCardControl(sc RawSmartCardControl, controlCodeToIoctl func(code uint16) uint32) SmartCardControl

RawSmartCardControlToSmartCardControl transforms RawSmartCardControl into an SmartCardControl with the ability to abandon waiting for a response if the context is cancelled

type SmartCardControlFunc

type SmartCardControlFunc func(ctx context.Context, code uint16, data []byte) ([]byte, error)

SmartCardControlFunc implements the SmartCardControl interface as an SmartCardControl.Control func

func (SmartCardControlFunc) Control

func (f SmartCardControlFunc) Control(ctx context.Context, code uint16, data []byte) ([]byte, error)