access

package

v0.0.0-...-3a9fb76 Latest Latest Go to latest Published: May 15, 2024 License: AGPL-3.0 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var ErrInvalidRegistrationConfig = errors.New("services: invalid registration configuration")

This section is empty.

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

AccessApplication holds all services related to access management.

func NewAccessApplication(cfgs []AccessConfig) (*AccessApplication, error)

NewAccessApplication intitializes the access application.

func (a *AccessApplication) CheckPasswordHash(password, hash string) bool

CheckPasswordHash checks that the input password matches the hash.

func (a *AccessApplication) HashPassword(password string) (string, error)

HashPassword hashes a password from plain text.

func (a *AccessApplication) RegisterUser(name, email, password string) (UserDTO, error)

RegisterUser registers a user if the email is not already registered.

type AccessConfig func(a *AccessApplication) error

AccessConfig is a function that modifies the application configuration.

func WithMemoryRepositories() AccessConfig

WithMemoryRepositories attaches in-memory repostories to application.

func WithPasswordHashCost(cost int) AccessConfig

WithPasswordHashCost attaches a password hash cost to application.

type UserDTO struct {
	Entity core.Person
	Email  string
	Active bool
}

UserDTO is a data transfer object of a user.

func NewUserDTO(user *model.User) UserDTO

NewUserDTO creates a user DTO.