yubikey

Documentation

Overview

Package yubikey provides an indicator for a waiting yubikey.

Index

• type Module
  • func ForPath(gpgPubringPath string) *Module
  • func New() *Module
  • func (m *Module) Output(outputFunc func(bool, bool) bar.Output) *Module
  • func (m *Module) Stream(sink bar.Sink)

Types

type Module

type Module struct {
	// contains filtered or unexported fields
}

Module represents a yubikey barista module that shows an indicator whenever the plugged-in yubikey is waiting for user input.

func ForPath

func ForPath(gpgPubringPath string) *Module

ForPath constructs a yubikey module with the given path to the gpg keyring.

func New

func New() *Module

New constructs a new yubikey module using the default paths for the u2f pending file and gpg keyring.

func (*Module) Output

func (m *Module) Output(outputFunc func(bool, bool) bar.Output) *Module

Output sets the output format for the module.

func (*Module) Stream

func (m *Module) Stream(sink bar.Sink)

Stream starts the module.