totpapi

Documentation

Overview

Package totpapi provides an HTTP API for TOTP management.

Index

• func NewService(options ...ConfigOption) auth.TOTPAPI
• func SetupHTTPHandler(svc auth.TOTPAPI, router *mux.Router, tokenSvc auth.TokenService, ...)
• type ConfigOption
  • func WithLogger(l log.Logger) ConfigOption
  • func WithOTP(o auth.OTPService) ConfigOption
  • func WithRepoManager(repoMngr auth.RepositoryManager) ConfigOption
  • func WithTokenService(t auth.TokenService) ConfigOption
• type Response

Functions

func NewService

func NewService(options ...ConfigOption) auth.TOTPAPI

NewService returns a new implementation of auth.TOTPAPI.

func SetupHTTPHandler

func SetupHTTPHandler(svc auth.TOTPAPI, router *mux.Router, tokenSvc auth.TokenService, logger log.Logger, lmt httpapi.LimiterFactory)

SetupHTTPHandler converts a service's public methods to http handlers.

Types

type ConfigOption

type ConfigOption func(*service)

ConfigOption configures the service.

func WithLogger

func WithLogger(l log.Logger) ConfigOption

WithLogger configures the service with a logger.

func WithOTP

func WithOTP(o auth.OTPService) ConfigOption

WithOTP configures the service with an OTP management service.

func WithRepoManager

func WithRepoManager(repoMngr auth.RepositoryManager) ConfigOption

WithRepoManager configures the service with a new RepositoryManager.

func WithTokenService

func WithTokenService(t auth.TokenService) ConfigOption

WithTokenService configures the service with a TokenService.

type Response

type Response struct {
	TOTP string `json:"totp"`
}

Response is a success response with an embedded TOTP string.