services

Documentation

Index

• Variables
• func UserCanDoSaml(cfg config.Config, identities models.Identities) bool
• func UserCanDoThirdParty(cfg config.Config, identities models.Identities) bool
• func ValidateUsername(name string) bool
• type DeviceTrustService
  • func (s DeviceTrustService) CheckDeviceTrust(userID uuid.UUID) bool
  • func (s DeviceTrustService) CreateTrustedDevice(userID uuid.UUID, deviceToken string) error
  • func (s DeviceTrustService) GenerateRandomToken(length int) (string, error)
• type Email
  • func NewEmailService(cfg config.Config) (*Email, error)
  • func (s *Email) RenderBody(lang, template string, data map[string]interface{}) (string, error)
  • func (s *Email) RenderSubject(lang, template string, data map[string]interface{}) string
  • func (s *Email) SendEmail(emailAddress, subject, body string) error
• type GenerateCreationOptionsParams
• type GenerateRequestOptionsPasskeyParams
• type GenerateRequestOptionsSecurityKeyParams
• type Passcode
  • func NewPasscodeService(cfg config.Config, emailService Email, persister persistence.Persister) Passcode
• type Password
  • func NewPasswordService(persister persistence.Persister) Password
• type SendPasscodeParams
• type SendPasscodeResult
• type ValidatePasscodeParams
• type VerifyAssertionResponseParams
• type VerifyAttestationResponseParams
• type WebauthnService
  • func NewWebauthnService(cfg config.Config, persister persistence.Persister) WebauthnService

Variables

var (
	ErrorPasscodeInvalid            = errors.New("passcode invalid")
	ErrorPasscodeNotFound           = errors.New("passcode not found")
	ErrorPasscodeExpired            = errors.New("passcode is expired")
	ErrorPasscodeMaxAttemptsReached = errors.New("the passcode was entered wrong too many times")
)

var (
	ErrInvalidWebauthnCredential        = errors.New("this passkey cannot be used anymore")
	ErrInvalidWebauthnCredentialMFAOnly = errors.New("this credential can be used as a second factor security key only")
)

var (
	ErrorPasswordInvalid = errors.New("password invalid")
)

Functions

func UserCanDoSaml

func UserCanDoSaml(cfg config.Config, identities models.Identities) bool

func UserCanDoThirdParty

func UserCanDoThirdParty(cfg config.Config, identities models.Identities) bool

func ValidateUsername

func ValidateUsername(name string) bool

Types

type DeviceTrustService

type DeviceTrustService struct {
	Persister   persistence.TrustedDevicePersister
	Cfg         config.Config
	HttpContext echo.Context
}

func (DeviceTrustService) CheckDeviceTrust

func (s DeviceTrustService) CheckDeviceTrust(userID uuid.UUID) bool

func (DeviceTrustService) CreateTrustedDevice

func (s DeviceTrustService) CreateTrustedDevice(userID uuid.UUID, deviceToken string) error

func (DeviceTrustService) GenerateRandomToken

func (s DeviceTrustService) GenerateRandomToken(length int) (string, error)

type Email

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

func NewEmailService

func NewEmailService(cfg config.Config) (*Email, error)

func (*Email) RenderBody

func (s *Email) RenderBody(lang, template string, data map[string]interface{}) (string, error)

RenderBody renders the body with the given template. The template name must be the name of the template without the content type and the file ending. E.g. when the file is created as "email_verification_text.tmpl" then the template name is just "email_verification"

func (*Email) RenderSubject

func (s *Email) RenderSubject(lang, template string, data map[string]interface{}) string

RenderSubject renders a subject with the given template. Must be "subject_[template_name]".

func (*Email) SendEmail

func (s *Email) SendEmail(emailAddress, subject, body string) error

SendEmail sends an email to the emailAddress with the given subject and body.

type GenerateCreationOptionsParams

type GenerateCreationOptionsParams struct {
	Tx       *pop.Connection
	UserID   uuid.UUID
	Email    *string
	Username *string
}

type GenerateRequestOptionsPasskeyParams

type GenerateRequestOptionsPasskeyParams struct {
	Tx *pop.Connection
}

type GenerateRequestOptionsSecurityKeyParams

type GenerateRequestOptionsSecurityKeyParams struct {
	Tx     *pop.Connection
	UserID uuid.UUID
}

type Passcode

type Passcode interface {
	ValidatePasscode(ValidatePasscodeParams) (bool, error)
	SendPasscode(*pop.Connection, SendPasscodeParams) (*SendPasscodeResult, error)
	VerifyPasscodeCode(tx *pop.Connection, passcodeID uuid.UUID, passcode string) error
}

func NewPasscodeService

func NewPasscodeService(cfg config.Config, emailService Email, persister persistence.Persister) Passcode

type Password

type Password interface {
	VerifyPassword(tx *pop.Connection, userId uuid.UUID, password string) error
	RecoverPassword(tx *pop.Connection, userId uuid.UUID, newPassword string) error
	CreatePassword(tx *pop.Connection, userId uuid.UUID, newPassword string) error
	UpdatePassword(tx *pop.Connection, passwordCredentialModel *models.PasswordCredential, newPassword string) error
}

func NewPasswordService

func NewPasswordService(persister persistence.Persister) Password

type SendPasscodeParams

type SendPasscodeParams struct {
	Template     string
	EmailAddress string
	Language     string
}

type SendPasscodeResult

type SendPasscodeResult struct {
	PasscodeModel models.Passcode
	Subject       string
	Body          string
	Code          string
}

type ValidatePasscodeParams

type ValidatePasscodeParams struct {
	Tx         *pop.Connection
	PasscodeID uuid.UUID
}

type VerifyAssertionResponseParams

type VerifyAssertionResponseParams struct {
	Tx                *pop.Connection
	SessionDataID     uuid.UUID
	AssertionResponse string
	IsMFA             bool
}

type VerifyAttestationResponseParams

type VerifyAttestationResponseParams struct {
	Tx            *pop.Connection
	SessionDataID uuid.UUID
	PublicKey     string
	UserID        uuid.UUID
	Email         *string
	Username      *string
}

type WebauthnService

type WebauthnService interface {
	GenerateRequestOptionsPasskey(GenerateRequestOptionsPasskeyParams) (*models.WebauthnSessionData, *protocol.CredentialAssertion, error)
	GenerateRequestOptionsSecurityKey(GenerateRequestOptionsSecurityKeyParams) (*models.WebauthnSessionData, *protocol.CredentialAssertion, error)
	VerifyAssertionResponse(VerifyAssertionResponseParams) (*models.User, error)
	GenerateCreationOptionsPasskey(GenerateCreationOptionsParams) (*models.WebauthnSessionData, *protocol.CredentialCreation, error)
	GenerateCreationOptionsSecurityKey(GenerateCreationOptionsParams) (*models.WebauthnSessionData, *protocol.CredentialCreation, error)
	VerifyAttestationResponse(VerifyAttestationResponseParams) (*webauthn.Credential, error)
}

func NewWebauthnService

func NewWebauthnService(cfg config.Config, persister persistence.Persister) WebauthnService