auth

README

auth

Package auth is a middleware that provides request authentication for Flamego.

Installation

The minimum requirement of Go is 1.18.

go get github.com/flamego/auth

Getting started

package main

import (
	"github.com/flamego/auth"
	"github.com/flamego/flamego"
)

func main() {
	f := flamego.Classic()
	f.Use(auth.Basic("username", "secretpassword"))
	f.Get("/", func(user auth.User) string {
		return "Welcome, " + string(user)
	})
	f.Run()
}

Getting help

• Read documentation and examples.
• Please file an issue or start a discussion on the flamego/flamego repository.

License

This project is under the MIT License. See the LICENSE file for the full license text.

Documentation

Index

• func Basic(username, password string) flamego.Handler
• func BasicFunc(fn func(username, password string) bool) flamego.Handler
• func Bearer(token string) flamego.Handler
• func BearerFunc(fn func(token string) bool) flamego.Handler
• func SecureCompare(given, actual string) bool
• type Token
• type User

Functions

func Basic

func Basic(username, password string) flamego.Handler

Basic returns a middleware handler that injects auth.User into the request context upon successful basic authentication. The handler responds http.StatusUnauthorized when authentication fails.

func BasicFunc

func BasicFunc(fn func(username, password string) bool) flamego.Handler

BasicFunc returns a middleware handler that injects auth.User into the request context upon successful basic authentication with the given function. The function should return true for a valid username and password combination.

func Bearer

func Bearer(token string) flamego.Handler

Bearer returns a middleware handler that injects auth.User (empty string) into the request context upon successful bearer authentication. The handler responds http.StatusUnauthorized when authentication fails.

func BearerFunc

func BearerFunc(fn func(token string) bool) flamego.Handler

BearerFunc returns a middleware handler that injects auth.User (empty string) into the request context upon successful bearer authentication with the given function. The function should return true for a valid bearer token.

func SecureCompare

func SecureCompare(given, actual string) bool

SecureCompare performs a constant time compare of two strings to prevent timing attacks.

Types

type Token

type Token string

Token is the authenticated token that was extracted from the request.

type User

type User string

User is the authenticated username that was extracted from the request.