authenticator

README

Authenticator

A useful gas that used to authenticate every request for the web applications built using Air.

Installation

Open your terminal and execute

$ go get github.com/air-gases/authenticator

done.

The only requirement is the Go, at least v1.13.

Usage

The following application will require all home requests to carry an HTTP Basic Authentication (See RFC 2617, Section 2) header with the username part is "foo" and password part is "bar".

package main

import (
	"github.com/air-gases/authenticator"
	"github.com/aofei/air"
)

func main() {
	a := air.Default
	a.DebugMode = true
	a.GET("/", func(req *air.Request, res *air.Response) error {
		return res.WriteString("You are authorized!")
	}, authenticator.BasicAuthGas(authenticator.BasicAuthGasConfig{
		Validator: func(
				username string,
				password string,
				_ *air.Request,
				_ *air.Response,
		) (bool, error) {
			return username == "foo" && password == "bar", nil
		},
	}))
	a.Serve()
}

Community

If you want to discuss Authenticator, or ask questions about it, simply post questions or ideas here.

Contributing

If you want to help build Authenticator, simply follow this to send pull requests here.

License

This project is licensed under the MIT License.

License can be found here.

Documentation

Index

• func BasicAuthGas(bagc BasicAuthGasConfig) air.Gas
• type BasicAuthGasConfig

Functions

func BasicAuthGas

func BasicAuthGas(bagc BasicAuthGasConfig) air.Gas

BasicAuthGas returns an `air.Gas` that is used to authenticate ervery request by using the HTTP Basic Authentication (See RFC 2617, Section 2) based on the bagc. It prevents unauthenticated clients from accessing server resources.

Types

type BasicAuthGasConfig

type BasicAuthGasConfig struct {
	Validator       func(username, password string, req *air.Request, res *air.Response) (bool, error)
	Realm           string
	ErrUnauthorized error

	Skippable func(*air.Request, *air.Response) bool
}

BasicAuthGasConfig is a set of configurations for the `BasicAuthGas`.