totp

Documentation

Overview

Package totp provides TOTP functionality

Index

• type HCP
  • func New(ctx context.Context) (*HCP, error)
  • func (h *HCP) DeleteTOTP(ctx context.Context, name string) error
  • func (h *HCP) GenerateTOTP(ctx context.Context, name string) (string, string, error)
  • func (h *HCP) VerifyTOTP(ctx context.Context, name, code string) (bool, error)
• type ITOTP

Types

type HCP

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

HCP is a HashiCorp Vault implementation of ITOTP

func New

func New(ctx context.Context) (*HCP, error)

New creates a new HCP

func (*HCP) DeleteTOTP

func (h *HCP) DeleteTOTP(ctx context.Context, name string) error

DeleteTOTP deletes a TOTP key

func (*HCP) GenerateTOTP

func (h *HCP) GenerateTOTP(ctx context.Context, name string) (string, string, error)

GenerateTOTP creates a new TOTP key and generates a code

func (*HCP) VerifyTOTP

func (h *HCP) VerifyTOTP(ctx context.Context, name, code string) (bool, error)

VerifyTOTP verifies a TOTP code

type ITOTP

type ITOTP interface {
	GenerateTOTP(ctx context.Context, name string) (string, string, error)
	VerifyTOTP(ctx context.Context, name, code string) (bool, error)
	DeleteTOTP(ctx context.Context, name string) error
}

ITOTP is an interface for TOTP