webauthn

Documentation

Index

• func NewService(options ...ConfigOption) (auth.WebAuthnService, error)
• type ConfigOption
  • func WithDB(db Rediser) ConfigOption
  • func WithDisplayName(name string) ConfigOption
  • func WithDomain(domain string) ConfigOption
  • func WithRepoManager(repoMngr auth.RepositoryManager) ConfigOption
  • func WithRequestOrigin(origin string) ConfigOption
• type Rediser
• type User
  • func (u *User) WebAuthnCredentials() []webauthnLib.Credential
  • func (u *User) WebAuthnDisplayName() string
  • func (u *User) WebAuthnID() []byte
  • func (u *User) WebAuthnIcon() string
  • func (u *User) WebAuthnName() string
• type WebAuthn
  • func (w *WebAuthn) BeginLogin(ctx context.Context, user *auth.User) ([]byte, error)
  • func (w *WebAuthn) BeginSignUp(ctx context.Context, user *auth.User) ([]byte, error)
  • func (w *WebAuthn) FinishLogin(ctx context.Context, user *auth.User, r *http.Request) error
  • func (w *WebAuthn) FinishSignUp(ctx context.Context, user *auth.User, r *http.Request) (*auth.Device, error)
• type Webauthner

Functions

func NewService

func NewService(options ...ConfigOption) (auth.WebAuthnService, error)

NewService returns a new WebAuthn validator.

Types

type ConfigOption

type ConfigOption func(*WebAuthn)

ConfigOption configures the validator.

func WithDB

func WithDB(db Rediser) ConfigOption

WithDB configures the service with a redis DB

func WithDisplayName

func WithDisplayName(name string) ConfigOption

WithDisplayName configures the validator with a display name.

func WithDomain

func WithDomain(domain string) ConfigOption

WithDomain configures the validator with a domain name.

func WithRepoManager

func WithRepoManager(repoMngr auth.RepositoryManager) ConfigOption

WithRepoManager configures the service with a new RepositoryManager.

func WithRequestOrigin

func WithRequestOrigin(origin string) ConfigOption

WithRequestOrigin configures the validator with a request origin.

type Rediser

type Rediser interface {
	Get(key string) *redis.StringCmd
	Set(key string, value interface{}, expiration time.Duration) *redis.StatusCmd
	WithContext(ctx context.Context) *redis.Client
	Close() error
}

Rediser is an interface to go-redis.

type User

type User struct {
	*auth.User
	Devices []*auth.Device
}

User is a wrapper for the authenticator domain entity auth.User to allow compatibility with duo-lab's webauthn User interface.

func (*User) WebAuthnCredentials

func (u *User) WebAuthnCredentials() []webauthnLib.Credential

WebAuthnCredentials returns all of the user's Devices.

func (*User) WebAuthnDisplayName

func (u *User) WebAuthnDisplayName() string

WebAuthnDisplayName returns the User's display name.

func (*User) WebAuthnID

func (u *User) WebAuthnID() []byte

WebAuthnID returns the User's ID.

func (*User) WebAuthnIcon

func (u *User) WebAuthnIcon() string

WebAuthnIcon returns an Icon for the user.

func (*User) WebAuthnName

func (u *User) WebAuthnName() string

WebAuthnName returns the User's name.

type WebAuthn

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

WebAuthn is a implements the WebAuthn authentication protocol. Under the hood it defers the actual validation to the /duo-labs/webauthn library and wraps the service's domain entities to provide compatibility with the third party library.

func (*WebAuthn) BeginLogin

func (w *WebAuthn) BeginLogin(ctx context.Context, user *auth.User) ([]byte, error)

BeginLogin attempts to authenticate a user through device ownership.

func (*WebAuthn) BeginSignUp

func (w *WebAuthn) BeginSignUp(ctx context.Context, user *auth.User) ([]byte, error)

BeginSignUp attempts to register a new WebAuthn capable device for a user.

func (*WebAuthn) FinishLogin

func (w *WebAuthn) FinishLogin(ctx context.Context, user *auth.User, r *http.Request) error

FinishLogin determines if a user successfully proved ownership of their device, thereby asserting their identity.

func (*WebAuthn) FinishSignUp

func (w *WebAuthn) FinishSignUp(ctx context.Context, user *auth.User, r *http.Request) (*auth.Device, error)

FinishSignUp attempts to verify a registration attempt for a new WebAuthn capable device.

type Webauthner

type Webauthner interface {
	BeginRegistration(user webauthnLib.User, opts ...webauthnLib.RegistrationOption) (*webauthnProto.CredentialCreation, *webauthnLib.SessionData, error)
	FinishRegistration(user webauthnLib.User, session webauthnLib.SessionData, r *http.Request) (*webauthnLib.Credential, error)
	BeginLogin(user webauthnLib.User, opts ...webauthnLib.LoginOption) (*webauthnProto.CredentialAssertion, *webauthnLib.SessionData, error)
	FinishLogin(user webauthnLib.User, session webauthnLib.SessionData, r *http.Request) (*webauthnLib.Credential, error)
}

Webauthner is an interface to duo-labs/webauthn