magic

package

v1.1.4 Latest Latest Go to latest Published: Oct 14, 2025 License: Apache-2.0 Imports: 17 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/loopholelabs/auth

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
type Magic
- func New(db *db.DB, logger types.Logger) (*Magic, error)

Constants ¶

View Source

const (
	GCInterval = time.Minute
	Expiry     = time.Minute * 5
	Timeout    = time.Second * 30
)

Variables ¶

View Source

var (
	ErrDBIsRequired   = errors.New("db is required")
	ErrCreatingFlow   = errors.New("error creating flow")
	ErrCompletingFlow = errors.New("error completing flow")
	ErrInvalidNextURL = errors.New("invalid next URL")
	ErrInvalidToken   = errors.New("invalid token")
	ErrInvalidSecret  = errors.New("invalid secret")
)

Functions ¶

This section is empty.

Types ¶

type Magic ¶

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

func New ¶

func New(db *db.DB, logger types.Logger) (*Magic, error)

func (*Magic) Close ¶

func (c *Magic) Close() error

func (*Magic) CompleteFlow ¶

func (c *Magic) CompleteFlow(ctx context.Context, token string) (flow.Data, error)

func (*Magic) CreateFlow ¶

func (c *Magic) CreateFlow(ctx context.Context, emailAddress string, deviceIdentifier pgtype.UUID, userIdentifier pgtype.UUID, nextURL string) (string, error)

CreateFlow creates a new magic link flow Called from API handler - inputs should be pre-validated pgx types Defensive check: validates deviceIdentifier.Valid and userIdentifier.Valid if provided Note: emailAddress and nextURL are strings (not database IDs)

Source Files ¶

View all Source files

magic.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL